rom/workbench/removeappicon.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Remove an icon from Workbench's list of AppIcons.
   6     Lang: English
   7 */
   8
   9 #include "workbench_intern.h"
  10 #include <workbench/workbench.h>
  11
  12 /*****************************************************************************
  13
  14     NAME */
  15
  16         #include <proto/workbench.h>
  17
  18         AROS_LH1(BOOL   , RemoveAppIcon,
  19 /*  SYNOPSIS */
  20         AROS_LHA(struct AppIcon *, appIcon, A0),
  21 /*  LOCATION */
  22
  23         struct WorkbenchBase *, WorkbenchBase, 11, Workbench)
  24 /*  FUNCTION
  25
  26     Try to remove an AppIcon from workbench.library's list of AppIcons.
  27
  28     INPUTS
  29
  30     appIcon  --  pointer to an AppIcon got from AddAppIconA()
  31
  32     RESULT
  33
  34     TRUE if the icon could be removed, FALSE otherwise.
  35
  36     NOTES
  37
  38     You must do a final check for messages on your AppMessage port as messages
  39     may have been sent between the last time you checked and the call to
  40     this function.
  41
  42     EXAMPLE
  43
  44     BUGS
  45
  46     SEE ALSO
  47
  48     AddAppIconA()
  49
  50     INTERNALS
  51
  52 ******************************************************************************/
  53 {
  54     AROS_LIBFUNC_INIT
  55
  56     if (appIcon == NULL)
  57     {
  58         return FALSE;
  59     }
  60
  61     LockWorkbench();
  62     Remove((struct Node *)appIcon);
  63     UnlockWorkbench();
  64
  65     FreeVec(appIcon);
  66
  67     /*
  68       Question is if we should negotiate with the (possible) workbench
  69       application. Probably not... we just remove it from the list and
  70       send a message to the workbench application that the icon should
  71       be removed as soon as possible.
  72
  73       NotifyWorkbench(WBNOTIFY_Delete, WBNOTIFY_AppIcon, WorkbenchBase); */
  74
  75     return TRUE;
  76
  77     AROS_LIBFUNC_EXIT
  78 } /* RemoveAppIcon */