summaryrefslogtreecommitdiffstats
path: root/contrib/syslinux-4.02/com32/cmenu/libmenu/help.h
blob: de01b46ecf6c8bfaaec50ca06494422705fb8187 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
/* -*- c -*- ------------------------------------------------------------- *
 *
 *   Copyright 2004-2005 Murali Krishnan Ganapathy - All Rights Reserved
 *
 *   This program 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, Inc., 53 Temple Place Ste 330,
 *   Boston MA 02111-1307, USA; either version 2 of the License, or
 *   (at your option) any later version; incorporated herein by reference.
 *
 * ----------------------------------------------------------------------- */

#ifndef __HELP_H_
#define __HELP_H_

#include "menu.h"
#include "com32io.h"
#include "tui.h"
#include <string.h>

// How many rows for the title
#define HELP_TITLE_HEIGHT 1
#define HELP_BODY_ROW (HELP_TITLE_HEIGHT+3)
#define HELP_LEFT_MARGIN 2
#define HELP_RIGHT_MARGIN 2	// Assume all lines dont cross this
#define HELP_BOTTOM_MARGIN 1	// Number of lines not use from bottom of screen

#define HELPBOX BOX_SINSIN
#define HELPDIRLEN  64
#define HELPPAGE 2

#define HELP_MORE_ABOVE '^'	// to print when more is available above
#define HELP_MORE_BELOW 'v'	// same as above but for below

// Display one screen of help information
void showhelp(const char *filename);

// Start the help system using id helpid
void runhelpsystem(unsigned int helpid);

// Start help system with specified file
void runhelp(const char *filename);

// Directory where help files are located
void init_help(const char *helpdir);
// Free internal datastructures
void close_help(void);

#endif