gnome-help

Name

gnome-help -- Display application and GNOME system help.

Synopsis


#include <libgnome/libgnome.h>


enum        GnomeHelpError;
#define     GNOME_HELP_ERROR
gboolean    gnome_help_display              (const char *file_name,
                                             const char *link_id,
                                             GError **error);
gboolean    gnome_help_display_desktop      (GnomeProgram *program,
                                             const char *doc_id,
                                             const char *file_name,
                                             const char *link_id,
                                             GError **error);
gboolean    gnome_help_display_uri          (const char *help_uri,
                                             GError **error);
GQuark      gnome_help_error_quark          (void);

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_INTERNAL Something went wrong interally. This is most likely caused by resource problems or a bad installation.
GNOME_HELP_ERROR_NOT_FOUND Help file does not exist.


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.

file_name : The name of the help document to display.
link_id : Can be NULL. If set, refers to an anchor or section id within the requested document.
error : A GError instance that will hold the specifics of any error which occurs during processing, or NULL
Returns : TRUE on success, FALSE otherwise (in which case error will contain the actual error).


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);

program : 
doc_id : 
file_name : 
link_id : 
error : 
Returns : 


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).

help_uri : The URI to display.
error : A GError instance that will hold the specifics of any error which occurs during processing, or NULL
Returns : TRUE on success, FALSE otherwise (in which case error will contain the actual error).


gnome_help_error_quark ()

GQuark      gnome_help_error_quark          (void);

Returns : A GQuark representing the domain of gnome-help errors.