#include <gnome.h> struct GnomeHelpMenuEntry; |
|
| app : | Name of this application |
| path : | File that contains the help document |
| Returns : | a fully resolved file name for path. Use needs to g_fee the path when done. It looks in LANG, then unser C if LANG is not set I added this because I didnt want to break all apps using gnome_help_file_path() currently. We need a good solution (if this isnt it) to handle case where locale file didnt exist |
|
| app : | Name of this application |
| path : | File that contains the help document |
| Returns : | a fully resolved file name for path. Use needs to g_fee the path when done. It looks in LANG, then unser C if LANG is not set |
void gnome_help_display (void *ignore,
GnomeHelpMenuEntry *ref); |
Cause a help viewer to display help entry defined in ref.
| ignore : | value of this is ignored. To simplify hooking into clicked signals |
| ref : | A GnomeHelpMenuEntry. |
void gnome_help_goto (void *ignore,
|
Cause a help viewer to display file.
| ignore : | ignored. |
| file : | file to display in the help browser. |
void gnome_help_pbox_display (void *ignore,
|
Cause a help viewer to display the help entry defined in ref. This function is meant to be connected to the "help" signal of a GnomePropertyBox. If ref is { "my-app", "properties-blah" }, and the current page number is 3, then the help viewer will display my-app/lang/properties-blah-3.html, which can be symlinked to the appropriate file.
| ignore : | ignored. |
| page_num : | The number of the current notebook page in the properties box. |
| ref : | A GnomeHelpMenuEntry |
void gnome_help_pbox_goto (void *ignore,
int ignore2,
GnomeHelpMenuEntry *ref); |
Cause a help viewer to display the help entry defined in ref. This function is meant to be connected to the help button of a GnomePropertyBox, when you don't want any munging of the help path done. Most of the time, you can use gnome_help_pbox_display, though.
| ignore : | ignored. |
| ignore2 : | also ignored. |
| ref : | A GnomeHelpMenuEntry |