← Back to branch summary

~ubuntu-branches/ubuntu/natty/gimp/natty

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/html/libgimpwidgets-GimpHelpUI.html

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2010-07-12 15:08:08 UTC
  • mfrom: (1.1.23) (0.4.6 sid)
  • Revision ID: package-import@ubuntu.com-20100712150808-db9xqgtxrvpyl3g2
Tags: 2.6.10-1ubuntu1
Resync on Debian, dropping changes which are in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/html/libgimpwidgets-GimpHelpUI.html
8
8
<link rel="up" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities">
9
9
<link rel="prev" href="libgimpwidgets-GimpCairoUtils.html" title="gimpcairo-utils">
10
10
<link rel="next" href="libgimpwidgets-GimpQueryBox.html" title="GimpQueryBox">
11
 
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="part" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
14
 
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
15
 
<link rel="chapter" href="libgimpwidgets-gallery.html" title="Widget Gallery">
16
 
<link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView">
17
 
<link rel="part" href="libgimpwidgets-colordisplay.html" title="Part II. GIMP Display Filters">
18
 
<link rel="part" href="libgimpwidgets-colorselector.html" title="Part III. GIMP Color Selectors">
19
 
<link rel="part" href="libgimpwidgets-controller.html" title="Part IV. GIMP Controllers">
20
 
<link rel="part" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities">
21
 
<link rel="part" href="libgimpwidgets-deprecated.html" title="Part VI. Deprecated API">
22
 
<link rel="index" href="libgimpwidgets-index.html" title="Index">
23
 
<link rel="index" href="libgimpwidgets-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
24
 
<link rel="index" href="libgimpwidgets-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
25
 
<link rel="index" href="libgimpwidgets-index-new-in-2-6.html" title="Index of new symbols in GIMP 2.6">
26
 
<link rel="index" href="libgimpwidgets-index-deprecated.html" title="Index of deprecated symbols">
27
13
</head>
28
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
29
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
36
22
</tr>
37
23
<tr><td colspan="5" class="shortcuts">
38
24
<a href="#libgimpwidgets-GimpHelpUI.synopsis" class="shortcut">Top</a>
39
 
                 | 
40
 
                <a href="#libgimpwidgets-GimpHelpUI.description" class="shortcut">Description</a>
 
25
                   | 
 
26
                  <a href="#libgimpwidgets-GimpHelpUI.description" class="shortcut">Description</a>
41
27
</td></tr>
42
28
</table>
43
29
<div class="refentry" title="GimpHelpUI">
45
31
<div class="refnamediv"><table width="100%"><tr>
46
32
<td valign="top">
47
33
<h2><span class="refentrytitle"><a name="libgimpwidgets-GimpHelpUI.top_of_page"></a>GimpHelpUI</span></h2>
48
 
<p>GimpHelpUI — Functions for setting <a
49
 
href="http://library.gnome.org/devel/gtk/unstable/GtkTooltips.html"
50
 
><span class="type">GtkTooltips</span></a> and help identifier used by GIMP help
 
34
<p>GimpHelpUI — Functions for setting <a href="/usr/share/gtk-doc/html/gtk/GtkTooltips.html"><span class="type">GtkTooltips</span></a> and help identifier used by GIMP help
51
35
system.</p>
52
36
</td>
53
37
<td valign="top" align="right"></td>
54
38
</tr></table></div>
55
39
<div class="refsynopsisdiv" title="Synopsis">
56
40
<a name="libgimpwidgets-GimpHelpUI.synopsis"></a><h2>Synopsis</h2>
57
 
<pre class="synopsis">
58
 
void                (<a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()">*GimpHelpFunc</a>)                     (const <a
59
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
60
 
>gchar</a> *help_id,
61
 
                                                         <a
62
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
63
 
>gpointer</a> help_data);
64
 
#define             <a class="link" href="libgimpwidgets-GimpHelpUI.html#GIMP-HELP-ID--CAPS" title="GIMP_HELP_ID">GIMP_HELP_ID</a>
65
 
void                <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-enable-tooltips" title="gimp_help_enable_tooltips ()">gimp_help_enable_tooltips</a>           (void);
66
 
void                <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-disable-tooltips" title="gimp_help_disable_tooltips ()">gimp_help_disable_tooltips</a>          (void);
67
 
void                <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-standard-help-func" title="gimp_standard_help_func ()">gimp_standard_help_func</a>             (const <a
68
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
69
 
>gchar</a> *help_id,
70
 
                                                         <a
71
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
72
 
>gpointer</a> help_data);
73
 
void                <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect" title="gimp_help_connect ()">gimp_help_connect</a>                   (<a
74
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
75
 
>GtkWidget</a> *widget,
76
 
                                                         <a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()">GimpHelpFunc</a> help_func,
77
 
                                                         const <a
78
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
79
 
>gchar</a> *help_id,
80
 
                                                         <a
81
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
82
 
>gpointer</a> help_data);
83
 
void                <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data" title="gimp_help_set_help_data ()">gimp_help_set_help_data</a>             (<a
84
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
85
 
>GtkWidget</a> *widget,
86
 
                                                         const <a
87
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
88
 
>gchar</a> *tooltip,
89
 
                                                         const <a
90
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
91
 
>gchar</a> *help_id);
92
 
void                <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data-with-markup" title="gimp_help_set_help_data_with_markup ()">gimp_help_set_help_data_with_markup</a> (<a
93
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
94
 
>GtkWidget</a> *widget,
95
 
                                                         const <a
96
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
97
 
>gchar</a> *tooltip,
98
 
                                                         const <a
99
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
100
 
>gchar</a> *help_id);
101
 
void                <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-context-help" title="gimp_context_help ()">gimp_context_help</a>                   (<a
102
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
103
 
>GtkWidget</a> *widget);
 
41
<pre class="synopsis"><span class="returnvalue">void</span>                (<a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()">*GimpHelpFunc</a>)                     (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>,
 
42
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> help_data</code></em>);
 
43
#define             <a class="link" href="libgimpwidgets-GimpHelpUI.html#GIMP-HELP-ID:CAPS" title="GIMP_HELP_ID">GIMP_HELP_ID</a>
 
44
<span class="returnvalue">void</span>                <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-enable-tooltips" title="gimp_help_enable_tooltips ()">gimp_help_enable_tooltips</a>           (<em class="parameter"><code><span class="type">void</span></code></em>);
 
45
<span class="returnvalue">void</span>                <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-disable-tooltips" title="gimp_help_disable_tooltips ()">gimp_help_disable_tooltips</a>          (<em class="parameter"><code><span class="type">void</span></code></em>);
 
46
<span class="returnvalue">void</span>                <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-standard-help-func" title="gimp_standard_help_func ()">gimp_standard_help_func</a>             (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>,
 
47
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> help_data</code></em>);
 
48
<span class="returnvalue">void</span>                <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect" title="gimp_help_connect ()">gimp_help_connect</a>                   (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
 
49
                                                         <em class="parameter"><code><a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()"><span class="type">GimpHelpFunc</span></a> help_func</code></em>,
 
50
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>,
 
51
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> help_data</code></em>);
 
52
<span class="returnvalue">void</span>                <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data" title="gimp_help_set_help_data ()">gimp_help_set_help_data</a>             (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
 
53
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tooltip</code></em>,
 
54
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>);
 
55
<span class="returnvalue">void</span>                <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data-with-markup" title="gimp_help_set_help_data_with_markup ()">gimp_help_set_help_data_with_markup</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
 
56
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tooltip</code></em>,
 
57
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>);
 
58
<span class="returnvalue">void</span>                <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-context-help" title="gimp_context_help ()">gimp_context_help</a>                   (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);
104
59
</pre>
105
60
</div>
106
61
<div class="refsect1" title="Description">
112
67
<a name="libgimpwidgets-GimpHelpUI.details"></a><h2>Details</h2>
113
68
<div class="refsect2" title="GimpHelpFunc ()">
114
69
<a name="GimpHelpFunc"></a><h3>GimpHelpFunc ()</h3>
115
 
<pre class="programlisting">void                (*GimpHelpFunc)                     (const <a
116
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
117
 
>gchar</a> *help_id,
118
 
                                                         <a
119
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
120
 
>gpointer</a> help_data);</pre>
 
70
<pre class="programlisting"><span class="returnvalue">void</span>                (*GimpHelpFunc)                     (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>,
 
71
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> help_data</code></em>);</pre>
121
72
<p>
122
73
This is the prototype for all functions you pass as <em class="parameter"><code>help_func</code></em> to the
123
74
various GIMP dialog constructors like <a class="link" href="GimpDialog.html#gimp-dialog-new" title="gimp_dialog_new ()"><code class="function">gimp_dialog_new()</code></a>,
132
83
</p>
133
84
<p>
134
85
In most cases it will be ok to use <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-standard-help-func" title="gimp_standard_help_func ()"><code class="function">gimp_standard_help_func()</code></a> which does
135
 
nothing but passing the <em class="parameter"><code>help_id</code></em> string to <a
136
 
href="../libgimp/libgimp-gimphelp.html#gimp-help"
137
 
><code class="function">gimp_help()</code></a>. If your
 
86
nothing but passing the <em class="parameter"><code>help_id</code></em> string to <a href="../libgimp/libgimp-gimphelp.html#gimp-help"><code class="function">gimp_help()</code></a>. If your
138
87
plug-in needs some more sophisticated help handling you can provide
139
 
your own <em class="parameter"><code>help_func</code></em> which has to call <a
140
 
href="../libgimp/libgimp-gimphelp.html#gimp-help"
141
 
><code class="function">gimp_help()</code></a> to actually display
 
88
your own <em class="parameter"><code>help_func</code></em> which has to call <a href="../libgimp/libgimp-gimphelp.html#gimp-help"><code class="function">gimp_help()</code></a> to actually display
142
89
the help.
143
90
</p>
144
91
<div class="variablelist"><table border="0">
159
106
</div>
160
107
<hr>
161
108
<div class="refsect2" title="GIMP_HELP_ID">
162
 
<a name="GIMP-HELP-ID--CAPS"></a><h3>GIMP_HELP_ID</h3>
 
109
<a name="GIMP-HELP-ID:CAPS"></a><h3>GIMP_HELP_ID</h3>
163
110
<pre class="programlisting">#define GIMP_HELP_ID (gimp_help_id_quark ())
164
111
</pre>
165
112
<p>
169
116
<hr>
170
117
<div class="refsect2" title="gimp_help_enable_tooltips ()">
171
118
<a name="gimp-help-enable-tooltips"></a><h3>gimp_help_enable_tooltips ()</h3>
172
 
<pre class="programlisting">void                gimp_help_enable_tooltips           (void);</pre>
 
119
<pre class="programlisting"><span class="returnvalue">void</span>                gimp_help_enable_tooltips           (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
173
120
<p>
174
121
Enable tooltips to be shown in the GIMP user interface.
175
122
</p>
176
123
<p>
177
124
As a plug-in author, you don't need to care about this as this
178
 
function is called for you from <a
179
 
href="../libgimp/libgimp-gimpui.html#gimp-ui-init"
180
 
><code class="function">gimp_ui_init()</code></a>. This ensures that
 
125
function is called for you from <a href="../libgimp/libgimp-gimpui.html#gimp-ui-init"><code class="function">gimp_ui_init()</code></a>. This ensures that
181
126
the user setting from the GIMP preferences dialog is respected in
182
 
all plug-in dialogs.</p>
183
 
<p>
 
127
all plug-in dialogs.
184
128
</p>
185
129
</div>
186
130
<hr>
187
131
<div class="refsect2" title="gimp_help_disable_tooltips ()">
188
132
<a name="gimp-help-disable-tooltips"></a><h3>gimp_help_disable_tooltips ()</h3>
189
 
<pre class="programlisting">void                gimp_help_disable_tooltips          (void);</pre>
 
133
<pre class="programlisting"><span class="returnvalue">void</span>                gimp_help_disable_tooltips          (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
190
134
<p>
191
135
Disable tooltips to be shown in the GIMP user interface.
192
136
</p>
193
137
<p>
194
138
As a plug-in author, you don't need to care about this as this
195
 
function is called for you from <a
196
 
href="../libgimp/libgimp-gimpui.html#gimp-ui-init"
197
 
><code class="function">gimp_ui_init()</code></a>. This ensures that
 
139
function is called for you from <a href="../libgimp/libgimp-gimpui.html#gimp-ui-init"><code class="function">gimp_ui_init()</code></a>. This ensures that
198
140
the user setting from the GIMP preferences dialog is respected in
199
 
all plug-in dialogs.</p>
200
 
<p>
 
141
all plug-in dialogs.
201
142
</p>
202
143
</div>
203
144
<hr>
204
145
<div class="refsect2" title="gimp_standard_help_func ()">
205
146
<a name="gimp-standard-help-func"></a><h3>gimp_standard_help_func ()</h3>
206
 
<pre class="programlisting">void                gimp_standard_help_func             (const <a
207
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
208
 
>gchar</a> *help_id,
209
 
                                                         <a
210
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
211
 
>gpointer</a> help_data);</pre>
 
147
<pre class="programlisting"><span class="returnvalue">void</span>                gimp_standard_help_func             (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>,
 
148
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> help_data</code></em>);</pre>
212
149
<p>
213
150
This is the standard GIMP help function which does nothing but calling
214
 
<a
215
 
href="../libgimp/libgimp-gimphelp.html#gimp-help"
216
 
><code class="function">gimp_help()</code></a>. It is the right function to use in almost all cases.</p>
217
 
<p>
 
151
<a href="../libgimp/libgimp-gimphelp.html#gimp-help"><code class="function">gimp_help()</code></a>. It is the right function to use in almost all cases.
218
152
</p>
219
153
<div class="variablelist"><table border="0">
220
154
<col align="left" valign="top">
221
155
<tbody>
222
156
<tr>
223
157
<td><p><span class="term"><em class="parameter"><code>help_id</code></em> :</span></p></td>
224
 
<td>   A unique help identifier.
 
158
<td>A unique help identifier.
225
159
</td>
226
160
</tr>
227
161
<tr>
228
162
<td><p><span class="term"><em class="parameter"><code>help_data</code></em> :</span></p></td>
229
 
<td> The <em class="parameter"><code>help_data</code></em> passed to <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect" title="gimp_help_connect ()"><code class="function">gimp_help_connect()</code></a>.
 
163
<td>The <em class="parameter"><code>help_data</code></em> passed to <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect" title="gimp_help_connect ()"><code class="function">gimp_help_connect()</code></a>.
230
164
</td>
231
165
</tr>
232
166
</tbody>
235
169
<hr>
236
170
<div class="refsect2" title="gimp_help_connect ()">
237
171
<a name="gimp-help-connect"></a><h3>gimp_help_connect ()</h3>
238
 
<pre class="programlisting">void                gimp_help_connect                   (<a
239
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
240
 
>GtkWidget</a> *widget,
241
 
                                                         <a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()">GimpHelpFunc</a> help_func,
242
 
                                                         const <a
243
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
244
 
>gchar</a> *help_id,
245
 
                                                         <a
246
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
247
 
>gpointer</a> help_data);</pre>
 
172
<pre class="programlisting"><span class="returnvalue">void</span>                gimp_help_connect                   (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
 
173
                                                         <em class="parameter"><code><a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()"><span class="type">GimpHelpFunc</span></a> help_func</code></em>,
 
174
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>,
 
175
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> help_data</code></em>);</pre>
248
176
<p>
249
177
Note that this function is automatically called by all libgimp dialog
250
178
constructors. You only have to call it for windows/dialogs you created
251
 
"manually".</p>
252
 
<p>
 
179
"manually".
253
180
</p>
254
181
<div class="variablelist"><table border="0">
255
182
<col align="left" valign="top">
256
183
<tbody>
257
184
<tr>
258
185
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
259
 
<td> The widget you want to connect the help accelerator for. Will
260
 
         be a <a
261
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWindow.html"
262
 
><span class="type">GtkWindow</span></a> in most cases.
 
186
<td>The widget you want to connect the help accelerator for. Will
 
187
         be a <a href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"><span class="type">GtkWindow</span></a> in most cases.
263
188
</td>
264
189
</tr>
265
190
<tr>
266
191
<td><p><span class="term"><em class="parameter"><code>help_func</code></em> :</span></p></td>
267
 
<td> The function which will be called if the user presses "F1".
 
192
<td>The function which will be called if the user presses "F1".
268
193
</td>
269
194
</tr>
270
195
<tr>
271
196
<td><p><span class="term"><em class="parameter"><code>help_id</code></em> :</span></p></td>
272
 
<td>   The <em class="parameter"><code>help_id</code></em> which will be passed to <em class="parameter"><code>help_func</code></em>.
 
197
<td>The <em class="parameter"><code>help_id</code></em> which will be passed to <em class="parameter"><code>help_func</code></em>.
273
198
</td>
274
199
</tr>
275
200
<tr>
276
201
<td><p><span class="term"><em class="parameter"><code>help_data</code></em> :</span></p></td>
277
 
<td> The <em class="parameter"><code>help_data</code></em> pointer which will be passed to <em class="parameter"><code>help_func</code></em>.
 
202
<td>The <em class="parameter"><code>help_data</code></em> pointer which will be passed to <em class="parameter"><code>help_func</code></em>.
278
203
</td>
279
204
</tr>
280
205
</tbody>
283
208
<hr>
284
209
<div class="refsect2" title="gimp_help_set_help_data ()">
285
210
<a name="gimp-help-set-help-data"></a><h3>gimp_help_set_help_data ()</h3>
286
 
<pre class="programlisting">void                gimp_help_set_help_data             (<a
287
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
288
 
>GtkWidget</a> *widget,
289
 
                                                         const <a
290
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
291
 
>gchar</a> *tooltip,
292
 
                                                         const <a
293
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
294
 
>gchar</a> *help_id);</pre>
 
211
<pre class="programlisting"><span class="returnvalue">void</span>                gimp_help_set_help_data             (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
 
212
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tooltip</code></em>,
 
213
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>);</pre>
295
214
<p>
296
 
The reason why we don't use <a
297
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html#gtk-widget-set-tooltip-text"
298
 
><code class="function">gtk_widget_set_tooltip_text()</code></a> is that
 
215
The reason why we don't use <a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html#gtk-widget-set-tooltip-text"><code class="function">gtk_widget_set_tooltip_text()</code></a> is that
299
216
elements in the GIMP user interface should, if possible, also have
300
217
a <em class="parameter"><code>help_id</code></em> set for context-sensitive help.
301
218
</p>
302
219
<p>
303
 
This function can be called with <a
304
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
305
 
><span class="type">NULL</span></a> for <em class="parameter"><code>tooltip</code></em>. Use this feature
 
220
This function can be called with <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> for <em class="parameter"><code>tooltip</code></em>. Use this feature
306
221
if you want to set a help link for a widget which shouldn't have
307
 
a visible tooltip.</p>
308
 
<p>
 
222
a visible tooltip.
309
223
</p>
310
224
<div class="variablelist"><table border="0">
311
225
<col align="left" valign="top">
312
226
<tbody>
313
227
<tr>
314
228
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
315
 
<td>  The <a
316
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
317
 
><span class="type">GtkWidget</span></a> you want to set a <em class="parameter"><code>tooltip</code></em> and/or <em class="parameter"><code>help_id</code></em> for.
 
229
<td>The <a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> you want to set a <em class="parameter"><code>tooltip</code></em> and/or <em class="parameter"><code>help_id</code></em> for.
318
230
</td>
319
231
</tr>
320
232
<tr>
321
233
<td><p><span class="term"><em class="parameter"><code>tooltip</code></em> :</span></p></td>
322
 
<td> The text for this widget's tooltip (or <a
323
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
324
 
><code class="literal">NULL</code></a>).
 
234
<td>The text for this widget's tooltip (or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).
325
235
</td>
326
236
</tr>
327
237
<tr>
328
238
<td><p><span class="term"><em class="parameter"><code>help_id</code></em> :</span></p></td>
329
 
<td> The <em class="parameter"><code>help_id</code></em> for the <a
330
 
href="http://library.gnome.org/devel/gtk/unstable/GtkTipsQuery.html"
331
 
><span class="type">GtkTipsQuery</span></a> tooltips inspector.
 
239
<td>The <em class="parameter"><code>help_id</code></em> for the <a href="/usr/share/gtk-doc/html/gtk/GtkTipsQuery.html"><span class="type">GtkTipsQuery</span></a> tooltips inspector.
332
240
</td>
333
241
</tr>
334
242
</tbody>
337
245
<hr>
338
246
<div class="refsect2" title="gimp_help_set_help_data_with_markup ()">
339
247
<a name="gimp-help-set-help-data-with-markup"></a><h3>gimp_help_set_help_data_with_markup ()</h3>
340
 
<pre class="programlisting">void                gimp_help_set_help_data_with_markup (<a
341
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
342
 
>GtkWidget</a> *widget,
343
 
                                                         const <a
344
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
345
 
>gchar</a> *tooltip,
346
 
                                                         const <a
347
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
348
 
>gchar</a> *help_id);</pre>
 
248
<pre class="programlisting"><span class="returnvalue">void</span>                gimp_help_set_help_data_with_markup (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
 
249
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tooltip</code></em>,
 
250
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>);</pre>
349
251
<p>
350
252
Just like <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data" title="gimp_help_set_help_data ()"><code class="function">gimp_help_set_help_data()</code></a>, but it allows to pass text which
351
253
is marked up with
352
 
<a
353
 
href="/usr/share/gtk-doc/html/pango/PangoMarkupFormat.html"
354
 
>Pango text markup language</a>.</p>
355
 
<p>
 
254
<a href="/usr/share/gtk-doc/html/pango/PangoMarkupFormat.html">Pango text markup language</a>.
356
255
</p>
357
256
<div class="variablelist"><table border="0">
358
257
<col align="left" valign="top">
359
258
<tbody>
360
259
<tr>
361
260
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
362
 
<td>  The <a
363
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
364
 
><span class="type">GtkWidget</span></a> you want to set a <em class="parameter"><code>tooltip</code></em> and/or <em class="parameter"><code>help_id</code></em> for.
 
261
<td>The <a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> you want to set a <em class="parameter"><code>tooltip</code></em> and/or <em class="parameter"><code>help_id</code></em> for.
365
262
</td>
366
263
</tr>
367
264
<tr>
368
265
<td><p><span class="term"><em class="parameter"><code>tooltip</code></em> :</span></p></td>
369
 
<td> The markup for this widget's tooltip (or <a
370
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
371
 
><code class="literal">NULL</code></a>).
 
266
<td>The markup for this widget's tooltip (or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).
372
267
</td>
373
268
</tr>
374
269
<tr>
375
270
<td><p><span class="term"><em class="parameter"><code>help_id</code></em> :</span></p></td>
376
 
<td> The <em class="parameter"><code>help_id</code></em> for the <a
377
 
href="http://library.gnome.org/devel/gtk/unstable/GtkTipsQuery.html"
378
 
><span class="type">GtkTipsQuery</span></a> tooltips inspector.
 
271
<td>The <em class="parameter"><code>help_id</code></em> for the <a href="/usr/share/gtk-doc/html/gtk/GtkTipsQuery.html"><span class="type">GtkTipsQuery</span></a> tooltips inspector.
379
272
</td>
380
273
</tr>
381
274
</tbody>
385
278
<hr>
386
279
<div class="refsect2" title="gimp_context_help ()">
387
280
<a name="gimp-context-help"></a><h3>gimp_context_help ()</h3>
388
 
<pre class="programlisting">void                gimp_context_help                   (<a
389
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
390
 
>GtkWidget</a> *widget);</pre>
 
281
<pre class="programlisting"><span class="returnvalue">void</span>                gimp_context_help                   (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
391
282
<p>
392
283
This function invokes the context help inspector.
393
284
</p>
400
291
(see <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data" title="gimp_help_set_help_data ()"><code class="function">gimp_help_set_help_data()</code></a>), the corresponding help page will
401
292
be displayed. Otherwise the help system will ascend the widget hierarchy
402
293
until it finds an attached <em class="parameter"><code>help_id</code></em> string (which should be the
403
 
case at least for every window/dialog).</p>
404
 
<p>
 
294
case at least for every window/dialog).
405
295
</p>
406
296
<div class="variablelist"><table border="0">
407
297
<col align="left" valign="top">
408
298
<tbody><tr>
409
299
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
410
 
<td> Any <a
411
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
412
 
><span class="type">GtkWidget</span></a> on the screen.
 
300
<td>Any <a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> on the screen.
413
301
</td>
414
302
</tr></tbody>
415
303
</table></div>
418
306
</div>
419
307
<div class="footer">
420
308
<hr>
421
 
          Generated by GTK-Doc V1.11</div>
 
309
          Generated by GTK-Doc V1.15</div>
422
310
</body>
423
 
</html>
 
311
</html>
 
 
b'\\ No newline at end of file'