gimp/devel-docs/libgimpwidgets/tmpl/gimphelpui.sgml

105 lines
1.6 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
GimpHelpUI
<!-- ##### SECTION Short_Description ##### -->
Functions for setting #GtkTooltips and help identifier used by 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>
Help IDs are textual identifiers the help system uses to figure which
page to display.
</para>
<para>
All these dialog constructors functions call gimp_help_connect().
</para>
<para>
In most cases it will be ok to use gimp_standard_help_func() which does
nothing but passing the @help_id 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_id:
@help_data:
<!-- ##### MACRO GIMP_HELP_ID ##### -->
<para>
Since: GIMP 2.2
</para>
<!-- ##### FUNCTION gimp_help_enable_tooltips ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_help_disable_tooltips ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_standard_help_func ##### -->
<para>
</para>
@help_id:
@help_data:
<!-- ##### FUNCTION gimp_help_connect ##### -->
<para>
</para>
@widget:
@help_func:
@help_id:
@help_data:
<!-- ##### FUNCTION gimp_help_set_help_data ##### -->
<para>
</para>
@widget:
@tooltip:
@help_id:
<!-- ##### FUNCTION gimp_context_help ##### -->
<para>
</para>
@widget: