rom/intuition/displayalert.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 <proto/intuition.h>
  13
  14     AROS_LH3(BOOL, DisplayAlert,
  15
  16 /*  SYNOPSIS */
  17          AROS_LHA(ULONG , alertnumber, D0),
  18          AROS_LHA(UBYTE*, string, A0),
  19          AROS_LHA(UWORD , height, D1),
  20
  21 /*  LOCATION */
  22          struct IntuitionBase *, IntuitionBase, 15, Intuition)
  23
  24 /*  FUNCTION
  25     Bring up an alert with the given message.
  26     A system recoverable alert is a RECOVERY_ALERT which waits until
  27     the user presses a mouse button. The display is then restored and
  28     a boolean value will be returned showing if the has pressed the
  29     left mouse button.
  30     A DEADEND_ALERT is an alert from which the system cannot recover.
  31     This alert immediately returns with FALSE after creating the
  32     alert display.
  33     If the system can not get enough memory for a RECOVERY_ALERT,
  34     this function returns FALSE.
  35
  36     INPUTS
  37     alertnumber - The
  38     string - The
  39     height - The
  40
  41     RESULT
  42     Always FALSE if DEADEND_ALERT. RECOVERY_ALERT returns TRUE if
  43     the user pressed the left mouse button and FALSE for other
  44     mouse button or if the alert could not be posted.
  45
  46     NOTES
  47
  48     EXAMPLE
  49
  50     BUGS
  51
  52     SEE ALSO
  53
  54     INTERNALS
  55
  56     HISTORY
  57
  58 *****************************************************************************/
  59 {
  60     AROS_LIBFUNC_INIT
  61
  62     /* Call TimedDisplayAlert with "infinite" time, 0xffffffff frames.
  63        It will wait ~993 days.
  64        "[It] should give enough time for people to notice"
  65      */
  66     return TimedDisplayAlert(alertnumber, string, height, 0xffffffff);
  67
  68     AROS_LIBFUNC_EXIT
  69 } /* DisplayAlert */