1 /** \file help.h 2 * \brief Header: hypertext file browser 3 * 4 * Implements the hypertext file viewer. 5 * The hypertext file is a file that may have one or more nodes. Each 6 * node ends with a ^D character and starts with a bracket, then the 7 * name of the node and then a closing bracket. Right after the closing 8 * bracket a newline is placed. This newline is not to be displayed by 9 * the help viewer and must be skipped - its sole purpose is to facilitate 10 * the work of the people managing the help file template (xnc.hlp) . 11 * 12 * Links in the hypertext file are specified like this: the text that 13 * will be highlighted should have a leading ^A, then it comes the 14 * text, then a ^B indicating that highlighting is done, then the name 15 * of the node you want to link to and then a ^C. 16 * 17 * The file must contain a ^D at the beginning and at the end of the 18 * file or the program will not be able to detect the end of file. 19 * 20 * Laziness/widgeting attack: This file does use the dialog manager 21 * and uses mainly the dialog to achieve the help work. there is only 22 * one specialized widget and it's only used to forward the mouse messages 23 * to the appropriate routine. 24 * 25 * This file is included by help.c and man2hlp.c 26 */ 27 28 #ifndef MC__HELP_H 29 #define MC__HELP_H 30 31 /*** typedefs(not structures) and defined constants **********************************************/ 32 33 /* Markers used in the help files */ 34 #define CHAR_LINK_START '\01' /* Ctrl-A */ 35 #define CHAR_LINK_POINTER '\02' /* Ctrl-B */ 36 #define CHAR_LINK_END '\03' /* Ctrl-C */ 37 #define CHAR_NODE_END '\04' /* Ctrl-D */ 38 #define CHAR_ALTERNATE '\05' /* Ctrl-E */ 39 #define CHAR_NORMAL '\06' /* Ctrl-F */ 40 #define CHAR_VERSION '\07' /* Ctrl-G */ 41 #define CHAR_FONT_BOLD '\010' /* Ctrl-H */ 42 #define CHAR_FONT_NORMAL '\013' /* Ctrl-K */ 43 #define CHAR_FONT_ITALIC '\024' /* Ctrl-T */ 44 45 /*** enums ***************************************************************************************/ 46 47 /*** structures declarations (and typedefs of structures)*****************************************/ 48 49 /*** global variables defined in .c file *********************************************************/ 50 51 /*** declarations of public functions ************************************************************/ 52 53 gboolean help_interactive_display (const gchar * event_group_name, const gchar * event_name, 54 gpointer init_data, gpointer data); 55 56 /*** inline functions ****************************************************************************/ 57 #endif /* MC__HELP_H */