Name
gnome-help -- Display application and GNOME system help.
Description
These functions provide a way to display help files that are either installed
as part of the main GNOME installation or that are specific to the current
application.
Details
enum GnomeHelpError
typedef enum {
GNOME_HELP_ERROR_INTERNAL,
GNOME_HELP_ERROR_NOT_FOUND
} GnomeHelpError; |
GNOME_HELP_ERROR
#define GNOME_HELP_ERROR (gnome_help_error_quark ()) |
The class (or domain) of errors raised directly by the gnome-help module. This
is used as a value in the domain field of the GError structure.
gnome_help_display ()
gboolean gnome_help_display (const char *file_name,
const char *link_id,
GError **error); |
Displays the help file specified by file_name at location link_id in the
preferred help browser of the user.
gnome_help_display_desktop ()
gboolean gnome_help_display_desktop (GnomeProgram *program,
const char *doc_id,
const char *file_name,
const char *link_id,
GError **error); |
gnome_help_display_uri ()
gboolean gnome_help_display_uri (const char *help_uri,
GError **error); |
Displays help_uri in the user's preferred viewer. You should never need to
call this function directly in code, since it is just a wrapper for
gnome_url_show() and consequently the viewer used to display the results
depends upon the scheme of the URI (so it is not strictly a help-only
function).
gnome_help_error_quark ()
GQuark gnome_help_error_quark (void); |