rom/workbench/removeappwindow.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Remove a window from Workbench's list of AppWindows.
   6     Lang: English
   7 */
   8
   9 #include <exec/lists.h>
  10
  11 #include "workbench_intern.h"
  12 #include <workbench/workbench.h>
  13
  14 /*****************************************************************************
  15
  16     NAME */
  17
  18         #include <proto/workbench.h>
  19
  20         AROS_LH1(BOOL, RemoveAppWindow,
  21
  22 /*  SYNOPSIS */
  23
  24         AROS_LHA(struct AppWindow *, appWindow, A0),
  25
  26 /*  LOCATION */
  27         struct WorkbenchBase *, WorkbenchBase, 9, Workbench)
  28
  29 /*  FUNCTION
  30
  31     Try to remove an AppWindow from workbench.library's list of AppWindow:s.
  32
  33     INPUTS
  34
  35     appWindow  --  pointer to AppWindow structure got from AddAppWindow().
  36
  37     RESULT
  38
  39     TRUE if the window could be removed, FALSE otherwise.
  40
  41     NOTES
  42
  43     You have to do another check for messages on the AppWindow message port
  44     you specified at the AppWindow creation time (AddAppWindow()) after the
  45     window is removed as it may have arrived messages between the last time
  46     you checked and the call of this function.
  47         Before the AppWindow is removed, all its drop zones will be removed.
  48     Thus there is no need to call RemoveAppWindowDropZone() explicitly.
  49
  50     EXAMPLE
  51
  52     BUGS
  53
  54     SEE ALSO
  55
  56     AddAppWindowA(), RemoveAppWindowDropZone()
  57
  58     INTERNALS
  59
  60 ******************************************************************************/
  61 {
  62     AROS_LIBFUNC_INIT
  63
  64     if (appWindow == NULL)
  65     {
  66         return FALSE;
  67     }
  68
  69     LockWorkbench();
  70
  71     while (!IsListEmpty(&appWindow->aw_DropZones))
  72     {
  73         RemoveAppWindowDropZone(appWindow,
  74               (struct AppWindowDropZone *)GetHead(&appWindow->aw_DropZones));
  75     }
  76
  77     Remove((struct Node *)appWindow);
  78
  79     UnlockWorkbench();
  80
  81     FreeVec(appWindow);
  82
  83     /* NotifyWorkbench(WBNOTIFY_Create, WBNOTIFY_AppWindow, WorkbenchBase); */
  84
  85     return TRUE;
  86
  87     AROS_LIBFUNC_EXIT
  88 } /* RemoveAppWindow */