workbench/libs/reqtools/rtsetwaitpointer.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 <proto/intuition.h>
  10 #include <exec/types.h>
  11 #include <exec/libraries.h>
  12 #include <aros/libcall.h>
  13 #include <intuition/intuition.h>
  14 #include "general.h"
  15 #include "reqtools_intern.h"
  16 #include "rtfuncs.h"
  17
  18 /*****************************************************************************
  19
  20     NAME */
  21
  22     AROS_LH1(VOID, rtSetWaitPointer,
  23
  24 /*  SYNOPSIS */
  25
  26         AROS_LHA(struct Window *, window, A0),
  27
  28 /*  LOCATION */
  29
  30         struct ReqToolsBase *, ReqToolsBase, 19, ReqTools)
  31
  32 /*  FUNCTION
  33         Change the pointer image to that of a wait pointer. This function should
  34         be called when your program is busy for a longer period of time.
  35
  36         It is recommended you call this function before calling any of the
  37         requester functions.  This way if the user clicks in your window he will
  38         know he must respond to the requester before doing anything else.  Also
  39         see the RT_WaitPointer tag for an automatic way of setting the wait
  40         pointer.  If you are using ReqTools V38+ check out the RT_LockWindow tag!
  41
  42     INPUTS
  43         window  --  pointer to the window to receive the wait pointer
  44
  45     RESULT
  46         none
  47
  48     NOTES
  49         The wait pointer will look exactly like the standard Workbench 2.0
  50         wait pointer. In combination with PointerX, ClockTick or
  51         LacePointer the handle will turn.
  52
  53     EXAMPLE
  54
  55     BUGS
  56         none known
  57
  58     SEE ALSO
  59         rtEZRequestA(), (RT_WaitPointer and RT_LockWindow tags), rtLockWindow()
  60
  61     INTERNALS
  62
  63     HISTORY
  64
  65 ******************************************************************************/
  66
  67 {
  68     AROS_LIBFUNC_INIT
  69
  70     RTFuncs_rtSetWaitPointer(window);
  71
  72     AROS_LIBFUNC_EXIT
  73
  74 } /* rtSetWaitPointer */