;
; help.sh
;
; Sending and handling help messages
;
; © 1994-1998 Straylight
;

;----- Licensing note -------------------------------------------------------
;
; This file is part of Straylight's Sapphire library.
;
; Sapphire is free software; you can redistribute it and/or modify
; it under the terms of the GNU General Public License as published by
; the Free Software Foundation; either version 2, or (at your option)
; any later version.
;
; Sapphire is distributed in the hope that it will be useful,
; but WITHOUT ANY WARRANTY; without even the implied warranty of
; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
; GNU General Public License for more details.
;
; You should have received a copy of the GNU General Public License
; along with Sapphire.  If not, write to the Free Software Foundation,
; 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

;----- Overview -------------------------------------------------------------
;
; Functions provided:
;
;  help_init
;  help_sendHints
;  help_add
;  help_reset

; --- help_init ---
;
; On entry:	--
;
; On exit:	--
;
; Use:		Initialises the help system for use.

		IMPORT	help_init

; --- help_sendHints ---
;
; On entry:	--
;
; On exit:	--
;
; Use:		Should be called on a pointer-entering-window event.  It
;		enables hint requests for the window beneath the pointer.

		IMPORT	help_sendHints

; --- help_add ---
;
; On entry:	R0 == pointer to message string to add
;
; On exit:	--
;
; Use:		Adds a line to the help message being built currently.  Note
;		that overflows are trapped, and errors are generated if one
;		would occur.

		IMPORT	help_add

; --- help_reset ---
;
; On entry:	--
;
; On exit:	--
;
; Use:		Resets the help system so that a hint request is sent to an
;		icon that the pointer is already over. The proposed use
;		is that the caller can change a help message for a given
;		icon as soon as it is clicked on.

		IMPORT	help_reset

;----- That's all, folks ----------------------------------------------------

		END