Top | ![]() |
![]() |
![]() |
![]() |
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.
gboolean gnome_help_display_with_doc_id (GnomeProgram *program
,const char *doc_id
,const char *file_name
,const char *link_id
,GError **error
);
Displays the help file specified by file_name
at location link_id
within
the doc_id
domain in the preferred help browser of the user. Most of the
time, you want to call gnome_help_display()
instead.
This function will display the help through creating a "ghelp" URI, by
looking for file_name
in the applications installed help location (found by
GNOME_FILE_DOMAIN_APP_HELP) and its app_id. The resulting URI is roughly
in the form "ghelp:appid/file_name?link_id". If a matching file cannot be
found, FALSE
is returned and error
is set.
Please note that this only displays application help. To display help files
from the global GNOME domain, you will want to use
gnome_help_display_desktop()
.
program |
The current application object, or |
|
doc_id |
The document identifier, or |
|
file_name |
The name of the help document to display. |
|
link_id |
Can be |
|
error |
A GError instance that will hold the specifics of any error which
occurs during processing, or |
gboolean gnome_help_display_with_doc_id_and_env (GnomeProgram *program
,const char *doc_id
,const char *file_name
,const char *link_id
,char **envp
,GError **error
);
Like gnome_display_with_doc_id()
, but the the contents of envp
will become the url viewer's environment rather than inheriting
from the parents environment.
program |
The current application object, or |
|
doc_id |
The document identifier, or |
|
file_name |
The name of the help document to display. |
|
link_id |
Can be |
|
envp |
child's environment, or |
|
error |
A GError instance that will hold the specifics of any error which
occurs during processing, or |
Since 2.2
gboolean gnome_help_display_desktop (GnomeProgram *program
,const char *doc_id
,const char *file_name
,const char *link_id
,GError **error
);
Displays the GNOME system help file specified by file_name
at location
link_id
in the preferred help browser of the user. This is done by creating
a "ghelp" URI, by looking for file_name
in the system help domain
(GNOME_FILE_DOMAIN_HELP) and it's app_id. This domain is determined when
the library is compiled. If a matching file cannot be found, FALSE
is
returned and error
is set.
Please note that this only displays system help. To display help files
for an application, you will want to use gnome_help_display()
.
program |
The current application object, or |
|
doc_id |
The name of the help file relative to the system's help domain (GNOME_FILE_DOMAIN_HELP). |
|
file_name |
The name of the help document to display. |
|
link_id |
Can be |
|
error |
A GError instance that will hold the specifics of any error which
occurs during processing, or |
gboolean gnome_help_display_desktop_with_env (GnomeProgram *program
,const char *doc_id
,const char *file_name
,const char *link_id
,char **envp
,GError **error
);
Like gnome_help_display_desktop()
, but the the contents of envp
will become the url viewer's environment rather than inheriting
from the parents environment.
program |
The current application object, or |
|
doc_id |
The name of the help file relative to the system's help domain (GNOME_FILE_DOMAIN_HELP). |
|
file_name |
The name of the help document to display. |
|
link_id |
Can be |
|
envp |
child's environment, or |
|
error |
A GError instance that will hold the specifics of any error which
occurs during processing, or |
Since 2.2
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).
gboolean gnome_help_display_uri_with_env (const char *help_uri
,char **envp
,GError **error
);
Like gnome_help_display_uri()
, but the the contents of envp
will become the help viewer's environment rather than inheriting
from the parents environment.
Since 2.2