Help Screen

Help screen. More...

Macros
#define	HELP_INDEX   "/HELP/index.htm"
	Default help filename used by run_help()

Typedefs
typedef void	user_style_fn_t(char *class_attr, disp_stat_t *ds)
	Prototype for user style callback function. More...

Functions
void	run_help ()
	Starts default help screen. More...
void	run_help_file (const char *help_file)
	Starts help screen. More...
void	run_help_file_style (const char *help_file, user_style_fn_t *user_style_fn)
	Starts help screen. More...

Detailed Description

Help screen.

Calculator system contains simplified web browser with very limited abilities. To comply try mainly to limit plain text blocks (i.e. text without html elements) below 200 characters.

Use following file as reference what is suported:

http://technical.swissmicros.com/dm42/fat/HELP/dm42help.htm

Note that the CSS section at the beginning is useful for displaying in normal browsers only. It isn't interpreted by simplified browser (it is just skipped).

Typedef Documentation

user_style_fn_t

typedef void user_style_fn_t(char *class_attr, disp_stat_t *ds)

Prototype for user style callback function.

Parameters

class_attr	Pointer to class attribute
ds	Current display state

Function Documentation

run_help()

void run_help

(

)

Starts default help screen.

Starts help screen with default file "/HELP/index.htm".

run_help_file()

void run_help_file

(

const char *

help_file

)

Starts help screen.

Starts help screen with given file.

Parameters

help_file

Help file name

run_help_file_style()

void run_help_file_style	(	const char *	help_file,
		user_style_fn_t *	user_style_fn
	)

Starts help screen.

Starts help screen with given file and user style callback.

Each time when help browser finds unsupported 'class' attribute calls user_style_fn with pointers to class attribute and current display state.

User function can then change current display state to reflect user font style.

Parameters

help_file	Help file name
user_style_fn	User style callback.