rom/intuition/timeddisplayalert.c

   1 /*
   2     Copyright © 1995-2010, 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.
  27
  28         See DisplayAlert() documentation
  29
  30     INPUTS
  31         alertnumber - Alert code
  32         string - Text data to display
  33         height - Total height of alert display in pixels
  34         time   - Timeout measured in display frame refresh periods.
  35
  36     RESULT
  37         TRUE or FALSE depending on user's reaction. FALSE in case of timeout.
  38
  39     NOTES
  40         See DisplayAlert() documentation for detailed description of
  41         parameters.
  42
  43     EXAMPLE
  44
  45     BUGS
  46         In AROS timeout is currently not implemented. Note that this
  47         function is obsolete and strongly deprecated for use in software.
  48         It is present only for backwards compatibility with AmigaOS(tm).
  49
  50     SEE ALSO
  51         DisplayAlert()
  52
  53     INTERNALS
  54
  55     HISTORY
  56
  57 *****************************************************************************/
  58 {
  59     AROS_LIBFUNC_INIT
  60
  61     return DisplayAlert(alertnumber, string, height);
  62
  63     AROS_LIBFUNC_EXIT
  64 } /* TimedDisplayAlert */