/*
 * help.h
 *
 * [Generated from help, 25 September 1996]
 */

#if !defined(__CC_NORCROFT) || !defined(__arm)
  #error You must use the Norcroft ARM Compiler for Sapphire programs
#endif

#pragma include_only_once
#pragma force_top_level

#ifndef __help_h
#define __help_h

#ifndef __sapphire_h
  #include "sapphire.h"
#endif

/*----- Overview ----------------------------------------------------------*
 *
 * Functions provided:
 *
 *  help_init
 *  help_sendHints
 *  help_add
 *  help_reset
 */

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

extern routine 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.
 */

extern routine 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.
 */

extern routine 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.
 */

extern routine help_reset;

/*----- That's all, folks -------------------------------------------------*/

#endif