rom/workbench/removeappwindowdropzone.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Remove a dropzone from a AppWindow's list of AppWindowDropZones.
   6     Lang: English
   7 */
   8
   9 #include <exec/types.h>
  10 #include <exec/ports.h>
  11 #include <utility/tagitem.h>
  12 #include <intuition/intuition.h>
  13
  14 #include "workbench_intern.h"
  15 #include <workbench/workbench.h>
  16
  17 /*****************************************************************************
  18
  19     NAME */
  20
  21         #include <proto/workbench.h>
  22
  23         AROS_LH2(BOOL, RemoveAppWindowDropZone,
  24
  25 /*  SYNOPSIS */
  26         AROS_LHA(struct AppWindow *        , aw      , A0),
  27         AROS_LHA(struct AppWindowDropZone *, dropZone, A1),
  28
  29 /*  LOCATION */
  30         struct WorkbenchBase *, WorkbenchBase, 20, Workbench)
  31
  32 /*  FUNCTION
  33
  34     Try to remove a drop zone from an AppWindow.
  35
  36     INPUTS
  37
  38     appWindow  --  pointer to the AppWindow (as returned by AddAppWindow()) to
  39                    try to remove the drop zone from; a value of NULL will
  40                    result in no operation
  41     dropZone   --  pointer to an AppWindowDropZone (as returned by
  42                    AddAppWindowDropZone()); a value of NULL will result in
  43                    no operation
  44
  45     RESULT
  46
  47     TRUE if the drop zone could be removed, FALSE otherwise. In case of
  48     failure, the reason may be obtained from dos.library/IoErr(). This
  49     function may fail if the specified drop zone is not registered with
  50     the supplied AppWindow.
  51
  52     NOTES
  53
  54     You must check for drop zone messages for zones that you just removed as
  55     there might have been messages sent between the last time you checked and
  56     the call to this function.
  57
  58     EXAMPLE
  59
  60     BUGS
  61
  62     SEE ALSO
  63
  64     INTERNALS
  65
  66 ******************************************************************************/
  67 {
  68     AROS_LIBFUNC_INIT
  69
  70     struct AppWindowDropZone *dz;
  71
  72     BOOL found = FALSE;         /* Is the drop zone 'dropZone' added to the
  73                                    window 'aw'? */
  74
  75     if ((aw == NULL) || (dropZone == NULL))
  76     {
  77         SetIoErr(ERROR_REQUIRED_ARG_MISSING);
  78
  79         return FALSE;
  80     }
  81
  82     LockWorkbench();
  83     ForeachNode(&aw->aw_DropZones, dz)
  84     {
  85         if (dz == dropZone)
  86         {
  87             found = TRUE;
  88             break;
  89         }
  90     }
  91
  92     if (!found)
  93     {
  94         UnlockWorkbench();
  95         SetIoErr(ERROR_OBJECT_NOT_FOUND);
  96
  97         return FALSE;
  98     }
  99
 100     Remove((struct Node *)dropZone);
 101     UnlockWorkbench();
 102
 103     FreeVec(dropZone);
 104
 105     /* NotifyWorkbench(WBNOTIFY_Delete, WBNOTIFY_DropZone, WorkbenchBase); */
 106
 107     return TRUE;
 108
 109     AROS_LIBFUNC_EXIT
 110 } /* RemoveAppWindowDropZone */
 111