libxfce4ui-common 4.12.1-2 / usr / share / gtk-doc / html / libxfce4ui / libxfce4ui-xfce-dialogs.html

This file is indexed.

/usr/share/gtk-doc/html/libxfce4ui/libxfce4ui-xfce-dialogs.html is in libxfce4ui-common 4.12.1-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Libxfce4ui Reference Manual: Xfce Dialogs</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.0">
<link rel="home" href="index.html" title="Libxfce4ui Reference Manual">
<link rel="up" href="libxfce4ui-widgets.html" title="Part IV. Xfce UI Widget">
<link rel="prev" href="libxfce4ui-widgets.html" title="Part IV. Xfce UI Widget">
<link rel="next" href="libxfce4ui-xfce-titled-dialog.html" title="Xfce Titled Dialog">
<meta name="generator" content="GTK-Doc V1.21 (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="#libxfce4ui-xfce-dialogs.description" class="shortcut">Description</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="libxfce4ui-widgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libxfce4ui-widgets.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libxfce4ui-xfce-titled-dialog.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libxfce4ui-xfce-dialogs"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libxfce4ui-xfce-dialogs.top_of_page"></a>Xfce Dialogs</span></h2>
<p>Xfce Dialogs — Common used dialogs to interact with the user.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libxfce4ui-xfce-dialogs.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="libxfce4ui-xfce-dialogs.html#xfce-message-dialog-new" title="xfce_message_dialog_new ()">xfce_message_dialog_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="libxfce4ui-xfce-dialogs.html#xfce-message-dialog-new-valist" title="xfce_message_dialog_new_valist ()">xfce_message_dialog_new_valist</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="libxfce4ui-xfce-dialogs.html#xfce-message-dialog" title="xfce_message_dialog ()">xfce_message_dialog</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="libxfce4ui-xfce-dialogs.html#xfce-dialog-show-help" title="xfce_dialog_show_help ()">xfce_dialog_show_help</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="libxfce4ui-xfce-dialogs.html#xfce-dialog-show-help-with-version" title="xfce_dialog_show_help_with_version ()">xfce_dialog_show_help_with_version</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="libxfce4ui-xfce-dialogs.html#xfce-dialog-show-info" title="xfce_dialog_show_info ()">xfce_dialog_show_info</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="libxfce4ui-xfce-dialogs.html#xfce-dialog-show-warning" title="xfce_dialog_show_warning ()">xfce_dialog_show_warning</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="libxfce4ui-xfce-dialogs.html#xfce-dialog-show-error" title="xfce_dialog_show_error ()">xfce_dialog_show_error</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libxfce4ui-xfce-dialogs.html#xfce-dialog-confirm" title="xfce_dialog_confirm ()">xfce_dialog_confirm</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libxfce4ui-xfce-dialogs.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libxfce4ui-xfce-dialogs.html#XFCE-BUTTON-TYPE-MIXED:CAPS" title="XFCE_BUTTON_TYPE_MIXED">XFCE_BUTTON_TYPE_MIXED</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libxfce4ui-xfce-dialogs.html#XFCE-BUTTON-TYPE-PIXBUF:CAPS" title="XFCE_BUTTON_TYPE_PIXBUF">XFCE_BUTTON_TYPE_PIXBUF</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libxfce4ui-xfce-dialogs.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libxfce4ui/libxfce4ui.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="libxfce4ui-xfce-dialogs.description"></a><h2>Description</h2>
<p>
Useful convientent function to interact with the user using a
<a href="http://developer.gnome.org/gtk2/GtkMessageDialog.html"><span class="type">GtkMessageDialog</span></a>.
</p>
</div>
<div class="refsect1">
<a name="libxfce4ui-xfce-dialogs.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="xfce-message-dialog-new"></a><h3>xfce_message_dialog_new ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
xfce_message_dialog_new (<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
                         <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
                         <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>,
                         <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *primary_text</code></em>,
                         <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *secondary_text</code></em>,
                         <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *first_button_text</code></em>,
                         <em class="parameter"><code>...</code></em>);</pre>
<p>xfce_message_dialog_new() allows you to easily create Gtk+ message dialogs.
It accepts GTK+ stock buttons, mixed buttons (using XFCE_BUTTON_TYPE_MIXED)
or buttons with a <span class="type">GdkPixbuf</span> (using XFCE_BUTTON_TYPE_PIXBUF).</p>
<p>The buttons are defined by <em class="parameter"><code>first_button_text</code></em>
 and the next arguments in the
following format <em class="parameter"><code>type</code></em>
, <em class="parameter"><code>param1</code></em>
[, <em class="parameter"><code>param2</code></em>
, <em class="parameter"><code>param3</code></em>
].</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="varname">XFCE_BUTTON_TYPE_MIXED</code></span></p></td>
<td><p>
        This allows you to easily create mixed buttons in a dialog.
        <em class="parameter"><code>param1</code></em> is used for the stock_id, <em class="parameter"><code>param2</code></em> for the label and
        <em class="parameter"><code>param3</code></em> for the response_id. See also <a class="link" href="libxfce4ui-xfce-gtk-extensions.html#xfce-gtk-button-new-mixed" title="xfce_gtk_button_new_mixed ()"><code class="function">xfce_gtk_button_new_mixed()</code></a>.
      </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="varname">XFCE_BUTTON_TYPE_PIXBUF</code></span></p></td>
<td><p>
        Creates a button with the <span class="type">GdkPixbuf</span> as button icon.
        <em class="parameter"><code>param1</code></em> is the <span class="type">GdkPixuf</span>, <em class="parameter"><code>param2</code></em> for the label and
        <em class="parameter"><code>param3</code></em> for the response_id.
      </p></td>
</tr>
<tr>
<td><p><span class="term">Stock Buttons</span></p></td>
<td><p>
        When the variables above were not matched, the button type
        will be a stock button. <em class="parameter"><code>type</code></em> will be the stock id, <em class="parameter"><code>param1</code></em>
        is used for the response_id.
      </p></td>
</tr>
</tbody>
</table></div>
<p>To clarify this behaviour see the example below. We create a dialog with
two stock buttons, a <span class="type">GdkPixbuf</span> button and a mixed button.</p>
<div class="example">
<a name="id-1.5.2.7.2.8"></a><p class="title"><b>Example 2. Creating a Xfce Message Dialog</b></p>
<div class="example-contents"><pre class="programlisting">
GdkPixbuf *pixbuf = gdk_pixbuf_new_from_file_at_size (filename, 24, 24);

GtkWidget *dialog = xfce_message_dialog (parent, "Question",
                                         GTK_STOCK_DIALOG_QUESTION,
                                         "There are unsaved modifications",
                                         "The menu has been modified, do you want to save it before quitting?",
                                         GTK_STOCK_SAVE, GTK_RESPONSE_YES,
                                         XFCE_BUTTON_TYPE_MIXED, GTK_STOCK_DELETE, "Forget modifications", GTK_RESPONSE_APPLY,
                                         XFCE_BUTTON_TYPE_PIXBUF, pixbuf, "Quit", GTK_RESPONSE_NO,
                                         GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
                                         NULL);

g_object_unref (G_OBJECT (pixbuf));
</pre></div>
</div>
<br class="example-break"><div class="refsect3">
<a name="id-1.5.2.7.2.9"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>parent</p></td>
<td class="parameter_description"><p>transient parent of the dialog, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>title</p></td>
<td class="parameter_description"><p>title of the dialog, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stock_id</p></td>
<td class="parameter_description"><p>gtk stock icon name to show in the dialog.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>primary_text</p></td>
<td class="parameter_description"><p>primary text shown in large bold font.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>secondary_text</p></td>
<td class="parameter_description"><p>secondary text shown in normal font.</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 for the first button.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.7.2.10"></a><h4>Returns</h4>
<p> A new <a href="http://developer.gnome.org/gtk2/GtkMessageDialog.html"><span class="type">GtkMessageDialog</span></a>.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-message-dialog-new-valist"></a><h3>xfce_message_dialog_new_valist ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
xfce_message_dialog_new_valist (<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
                                <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
                                <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_stock_id</code></em>,
                                <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *primary_text</code></em>,
                                <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *secondary_text</code></em>,
                                <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *first_button_text</code></em>,
                                <em class="parameter"><code><span class="type">va_list</span> args</code></em>);</pre>
<p>See <a class="link" href="libxfce4ui-xfce-dialogs.html#xfce-message-dialog-new" title="xfce_message_dialog_new ()"><code class="function">xfce_message_dialog_new()</code></a>, this version takes a va_list for
language bindings to use.</p>
<div class="refsect3">
<a name="id-1.5.2.7.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>parent</p></td>
<td class="parameter_description"><p>transient parent of the dialog, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>title</p></td>
<td class="parameter_description"><p>title of the dialog, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>icon_stock_id</p></td>
<td class="parameter_description"><p>gtk stock icon name to show in the dialog.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>primary_text</p></td>
<td class="parameter_description"><p>primary text shown in large bold font.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>secondary_text</p></td>
<td class="parameter_description"><p>secondary text shown in normal font.</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 for the first button.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>args</p></td>
<td class="parameter_description"><p>argument list.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.7.3.6"></a><h4>Returns</h4>
<p> A new <a href="http://developer.gnome.org/gtk2/GtkMessageDialog.html"><span class="type">GtkMessageDialog</span></a>.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-message-dialog"></a><h3>xfce_message_dialog ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
xfce_message_dialog (<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
                     <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
                     <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>,
                     <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *primary_text</code></em>,
                     <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *secondary_text</code></em>,
                     <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *first_button_text</code></em>,
                     <em class="parameter"><code>...</code></em>);</pre>
<p>Create a new dialog as in <a class="link" href="libxfce4ui-xfce-dialogs.html#xfce-message-dialog-new" title="xfce_message_dialog_new ()"><code class="function">xfce_message_dialog_new()</code></a>, then runs the
dialog using <a href="http://developer.gnome.org/gtk2/GtkDialog.html#gtk-dialog-run"><span class="type">gtk_dialog_run</span></a> and return the response id selected by the user.</p>
<p>See <a class="link" href="libxfce4ui-xfce-dialogs.html#xfce-message-dialog-new" title="xfce_message_dialog_new ()"><code class="function">xfce_message_dialog_new()</code></a> for more information.</p>
<div class="refsect3">
<a name="id-1.5.2.7.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>parent</p></td>
<td class="parameter_description"><p>transient parent of the dialog, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>title</p></td>
<td class="parameter_description"><p>title of the dialog, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stock_id</p></td>
<td class="parameter_description"><p>gtk stock icon name to show in the dialog.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>primary_text</p></td>
<td class="parameter_description"><p>primary text shown in large bold font.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>secondary_text</p></td>
<td class="parameter_description"><p>secondary text shown in normal font.</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 for the first button.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.7.4.7"></a><h4>Returns</h4>
<p> the selected response id.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-dialog-show-help"></a><h3>xfce_dialog_show_help ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xfce_dialog_show_help (<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
                       <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *application</code></em>,
                       <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *page</code></em>,
                       <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *offset</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="xfce-dialog-show-help-with-version"></a><h3>xfce_dialog_show_help_with_version ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xfce_dialog_show_help_with_version (<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
                                    <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *application</code></em>,
                                    <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *page</code></em>,
                                    <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *offset</code></em>,
                                    <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *version</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="xfce-dialog-show-info"></a><h3>xfce_dialog_show_info ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xfce_dialog_show_info (<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
                       <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *secondary_text</code></em>,
                       <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *primary_format</code></em>,
                       <em class="parameter"><code>...</code></em>);</pre>
<p>Displays an information dialog on <em class="parameter"><code>parent</code></em>
 using the <em class="parameter"><code>primary_format</code></em>
 as message.</p>
<div class="refsect3">
<a name="id-1.5.2.7.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>parent</p></td>
<td class="parameter_description"><p>transient parent of the dialog, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>secondary_text</p></td>
<td class="parameter_description"><p>secondary text of the dialog or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>primary_format</p></td>
<td class="parameter_description"><p>the <code class="function">printf()</code>-style format for the primary problem description.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-dialog-show-warning"></a><h3>xfce_dialog_show_warning ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xfce_dialog_show_warning (<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
                          <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *secondary_text</code></em>,
                          <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *primary_format</code></em>,
                          <em class="parameter"><code>...</code></em>);</pre>
<p>Displays a warning dialog on <em class="parameter"><code>parent</code></em>
 using the <em class="parameter"><code>primary_format</code></em>
 as message.</p>
<div class="refsect3">
<a name="id-1.5.2.7.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>parent</p></td>
<td class="parameter_description"><p>transient parent of the dialog, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>secondary_text</p></td>
<td class="parameter_description"><p>secondary text of the dialog or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>primary_format</p></td>
<td class="parameter_description"><p>the <code class="function">printf()</code>-style format for the primary problem description.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-dialog-show-error"></a><h3>xfce_dialog_show_error ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xfce_dialog_show_error (<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
                        <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>,
                        <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *primary_format</code></em>,
                        <em class="parameter"><code>...</code></em>);</pre>
<p>Displays an error dialog on <em class="parameter"><code>parent</code></em>
 using the <em class="parameter"><code>primary_format</code></em>
 as primary message and optionally
displaying <em class="parameter"><code>error</code></em>
 as secondary error text.</p>
<div class="refsect3">
<a name="id-1.5.2.7.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>parent</p></td>
<td class="parameter_description"><p>transient parent of the dialog, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, which gives a more precise description of the problem or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>primary_format</p></td>
<td class="parameter_description"><p>the <code class="function">printf()</code>-style format for the primary problem description.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-dialog-confirm"></a><h3>xfce_dialog_confirm ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
xfce_dialog_confirm (<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
                     <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>,
                     <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *confirm_label</code></em>,
                     <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *secondary_text</code></em>,
                     <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *primary_format</code></em>,
                     <em class="parameter"><code>...</code></em>);</pre>
<p>Runs a questions dialog, that has a 'Cancel' and a 'Confirm' button. The 'Confirm'
button text can be set by <em class="parameter"><code>action</code></em>
 if given.</p>
<p>If <em class="parameter"><code>stock_id</code></em>
 is equal to <a href="http://developer.gnome.org/gtk2/gtk3-Stock-Items.html#GTK-STOCK-YES:CAPS"><span class="type">GTK_STOCK_YES</span></a>, the 'Cancel' button becomes a 'No' button.</p>
<div class="refsect3">
<a name="id-1.5.2.7.10.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>parent</p></td>
<td class="parameter_description"><p>transient parent of the dialog, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stock_id</p></td>
<td class="parameter_description"><p>the stock name of the confirm button, for example <a href="http://developer.gnome.org/gtk2/gtk3-Stock-Items.html#GTK-STOCK-YES:CAPS"><span class="type">GTK_STOCK_YES</span></a> or <a href="http://developer.gnome.org/gtk2/gtk3-Stock-Items.html#GTK-STOCK-CLEAR:CAPS"><span class="type">GTK_STOCK_CLEAR</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>confirm_label</p></td>
<td class="parameter_description"><p>if non-<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, this text is used on the confirm button together with the <em class="parameter"><code>stock_id</code></em>
icon.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>secondary_text</p></td>
<td class="parameter_description"><p>secondary text in the dialog.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>primary_format</p></td>
<td class="parameter_description"><p>the <code class="function">printf()</code>-style format for the dialog question.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.7.10.7"></a><h4>Returns</h4>
<p> TRUE if the user confirms, else FALSE.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libxfce4ui-xfce-dialogs.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="XFCE-BUTTON-TYPE-MIXED:CAPS"></a><h3>XFCE_BUTTON_TYPE_MIXED</h3>
<pre class="programlisting">#define XFCE_BUTTON_TYPE_MIXED  "button-mixed"
</pre>
<p>
Used to define a mixed button in <a class="link" href="libxfce4ui-xfce-dialogs.html#xfce-message-dialog-new" title="xfce_message_dialog_new ()"><code class="function">xfce_message_dialog_new()</code></a> and
<code class="function">xfce_message_dialog_run()</code>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="XFCE-BUTTON-TYPE-PIXBUF:CAPS"></a><h3>XFCE_BUTTON_TYPE_PIXBUF</h3>
<pre class="programlisting">#define XFCE_BUTTON_TYPE_PIXBUF "button-pixbuf"
</pre>
<p>
Used to define a <span class="type">GdkPixuf</span> button in <a class="link" href="libxfce4ui-xfce-dialogs.html#xfce-message-dialog-new" title="xfce_message_dialog_new ()"><code class="function">xfce_message_dialog_new()</code></a> and
<code class="function">xfce_message_dialog_run()</code>.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.21</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.