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

   1 /*
   2  * help.h
   3  *
   4  * [Generated from help, 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 __help_h
  15 #define __help_h
  16
  17 #ifndef __sapphire_h
  18   #include "sapphire.h"
  19 #endif
  20
  21 /*----- Overview ----------------------------------------------------------*
  22  *
  23  * Functions provided:
  24  *
  25  *  help_init
  26  *  help_sendHints
  27  *  help_add
  28  *  help_reset
  29  */
  30
  31 /* --- help_init --- *
  32  *
  33  * On entry:    --
  34  *
  35  * On exit:     --
  36  *
  37  * Use:         Initialises the help system for use.
  38  */
  39
  40 extern routine help_init;
  41
  42 /* --- help_sendHints --- *
  43  *
  44  * On entry:    --
  45  *
  46  * On exit:     --
  47  *
  48  * Use:         Should be called on a pointer-entering-window event.  It
  49  *              enables hint requests for the window beneath the pointer.
  50  */
  51
  52 extern routine help_sendHints;
  53
  54 /* --- help_add --- *
  55  *
  56  * On entry:    R0 == pointer to message string to add
  57  *
  58  * On exit:     --
  59  *
  60  * Use:         Adds a line to the help message being built currently.  Note
  61  *              that overflows are trapped, and errors are generated if one
  62  *              would occur.
  63  */
  64
  65 extern routine help_add;
  66
  67 /* --- help_reset --- *
  68  *
  69  * On entry:    --
  70  *
  71  * On exit:     --
  72  *
  73  * Use:         Resets the help system so that a hint request is sent to an
  74  *              icon that the pointer is already over. The proposed use
  75  *              is that the caller can change a help message for a given
  76  *              icon as soon as it is clicked on.
  77  */
  78
  79 extern routine help_reset;
  80
  81 /*----- That's all, folks -------------------------------------------------*/
  82
  83 #endif