rom/workbench/getnextappicon.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Accesses AppIcon information from workbench.library.
   6     Lang: English
   7 */
   8
   9 #include <exec/types.h>
  10 #include <exec/ports.h>
  11 #include <utility/tagitem.h>
  12 #include <dos/dos.h>
  13 #include <graphics/gfx.h>
  14
  15 #include <proto/utility.h>
  16
  17 #include "workbench_intern.h"
  18 #include <workbench/workbench.h>
  19
  20 #define DEBUG 0
  21 #include <aros/debug.h>
  22 /*****************************************************************************
  23
  24     NAME */
  25     #include <proto/workbench.h>
  26
  27         AROS_LH2(struct DiskObject *, GetNextAppIcon,
  28 /*  SYNOPSIS */
  29         AROS_LHA(struct DiskObject *, lastdiskobj,  A0),
  30         AROS_LHA(char *,              text,         A1),
  31
  32 /*  LOCATION */
  33         struct WorkbenchBase *, WorkbenchBase, 10, Workbench)
  34
  35 /*  FUNCTION
  36
  37     Accesses AppIcon information from workbench.library. This function
  38     is meant for iterations through wblibs´ AppIcon storage as needed
  39     to display those.
  40         Initialised with a NULL as the first argument, it iterates
  41     through all AppIcons stored in workbench.library by returning the
  42     pointer to the next AppIcon´s DiskObject structure and copies the
  43     name of the given AppIcon to the given array. The function returns
  44     a NULL if the end of AppIcon list was reached or if no AppIcons
  45     were stored.
  46
  47     INPUTS
  48
  49     lastdiskobj  --  NULL (initial value) or pointer to a DiskObject
  50                      structure stored in workbench.library
  51     text         --  char array pointer to store AppIcon´s name in
  52
  53     RESULT
  54
  55     A pointer to an DiskObject structure -- which should be used within
  56     the next function call to access the next AppIcon -- or NULL if no
  57     AppIcons were found or end of list was reached.
  58
  59     NOTES
  60
  61     EXAMPLE
  62
  63       struct DiskObject *_nb_dob = NULL;
  64       char text[32];
  65
  66       while ( _nb_dob = GetNextAppIcon(_nb_dob, &text) )
  67       {
  68           printf("appicon found: %s \n", text);
  69       }
  70
  71
  72     BUGS
  73
  74     SEE ALSO
  75
  76     AddAppIconA(), RemoveAppIcon(), WorkbenchControlA(), icon.library/DrawIconStateA()
  77
  78     INTERNALS
  79
  80 ******************************************************************************/
  81 {
  82     AROS_LIBFUNC_INIT
  83
  84     /* get wblibs list of appicons */
  85     struct List *appiconlist = NULL;
  86     appiconlist = &WorkbenchBase->wb_AppIcons;
  87
  88
  89     /* return NULL if list empty or argument dob is already from last appicon in list*/
  90     if ( !IsListEmpty(appiconlist) )
  91     {
  92         /* return NULL if last entry reached */
  93         if (lastdiskobj == ((struct AppIcon *)(appiconlist->lh_TailPred))->ai_DiskObject) return NULL;
  94
  95         struct Node *currentnode = appiconlist->lh_Head;
  96         currentnode = GetHead(appiconlist);
  97
  98         /* iterations through the list */
  99         do
 100         {
 101             /* check if given DiskObject was found and return it´s successor */
 102             if ( ((struct AppIcon*)currentnode)->ai_DiskObject == lastdiskobj)
 103             {
 104                 currentnode = GetSucc(currentnode);
 105
 106                 bug("[getnextappicon] appicon found: %s \n", ((struct AppIcon*)currentnode)->ai_Text );
 107
 108                 strcpy(text, ((struct AppIcon*)currentnode)->ai_Text );
 109                 return ((struct AppIcon*)currentnode)->ai_DiskObject;
 110             }
 111
 112
 113         } while ( currentnode = GetSucc(currentnode) );
 114
 115         /* return first entry if NULL was given or DiskObject could not be found */
 116         strcpy(text, ((struct AppIcon *)(appiconlist->lh_Head))->ai_Text );
 117         return ((struct AppIcon *)(appiconlist->lh_Head))->ai_DiskObject;
 118
 119     }
 120
 121     return NULL;
 122
 123     AROS_LIBFUNC_EXIT
 124 } /* GetNextAppIcon() */