mdw@git.distorted.org.uk Git - ssr/blob - StraySrc/Libraries/Sapphire/csapph/h/errorBox

   1 /*
   2  * errorBox.h
   3  *
   4  * [Generated from errorBox, 25 September 1996]
   5  */
   6
   7 #if !defined(__CC_NORCROFT) || !defined(__arm)
   8   #error You must use the Norcroft ARM Compiler for Sapphire programs
   9 #endif
  10
  11 #pragma include_only_once
  12 #pragma force_top_level
  13
  14 #ifndef __errorBox_h
  15 #define __errorBox_h
  16
  17 #ifndef __sapphire_h
  18   #include "sapphire.h"
  19 #endif
  20
  21 /*----- Overview ----------------------------------------------------------*
  22  *
  23  * Functions provided:
  24  *
  25  *  errorBox_init
  26  *  errorBox_beep
  27  *  errorBox
  28  */
  29
  30 /* --- errorBox_init --- *
  31  *
  32  * On entry:    R0 == pointer to application name
  33  *
  34  * On exit:     --
  35  *
  36  * Use:         Initialises the errorBox system nicely.  It creates the
  37  *              dialogue box now, and just uses it for the rest of the
  38  *              time.
  39  */
  40
  41 extern routine errorBox_init;
  42
  43 /* --- errorBox_beep --- *
  44  *
  45  * On entry:    --
  46  *
  47  * On exit:     --
  48  *
  49  * Use:         Sounds the bell (VDU 7) if the CMOS settings dictate that
  50  *              error boxes should cause a beep.
  51  */
  52
  53 extern routine errorBox_beep;
  54
  55 /* --- errorBox --- *
  56  *
  57  * On entry:    R0 == pointer to error block
  58  *              R1 == button style code, or pointer to buttons block
  59  *
  60  * On exit:     R0 == icon number clicked (ordered from the right)
  61  *              CS if R0 == 0, else CC
  62  *
  63  * Use:         Displays an error box on the screen.  The error block
  64  *              doesn't have to have a sensible error number, and doesn't
  65  *              have to be word aligned, either.
  66  *
  67  *              Since errorBox claims a dialogue box handle on
  68  *              initialisation, it isn't possible for this call to fail.
  69  *              Hence it is ideal for reporting problems like `Out of
  70  *              memory' or `Too many windows'.
  71  *
  72  *              The buttons in the error box may be given either by a code
  73  *              or by a pointer to a buttons block (these may easily be
  74  *              distinguished, since the codes are lower than &8000).
  75  *
  76  *              Standard button arrangements are given by codes, as follows:
  77  *
  78  *              0 == Cancel
  79  *              1 == OK
  80  *              2 == OK, Cancel
  81  *              4 == OK, Help
  82  *              5 == OK, Cancel, Help
  83  */
  84
  85 extern routine errorBox;
  86
  87 /*----- That's all, folks -------------------------------------------------*/
  88
  89 #endif