/*
 * Help
 *  Provides support for the !Help application
 *
 * v. 1.00 (25 July 1991)
 *
 * © 1991-1998 Straylight
 */

/*----- Licensing note ----------------------------------------------------*
 *
 * This file is part of Straylight's Steel library.
 *
 * Steel 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.
 *
 * Steel 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 Steel.  If not, write to the Free Software Foundation,
 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef __help_h
#define __help_h

/*
 * void help_startHelp(void)
 *
 * Use
 *  This call sets up a new message to bundle off to !Help.
 */

void help_startHelp(void);

/*
 * void help_addLine(char *line,...)
 *
 * Use
 *  This call adds a line of text to the current help message.  If the
 *  message starts off blank, then the line will become the current message,
 *  otherwise the message will have a '|m' followed by the new line appended
 *  on the end.
 *
 * Parameters
 *  char *line == a printf()-style format string for what you want to say.
 */

void help_addLine(char *line,...);

/*
 * void help_endHelp(void)
 *
 * Use
 *  This call bundles off the current help message to the application.
 */

void help_endHelp(void);

/*
 * void help_readFromIcon(void)
 *
 * Use
 *  This call will read a help message from the icon the help system is
 *  interested in, and tack it on the end of the message.  The help message
 *  should be stored in the icon's validation string with the command 'H'
 *  (e.g. validation string == "A0-9;B3;HType a number in this icon."
 */

void help_readFromIcon(void);

/*
 * BOOL help_wasHelp(void)
 *
 * Use
 *  Informs caller if the last event was a help request.
 *
 * Returns
 *  TRUE if it was.
 */

BOOL help_wasHelp(void);

/*
 * void help_readFromMenu(char *prefix,int hit[])
 *
 * Use
 *  Converts the menu hit structure into a message tag and then reads the
 *  message and adds it to the help message being constructed.
 *  The message tag is constructed from the prefix, followed by a character
 *  for each entry in the hit structure.  The characters are in order (first
 *  to last) 0-9,A-Z,a-z, giving 62 entries.  This WILL be enough for any
 *  *reasonable* menu...
 *
 * Parameters
 *  char *prefix == 
 *  int hit[] == a menu hit structure as passed to a menu handler.
 */

void help_readFromMenu(char *prefix,int hit[]);

#endif