summaryrefslogtreecommitdiffstats
path: root/devel-docs/libgimpwidgets/html/GimpDialog.html
blob: 01af9dc892f4b3a26b3135790d0d618c811ad40c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GimpDialog: GIMP Widgets Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP Widgets Library Reference Manual">
<link rel="up" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
<link rel="prev" href="GimpColorProfileView.html" title="GimpColorProfileView">
<link rel="next" href="GimpEnumStore.html" title="GimpEnumStore">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GimpDialog.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GimpDialog.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GimpDialog.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GimpDialog.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimpwidgets-widgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GimpColorProfileView.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GimpEnumStore.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GimpDialog"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GimpDialog.top_of_page"></a>GimpDialog</span></h2>
<p>GimpDialog — Constructors for <span class="type">GtkDialog</span>'s and action_areas as
well as other dialog-related stuff.</p>
</td>
<td class="gallery_image" valign="top" align="right"><img src="gimp-widget-dialog.png"></td>
</tr></table></div>
<div class="refsect1">
<a name="GimpDialog.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">GtkWidget</span> *
</td>
<td class="function_name">
<a class="link" href="GimpDialog.html#gimp-dialog-new" title="gimp_dialog_new ()">gimp_dialog_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GtkWidget</span> *
</td>
<td class="function_name">
<a class="link" href="GimpDialog.html#gimp-dialog-new-valist" title="gimp_dialog_new_valist ()">gimp_dialog_new_valist</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GtkWidget</span> *
</td>
<td class="function_name">
<a class="link" href="GimpDialog.html#gimp-dialog-add-button" title="gimp_dialog_add_button ()">gimp_dialog_add_button</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GimpDialog.html#gimp-dialog-add-buttons" title="gimp_dialog_add_buttons ()">gimp_dialog_add_buttons</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GimpDialog.html#gimp-dialog-add-buttons-valist" title="gimp_dialog_add_buttons_valist ()">gimp_dialog_add_buttons_valist</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="GimpDialog.html#gimp-dialog-run" title="gimp_dialog_run ()">gimp_dialog_run</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GimpDialog.html#gimp-dialogs-show-help-button" title="gimp_dialogs_show_help_button ()">gimp_dialogs_show_help_button</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpDialog.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><span class="type">gpointer</span></td>
<td class="property_name"><a class="link" href="GimpDialog.html#GimpDialog--help-func" title="The “help-func” property">help-func</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">char</span> *</td>
<td class="property_name"><a class="link" href="GimpDialog.html#GimpDialog--help-id" title="The “help-id” property">help-id</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">GtkWidget</span> *</td>
<td class="property_name"><a class="link" href="GimpDialog.html#GimpDialog--parent" title="The “parent” property">parent</a></td>
<td class="property_flags">Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpDialog.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GimpDialog.html#GimpDialog-struct" title="GimpDialog">GimpDialog</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpDialog.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GInitiallyUnowned
        <span class="lineart">╰──</span> GtkObject
            <span class="lineart">╰──</span> GtkWidget
                <span class="lineart">╰──</span> GtkContainer
                    <span class="lineart">╰──</span> GtkBin
                        <span class="lineart">╰──</span> GtkWindow
                            <span class="lineart">╰──</span> GtkDialog
                                <span class="lineart">╰──</span> GimpDialog
</pre>
</div>
<div class="refsect1">
<a name="GimpDialog.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GimpDialog implements
 AtkImplementorIface and  GtkBuildable.</p>
</div>
<div class="refsect1">
<a name="GimpDialog.description"></a><h2>Description</h2>
<p>Constructors for <span class="type">GtkDialog</span>'s and action_areas as well as other
dialog-related stuff.</p>
</div>
<div class="refsect1">
<a name="GimpDialog.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-dialog-new"></a><h3>gimp_dialog_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
gimp_dialog_new (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
                 <em class="parameter"><code>const <span class="type">gchar</span> *role</code></em>,
                 <em class="parameter"><code><span class="type">GtkWidget</span> *parent</code></em>,
                 <em class="parameter"><code><span class="type">GtkDialogFlags</span> flags</code></em>,
                 <em class="parameter"><code><a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()"><span class="type">GimpHelpFunc</span></a> help_func</code></em>,
                 <em class="parameter"><code>const <span class="type">gchar</span> *help_id</code></em>,
                 <em class="parameter"><code>...</code></em>);</pre>
<p>Creates a new <em class="parameter"><code>GimpDialog</code></em>
 widget.</p>
<p>This function simply packs the action_area arguments passed in "..."
into a <em class="parameter"><code>va_list</code></em>
 variable and passes everything to <a class="link" href="GimpDialog.html#gimp-dialog-new-valist" title="gimp_dialog_new_valist ()"><code class="function">gimp_dialog_new_valist()</code></a>.</p>
<p>For a description of the format of the <em class="parameter"><code>va_list</code></em>
 describing the
action_area buttons see <code class="function">gtk_dialog_new_with_buttons()</code>.</p>
<div class="refsect3">
<a name="gimp-dialog-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>title</p></td>
<td class="parameter_description"><p>The dialog's title which will be set with
<code class="function">gtk_window_set_title()</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>role</p></td>
<td class="parameter_description"><p>The dialog's <em class="parameter"><code>role</code></em>
which will be set with
<code class="function">gtk_window_set_role()</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>parent</p></td>
<td class="parameter_description"><p>The <em class="parameter"><code>parent</code></em>
widget of this dialog.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>The <em class="parameter"><code>flags</code></em>
(see the <span class="type">GtkDialog</span> documentation).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>help_func</p></td>
<td class="parameter_description"><p>The function which will be called if the user presses "F1".</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>help_id</p></td>
<td class="parameter_description"><p>The help_id which will be passed to <em class="parameter"><code>help_func</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>A <code class="literal">NULL</code>-terminated <em class="parameter"><code>va_list</code></em>
destribing the
action_area buttons.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-dialog-new.returns"></a><h4>Returns</h4>
<p> A <a class="link" href="GimpDialog.html" title="GimpDialog"><span class="type">GimpDialog</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-dialog-new-valist"></a><h3>gimp_dialog_new_valist ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
gimp_dialog_new_valist (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
                        <em class="parameter"><code>const <span class="type">gchar</span> *role</code></em>,
                        <em class="parameter"><code><span class="type">GtkWidget</span> *parent</code></em>,
                        <em class="parameter"><code><span class="type">GtkDialogFlags</span> flags</code></em>,
                        <em class="parameter"><code><a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()"><span class="type">GimpHelpFunc</span></a> help_func</code></em>,
                        <em class="parameter"><code>const <span class="type">gchar</span> *help_id</code></em>,
                        <em class="parameter"><code><span class="type">va_list</span> args</code></em>);</pre>
<p>Creates a new <em class="parameter"><code>GimpDialog</code></em>
 widget. If a GtkWindow is specified as
<em class="parameter"><code>parent</code></em>
 then the dialog will be made transient for this window.</p>
<p>For a description of the format of the <em class="parameter"><code>va_list</code></em>
 describing the
action_area buttons see <code class="function">gtk_dialog_new_with_buttons()</code>.</p>
<div class="refsect3">
<a name="gimp-dialog-new-valist.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>title</p></td>
<td class="parameter_description"><p>The dialog's title which will be set with
<code class="function">gtk_window_set_title()</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>role</p></td>
<td class="parameter_description"><p>The dialog's <em class="parameter"><code>role</code></em>
which will be set with
<code class="function">gtk_window_set_role()</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>parent</p></td>
<td class="parameter_description"><p>The <em class="parameter"><code>parent</code></em>
widget of this dialog or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>The <em class="parameter"><code>flags</code></em>
(see the <span class="type">GtkDialog</span> documentation).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>help_func</p></td>
<td class="parameter_description"><p>The function which will be called if the user presses "F1".</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>help_id</p></td>
<td class="parameter_description"><p>The help_id which will be passed to <em class="parameter"><code>help_func</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>args</p></td>
<td class="parameter_description"><p>A <em class="parameter"><code>va_list</code></em>
destribing the action_area buttons.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-dialog-new-valist.returns"></a><h4>Returns</h4>
<p> A <a class="link" href="GimpDialog.html" title="GimpDialog"><span class="type">GimpDialog</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-dialog-add-button"></a><h3>gimp_dialog_add_button ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
gimp_dialog_add_button (<em class="parameter"><code><a class="link" href="GimpDialog.html" title="GimpDialog"><span class="type">GimpDialog</span></a> *dialog</code></em>,
                        <em class="parameter"><code>const <span class="type">gchar</span> *button_text</code></em>,
                        <em class="parameter"><code><span class="type">gint</span> response_id</code></em>);</pre>
<p>This function is essentially the same as <code class="function">gtk_dialog_add_button()</code>
except it ensures there is only one help button and automatically
sets the RESPONSE_OK widget as the default response.</p>
<div class="refsect3">
<a name="gimp-dialog-add-button.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dialog</p></td>
<td class="parameter_description"><p>The <em class="parameter"><code>dialog</code></em>
to add a button to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>button_text</p></td>
<td class="parameter_description"><p>text of button, or stock ID.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>response_id</p></td>
<td class="parameter_description"><p>response ID for the button.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-dialog-add-button.returns"></a><h4>Returns</h4>
<p> the button widget that was added.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-dialog-add-buttons"></a><h3>gimp_dialog_add_buttons ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_dialog_add_buttons (<em class="parameter"><code><a class="link" href="GimpDialog.html" title="GimpDialog"><span class="type">GimpDialog</span></a> *dialog</code></em>,
                         <em class="parameter"><code>...</code></em>);</pre>
<p>This function is essentially the same as <code class="function">gtk_dialog_add_buttons()</code>
except it calls <a class="link" href="GimpDialog.html#gimp-dialog-add-button" title="gimp_dialog_add_button ()"><code class="function">gimp_dialog_add_button()</code></a> instead of <code class="function">gtk_dialog_add_button()</code></p>
<div class="refsect3">
<a name="gimp-dialog-add-buttons.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dialog</p></td>
<td class="parameter_description"><p>The <em class="parameter"><code>dialog</code></em>
to add buttons to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>button_text-response_id pairs.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-dialog-add-buttons-valist"></a><h3>gimp_dialog_add_buttons_valist ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_dialog_add_buttons_valist (<em class="parameter"><code><a class="link" href="GimpDialog.html" title="GimpDialog"><span class="type">GimpDialog</span></a> *dialog</code></em>,
                                <em class="parameter"><code><span class="type">va_list</span> args</code></em>);</pre>
<p>This function is essentially the same as <a class="link" href="GimpDialog.html#gimp-dialog-add-buttons" title="gimp_dialog_add_buttons ()"><code class="function">gimp_dialog_add_buttons()</code></a>
except it takes a va_list instead of '...'</p>
<div class="refsect3">
<a name="gimp-dialog-add-buttons-valist.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dialog</p></td>
<td class="parameter_description"><p>The <em class="parameter"><code>dialog</code></em>
to add buttons to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>args</p></td>
<td class="parameter_description"><p>The buttons as va_list.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-dialog-run"></a><h3>gimp_dialog_run ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
gimp_dialog_run (<em class="parameter"><code><a class="link" href="GimpDialog.html" title="GimpDialog"><span class="type">GimpDialog</span></a> *dialog</code></em>);</pre>
<p>This function does exactly the same as <code class="function">gtk_dialog_run()</code> except it
does not make the dialog modal while the <span class="type">GMainLoop</span> is running.</p>
<div class="refsect3">
<a name="gimp-dialog-run.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>dialog</p></td>
<td class="parameter_description"><p>a <a class="link" href="GimpDialog.html" title="GimpDialog"><span class="type">GimpDialog</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-dialog-run.returns"></a><h4>Returns</h4>
<p> response ID</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-dialogs-show-help-button"></a><h3>gimp_dialogs_show_help_button ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_dialogs_show_help_button (<em class="parameter"><code><span class="type">gboolean</span> show</code></em>);</pre>
<p>This function is for internal use only.</p>
<div class="refsect3">
<a name="gimp-dialogs-show-help-button.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>show</p></td>
<td class="parameter_description"><p>whether a help button should be added when creating a GimpDialog</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
</div>
<div class="refsect1">
<a name="GimpDialog.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GimpDialog-struct"></a><h3>GimpDialog</h3>
<pre class="programlisting">typedef struct _GimpDialog GimpDialog;</pre>
</div>
</div>
<div class="refsect1">
<a name="GimpDialog.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GimpDialog--help-func"></a><h3>The <code class="literal">“help-func”</code> property</h3>
<pre class="programlisting">  “help-func”                <span class="type">gpointer</span></pre>
<p>The help function to call when F1 is hit.</p>
<p>Owner: GimpDialog</p>
<p>Flags: Read / Write / Construct Only</p>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GimpDialog--help-id"></a><h3>The <code class="literal">“help-id”</code> property</h3>
<pre class="programlisting">  “help-id”                  <span class="type">char</span> *</pre>
<p>The help ID to pass to help-func.</p>
<p>Owner: GimpDialog</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GimpDialog--parent"></a><h3>The <code class="literal">“parent”</code> property</h3>
<pre class="programlisting">  “parent”                   <span class="type">GtkWidget</span> *</pre>
<p>The dialog's parent widget.</p>
<p>Owner: GimpDialog</p>
<p>Flags: Write / Construct Only</p>
<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>