← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gimp/trusty

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Ari Pollak
  • Date: 2009-08-14 09:57:17 UTC
  • mto: (1.1.21 upstream) (0.1.5 squeeze)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20090814095717-37dh2xqy5t0rurpk
Import upstream version 2.6.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/html/libgimpwidgets-GimpHelpUI.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>GimpHelpUI</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
 
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="GIMP Widgets Library Reference Manual">
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.10 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
14
14
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
34
34
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
35
35
<td><a accesskey="n" href="libgimpwidgets-GimpQueryBox.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
36
36
</tr>
37
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#libgimpwidgets-GimpHelpUI.synopsis" class="shortcut">Top</a>
38
 
                   | 
39
 
                  <a href="#libgimpwidgets-GimpHelpUI.description" class="shortcut">Description</a></nobr></td></tr>
 
37
<tr><td colspan="5" class="shortcuts">
 
38
<a href="#libgimpwidgets-GimpHelpUI.synopsis" class="shortcut">Top</a>
 
39
                 | 
 
40
                <a href="#libgimpwidgets-GimpHelpUI.description" class="shortcut">Description</a>
 
41
</td></tr>
40
42
</table>
41
 
<div class="refentry" lang="en">
 
43
<div class="refentry" title="GimpHelpUI">
42
44
<a name="libgimpwidgets-GimpHelpUI"></a><div class="titlepage"></div>
43
45
<div class="refnamediv"><table width="100%"><tr>
44
46
<td valign="top">
45
47
<h2><span class="refentrytitle"><a name="libgimpwidgets-GimpHelpUI.top_of_page"></a>GimpHelpUI</span></h2>
46
48
<p>GimpHelpUI — Functions for setting <a
47
 
href="/usr/share/gtk-doc/html/gtk/GtkTooltips.html"
 
49
href="http://library.gnome.org/devel/gtk/unstable/GtkTooltips.html"
48
50
><span class="type">GtkTooltips</span></a> and help identifier used by GIMP help
49
51
system.</p>
50
52
</td>
51
53
<td valign="top" align="right"></td>
52
54
</tr></table></div>
53
 
<div class="refsynopsisdiv">
 
55
<div class="refsynopsisdiv" title="Synopsis">
54
56
<a name="libgimpwidgets-GimpHelpUI.synopsis"></a><h2>Synopsis</h2>
55
57
<pre class="synopsis">
56
58
void                (<a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()">*GimpHelpFunc</a>)                     (const <a
59
61
                                                         <a
60
62
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
61
63
>gpointer</a> help_data);
62
 
#define             <a class="link" href="libgimpwidgets-GimpHelpUI.html#GIMP-HELP-ID:CAPS" title="GIMP_HELP_ID">GIMP_HELP_ID</a>
 
64
#define             <a class="link" href="libgimpwidgets-GimpHelpUI.html#GIMP-HELP-ID--CAPS" title="GIMP_HELP_ID">GIMP_HELP_ID</a>
63
65
void                <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-enable-tooltips" title="gimp_help_enable_tooltips ()">gimp_help_enable_tooltips</a>           (void);
64
66
void                <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-disable-tooltips" title="gimp_help_disable_tooltips ()">gimp_help_disable_tooltips</a>          (void);
65
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
69
71
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
70
72
>gpointer</a> help_data);
71
73
void                <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect" title="gimp_help_connect ()">gimp_help_connect</a>                   (<a
72
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
 
74
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
73
75
>GtkWidget</a> *widget,
74
76
                                                         <a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()">GimpHelpFunc</a> help_func,
75
77
                                                         const <a
79
81
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
80
82
>gpointer</a> help_data);
81
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
82
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
 
84
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
83
85
>GtkWidget</a> *widget,
84
86
                                                         const <a
85
87
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
88
90
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
89
91
>gchar</a> *help_id);
90
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
91
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
 
93
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
92
94
>GtkWidget</a> *widget,
93
95
                                                         const <a
94
96
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
97
99
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
98
100
>gchar</a> *help_id);
99
101
void                <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-context-help" title="gimp_context_help ()">gimp_context_help</a>                   (<a
100
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
 
102
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
101
103
>GtkWidget</a> *widget);
102
104
</pre>
103
105
</div>
104
 
<div class="refsect1" lang="en">
 
106
<div class="refsect1" title="Description">
105
107
<a name="libgimpwidgets-GimpHelpUI.description"></a><h2>Description</h2>
106
108
<p>
107
 
 
108
109
</p>
109
110
</div>
110
 
<div class="refsect1" lang="en">
 
111
<div class="refsect1" title="Details">
111
112
<a name="libgimpwidgets-GimpHelpUI.details"></a><h2>Details</h2>
112
 
<div class="refsect2" lang="en">
 
113
<div class="refsect2" title="GimpHelpFunc ()">
113
114
<a name="GimpHelpFunc"></a><h3>GimpHelpFunc ()</h3>
114
115
<pre class="programlisting">void                (*GimpHelpFunc)                     (const <a
115
116
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
151
152
<tr>
152
153
<td><p><span class="term"><em class="parameter"><code>help_data</code></em> :</span></p></td>
153
154
<td>
154
 
 
155
 
 
156
155
</td>
157
156
</tr>
158
157
</tbody>
159
158
</table></div>
160
159
</div>
161
160
<hr>
162
 
<div class="refsect2" lang="en">
163
 
<a name="GIMP-HELP-ID:CAPS"></a><h3>GIMP_HELP_ID</h3>
 
161
<div class="refsect2" title="GIMP_HELP_ID">
 
162
<a name="GIMP-HELP-ID--CAPS"></a><h3>GIMP_HELP_ID</h3>
164
163
<pre class="programlisting">#define GIMP_HELP_ID (gimp_help_id_quark ())
165
164
</pre>
166
165
<p>
168
167
</p>
169
168
</div>
170
169
<hr>
171
 
<div class="refsect2" lang="en">
 
170
<div class="refsect2" title="gimp_help_enable_tooltips ()">
172
171
<a name="gimp-help-enable-tooltips"></a><h3>gimp_help_enable_tooltips ()</h3>
173
172
<pre class="programlisting">void                gimp_help_enable_tooltips           (void);</pre>
174
173
<p>
182
181
the user setting from the GIMP preferences dialog is respected in
183
182
all plug-in dialogs.</p>
184
183
<p>
185
 
 
186
184
</p>
187
185
</div>
188
186
<hr>
189
 
<div class="refsect2" lang="en">
 
187
<div class="refsect2" title="gimp_help_disable_tooltips ()">
190
188
<a name="gimp-help-disable-tooltips"></a><h3>gimp_help_disable_tooltips ()</h3>
191
189
<pre class="programlisting">void                gimp_help_disable_tooltips          (void);</pre>
192
190
<p>
200
198
the user setting from the GIMP preferences dialog is respected in
201
199
all plug-in dialogs.</p>
202
200
<p>
203
 
 
204
201
</p>
205
202
</div>
206
203
<hr>
207
 
<div class="refsect2" lang="en">
 
204
<div class="refsect2" title="gimp_standard_help_func ()">
208
205
<a name="gimp-standard-help-func"></a><h3>gimp_standard_help_func ()</h3>
209
206
<pre class="programlisting">void                gimp_standard_help_func             (const <a
210
207
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
218
215
href="../libgimp/libgimp-gimphelp.html#gimp-help"
219
216
><code class="function">gimp_help()</code></a>. It is the right function to use in almost all cases.</p>
220
217
<p>
221
 
 
222
218
</p>
223
219
<div class="variablelist"><table border="0">
224
220
<col align="left" valign="top">
237
233
</table></div>
238
234
</div>
239
235
<hr>
240
 
<div class="refsect2" lang="en">
 
236
<div class="refsect2" title="gimp_help_connect ()">
241
237
<a name="gimp-help-connect"></a><h3>gimp_help_connect ()</h3>
242
238
<pre class="programlisting">void                gimp_help_connect                   (<a
243
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
 
239
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
244
240
>GtkWidget</a> *widget,
245
241
                                                         <a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()">GimpHelpFunc</a> help_func,
246
242
                                                         const <a
254
250
constructors. You only have to call it for windows/dialogs you created
255
251
"manually".</p>
256
252
<p>
257
 
 
258
253
</p>
259
254
<div class="variablelist"><table border="0">
260
255
<col align="left" valign="top">
263
258
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
264
259
<td> The widget you want to connect the help accelerator for. Will
265
260
         be a <a
266
 
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
 
261
href="http://library.gnome.org/devel/gtk/unstable/GtkWindow.html"
267
262
><span class="type">GtkWindow</span></a> in most cases.
268
263
</td>
269
264
</tr>
286
281
</table></div>
287
282
</div>
288
283
<hr>
289
 
<div class="refsect2" lang="en">
 
284
<div class="refsect2" title="gimp_help_set_help_data ()">
290
285
<a name="gimp-help-set-help-data"></a><h3>gimp_help_set_help_data ()</h3>
291
286
<pre class="programlisting">void                gimp_help_set_help_data             (<a
292
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
 
287
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
293
288
>GtkWidget</a> *widget,
294
289
                                                         const <a
295
290
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
299
294
>gchar</a> *help_id);</pre>
300
295
<p>
301
296
The reason why we don't use <a
302
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html#gtk-widget-set-tooltip-text"
 
297
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html#gtk-widget-set-tooltip-text"
303
298
><code class="function">gtk_widget_set_tooltip_text()</code></a> is that
304
299
elements in the GIMP user interface should, if possible, also have
305
300
a <em class="parameter"><code>help_id</code></em> set for context-sensitive help.
306
301
</p>
307
302
<p>
308
303
This function can be called with <a
309
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"
 
304
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
310
305
><span class="type">NULL</span></a> for <em class="parameter"><code>tooltip</code></em>. Use this feature
311
306
if you want to set a help link for a widget which shouldn't have
312
307
a visible tooltip.</p>
313
308
<p>
314
 
 
315
309
</p>
316
310
<div class="variablelist"><table border="0">
317
311
<col align="left" valign="top">
319
313
<tr>
320
314
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
321
315
<td>  The <a
322
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
 
316
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
323
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.
324
318
</td>
325
319
</tr>
326
320
<tr>
327
321
<td><p><span class="term"><em class="parameter"><code>tooltip</code></em> :</span></p></td>
328
322
<td> The text for this widget's tooltip (or <a
329
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"
 
323
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
330
324
><code class="literal">NULL</code></a>).
331
325
</td>
332
326
</tr>
333
327
<tr>
334
328
<td><p><span class="term"><em class="parameter"><code>help_id</code></em> :</span></p></td>
335
329
<td> The <em class="parameter"><code>help_id</code></em> for the <a
336
 
href="/usr/share/gtk-doc/html/gtk/GtkTipsQuery.html"
 
330
href="http://library.gnome.org/devel/gtk/unstable/GtkTipsQuery.html"
337
331
><span class="type">GtkTipsQuery</span></a> tooltips inspector.
338
332
</td>
339
333
</tr>
341
335
</table></div>
342
336
</div>
343
337
<hr>
344
 
<div class="refsect2" lang="en">
 
338
<div class="refsect2" title="gimp_help_set_help_data_with_markup ()">
345
339
<a name="gimp-help-set-help-data-with-markup"></a><h3>gimp_help_set_help_data_with_markup ()</h3>
346
340
<pre class="programlisting">void                gimp_help_set_help_data_with_markup (<a
347
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
 
341
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
348
342
>GtkWidget</a> *widget,
349
343
                                                         const <a
350
344
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
359
353
href="/usr/share/gtk-doc/html/pango/PangoMarkupFormat.html"
360
354
>Pango text markup language</a>.</p>
361
355
<p>
362
 
 
363
356
</p>
364
357
<div class="variablelist"><table border="0">
365
358
<col align="left" valign="top">
367
360
<tr>
368
361
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
369
362
<td>  The <a
370
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
 
363
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
371
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.
372
365
</td>
373
366
</tr>
374
367
<tr>
375
368
<td><p><span class="term"><em class="parameter"><code>tooltip</code></em> :</span></p></td>
376
369
<td> The markup for this widget's tooltip (or <a
377
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"
 
370
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
378
371
><code class="literal">NULL</code></a>).
379
372
</td>
380
373
</tr>
381
374
<tr>
382
375
<td><p><span class="term"><em class="parameter"><code>help_id</code></em> :</span></p></td>
383
376
<td> The <em class="parameter"><code>help_id</code></em> for the <a
384
 
href="/usr/share/gtk-doc/html/gtk/GtkTipsQuery.html"
 
377
href="http://library.gnome.org/devel/gtk/unstable/GtkTipsQuery.html"
385
378
><span class="type">GtkTipsQuery</span></a> tooltips inspector.
386
379
</td>
387
380
</tr>
388
381
</tbody>
389
382
</table></div>
390
 
<p class="since">Since  GIMP 2.6
391
 
</p>
 
383
<p class="since">Since GIMP 2.6</p>
392
384
</div>
393
385
<hr>
394
 
<div class="refsect2" lang="en">
 
386
<div class="refsect2" title="gimp_context_help ()">
395
387
<a name="gimp-context-help"></a><h3>gimp_context_help ()</h3>
396
388
<pre class="programlisting">void                gimp_context_help                   (<a
397
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
 
389
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
398
390
>GtkWidget</a> *widget);</pre>
399
391
<p>
400
392
This function invokes the context help inspector.
410
402
until it finds an attached <em class="parameter"><code>help_id</code></em> string (which should be the
411
403
case at least for every window/dialog).</p>
412
404
<p>
413
 
 
414
405
</p>
415
406
<div class="variablelist"><table border="0">
416
407
<col align="left" valign="top">
417
408
<tbody><tr>
418
409
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
419
410
<td> Any <a
420
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
 
411
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
421
412
><span class="type">GtkWidget</span></a> on the screen.
422
413
</td>
423
414
</tr></tbody>
427
418
</div>
428
419
<div class="footer">
429
420
<hr>
430
 
          Generated by GTK-Doc V1.10</div>
 
421
          Generated by GTK-Doc V1.11</div>
431
422
</body>
432
423
</html>