rom/intuition/timeddisplayalert.c

   1 /*
   2     Copyright © 1995-2013, 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 <proto/intuition.h>
  13
  14         AROS_LH4(BOOL, TimedDisplayAlert,
  15
  16 /*  SYNOPSIS */
  17         AROS_LHA(ULONG  , alertnumber, D0),
  18         AROS_LHA(UBYTE *, string     , A0),
  19         AROS_LHA(UWORD  , height     , D1),
  20         AROS_LHA(ULONG  , time       , A1),
  21
  22 /*  LOCATION */
  23         struct IntuitionBase *, IntuitionBase, 137, Intuition)
  24
  25 /*  FUNCTION
  26         Display an alert with automatic time-out. See DisplayAlert()
  27         documentation.
  28
  29     INPUTS
  30         alertnumber - Alert code
  31         string - Text data to display
  32         height - Total height of alert display in pixels
  33         time   - Timeout measured in display frame refresh periods.
  34
  35     RESULT
  36         TRUE or FALSE depending on user's reaction. FALSE in case of timeout.
  37
  38     NOTES
  39         See DisplayAlert() documentation for detailed description of
  40         parameters.
  41
  42     EXAMPLE
  43
  44     BUGS
  45         In AROS timeout is currently not implemented. Note that this
  46         function is obsolete and strongly deprecated for use in software.
  47         It is present only for backwards compatibility with AmigaOS(tm).
  48
  49     SEE ALSO
  50         DisplayAlert()
  51
  52     INTERNALS
  53
  54 *****************************************************************************/
  55 {
  56     AROS_LIBFUNC_INIT
  57
  58     return DisplayAlert(alertnumber, string, height);
  59
  60     AROS_LIBFUNC_EXIT
  61 } /* TimedDisplayAlert */