Debian Codegraph @

docs/reference/html/libxfce4ui-XfceDialogs.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>XfceDialogs: libxfce4ui Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7 <link rel="home" href="index.html" title="libxfce4ui Reference Manual">
8 <link rel="up" href="ch01.html" title="[Insert title here]">
9 <link rel="prev" href="libxfce4ui-Gtk-Extensions.html" title="Gtk Extensions">
10 <link rel="next" href="XfceTitledDialog.html" title="XfceTitledDialog">
11 <meta name="generator" content="GTK-Doc V1.34.0 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#libxfce4ui-XfceDialogs.description" class="shortcut">Description</a></span>
19 </td>
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="libxfce4ui-Gtk-Extensions.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="XfceTitledDialog.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
24 </tr></table>
25 <div class="refentry">
26 <a name="libxfce4ui-XfceDialogs"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="libxfce4ui-XfceDialogs.top_of_page"></a>XfceDialogs</span></h2>
30 <p>XfceDialogs — A collection of helper dialogs</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="libxfce4ui-XfceDialogs.stability-level"></a><h2>Stability Level</h2>
36 <acronym title="The intention of a Stable interface is to enable arbitrary third parties to
37 develop applications to these interfaces, release them, and have confidence that
38 they will run on all minor releases of the product (after the one in which the
39 interface was introduced, and within the same major release). Even at a major
40 release, incompatible changes are expected to be rare, and to have strong
41 justifications.
42 "><span class="acronym">Stable</span></acronym>, unless otherwise indicated
43 </div>
44 <div class="refsect1">
45 <a name="libxfce4ui-XfceDialogs.functions"></a><h2>Functions</h2>
46 <div class="informaltable"><table class="informaltable" width="100%" border="0">
47 <colgroup>
48 <col width="150px" class="functions_proto_type">
49 <col class="functions_proto_name">
50 </colgroup>
51 <tbody>
52 <tr>
53 <td class="function_type">
54 <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
55 </td>
56 <td class="function_name">
57 <a class="link" href="libxfce4ui-XfceDialogs.html#xfce-message-dialog-new" title="xfce_message_dialog_new ()">xfce_message_dialog_new</a> <span class="c_punctuation">()</span>
58 </td>
59 </tr>
60 <tr>
61 <td class="function_type">
62 <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
63 </td>
64 <td class="function_name">
65 <a class="link" href="libxfce4ui-XfceDialogs.html#xfce-message-dialog-new-valist" title="xfce_message_dialog_new_valist ()">xfce_message_dialog_new_valist</a> <span class="c_punctuation">()</span>
66 </td>
67 </tr>
68 <tr>
69 <td class="function_type">
70 <span class="returnvalue">gint</span>
71 </td>
72 <td class="function_name">
73 <a class="link" href="libxfce4ui-XfceDialogs.html#xfce-message-dialog" title="xfce_message_dialog ()">xfce_message_dialog</a> <span class="c_punctuation">()</span>
74 </td>
75 </tr>
76 <tr>
77 <td class="function_type">
78 <span class="returnvalue">void</span>
79 </td>
80 <td class="function_name">
81 <a class="link" href="libxfce4ui-XfceDialogs.html#xfce-dialog-show-help" title="xfce_dialog_show_help ()">xfce_dialog_show_help</a> <span class="c_punctuation">()</span>
82 </td>
83 </tr>
84 <tr>
85 <td class="function_type">
86 <span class="returnvalue">void</span>
87 </td>
88 <td class="function_name">
89 <a class="link" href="libxfce4ui-XfceDialogs.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>
90 </td>
91 </tr>
92 <tr>
93 <td class="function_type">
94 <span class="returnvalue">void</span>
95 </td>
96 <td class="function_name">
97 <a class="link" href="libxfce4ui-XfceDialogs.html#xfce-dialog-show-info" title="xfce_dialog_show_info ()">xfce_dialog_show_info</a> <span class="c_punctuation">()</span>
98 </td>
99 </tr>
100 <tr>
101 <td class="function_type">
102 <span class="returnvalue">void</span>
103 </td>
104 <td class="function_name">
105 <a class="link" href="libxfce4ui-XfceDialogs.html#xfce-dialog-show-warning" title="xfce_dialog_show_warning ()">xfce_dialog_show_warning</a> <span class="c_punctuation">()</span>
106 </td>
107 </tr>
108 <tr>
109 <td class="function_type">
110 <span class="returnvalue">void</span>
111 </td>
112 <td class="function_name">
113 <a class="link" href="libxfce4ui-XfceDialogs.html#xfce-dialog-show-error" title="xfce_dialog_show_error ()">xfce_dialog_show_error</a> <span class="c_punctuation">()</span>
114 </td>
115 </tr>
116 <tr>
117 <td class="function_type">
118 <span class="returnvalue">gboolean</span>
119 </td>
120 <td class="function_name">
121 <a class="link" href="libxfce4ui-XfceDialogs.html#xfce-dialog-confirm" title="xfce_dialog_confirm ()">xfce_dialog_confirm</a> <span class="c_punctuation">()</span>
122 </td>
123 </tr>
124 <tr>
125 <td class="function_type">
126 <span class="returnvalue">gint</span>
127 </td>
128 <td class="function_name">
129 <a class="link" href="libxfce4ui-XfceDialogs.html#xfce-dialog-confirm-close-tabs" title="xfce_dialog_confirm_close_tabs ()">xfce_dialog_confirm_close_tabs</a> <span class="c_punctuation">()</span>
130 </td>
131 </tr>
132 </tbody>
133 </table></div>
134 </div>
135 <div class="refsect1">
136 <a name="libxfce4ui-XfceDialogs.other"></a><h2>Types and Values</h2>
137 <div class="informaltable"><table class="informaltable" width="100%" border="0">
138 <colgroup>
139 <col width="150px" class="other_proto_type">
140 <col class="other_proto_name">
141 </colgroup>
142 <tbody>
143 <tr>
144 <td class="define_keyword">#define</td>
145 <td class="function_name"><a class="link" href="libxfce4ui-XfceDialogs.html#XFCE-BUTTON-TYPE-MIXED:CAPS" title="XFCE_BUTTON_TYPE_MIXED">XFCE_BUTTON_TYPE_MIXED</a></td>
146 </tr>
147 <tr>
148 <td class="define_keyword">#define</td>
149 <td class="function_name"><a class="link" href="libxfce4ui-XfceDialogs.html#XFCE-BUTTON-TYPE-PIXBUF:CAPS" title="XFCE_BUTTON_TYPE_PIXBUF">XFCE_BUTTON_TYPE_PIXBUF</a></td>
150 </tr>
151 </tbody>
152 </table></div>
153 </div>
154 <div class="refsect1">
155 <a name="libxfce4ui-XfceDialogs.includes"></a><h2>Includes</h2>
156 <pre class="synopsis">#include &lt;libxfce4ui/libxfce4ui.h&gt;
157 </pre>
158 </div>
159 <div class="refsect1">
160 <a name="libxfce4ui-XfceDialogs.description"></a><h2>Description</h2>
161 <p>Xfce-dialogs are a collection of helper dialogs to display
162 the help dialog with link to the docs website, warning, info, and
163 error dialogs and more.</p>
164 </div>
165 <div class="refsect1">
166 <a name="libxfce4ui-XfceDialogs.functions_details"></a><h2>Functions</h2>
167 <div class="refsect2">
168 <a name="xfce-message-dialog-new"></a><h3>xfce_message_dialog_new ()</h3>
169 <pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
170 xfce_message_dialog_new (<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>,
171 <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
172 <em class="parameter"><code>const <span class="type">gchar</span> *stock_id</code></em>,
173 <em class="parameter"><code>const <span class="type">gchar</span> *primary_text</code></em>,
174 <em class="parameter"><code>const <span class="type">gchar</span> *secondary_text</code></em>,
175 <em class="parameter"><code>const <span class="type">gchar</span> *first_button_text</code></em>,
176 <em class="parameter"><code>...</code></em>);</pre>
177 <p>xfce_message_dialog_new() allows you to easily create Gtk+ message dialogs.
178 It accepts GTK+ stock buttons (deprecated), mixed buttons (using XFCE_BUTTON_TYPE_MIXED)
179 or buttons with a <span class="type">GdkPixbuf</span> (using XFCE_BUTTON_TYPE_PIXBUF).</p>
180 <p>The buttons are defined by <em class="parameter"><code>first_button_text</code></em>
181 and the next arguments in the
182 following format <em class="parameter"><code>type</code></em>
183 , <em class="parameter"><code>param1</code></em>
184 [, <em class="parameter"><code>param2</code></em>
185 , <em class="parameter"><code>param3</code></em>
186 ].</p>
187 <div class="variablelist"><table border="0" class="variablelist">
188 <colgroup>
189 <col align="left" valign="top">
190 <col>
191 </colgroup>
192 <tbody>
193 <tr>
194 <td><p><span class="term"><code class="varname">XFCE_BUTTON_TYPE_MIXED</code></span></p></td>
195 <td><p>
196 This allows you to easily create mixed buttons in a dialog.
197 <em class="parameter"><code>param1</code></em> is used for the icon name, <em class="parameter"><code>param2</code></em> for the label and
198 <em class="parameter"><code>param3</code></em> for the response_id. See also <a class="link" href="libxfce4ui-Gtk-Extensions.html#xfce-gtk-button-new-mixed" title="xfce_gtk_button_new_mixed ()"><code class="function">xfce_gtk_button_new_mixed()</code></a>.
199 </p></td>
200 </tr>
201 <tr>
202 <td><p><span class="term"><code class="varname">XFCE_BUTTON_TYPE_PIXBUF</code></span></p></td>
203 <td><p>
204 Creates a button with the <span class="type">GdkPixbuf</span> as button icon.
205 <em class="parameter"><code>param1</code></em> is the <span class="type">GdkPixbuf</span>, <em class="parameter"><code>param2</code></em> for the label and
206 <em class="parameter"><code>param3</code></em> for the response_id.
207 </p></td>
208 </tr>
209 <tr>
210 <td><p><span class="term">Stock Buttons</span></p></td>
211 <td><p>
212 When the variables above were not matched, the button type
213 will be a stock button. <em class="parameter"><code>type</code></em> will be the stock id, <em class="parameter"><code>param1</code></em>
214 is used for the response_id.
215 </p></td>
216 </tr>
217 </tbody>
218 </table></div>
219 <p>To clarify this behaviour see the example below. We create a dialog with
220 two stock buttons, a <span class="type">GdkPixbuf</span> button and a mixed button.</p>
221 <div class="example">
222 <a name="id-1.2.6.8.2.8"></a><p class="title"><b>Example 3. Creating a Xfce Message Dialog</b></p>
223 <div class="example-contents">
224 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
225 <tbody>
226 <tr>
227 <td class="listing_lines" align="right"><pre>1
228 2
229 3
230 4
231 5
232 6
233 7
234 8
235 9
236 10
237 11
238 12
239 13</pre></td>
240 <td class="listing_code"><pre class="programlisting"><span class="n">GdkPixbuf</span><span class="w"> </span><span class="o">*</span><span class="n">pixbuf</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">gdk_pixbuf_new_from_file_at_size</span><span class="w"> </span><span class="p">(</span><span class="n">filename</span><span class="p">,</span><span class="w"> </span><span class="mi">24</span><span class="p">,</span><span class="w"> </span><span class="mi">24</span><span class="p">);</span>
241
242 <span class="n">GtkWidget</span><span class="w"> </span><span class="o">*</span><span class="n">dialog</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">xfce_message_dialog</span><span class="w"> </span><span class="p">(</span><span class="n">parent</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;Question&quot;</span><span class="p">,</span>
243 <span class="w"> </span><span class="n">GTK_STOCK_DIALOG_QUESTION</span><span class="p">,</span>
244 <span class="w"> </span><span class="s">&quot;There are unsaved modifications&quot;</span><span class="p">,</span>
245 <span class="w"> </span><span class="s">&quot;The menu has been modified, do you want to save it before quitting?&quot;</span><span class="p">,</span>
246 <span class="w"> </span><span class="n">GTK_STOCK_SAVE</span><span class="p">,</span><span class="w"> </span><span class="n">GTK_RESPONSE_YES</span><span class="p">,</span>
247 <span class="w"> </span><span class="n">XFCE_BUTTON_TYPE_MIXED</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;edit-delete&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">_</span><span class="p">(</span><span class="s">&quot;Forget modifications&quot;</span><span class="p">),</span><span class="w"> </span><span class="n">GTK_RESPONSE_APPLY</span><span class="p">,</span>
248 <span class="w"> </span><span class="n">XFCE_BUTTON_TYPE_PIXBUF</span><span class="p">,</span><span class="w"> </span><span class="n">pixbuf</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;Quit&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">GTK_RESPONSE_NO</span><span class="p">,</span>
249 <span class="w"> </span><span class="n">GTK_STOCK_CANCEL</span><span class="p">,</span><span class="w"> </span><span class="n">GTK_RESPONSE_CANCEL</span><span class="p">,</span>
250 <span class="w"> </span><span class="nb">NULL</span><span class="p">);</span>
251
252 <span class="n">g_object_unref</span><span class="w"> </span><span class="p">(</span><span class="n">G_OBJECT</span><span class="w"> </span><span class="p">(</span><span class="n">pixbuf</span><span class="p">));</span></pre></td>
253 </tr>
254 </tbody>
255 </table>
256 </div>
257
258 </div>
259 <br class="example-break"><p>The caller is responsible for destroying the dialog with <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#gtk-widget-destroy"><code class="function">gtk_widget_destroy()</code></a>
260 when it is no longer required.</p>
261 <div class="refsect3">
262 <a name="xfce-message-dialog-new.parameters"></a><h4>Parameters</h4>
263 <div class="informaltable"><table class="informaltable" width="100%" border="0">
264 <colgroup>
265 <col width="150px" class="parameters_name">
266 <col class="parameters_description">
267 <col width="200px" class="parameters_annotations">
268 </colgroup>
269 <tbody>
270 <tr>
271 <td class="parameter_name"><p>parent</p></td>
272 <td class="parameter_description"><p>transient parent of the dialog, or <code class="literal">NULL</code>. </p></td>
273 <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>
274 </tr>
275 <tr>
276 <td class="parameter_name"><p>title</p></td>
277 <td class="parameter_description"><p>title of the dialog, or <code class="literal">NULL</code>. </p></td>
278 <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>
279 </tr>
280 <tr>
281 <td class="parameter_name"><p>stock_id</p></td>
282 <td class="parameter_description"><p>gtk stock icon name to show in the dialog.</p></td>
283 <td class="parameter_annotations"> </td>
284 </tr>
285 <tr>
286 <td class="parameter_name"><p>primary_text</p></td>
287 <td class="parameter_description"><p>primary text shown in large bold font.</p></td>
288 <td class="parameter_annotations"> </td>
289 </tr>
290 <tr>
291 <td class="parameter_name"><p>secondary_text</p></td>
292 <td class="parameter_description"><p>secondary text shown in normal font.</p></td>
293 <td class="parameter_annotations"> </td>
294 </tr>
295 <tr>
296 <td class="parameter_name"><p>first_button_text</p></td>
297 <td class="parameter_description"><p>text for the first button.</p></td>
298 <td class="parameter_annotations"> </td>
299 </tr>
300 <tr>
301 <td class="parameter_name"><p>...</p></td>
302 <td class="parameter_description"><p><code class="literal">NULL</code> terminated list of parameters.</p></td>
303 <td class="parameter_annotations"> </td>
304 </tr>
305 </tbody>
306 </table></div>
307 </div>
308 <div class="refsect3">
309 <a name="xfce-message-dialog-new.returns"></a><h4>Returns</h4>
310 <p>A new <a href="/usr/share/gtk-doc/html/gtk3/GtkMessageDialog.html#GtkMessageDialog-struct"><span class="type">GtkMessageDialog</span></a>. </p>
311 <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>
312 </div>
313 </div>
314 <hr>
315 <div class="refsect2">
316 <a name="xfce-message-dialog-new-valist"></a><h3>xfce_message_dialog_new_valist ()</h3>
317 <pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
318 xfce_message_dialog_new_valist (<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>,
319 <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
320 <em class="parameter"><code>const <span class="type">gchar</span> *icon_stock_id</code></em>,
321 <em class="parameter"><code>const <span class="type">gchar</span> *primary_text</code></em>,
322 <em class="parameter"><code>const <span class="type">gchar</span> *secondary_text</code></em>,
323 <em class="parameter"><code>const <span class="type">gchar</span> *first_button_text</code></em>,
324 <em class="parameter"><code><span class="type">va_list</span> args</code></em>);</pre>
325 <p>See <a class="link" href="libxfce4ui-XfceDialogs.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
326 language bindings to use.</p>
327 <div class="refsect3">
328 <a name="xfce-message-dialog-new-valist.parameters"></a><h4>Parameters</h4>
329 <div class="informaltable"><table class="informaltable" width="100%" border="0">
330 <colgroup>
331 <col width="150px" class="parameters_name">
332 <col class="parameters_description">
333 <col width="200px" class="parameters_annotations">
334 </colgroup>
335 <tbody>
336 <tr>
337 <td class="parameter_name"><p>parent</p></td>
338 <td class="parameter_description"><p>transient parent of the dialog, or <code class="literal">NULL</code>. </p></td>
339 <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>
340 </tr>
341 <tr>
342 <td class="parameter_name"><p>title</p></td>
343 <td class="parameter_description"><p>title of the dialog, or <code class="literal">NULL</code>. </p></td>
344 <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>
345 </tr>
346 <tr>
347 <td class="parameter_name"><p>icon_stock_id</p></td>
348 <td class="parameter_description"><p>gtk stock icon name to show in the dialog.</p></td>
349 <td class="parameter_annotations"> </td>
350 </tr>
351 <tr>
352 <td class="parameter_name"><p>primary_text</p></td>
353 <td class="parameter_description"><p>primary text shown in large bold font.</p></td>
354 <td class="parameter_annotations"> </td>
355 </tr>
356 <tr>
357 <td class="parameter_name"><p>secondary_text</p></td>
358 <td class="parameter_description"><p>secondary text shown in normal font.</p></td>
359 <td class="parameter_annotations"> </td>
360 </tr>
361 <tr>
362 <td class="parameter_name"><p>first_button_text</p></td>
363 <td class="parameter_description"><p>text for the first button.</p></td>
364 <td class="parameter_annotations"> </td>
365 </tr>
366 <tr>
367 <td class="parameter_name"><p>args</p></td>
368 <td class="parameter_description"><p>argument list.</p></td>
369 <td class="parameter_annotations"> </td>
370 </tr>
371 </tbody>
372 </table></div>
373 </div>
374 <div class="refsect3">
375 <a name="xfce-message-dialog-new-valist.returns"></a><h4>Returns</h4>
376 <p>A new <a href="/usr/share/gtk-doc/html/gtk3/GtkMessageDialog.html#GtkMessageDialog-struct"><span class="type">GtkMessageDialog</span></a>. </p>
377 <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>
378 </div>
379 </div>
380 <hr>
381 <div class="refsect2">
382 <a name="xfce-message-dialog"></a><h3>xfce_message_dialog ()</h3>
383 <pre class="programlisting"><span class="returnvalue">gint</span>
384 xfce_message_dialog (<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>,
385 <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
386 <em class="parameter"><code>const <span class="type">gchar</span> *stock_id</code></em>,
387 <em class="parameter"><code>const <span class="type">gchar</span> *primary_text</code></em>,
388 <em class="parameter"><code>const <span class="type">gchar</span> *secondary_text</code></em>,
389 <em class="parameter"><code>const <span class="type">gchar</span> *first_button_text</code></em>,
390 <em class="parameter"><code>...</code></em>);</pre>
391 <p>Create a new dialog as in <a class="link" href="libxfce4ui-XfceDialogs.html#xfce-message-dialog-new" title="xfce_message_dialog_new ()"><code class="function">xfce_message_dialog_new()</code></a>, then runs the
392 dialog using <a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#gtk-dialog-run"><span class="type">gtk_dialog_run</span></a> and return the response id selected by the user.</p>
393 <p>See <a class="link" href="libxfce4ui-XfceDialogs.html#xfce-message-dialog-new" title="xfce_message_dialog_new ()"><code class="function">xfce_message_dialog_new()</code></a> for more information.</p>
394 <div class="refsect3">
395 <a name="xfce-message-dialog.parameters"></a><h4>Parameters</h4>
396 <div class="informaltable"><table class="informaltable" width="100%" border="0">
397 <colgroup>
398 <col width="150px" class="parameters_name">
399 <col class="parameters_description">
400 <col width="200px" class="parameters_annotations">
401 </colgroup>
402 <tbody>
403 <tr>
404 <td class="parameter_name"><p>parent</p></td>
405 <td class="parameter_description"><p>transient parent of the dialog, or <code class="literal">NULL</code>. </p></td>
406 <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>
407 </tr>
408 <tr>
409 <td class="parameter_name"><p>title</p></td>
410 <td class="parameter_description"><p>title of the dialog, or <code class="literal">NULL</code>. </p></td>
411 <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>
412 </tr>
413 <tr>
414 <td class="parameter_name"><p>stock_id</p></td>
415 <td class="parameter_description"><p>gtk stock icon name to show in the dialog.</p></td>
416 <td class="parameter_annotations"> </td>
417 </tr>
418 <tr>
419 <td class="parameter_name"><p>primary_text</p></td>
420 <td class="parameter_description"><p>primary text shown in large bold font.</p></td>
421 <td class="parameter_annotations"> </td>
422 </tr>
423 <tr>
424 <td class="parameter_name"><p>secondary_text</p></td>
425 <td class="parameter_description"><p>secondary text shown in normal font.</p></td>
426 <td class="parameter_annotations"> </td>
427 </tr>
428 <tr>
429 <td class="parameter_name"><p>first_button_text</p></td>
430 <td class="parameter_description"><p>text for the first button.</p></td>
431 <td class="parameter_annotations"> </td>
432 </tr>
433 <tr>
434 <td class="parameter_name"><p>...</p></td>
435 <td class="parameter_description"><p><code class="literal">NULL</code> ended list of parameters.</p></td>
436 <td class="parameter_annotations"> </td>
437 </tr>
438 </tbody>
439 </table></div>
440 </div>
441 <div class="refsect3">
442 <a name="xfce-message-dialog.returns"></a><h4>Returns</h4>
443 <p> the selected response id.</p>
444 </div>
445 </div>
446 <hr>
447 <div class="refsect2">
448 <a name="xfce-dialog-show-help"></a><h3>xfce_dialog_show_help ()</h3>
449 <pre class="programlisting"><span class="returnvalue">void</span>
450 xfce_dialog_show_help (<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>,
451 <em class="parameter"><code>const <span class="type">gchar</span> *component</code></em>,
452 <em class="parameter"><code>const <span class="type">gchar</span> *page</code></em>,
453 <em class="parameter"><code>const <span class="type">gchar</span> *offset</code></em>);</pre>
454 <p>Asks the user to visit the online documentation. If confirmed, it will open
455 the webbrowser and redirect the user to the correct location.</p>
456 <p>Appart from the <em class="parameter"><code>component</code></em>
457 , <em class="parameter"><code>page</code></em>
458 and <em class="parameter"><code>offset</code></em>
459 the following information
460 is also send to the server: user language and the <a href="/usr/share/gtk-doc/html/libxfce4util/libxfce4util-Version-Information.html#xfce-version-string"><code class="function">xfce_version_string()</code></a>.</p>
461 <p>See also: <a class="link" href="libxfce4ui-XfceDialogs.html#xfce-dialog-show-help-with-version" title="xfce_dialog_show_help_with_version ()"><code class="function">xfce_dialog_show_help_with_version()</code></a>.</p>
462 <div class="refsect3">
463 <a name="xfce-dialog-show-help.parameters"></a><h4>Parameters</h4>
464 <div class="informaltable"><table class="informaltable" width="100%" border="0">
465 <colgroup>
466 <col width="150px" class="parameters_name">
467 <col class="parameters_description">
468 <col width="200px" class="parameters_annotations">
469 </colgroup>
470 <tbody>
471 <tr>
472 <td class="parameter_name"><p>parent</p></td>
473 <td class="parameter_description"><p>transient parent of the dialog, or <code class="literal">NULL</code>. </p></td>
474 <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>
475 </tr>
476 <tr>
477 <td class="parameter_name"><p>component</p></td>
478 <td class="parameter_description"><p>name of the component opening the help page or <code class="literal">NULL</code>. If the
479 value is <code class="literal">NULL</code> the target will be the main page of the
480 documentation website. </p></td>
481 <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>
482 </tr>
483 <tr>
484 <td class="parameter_name"><p>page</p></td>
485 <td class="parameter_description"><p>subpage of the <em class="parameter"><code>component</code></em>
486 on the website or <code class="literal">NULL</code>. </p></td>
487 <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>
488 </tr>
489 <tr>
490 <td class="parameter_name"><p>offset</p></td>
491 <td class="parameter_description"><p>anchor offset in <em class="parameter"><code>page</code></em>
492 or <code class="literal">NULL</code>. </p></td>
493 <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>
494 </tr>
495 </tbody>
496 </table></div>
497 </div>
498 <p class="since">Since: <a class="link" href="api-index-4-10.html#api-index-4.10">4.10</a></p>
499 </div>
500 <hr>
501 <div class="refsect2">
502 <a name="xfce-dialog-show-help-with-version"></a><h3>xfce_dialog_show_help_with_version ()</h3>
503 <pre class="programlisting"><span class="returnvalue">void</span>
504 xfce_dialog_show_help_with_version (<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>,
505 <em class="parameter"><code>const <span class="type">gchar</span> *component</code></em>,
506 <em class="parameter"><code>const <span class="type">gchar</span> *page</code></em>,
507 <em class="parameter"><code>const <span class="type">gchar</span> *offset</code></em>,
508 <em class="parameter"><code>const <span class="type">gchar</span> *version</code></em>);</pre>
509 <p>Asks the user to visit the online documentation. If confirmed, it will open
510 the webbrowser and redirect the user to the correct location.</p>
511 <p>Apart from the <em class="parameter"><code>component</code></em>
512 , <em class="parameter"><code>page</code></em>
513 and <em class="parameter"><code>offset</code></em>
514 the following information
515 is also sent to the server: user language and the <a href="/usr/share/gtk-doc/html/libxfce4util/libxfce4util-Version-Information.html#xfce-version-string"><code class="function">xfce_version_string()</code></a>
516 or <em class="parameter"><code>version</code></em>
517 if set.</p>
518 <p>See also: <a class="link" href="libxfce4ui-XfceDialogs.html#xfce-dialog-show-help" title="xfce_dialog_show_help ()"><code class="function">xfce_dialog_show_help()</code></a>.</p>
519 <div class="refsect3">
520 <a name="xfce-dialog-show-help-with-version.parameters"></a><h4>Parameters</h4>
521 <div class="informaltable"><table class="informaltable" width="100%" border="0">
522 <colgroup>
523 <col width="150px" class="parameters_name">
524 <col class="parameters_description">
525 <col width="200px" class="parameters_annotations">
526 </colgroup>
527 <tbody>
528 <tr>
529 <td class="parameter_name"><p>parent</p></td>
530 <td class="parameter_description"><p>transient parent of the dialog, or <code class="literal">NULL</code>. </p></td>
531 <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>
532 </tr>
533 <tr>
534 <td class="parameter_name"><p>component</p></td>
535 <td class="parameter_description"><p>name of the component opening the help page or <code class="literal">NULL</code>. If the
536 value is <code class="literal">NULL</code> the target will be the main page of the
537 documentation website. </p></td>
538 <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>
539 </tr>
540 <tr>
541 <td class="parameter_name"><p>page</p></td>
542 <td class="parameter_description"><p>subpage of the <em class="parameter"><code>component</code></em>
543 on the website or <code class="literal">NULL</code>. </p></td>
544 <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>
545 </tr>
546 <tr>
547 <td class="parameter_name"><p>offset</p></td>
548 <td class="parameter_description"><p>anchor offset in <em class="parameter"><code>page</code></em>
549 or <code class="literal">NULL</code>. </p></td>
550 <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>
551 </tr>
552 <tr>
553 <td class="parameter_name"><p>version</p></td>
554 <td class="parameter_description"><p>alternative version, or <code class="literal">NULL</code> to use <a href="/usr/share/gtk-doc/html/libxfce4util/libxfce4util-Version-Information.html#xfce-version-string"><code class="function">xfce_version_string()</code></a>. </p></td>
555 <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>
556 </tr>
557 </tbody>
558 </table></div>
559 </div>
560 <p class="since">Since: <a class="link" href="api-index-4-12.html#api-index-4.12">4.12</a></p>
561 </div>
562 <hr>
563 <div class="refsect2">
564 <a name="xfce-dialog-show-info"></a><h3>xfce_dialog_show_info ()</h3>
565 <pre class="programlisting"><span class="returnvalue">void</span>
566 xfce_dialog_show_info (<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>,
567 <em class="parameter"><code>const <span class="type">gchar</span> *secondary_text</code></em>,
568 <em class="parameter"><code>const <span class="type">gchar</span> *primary_format</code></em>,
569 <em class="parameter"><code>...</code></em>);</pre>
570 <p>Displays an information dialog on <em class="parameter"><code>parent</code></em>
571 using the <em class="parameter"><code>primary_format</code></em>
572 as message.</p>
573 <div class="refsect3">
574 <a name="xfce-dialog-show-info.parameters"></a><h4>Parameters</h4>
575 <div class="informaltable"><table class="informaltable" width="100%" border="0">
576 <colgroup>
577 <col width="150px" class="parameters_name">
578 <col class="parameters_description">
579 <col width="200px" class="parameters_annotations">
580 </colgroup>
581 <tbody>
582 <tr>
583 <td class="parameter_name"><p>parent</p></td>
584 <td class="parameter_description"><p>transient parent of the dialog, or <code class="literal">NULL</code>. </p></td>
585 <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>
586 </tr>
587 <tr>
588 <td class="parameter_name"><p>secondary_text</p></td>
589 <td class="parameter_description"><p>secondary text of the dialog or <code class="literal">NULL</code>. </p></td>
590 <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>
591 </tr>
592 <tr>
593 <td class="parameter_name"><p>primary_format</p></td>
594 <td class="parameter_description"><p>the <code class="function">printf()</code>-style format for the primary problem description.</p></td>
595 <td class="parameter_annotations"> </td>
596 </tr>
597 <tr>
598 <td class="parameter_name"><p>...</p></td>
599 <td class="parameter_description"><p>argument list for the <em class="parameter"><code>format</code></em>
600 .</p></td>
601 <td class="parameter_annotations"> </td>
602 </tr>
603 </tbody>
604 </table></div>
605 </div>
606 </div>
607 <hr>
608 <div class="refsect2">
609 <a name="xfce-dialog-show-warning"></a><h3>xfce_dialog_show_warning ()</h3>
610 <pre class="programlisting"><span class="returnvalue">void</span>
611 xfce_dialog_show_warning (<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>,
612 <em class="parameter"><code>const <span class="type">gchar</span> *secondary_text</code></em>,
613 <em class="parameter"><code>const <span class="type">gchar</span> *primary_format</code></em>,
614 <em class="parameter"><code>...</code></em>);</pre>
615 <p>Displays a warning dialog on <em class="parameter"><code>parent</code></em>
616 using the <em class="parameter"><code>primary_format</code></em>
617 as message.</p>
618 <div class="refsect3">
619 <a name="xfce-dialog-show-warning.parameters"></a><h4>Parameters</h4>
620 <div class="informaltable"><table class="informaltable" width="100%" border="0">
621 <colgroup>
622 <col width="150px" class="parameters_name">
623 <col class="parameters_description">
624 <col width="200px" class="parameters_annotations">
625 </colgroup>
626 <tbody>
627 <tr>
628 <td class="parameter_name"><p>parent</p></td>
629 <td class="parameter_description"><p>transient parent of the dialog, or <code class="literal">NULL</code>. </p></td>
630 <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>
631 </tr>
632 <tr>
633 <td class="parameter_name"><p>secondary_text</p></td>
634 <td class="parameter_description"><p>secondary text of the dialog or <code class="literal">NULL</code>. </p></td>
635 <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>
636 </tr>
637 <tr>
638 <td class="parameter_name"><p>primary_format</p></td>
639 <td class="parameter_description"><p>the <code class="function">printf()</code>-style format for the primary problem description.</p></td>
640 <td class="parameter_annotations"> </td>
641 </tr>
642 <tr>
643 <td class="parameter_name"><p>...</p></td>
644 <td class="parameter_description"><p>argument list for the <em class="parameter"><code>format</code></em>
645 .</p></td>
646 <td class="parameter_annotations"> </td>
647 </tr>
648 </tbody>
649 </table></div>
650 </div>
651 </div>
652 <hr>
653 <div class="refsect2">
654 <a name="xfce-dialog-show-error"></a><h3>xfce_dialog_show_error ()</h3>
655 <pre class="programlisting"><span class="returnvalue">void</span>
656 xfce_dialog_show_error (<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>,
657 <em class="parameter"><code>const <span class="type">GError</span> *error</code></em>,
658 <em class="parameter"><code>const <span class="type">gchar</span> *primary_format</code></em>,
659 <em class="parameter"><code>...</code></em>);</pre>
660 <p>Displays an error dialog on <em class="parameter"><code>parent</code></em>
661 using the <em class="parameter"><code>primary_format</code></em>
662 as primary message and optionally
663 displaying <em class="parameter"><code>error</code></em>
664 as secondary error text.</p>
665 <div class="refsect3">
666 <a name="xfce-dialog-show-error.parameters"></a><h4>Parameters</h4>
667 <div class="informaltable"><table class="informaltable" width="100%" border="0">
668 <colgroup>
669 <col width="150px" class="parameters_name">
670 <col class="parameters_description">
671 <col width="200px" class="parameters_annotations">
672 </colgroup>
673 <tbody>
674 <tr>
675 <td class="parameter_name"><p>parent</p></td>
676 <td class="parameter_description"><p>transient parent of the dialog, or <code class="literal">NULL</code>. </p></td>
677 <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>
678 </tr>
679 <tr>
680 <td class="parameter_name"><p>error</p></td>
681 <td class="parameter_description"><p>a <span class="type">GError</span>, which gives a more precise description of the problem or <code class="literal">NULL</code>. </p></td>
682 <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>
683 </tr>
684 <tr>
685 <td class="parameter_name"><p>primary_format</p></td>
686 <td class="parameter_description"><p>the <code class="function">printf()</code>-style format for the primary problem description.</p></td>
687 <td class="parameter_annotations"> </td>
688 </tr>
689 <tr>
690 <td class="parameter_name"><p>...</p></td>
691 <td class="parameter_description"><p>argument list for the <em class="parameter"><code>primary_format</code></em>
692 .</p></td>
693 <td class="parameter_annotations"> </td>
694 </tr>
695 </tbody>
696 </table></div>
697 </div>
698 </div>
699 <hr>
700 <div class="refsect2">
701 <a name="xfce-dialog-confirm"></a><h3>xfce_dialog_confirm ()</h3>
702 <pre class="programlisting"><span class="returnvalue">gboolean</span>
703 xfce_dialog_confirm (<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>,
704 <em class="parameter"><code>const <span class="type">gchar</span> *stock_id</code></em>,
705 <em class="parameter"><code>const <span class="type">gchar</span> *confirm_label</code></em>,
706 <em class="parameter"><code>const <span class="type">gchar</span> *secondary_text</code></em>,
707 <em class="parameter"><code>const <span class="type">gchar</span> *primary_format</code></em>,
708 <em class="parameter"><code>...</code></em>);</pre>
709 <p>Runs a questions dialog that has a 'Cancel' and a 'Confirm' button. The 'Confirm'
710 button text can be set by <em class="parameter"><code>action</code></em>
711 if given.</p>
712 <p>If <em class="parameter"><code>stock_id</code></em>
713 is equal to <a href="/usr/share/gtk-doc/html/gtk3/gtk3-Stock-Items.html#GTK-STOCK-YES:CAPS"><span class="type">GTK_STOCK_YES</span></a>, the 'Cancel' button becomes a 'No' button.</p>
714 <div class="refsect3">
715 <a name="xfce-dialog-confirm.parameters"></a><h4>Parameters</h4>
716 <div class="informaltable"><table class="informaltable" width="100%" border="0">
717 <colgroup>
718 <col width="150px" class="parameters_name">
719 <col class="parameters_description">
720 <col width="200px" class="parameters_annotations">
721 </colgroup>
722 <tbody>
723 <tr>
724 <td class="parameter_name"><p>parent</p></td>
725 <td class="parameter_description"><p>transient parent of the dialog, or <code class="literal">NULL</code>. </p></td>
726 <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>
727 </tr>
728 <tr>
729 <td class="parameter_name"><p>stock_id</p></td>
730 <td class="parameter_description"><p>the stock name of the confirm button, for example <a href="/usr/share/gtk-doc/html/gtk3/gtk3-Stock-Items.html#GTK-STOCK-YES:CAPS"><span class="type">GTK_STOCK_YES</span></a> or <a href="/usr/share/gtk-doc/html/gtk3/gtk3-Stock-Items.html#GTK-STOCK-CLEAR:CAPS"><span class="type">GTK_STOCK_CLEAR</span></a>.</p></td>
731 <td class="parameter_annotations"> </td>
732 </tr>
733 <tr>
734 <td class="parameter_name"><p>confirm_label</p></td>
735 <td class="parameter_description"><p>if non-<code class="literal">NULL</code>, this text is used on the confirm button together with the <em class="parameter"><code>stock_id</code></em>
736 icon. </p></td>
737 <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>
738 </tr>
739 <tr>
740 <td class="parameter_name"><p>secondary_text</p></td>
741 <td class="parameter_description"><p>secondary text in the dialog. </p></td>
742 <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>
743 </tr>
744 <tr>
745 <td class="parameter_name"><p>primary_format</p></td>
746 <td class="parameter_description"><p>the <code class="function">printf()</code>-style format for the dialog question. </p></td>
747 <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>
748 </tr>
749 <tr>
750 <td class="parameter_name"><p>...</p></td>
751 <td class="parameter_description"><p>argument list for the <em class="parameter"><code>primary_format</code></em>
752 . </p></td>
753 <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>
754 </tr>
755 </tbody>
756 </table></div>
757 </div>
758 <div class="refsect3">
759 <a name="xfce-dialog-confirm.returns"></a><h4>Returns</h4>
760 <p> TRUE if the user confirms, else FALSE.</p>
761 </div>
762 </div>
763 <hr>
764 <div class="refsect2">
765 <a name="xfce-dialog-confirm-close-tabs"></a><h3>xfce_dialog_confirm_close_tabs ()</h3>
766 <pre class="programlisting"><span class="returnvalue">gint</span>
767 xfce_dialog_confirm_close_tabs (<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>,
768 <em class="parameter"><code><span class="type">gint</span> num_tabs</code></em>,
769 <em class="parameter"><code><span class="type">gboolean</span> show_confirm_box</code></em>,
770 <em class="parameter"><code><span class="type">gboolean</span> *confirm_box_checked</code></em>);</pre>
771 <p>Runs a dialog to ask the user whether they want to close the whole window,
772 close the current tab, or cancel.</p>
773 <p>If <em class="parameter"><code>num_tabs</code></em>
774 is non-negative, the message to the user will state that there
775 are <em class="parameter"><code>num_tabs</code></em>
776 open tabs. If <em class="parameter"><code>num_tabs</code></em>
777 is negative, then the message to the
778 user will state simply that there are "multiple open tabs".</p>
779 <p>If <em class="parameter"><code>show_confirm_box</code></em>
780 is <code class="literal">TRUE</code> a checkbox is added to the dialog to allow
781 the user to set whether they wish to see this dialog in future. The initial
782 state of the checkbox is determined by the value stored at <em class="parameter"><code>confirm_box_checked</code></em>
783
784 and the value at <em class="parameter"><code>confirm_box_checked</code></em>
785 after returning records the state of the
786 checkbox. If <em class="parameter"><code>show_confirm_box</code></em>
787 is <code class="literal">FALSE</code>, <em class="parameter"><code>confirm_box_checked</code></em>
788 is ignored and
789 may be <code class="literal">NULL</code>.</p>
790 <div class="refsect3">
791 <a name="xfce-dialog-confirm-close-tabs.parameters"></a><h4>Parameters</h4>
792 <div class="informaltable"><table class="informaltable" width="100%" border="0">
793 <colgroup>
794 <col width="150px" class="parameters_name">
795 <col class="parameters_description">
796 <col width="200px" class="parameters_annotations">
797 </colgroup>
798 <tbody>
799 <tr>
800 <td class="parameter_name"><p>parent</p></td>
801 <td class="parameter_description"><p>transient parent of the dialog, or <code class="literal">NULL</code>. </p></td>
802 <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>
803 </tr>
804 <tr>
805 <td class="parameter_name"><p>num_tabs</p></td>
806 <td class="parameter_description"><p>the number of open tabs for display to user</p></td>
807 <td class="parameter_annotations"> </td>
808 </tr>
809 <tr>
810 <td class="parameter_name"><p>show_confirm_box</p></td>
811 <td class="parameter_description"><p>whether to ask the user if this confirmation shall be shown in the future</p></td>
812 <td class="parameter_annotations"> </td>
813 </tr>
814 <tr>
815 <td class="parameter_name"><p>confirm_box_checked</p></td>
816 <td class="parameter_description"><p>state of confirmation checkbox. </p></td>
817 <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>
818 </tr>
819 </tbody>
820 </table></div>
821 </div>
822 <div class="refsect3">
823 <a name="xfce-dialog-confirm-close-tabs.returns"></a><h4>Returns</h4>
824 <p> <a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#GTK-RESPONSE-CANCEL:CAPS"><span class="type">GTK_RESPONSE_CANCEL</span></a> if cancelled, <a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#GTK-RESPONSE-YES:CAPS"><span class="type">GTK_RESPONSE_YES</span></a> if the user
825 wants to close the window, <a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#GTK-RESPONSE-CLOSE:CAPS"><span class="type">GTK_RESPONSE_CLOSE</span></a> if the user wants to close the tab,
826 and <a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#GTK-RESPONSE-NONE:CAPS"><span class="type">GTK_RESPONSE_NONE</span></a> for an error.</p>
827 </div>
828 <p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p>
829 </div>
830 </div>
831 <div class="refsect1">
832 <a name="libxfce4ui-XfceDialogs.other_details"></a><h2>Types and Values</h2>
833 <div class="refsect2">
834 <a name="XFCE-BUTTON-TYPE-MIXED:CAPS"></a><h3>XFCE_BUTTON_TYPE_MIXED</h3>
835 <pre class="programlisting">#define XFCE_BUTTON_TYPE_MIXED "button-mixed"
836 </pre>
837 <p>This allows you to easily create mixed buttons in a dialog.
838 param1 is used for the stock_id, param2 for the label and
839 param3 for the response_id. See also <a class="link" href="libxfce4ui-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>
840 </div>
841 <hr>
842 <div class="refsect2">
843 <a name="XFCE-BUTTON-TYPE-PIXBUF:CAPS"></a><h3>XFCE_BUTTON_TYPE_PIXBUF</h3>
844 <pre class="programlisting">#define XFCE_BUTTON_TYPE_PIXBUF "button-pixbuf"
845 </pre>
846 <p>Creates a button with the <span class="type">GdkPixbuf</span> as button icon.
847 param1 is the <span class="type">GdkPixbuf</span>, param2 for the label and
848 param3 for the response_id.</p>
849 </div>
850 </div>
851 </div>
852 <div class="footer">
853 <hr>Generated by GTK-Doc V1.34.0</div>
854 </body>
855 </html>