mirror of https://github.com/GNOME/gimp.git
123 lines
2.3 KiB
Plaintext
123 lines
2.3 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
GimpHelpUI
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
Functions for setting #GtkTooltips and HTML links into the GIMP help
|
|
system.
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### USER_FUNCTION GimpHelpFunc ##### -->
|
|
<para>
|
|
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.
|
|
</para>
|
|
|
|
<para>
|
|
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".
|
|
</para>
|
|
|
|
<para>
|
|
All these functions finally call gimp_help_connect_help_accel() which
|
|
does the work of installing the "F1" accelerator.
|
|
</para>
|
|
|
|
<para>
|
|
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.
|
|
</para>
|
|
|
|
@help_data: A string containing the path to a HTML page.
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_help_init ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_help_free ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_help_enable_tooltips ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_help_disable_tooltips ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_standard_help_func ##### -->
|
|
<para>
|
|
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.
|
|
</para>
|
|
|
|
<para>
|
|
Currently, gimp_standard_help_func() and gimp_plugin_help_func() do
|
|
exactly the same. The latter one was introduced to ensure future
|
|
flexibility.
|
|
</para>
|
|
|
|
<para>
|
|
See #GimpHelpFunc for the naming conventions of HTML help files.
|
|
</para>
|
|
|
|
@help_data: A string containing the path to a HTML page.
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_help_connect ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@widget:
|
|
@help_func:
|
|
@help_data:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_help_set_help_data ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@widget:
|
|
@tooltip:
|
|
@help_data:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_context_help ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|