added GimpStock section, removed GimpWidgetTypes.
2002-05-13 Sven Neumann <sven@gimp.org> * libgimpwidgets/libgimpwidgets-docs.sgml: added GimpStock section, removed GimpWidgetTypes. * libgimpwidgets/libgimpwidgets-sections.txt: updated. * libgimpwidgets/tmpl/gimpstock.sgml: added GimpStock templates. * libgimpwidgets/tmpl/gimpwidgetstypes.sgml: removed. * libgimpwidgets/tmpl/gimpbutton.sgml * libgimpwidgets/tmpl/gimpchainbutton.sgml * libgimpwidgets/tmpl/gimpcolorarea.sgml * libgimpwidgets/tmpl/gimpcolorbutton.sgml * libgimpwidgets/tmpl/gimpdialog.sgml * libgimpwidgets/tmpl/gimpfileselection.sgml * libgimpwidgets/tmpl/gimphelpui.sgml * libgimpwidgets/tmpl/gimpoffsetarea.sgml * libgimpwidgets/tmpl/gimppatheditor.sgml * libgimpwidgets/tmpl/gimppixmap.sgml * libgimpwidgets/tmpl/gimpquerybox.sgml * libgimpwidgets/tmpl/gimpsizeentry.sgml * libgimpwidgets/tmpl/gimpunitmenu.sgml * libgimpwidgets/tmpl/gimpwidgets.sgml: updated.
This commit is contained in:
committed by
Sven Neumann
parent
2216807dca
commit
1be6408590
@ -15,6 +15,36 @@ system.
|
||||
|
||||
</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>
|
||||
|
||||
@ -63,6 +93,16 @@ See #GimpHelpFunc for the naming conventions of HTML help files.
|
||||
@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>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user