Libhelp Resources

Resources are used to pass data or flags to libhelp. Libhelp provides the function help_set_resource to set a value for a libhelp resource.

This concept is similar to Xt Toolkit resources concept and can be thought of as a very small subset of it (of course, we should have used Xt Toolkits resources to be more flexible). The current implementation of libhelp resources is rather trivial.

Each resource value has its own type. Values of type string are '\0' terminated character strings. Values of type boolean are 0 for false and 1 for true.

Available resources

String help_class_name
Name of the application class. libhelp will take Xt resources kile background from this class to provide consistency with the application using libhelp as help system.
Boolean help_standalone
This resource should be set to True (1) if libhelp is used for a standalone help browser. The main differences are: in standalone mode, libhelp uses the existing toplevel shell whereas in normal mode it creates its own toplevel shell. The dismiss action (either dismiss button or window manager delete function) exits the standalone application whereas it just pops down the help shell in normal mode.
String help_index
Name of the index file for your applications help.

Setting resources

Libhelp provides the function help_set_resource to set a libhelp resource.

#include <help.h>
void
help_set_resource (/* i  */ int 	symbol,
		   /* i  */ XtPointer	value);

Setting undefined resources has no effect. Setting wrong types to resources can be somewhat unpredictable. Take a look at the standalone help browser example code.

-----------

Libhelp version 1.8.1 (Jun 28. 95).
Thomas Harrer