GIMP Library Reference Manual | |||
---|---|---|---|
<<< Previous Page | Home | Up | Next Page >>> |
gimphelpui
Synopsis
void (*GimpHelpFunc) (const |
Details
GimpHelpFunc ()
void (*GimpHelpFunc) (const |
This is the prototype for all functions you pass as help_func to the various GIMP dialog constructors like gimp_dialog_new(), gimp_query_int_box() etc.
Note that all help paths are relative to the root of the help system in the current language. So if your language is "C", a help path of "filters/foo_bar.html" will expand to "${gimp_data_dir}/help/C/filters/foo_bar.html".
All these functions finally call gimp_help_connect_help_accel() which does the work of installing the "F1" accelerator.
In most cases it will be ok to use gimp_plugin_help_func() which does nothing but passing the help_data string to gimp_help(). If your plug-in needs some more sophisticated help handling you can provide your own help_func which has to call gimp_help() to actually display the help.
gimp_help_init ()
void gimp_help_init (void); |
This function initializes GIMP's help system.
Currently it only creates a
gimp_help_free ()
void gimp_help_free (void); |
This function frees the memory used by the
gimp_help_enable_tooltips ()
void gimp_help_enable_tooltips (void); |
This function calls
gimp_help_disable_tooltips ()
void gimp_help_disable_tooltips (void); |
This function calls
gimp_standard_help_func ()
void gimp_standard_help_func (const |
This is the standard GIMP help function which does nothing but calling gimp_help(). Please use gimp_plugin_help_func() for your plug-in's help links.
Currently, gimp_standard_help_func() and gimp_plugin_help_func() do exactly the same. The latter one was introduced to ensure future flexibility.
See GimpHelpFunc for the naming conventions of HTML help files.
gimp_help_connect_help_accel ()
void gimp_help_connect_help_accel ( |
Note that this function is automatically called by all libgimp dialog constructors. You only have to call it for windows/dialogs you created "manually".
For convenience, gimp_help_connect_help_accel() calls
gimp_dialog_set_icon() if the passed widget is a
gimp_help_set_help_data ()
void gimp_help_set_help_data ( |
The reason why we don't use
This function can be called with tooltip ==
You can e.g. set a help_data string to a complete HTML page for a
container widget (e.g. a
If the tooltips inspector (Shift + "F1") is invoked and the user clicks on one of the widgets which only contain a "#" link, the help system will automatically ascend the widget hierarchy until it finds another widget with help_data attached and concatenates both to a complete help path.
gimp_context_help ()
void gimp_context_help (void); |
This function invokes the
The mouse cursor will turn turn into a question mark and the user can click on any widget of the application which started the inspector.
If the widget the user clicked on has a help_data string attached (see gimp_help_set_help_data()), the corresponding HTML page will be displayed. Otherwise the help system will ascend the widget hierarchy until it finds an attached help_data string (which should be the case at least for every window/dialog).