com32/cmenu/libmenu/help.h

   1 /* -*- c -*- ------------------------------------------------------------- *
   2  *
   3  *   Copyright 2004-2005 Murali Krishnan Ganapathy - All Rights Reserved
   4  *
   5  *   This program is free software; you can redistribute it and/or modify
   6  *   it under the terms of the GNU General Public License as published by
   7  *   the Free Software Foundation, Inc., 53 Temple Place Ste 330,
   8  *   Boston MA 02111-1307, USA; either version 2 of the License, or
   9  *   (at your option) any later version; incorporated herein by reference.
  10  *
  11  * ----------------------------------------------------------------------- */
  12
  13 #ifndef __HELP_H_
  14 #define __HELP_H_
  15
  16 #include "menu.h"
  17 #include "com32io.h"
  18 #include "tui.h"
  19 #include <string.h>
  20
  21 // How many rows for the title
  22 #define HELP_TITLE_HEIGHT 1
  23 #define HELP_BODY_ROW (HELP_TITLE_HEIGHT+3)
  24 #define HELP_LEFT_MARGIN 2
  25 #define HELP_RIGHT_MARGIN 2     // Assume all lines dont cross this
  26 #define HELP_BOTTOM_MARGIN 1    // Number of lines not use from bottom of screen
  27
  28 #define HELPBOX BOX_SINSIN
  29 #define HELPDIRLEN  64
  30 #define HELPPAGE 2
  31
  32 #define HELP_MORE_ABOVE '^'     // to print when more is available above
  33 #define HELP_MORE_BELOW 'v'     // same as above but for below
  34
  35 // Display one screen of help information
  36 void showhelp(const char *filename);
  37
  38 // Start the help system using id helpid
  39 void runhelpsystem(unsigned int helpid);
  40
  41 // Start help system with specified file
  42 void runhelp(const char *filename);
  43
  44 // Directory where help files are located
  45 void init_help(const char *helpdir);
  46 // Free internal datastructures
  47 void close_help(void);
  48
  49 #endif