callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added documentation.

Browse Source 
2000-02-27  Michael Natterer  <mitch@gimp.org>

	* libgimp/gimphelpui.c: added documentation.

2000-02-27  Michael Natterer  <mitch@gimp.org>

	* libgimp/tmpl/gimphelpui.sgml: updated.
This commit is contained in:
Michael Natterer
2000-02-27 12:34:13 +00:00
committed by Michael Natterer
parent 1bd3c65443
commit cb9243e481
5 changed files with 120 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
devel-docs/ChangeLog
View File

@ -1,3 +1,7 @@
2000-02-27 Michael Natterer <mitch@gimp.org>
* libgimp/tmpl/gimphelpui.sgml: updated.
2000-02-26 Michael Natterer <mitch@gimp.org>
* libgimp/libgimp-decl.txt

44
devel-docs/libgimp/tmpl/gimphelpui.sgml
View File

@ -17,10 +17,32 @@ system.
<!-- ##### 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>
@help_data:
<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 ##### -->
@ -53,10 +75,22 @@ system.
<!-- ##### 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>
@help_data:
<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_help_accel ##### -->
@ -77,8 +111,6 @@ system.
@widget:
@tooltip:
@help_data:
<!-- # Unused Parameters # -->
@tool_tip:
<!-- ##### FUNCTION gimp_context_help ##### -->