rom/intuition/easyrequestargs.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     Copyright © 2001-2003, The MorphOS Development Team. All Rights Reserved.
   4     $Id$
   5 */
   6
   7 #include "intuition_intern.h"
   8
   9 /*****************************************************************************
  10
  11     NAME */
  12 #include <exec/types.h>
  13 #include <intuition/intuition.h>
  14 #include <proto/intuition.h>
  15
  16     AROS_LH4(LONG, EasyRequestArgs,
  17
  18 /*  SYNOPSIS */
  19          AROS_LHA(struct Window     *, window, A0),
  20          AROS_LHA(struct EasyStruct *, easyStruct, A1),
  21          AROS_LHA(ULONG             *, IDCMP_ptr, A2),
  22          AROS_LHA(APTR               , argList, A3),
  23
  24 /*  LOCATION */
  25          struct IntuitionBase *, IntuitionBase, 98, Intuition)
  26
  27 /*  FUNCTION
  28     Opens and handles a requester, which provides one or more choices.
  29     It blocks the application until the user closes the requester.
  30     Returned is an integer indicating which gadget had been selected.
  31
  32     INPUTS
  33     Window - A reference window. If NULL, the requester opens on
  34          the default public screen.
  35     easyStruct - The EasyStruct structure (<intuition/intuition.h>)
  36         describing the requester.
  37     IDCMP_Ptr - Pointer to IDCMP flags. The requester will be closed early
  38         if any of the specified message types is received. This is useful
  39         for requesters that want to listen to disk changes etc. The contents
  40         of this pointer is set to the IDCMP flag that caused the requester
  41         to close. This pointer may be NULL.
  42     ArgList - The arguments for easyStruct->es_TextFormat.
  43
  44     RESULT
  45     -1, if one of the IDCMP flags of IDCMP_ptr was set.
  46      0, if the rightmost button was clicked or an error occured.
  47      n, if the n-th button from the left was clicked.
  48
  49     NOTES
  50
  51     EXAMPLE
  52
  53     BUGS
  54
  55     SEE ALSO
  56     BuildEasyRequestArgs()
  57
  58     INTERNALS
  59
  60 *****************************************************************************/
  61 {
  62     AROS_LIBFUNC_INIT
  63
  64     struct Window *req;
  65     LONG           result;
  66
  67     req = BuildEasyRequestArgs(window, easyStruct,
  68                                IDCMP_ptr != NULL ? *IDCMP_ptr : NULL, argList);
  69
  70     /* req = 0/1 is handled by SysReqHandler */
  71     while ((result = SysReqHandler(req, IDCMP_ptr, TRUE)) == -2)
  72     {
  73     }
  74
  75
  76     FreeSysRequest(req);
  77
  78     return result;
  79
  80     AROS_LIBFUNC_EXIT
  81 } /* EasyRequestArgs */