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

   1 ;
   2 ; help.sh
   3 ;
   4 ; Sending and handling help messages
   5 ;
   6 ; © 1994-1998 Straylight
   7 ;
   8
   9 ;----- Licensing note -------------------------------------------------------
  10 ;
  11 ; This file is part of Straylight's Sapphire library.
  12 ;
  13 ; Sapphire is free software; you can redistribute it and/or modify
  14 ; it under the terms of the GNU General Public License as published by
  15 ; the Free Software Foundation; either version 2, or (at your option)
  16 ; any later version.
  17 ;
  18 ; Sapphire is distributed in the hope that it will be useful,
  19 ; but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 ; GNU General Public License for more details.
  22 ;
  23 ; You should have received a copy of the GNU General Public License
  24 ; along with Sapphire.  If not, write to the Free Software Foundation,
  25 ; 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  26
  27 ;----- Overview -------------------------------------------------------------
  28 ;
  29 ; Functions provided:
  30 ;
  31 ;  help_init
  32 ;  help_sendHints
  33 ;  help_add
  34 ;  help_reset
  35
  36 ; --- help_init ---
  37 ;
  38 ; On entry:     --
  39 ;
  40 ; On exit:      --
  41 ;
  42 ; Use:          Initialises the help system for use.
  43
  44                 IMPORT  help_init
  45
  46 ; --- help_sendHints ---
  47 ;
  48 ; On entry:     --
  49 ;
  50 ; On exit:      --
  51 ;
  52 ; Use:          Should be called on a pointer-entering-window event.  It
  53 ;               enables hint requests for the window beneath the pointer.
  54
  55                 IMPORT  help_sendHints
  56
  57 ; --- help_add ---
  58 ;
  59 ; On entry:     R0 == pointer to message string to add
  60 ;
  61 ; On exit:      --
  62 ;
  63 ; Use:          Adds a line to the help message being built currently.  Note
  64 ;               that overflows are trapped, and errors are generated if one
  65 ;               would occur.
  66
  67                 IMPORT  help_add
  68
  69 ; --- help_reset ---
  70 ;
  71 ; On entry:     --
  72 ;
  73 ; On exit:      --
  74 ;
  75 ; Use:          Resets the help system so that a hint request is sent to an
  76 ;               icon that the pointer is already over. The proposed use
  77 ;               is that the caller can change a help message for a given
  78 ;               icon as soon as it is clicked on.
  79
  80                 IMPORT  help_reset
  81
  82 ;----- That's all, folks ----------------------------------------------------
  83
  84                 END