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 a 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              which describes the requester.
  37     IDCMP_Ptr - Pointer to IDCMP flags, which satisfy the requester,
  38             too. This is useful for requesters, which want to
  39             listen to disk changes, etc. The contents of this
  40             pointer is set to the IDCMP flag, which caused the
  41             requester 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 idcmpPTR 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     HISTORY
  61     29-10-95    digulla automatically created from
  62                 intuition_lib.fd and clib/intuition_protos.h
  63
  64 *****************************************************************************/
  65 {
  66     AROS_LIBFUNC_INIT
  67
  68     struct Window *req;
  69     LONG           result;
  70
  71     req = BuildEasyRequestArgs(window, easyStruct,
  72                                IDCMP_ptr != NULL ? *IDCMP_ptr : NULL, argList);
  73
  74     /* req = 0/1 is handled by SysReqHandler */
  75     while ((result = SysReqHandler(req, IDCMP_ptr, TRUE)) == -2)
  76     {
  77     }
  78
  79
  80     FreeSysRequest(req);
  81
  82     return result;
  83
  84     AROS_LIBFUNC_EXIT
  85 } /* EasyRequestArgs */