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
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XfceTitledDialog: libxfce4ui Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="libxfce4ui Reference Manual">
<link rel="up" href="ch01.html" title="[Insert title here]">
<link rel="prev" href="libxfce4ui-XfceDialogs.html" title="XfceDialogs">
<link rel="next" href="XfceClipboardManager.html" title="XfceClipboardManager">
<meta name="generator" content="GTK-Doc V1.34.0 (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="#XfceTitledDialog.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#XfceTitledDialog.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#XfceTitledDialog.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#XfceTitledDialog.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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libxfce4ui-XfceDialogs.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="XfceClipboardManager.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="XfceTitledDialog"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="XfceTitledDialog.top_of_page"></a>XfceTitledDialog</span></h2>
<p>XfceTitledDialog — A titled dialog window</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="XfceTitledDialog.stability-level"></a><h2>Stability Level</h2>
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to
develop applications to these interfaces, release them, and have confidence that
they will run on all minor releases of the product (after the one in which the
interface was introduced, and within the same major release). Even at a major
release, incompatible changes are expected to be rare, and to have strong
justifications.
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="XfceTitledDialog.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">
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="XfceTitledDialog.html#xfce-titled-dialog-new" title="xfce_titled_dialog_new ()">xfce_titled_dialog_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="XfceTitledDialog.html#xfce-titled-dialog-new-with-buttons" title="xfce_titled_dialog_new_with_buttons ()">xfce_titled_dialog_new_with_buttons</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="XfceTitledDialog.html#xfce-titled-dialog-new-with-mixed-buttons" title="xfce_titled_dialog_new_with_mixed_buttons ()">xfce_titled_dialog_new_with_mixed_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="XfceTitledDialog.html#xfce-titled-dialog-create-action-area" title="xfce_titled_dialog_create_action_area ()">xfce_titled_dialog_create_action_area</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="XfceTitledDialog.html#xfce-titled-dialog-add-button" title="xfce_titled_dialog_add_button ()">xfce_titled_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="XfceTitledDialog.html#xfce-titled-dialog-add-action-widget" title="xfce_titled_dialog_add_action_widget ()">xfce_titled_dialog_add_action_widget</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="XfceTitledDialog.html#xfce-titled-dialog-set-default-response" title="xfce_titled_dialog_set_default_response ()">xfce_titled_dialog_set_default_response</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="XfceTitledDialog.html#xfce-titled-dialog-get-subtitle" title="xfce_titled_dialog_get_subtitle ()">xfce_titled_dialog_get_subtitle</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="XfceTitledDialog.html#xfce-titled-dialog-set-subtitle" title="xfce_titled_dialog_set_subtitle ()">xfce_titled_dialog_set_subtitle</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XfceTitledDialog.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">char</span> *</td>
<td class="property_name"><a class="link" href="XfceTitledDialog.html#XfceTitledDialog--subtitle" title="The “subtitle” property">subtitle</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XfceTitledDialog.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">struct</td>
<td class="function_name"><a class="link" href="XfceTitledDialog.html#XfceTitledDialog-struct" title="struct XfceTitledDialog">XfceTitledDialog</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XfceTitledDialog.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkBin.html#GtkBin-struct">GtkBin</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkWindow.html#GtkWindow-struct">GtkWindow</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#GtkDialog-struct">GtkDialog</a>
<span class="lineart">╰──</span> XfceTitledDialog
</pre>
</div>
<div class="refsect1">
<a name="XfceTitledDialog.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
XfceTitledDialog implements
AtkImplementorIface and <a href="/usr/share/gtk-doc/html/gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="XfceTitledDialog.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libxfce4ui/libxfce4ui.h>
</pre>
</div>
<div class="refsect1">
<a name="XfceTitledDialog.description"></a><h2>Description</h2>
<p><a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> is a titled dialog window supporting an optional
subtitle and mixed or pixbuf buttons.</p>
</div>
<div class="refsect1">
<a name="XfceTitledDialog.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="xfce-titled-dialog-new"></a><h3>xfce_titled_dialog_new ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
xfce_titled_dialog_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Allocates a new <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> instance.</p>
<div class="refsect3">
<a name="xfce-titled-dialog-new.returns"></a><h4>Returns</h4>
<p> the newly allocated <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-titled-dialog-new-with-buttons"></a><h3>xfce_titled_dialog_new_with_buttons ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
xfce_titled_dialog_new_with_buttons (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> *parent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#GtkDialogFlags"><span class="type">GtkDialogFlags</span></a> flags</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *first_button_text</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<div class="warning">
<p><code class="literal">xfce_titled_dialog_new_with_buttons</code> has been deprecated since version 4.16 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="XfceTitledDialog.html#xfce-titled-dialog-new-with-mixed-buttons" title="xfce_titled_dialog_new_with_mixed_buttons ()"><span class="type">xfce_titled_dialog_new_with_mixed_buttons</span></a> instead.</p>
</div>
<p>See the documentation of <a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#gtk-dialog-new-with-buttons"><code class="function">gtk_dialog_new_with_buttons()</code></a> for details about the
parameters and the returned dialog.</p>
<div class="refsect3">
<a name="xfce-titled-dialog-new-with-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>title</p></td>
<td class="parameter_description"><p>title of the dialog, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>parent</p></td>
<td class="parameter_description"><p>transient parent window of the dialog, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>from <a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#GtkDialogFlags"><span class="type">GtkDialogFlags</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>first_button_text</p></td>
<td class="parameter_description"><p>stock ID or text to go in first, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>response ID for the first button, then additional buttons, ending with <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfce-titled-dialog-new-with-buttons.returns"></a><h4>Returns</h4>
<p> the newly allocated <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-titled-dialog-new-with-mixed-buttons"></a><h3>xfce_titled_dialog_new_with_mixed_buttons ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
xfce_titled_dialog_new_with_mixed_buttons
(<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> *parent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#GtkDialogFlags"><span class="type">GtkDialogFlags</span></a> flags</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *first_button_icon_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *first_button_text</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Creates an <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> using xfce_gtk_button_new_mixed. This allows
the buttons to use an optional named or stock icon.</p>
<div class="refsect3">
<a name="xfce-titled-dialog-new-with-mixed-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>title</p></td>
<td class="parameter_description"><p>title of the dialog, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>parent</p></td>
<td class="parameter_description"><p>transient parent window of the dialog, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>from <a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#GtkDialogFlags"><span class="type">GtkDialogFlags</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>first_button_icon_name</p></td>
<td class="parameter_description"><p>icon name to go in first, or "" for no icon.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>first_button_text</p></td>
<td class="parameter_description"><p>text to go in first, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>response ID for the first button, then additional buttons, ending with <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfce-titled-dialog-new-with-mixed-buttons.returns"></a><h4>Returns</h4>
<p> the newly allocated <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-4-14.html#api-index-4.14">4.14</a></p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-titled-dialog-create-action-area"></a><h3>xfce_titled_dialog_create_action_area ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xfce_titled_dialog_create_action_area (<em class="parameter"><code><a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> *titled_dialog</code></em>);</pre>
<div class="warning"><p><code class="literal">xfce_titled_dialog_create_action_area</code> has been deprecated since version 4.19.3 and should not be used in newly-written code.</p></div>
<p>This function is a no-op since 4.19.3.</p>
<div class="refsect3">
<a name="xfce-titled-dialog-create-action-area.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>titled_dialog</p></td>
<td class="parameter_description"><p>a <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-titled-dialog-add-button"></a><h3>xfce_titled_dialog_add_button ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
xfce_titled_dialog_add_button (<em class="parameter"><code><a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> *titled_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 a replacement for <a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#gtk-dialog-add-button"><span class="type">gtk_dialog_add_button</span></a>.</p>
<p>Buttons with <a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#GTK-RESPONSE-HELP:CAPS"><span class="type">GTK_RESPONSE_HELP</span></a> will be added to the secondary group of children
(see <a href="/usr/share/gtk-doc/html/gtk3/GtkButtonBox.html#gtk-button-box-set-child-secondary"><span class="type">gtk_button_box_set_child_secondary</span></a> for reference).</p>
<div class="refsect3">
<a name="xfce-titled-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>titled_dialog</p></td>
<td class="parameter_description"><p>a <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</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.</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 <em class="parameter"><code>child</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfce-titled-dialog-add-button.returns"></a><h4>Returns</h4>
<p>the GtkButton widget that was added. </p>
<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-titled-dialog-add-action-widget"></a><h3>xfce_titled_dialog_add_action_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xfce_titled_dialog_add_action_widget (<em class="parameter"><code><a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> *titled_dialog</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *child</code></em>,
<em class="parameter"><code><span class="type">gint</span> response_id</code></em>);</pre>
<p>This function is a replacement for <a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#gtk-dialog-add-action-widget"><span class="type">gtk_dialog_add_action_widget</span></a>.</p>
<p>Children with <a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#GTK-RESPONSE-HELP:CAPS"><span class="type">GTK_RESPONSE_HELP</span></a> will be added to the secondary group of children
(see <a href="/usr/share/gtk-doc/html/gtk3/GtkButtonBox.html#gtk-button-box-set-child-secondary"><span class="type">gtk_button_box_set_child_secondary</span></a> for reference).</p>
<div class="refsect3">
<a name="xfce-titled-dialog-add-action-widget.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>titled_dialog</p></td>
<td class="parameter_description"><p>a <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>child</p></td>
<td class="parameter_description"><p>an activatable widget.</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 <em class="parameter"><code>child</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-titled-dialog-set-default-response"></a><h3>xfce_titled_dialog_set_default_response ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xfce_titled_dialog_set_default_response
(<em class="parameter"><code><a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> *titled_dialog</code></em>,
<em class="parameter"><code><span class="type">gint</span> response_id</code></em>);</pre>
<p>Sets the last widget in the dialog’s action area with the given <em class="parameter"><code>response_id</code></em>
as the default widget for the dialog. Pressing “Enter” normally activates
the default widget.</p>
<p>This function is a replacement for <a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#gtk-dialog-set-default-response"><span class="type">gtk_dialog_set_default_response</span></a>, which does
not work with <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p>
<div class="refsect3">
<a name="xfce-titled-dialog-set-default-response.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>titled_dialog</p></td>
<td class="parameter_description"><p>a <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>response_id</p></td>
<td class="parameter_description"><p>a response ID</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-titled-dialog-get-subtitle"></a><h3>xfce_titled_dialog_get_subtitle ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
xfce_titled_dialog_get_subtitle (<em class="parameter"><code><a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> *titled_dialog</code></em>);</pre>
<p>Returns the subtitle of the <em class="parameter"><code>titled_dialog</code></em>
, or <code class="literal">NULL</code>
if no subtitle is displayed in the <em class="parameter"><code>titled_dialog</code></em>
.
This is just a convenience function around <a href="/usr/share/gtk-doc/html/gtk3/GtkHeaderBar.html#gtk-header-bar-get-subtitle"><span class="type">gtk_header_bar_get_subtitle</span></a>.</p>
<div class="refsect3">
<a name="xfce-titled-dialog-get-subtitle.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>titled_dialog</p></td>
<td class="parameter_description"><p>a <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfce-titled-dialog-get-subtitle.returns"></a><h4>Returns</h4>
<p> the subtitle of <em class="parameter"><code>titled_dialog</code></em>
, or <code class="literal">NULL</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-titled-dialog-set-subtitle"></a><h3>xfce_titled_dialog_set_subtitle ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xfce_titled_dialog_set_subtitle (<em class="parameter"><code><a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> *titled_dialog</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *subtitle</code></em>);</pre>
<p>Sets the subtitle displayed by <em class="parameter"><code>titled_dialog</code></em>
to <em class="parameter"><code>subtitle</code></em>
; if
<em class="parameter"><code>subtitle</code></em>
is <code class="literal">NULL</code> no subtitle will be displayed by the <em class="parameter"><code>titled_dialog</code></em>
.
This is just a convenience function around <a href="/usr/share/gtk-doc/html/gtk3/GtkHeaderBar.html#gtk-header-bar-set-subtitle"><span class="type">gtk_header_bar_set_subtitle</span></a>
when dialogs use header bars. Otherwise a simple label and separator are
shown at the top of dialog.</p>
<div class="refsect3">
<a name="xfce-titled-dialog-set-subtitle.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>titled_dialog</p></td>
<td class="parameter_description"><p>a <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>subtitle</p></td>
<td class="parameter_description"><p>the new subtitle for the <em class="parameter"><code>titled_dialog</code></em>
, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="XfceTitledDialog.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="XfceTitledDialog-struct"></a><h3>struct XfceTitledDialog</h3>
<pre class="programlisting">struct XfceTitledDialog;</pre>
<p>An opaque struct with only private fields.</p>
</div>
</div>
<div class="refsect1">
<a name="XfceTitledDialog.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="XfceTitledDialog--subtitle"></a><h3>The <code class="literal">“subtitle”</code> property</h3>
<pre class="programlisting"> “subtitle” <span class="type">char</span> *</pre>
<p>The subtitle displayed below the main dialog title.</p>
<p>Owner: XfceTitledDialog</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.34.0</div>
</body>
</html>
|
