workbench/libs/reqtools/rtlockwindow.c

   1 /*
   2     Copyright © 1995-2001, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc:
   6     Lang: English
   7 */
   8
   9 #include <exec/types.h>
  10 #include <proto/exec.h>
  11 #include <proto/reqtools.h>
  12 #include <proto/intuition.h>
  13 #include <exec/libraries.h>
  14 #include <exec/memory.h>
  15 #include <aros/libcall.h>
  16 #include "reqtools_intern.h"
  17 #include "general.h"
  18 #include "rtfuncs.h"
  19
  20 /*****************************************************************************
  21
  22     NAME */
  23
  24     AROS_LH1(APTR, rtLockWindow,
  25
  26 /*  SYNOPSIS */
  27
  28         AROS_LHA(struct Window *, window, A0),
  29
  30 /*  LOCATION */
  31
  32         struct ReqToolsBase *, ReqToolsBase, 26, ReqTools)
  33
  34 /*  FUNCTION
  35
  36         Lock a window so it will no longer accept any user input.  The only
  37         functions left to the user are depth arrangement and window dragging.
  38         All gadgets will be un-selectable and the window can not be resized.
  39         It will also get the standard wait pointer set.  The pointer at the
  40         time of locking will be restored when the window is unlocked.
  41
  42         You may nest calls to rtLockWindow() and rtUnlockWindow().  Just make
  43         sure you unlock the window in the correct (opposite) order.
  44
  45         See the RT_LockWindow tag for an automatic way of locking your window.
  46
  47         Use this function (and rtUnlockWindow()) instead of rtSetWaitPointer().
  48
  49     INPUTS
  50
  51         window  --  pointer to the window to be locked
  52
  53     RESULT
  54
  55         a pointer to a (private) window lock.  You must pass this to
  56         rtUnlockWindow() to unlock the window again. Never mind if this is NULL.
  57         This means there was not enough memory and the window will not be locked.
  58         There is no sense in reporting this, just carry on and pass the NULL
  59         window lock to rtUnlockWindow().
  60
  61     NOTES
  62         The wait pointer will look exactly like the standard Workbench 2.0
  63         wait pointer. In combination with PointerX, ClockTick or
  64         LacePointer the handle will turn.
  65
  66     EXAMPLE
  67
  68     BUGS
  69         none known
  70
  71     SEE ALSO
  72
  73     INTERNALS
  74
  75     HISTORY
  76
  77 ******************************************************************************/
  78 {
  79     AROS_LIBFUNC_INIT
  80
  81     return RTFuncs_rtLockWindow(window);
  82
  83     AROS_LIBFUNC_EXIT
  84
  85 } /* rtLockWindow */