← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/xml/gimphelpui.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimphelpui.xml
4
4
 
5
5
<refentry id="libgimpwidgets-GimpHelpUI">
6
6
<refmeta>
7
 
<refentrytitle id="top_of_page">GimpHelpUI</refentrytitle>
 
7
<refentrytitle role="top_of_page">GimpHelpUI</refentrytitle>
8
8
<manvolnum>3</manvolnum>
9
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
10
10
</refmeta>
16
16
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
17
17
</refnamediv>
18
18
 
19
 
<refsynopsisdiv id="synopsis">
20
 
<title id="synopsis.title">Synopsis</title>
 
19
<refsynopsisdiv role="synopsis">
 
20
<title role="synopsis.title">Synopsis</title>
21
21
 
22
22
<synopsis>
23
23
 
24
24
 
25
25
 
26
 
<link linkend="void">void</link>        (<link linkend="GimpHelpFunc">*GimpHelpFunc</link>)                 (const <link linkend="gchar">gchar</link> *help_id,
27
 
                                             <link linkend="gpointer">gpointer</link> help_data);
28
 
#define     <link linkend="GIMP-HELP-ID:CAPS">GIMP_HELP_ID</link>
29
 
<link linkend="void">void</link>        <link linkend="gimp-help-enable-tooltips">gimp_help_enable_tooltips</link>       (void);
30
 
<link linkend="void">void</link>        <link linkend="gimp-help-disable-tooltips">gimp_help_disable_tooltips</link>      (void);
31
 
<link linkend="void">void</link>        <link linkend="gimp-standard-help-func">gimp_standard_help_func</link>         (const <link linkend="gchar">gchar</link> *help_id,
32
 
                                             <link linkend="gpointer">gpointer</link> help_data);
33
 
<link linkend="void">void</link>        <link linkend="gimp-help-connect">gimp_help_connect</link>               (<link linkend="GtkWidget">GtkWidget</link> *widget,
34
 
                                             <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
35
 
                                             const <link linkend="gchar">gchar</link> *help_id,
36
 
                                             <link linkend="gpointer">gpointer</link> help_data);
37
 
<link linkend="void">void</link>        <link linkend="gimp-help-set-help-data">gimp_help_set_help_data</link>         (<link linkend="GtkWidget">GtkWidget</link> *widget,
38
 
                                             const <link linkend="gchar">gchar</link> *tooltip,
39
 
                                             const <link linkend="gchar">gchar</link> *help_id);
40
 
<link linkend="void">void</link>        <link linkend="gimp-context-help">gimp_context_help</link>               (<link linkend="GtkWidget">GtkWidget</link> *widget);
 
26
<link linkend="void">void</link>                (<link linkend="GimpHelpFunc">*GimpHelpFunc</link>)                     (const <link linkend="gchar">gchar</link> *help_id,
 
27
                                                         <link linkend="gpointer">gpointer</link> help_data);
 
28
#define             <link linkend="GIMP-HELP-ID:CAPS">GIMP_HELP_ID</link>
 
29
<link linkend="void">void</link>                <link linkend="gimp-help-enable-tooltips">gimp_help_enable_tooltips</link>           (void);
 
30
<link linkend="void">void</link>                <link linkend="gimp-help-disable-tooltips">gimp_help_disable_tooltips</link>          (void);
 
31
<link linkend="void">void</link>                <link linkend="gimp-standard-help-func">gimp_standard_help_func</link>             (const <link linkend="gchar">gchar</link> *help_id,
 
32
                                                         <link linkend="gpointer">gpointer</link> help_data);
 
33
<link linkend="void">void</link>                <link linkend="gimp-help-connect">gimp_help_connect</link>                   (<link linkend="GtkWidget">GtkWidget</link> *widget,
 
34
                                                         <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
 
35
                                                         const <link linkend="gchar">gchar</link> *help_id,
 
36
                                                         <link linkend="gpointer">gpointer</link> help_data);
 
37
<link linkend="void">void</link>                <link linkend="gimp-help-set-help-data">gimp_help_set_help_data</link>             (<link linkend="GtkWidget">GtkWidget</link> *widget,
 
38
                                                         const <link linkend="gchar">gchar</link> *tooltip,
 
39
                                                         const <link linkend="gchar">gchar</link> *help_id);
 
40
<link linkend="void">void</link>                <link linkend="gimp-context-help">gimp_context_help</link>                   (<link linkend="GtkWidget">GtkWidget</link> *widget);
41
41
 
42
42
</synopsis>
43
43
</refsynopsisdiv>
50
50
 
51
51
 
52
52
 
53
 
<refsect1 id="desc">
54
 
<title id="desc.title">Description</title>
 
53
<refsect1 role="desc">
 
54
<title role="desc.title">Description</title>
55
55
<para>
56
56
 
57
57
</para>
58
58
</refsect1>
59
59
 
60
 
<refsect1 id="details">
61
 
<title id="details.title">Details</title>
 
60
<refsect1 role="details">
 
61
<title role="details.title">Details</title>
62
62
<refsect2>
63
63
<title><anchor id="GimpHelpFunc" role="function"/>GimpHelpFunc ()</title>
64
 
<indexterm><primary>GimpHelpFunc</primary></indexterm><programlisting><link linkend="void">void</link>        (*GimpHelpFunc)                 (const <link linkend="gchar">gchar</link> *help_id,
65
 
                                             <link linkend="gpointer">gpointer</link> help_data);</programlisting>
 
64
<indexterm><primary>GimpHelpFunc</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpHelpFunc)                     (const <link linkend="gchar">gchar</link> *help_id,
 
65
                                                         <link linkend="gpointer">gpointer</link> help_data);</programlisting>
66
66
<para>
67
67
This is the prototype for all functions you pass as <parameter>help_func</parameter> to the
68
68
various GIMP dialog constructors like <link linkend="gimp-dialog-new"><function>gimp_dialog_new()</function></link>,
103
103
</para></refsect2>
104
104
<refsect2>
105
105
<title><anchor id="gimp-help-enable-tooltips" role="function"/>gimp_help_enable_tooltips ()</title>
106
 
<indexterm><primary>gimp_help_enable_tooltips</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_help_enable_tooltips       (void);</programlisting>
 
106
<indexterm><primary>gimp_help_enable_tooltips</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_help_enable_tooltips           (void);</programlisting>
107
107
<para>
108
108
This function calls <link linkend="gtk-tooltips-enable"><function>gtk_tooltips_enable()</function></link>.</para>
109
109
<para>
111
111
</para></refsect2>
112
112
<refsect2>
113
113
<title><anchor id="gimp-help-disable-tooltips" role="function"/>gimp_help_disable_tooltips ()</title>
114
 
<indexterm><primary>gimp_help_disable_tooltips</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_help_disable_tooltips      (void);</programlisting>
 
114
<indexterm><primary>gimp_help_disable_tooltips</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_help_disable_tooltips          (void);</programlisting>
115
115
<para>
116
116
This function calls <link linkend="gtk-tooltips-disable"><function>gtk_tooltips_disable()</function></link>.</para>
117
117
<para>
119
119
</para></refsect2>
120
120
<refsect2>
121
121
<title><anchor id="gimp-standard-help-func" role="function"/>gimp_standard_help_func ()</title>
122
 
<indexterm><primary>gimp_standard_help_func</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_standard_help_func         (const <link linkend="gchar">gchar</link> *help_id,
123
 
                                             <link linkend="gpointer">gpointer</link> help_data);</programlisting>
 
122
<indexterm><primary>gimp_standard_help_func</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_standard_help_func             (const <link linkend="gchar">gchar</link> *help_id,
 
123
                                                         <link linkend="gpointer">gpointer</link> help_data);</programlisting>
124
124
<para>
125
125
This is the standard GIMP help function which does nothing but calling
126
126
<link linkend="gimp-help"><function>gimp_help()</function></link>. It is the right function to use in almost all cases.</para>
136
136
</variablelist></refsect2>
137
137
<refsect2>
138
138
<title><anchor id="gimp-help-connect" role="function"/>gimp_help_connect ()</title>
139
 
<indexterm><primary>gimp_help_connect</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_help_connect               (<link linkend="GtkWidget">GtkWidget</link> *widget,
140
 
                                             <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
141
 
                                             const <link linkend="gchar">gchar</link> *help_id,
142
 
                                             <link linkend="gpointer">gpointer</link> help_data);</programlisting>
 
139
<indexterm><primary>gimp_help_connect</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_help_connect                   (<link linkend="GtkWidget">GtkWidget</link> *widget,
 
140
                                                         <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
 
141
                                                         const <link linkend="gchar">gchar</link> *help_id,
 
142
                                                         <link linkend="gpointer">gpointer</link> help_data);</programlisting>
143
143
<para>
144
144
Note that this function is automatically called by all libgimp dialog
145
145
constructors. You only have to call it for windows/dialogs you created
163
163
</variablelist></refsect2>
164
164
<refsect2>
165
165
<title><anchor id="gimp-help-set-help-data" role="function"/>gimp_help_set_help_data ()</title>
166
 
<indexterm><primary>gimp_help_set_help_data</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_help_set_help_data         (<link linkend="GtkWidget">GtkWidget</link> *widget,
167
 
                                             const <link linkend="gchar">gchar</link> *tooltip,
168
 
                                             const <link linkend="gchar">gchar</link> *help_id);</programlisting>
 
166
<indexterm><primary>gimp_help_set_help_data</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_help_set_help_data             (<link linkend="GtkWidget">GtkWidget</link> *widget,
 
167
                                                         const <link linkend="gchar">gchar</link> *tooltip,
 
168
                                                         const <link linkend="gchar">gchar</link> *help_id);</programlisting>
169
169
<para>
170
170
The reason why we don't use <link linkend="gtk-tooltips-set-tip"><function>gtk_tooltips_set_tip()</function></link> is that it's
171
171
impossible to set a <parameter>private_tip</parameter> (aka <parameter>help_id</parameter>) without a visible
190
190
</variablelist></refsect2>
191
191
<refsect2>
192
192
<title><anchor id="gimp-context-help" role="function"/>gimp_context_help ()</title>
193
 
<indexterm><primary>gimp_context_help</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_context_help               (<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>
 
193
<indexterm><primary>gimp_context_help</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_context_help                   (<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>
194
194
<para>
195
195
This function invokes the context help inspector.
196
196
</para>