| 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>XfceTitledDialog: 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-XfceDialogs.html" title="XfceDialogs"> |
| 10 |
<link rel="next" href="XfceClipboardManager.html" title="XfceClipboardManager"> |
| 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="#XfceTitledDialog.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> |
| 19 |
<a href="#XfceTitledDialog.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> |
| 20 |
<a href="#XfceTitledDialog.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> |
| 21 |
<a href="#XfceTitledDialog.properties" class="shortcut">Properties</a></span> |
| 22 |
</td> |
| 23 |
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| 24 |
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| 25 |
<td><a accesskey="p" href="libxfce4ui-XfceDialogs.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| 26 |
<td><a accesskey="n" href="XfceClipboardManager.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| 27 |
</tr></table> |
| 28 |
<div class="refentry"> |
| 29 |
<a name="XfceTitledDialog"></a><div class="titlepage"></div> |
| 30 |
<div class="refnamediv"><table width="100%"><tr> |
| 31 |
<td valign="top"> |
| 32 |
<h2><span class="refentrytitle"><a name="XfceTitledDialog.top_of_page"></a>XfceTitledDialog</span></h2> |
| 33 |
<p>XfceTitledDialog — A titled dialog window</p> |
| 34 |
</td> |
| 35 |
<td class="gallery_image" valign="top" align="right"></td> |
| 36 |
</tr></table></div> |
| 37 |
<div class="refsect1"> |
| 38 |
<a name="XfceTitledDialog.stability-level"></a><h2>Stability Level</h2> |
| 39 |
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to |
| 40 |
develop applications to these interfaces, release them, and have confidence that |
| 41 |
they will run on all minor releases of the product (after the one in which the |
| 42 |
interface was introduced, and within the same major release). Even at a major |
| 43 |
release, incompatible changes are expected to be rare, and to have strong |
| 44 |
justifications. |
| 45 |
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated |
| 46 |
</div> |
| 47 |
<div class="refsect1"> |
| 48 |
<a name="XfceTitledDialog.functions"></a><h2>Functions</h2> |
| 49 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 50 |
<colgroup> |
| 51 |
<col width="150px" class="functions_proto_type"> |
| 52 |
<col class="functions_proto_name"> |
| 53 |
</colgroup> |
| 54 |
<tbody> |
| 55 |
<tr> |
| 56 |
<td class="function_type"> |
| 57 |
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 58 |
</td> |
| 59 |
<td class="function_name"> |
| 60 |
<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> |
| 61 |
</td> |
| 62 |
</tr> |
| 63 |
<tr> |
| 64 |
<td class="function_type"> |
| 65 |
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 66 |
</td> |
| 67 |
<td class="function_name"> |
| 68 |
<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> |
| 69 |
</td> |
| 70 |
</tr> |
| 71 |
<tr> |
| 72 |
<td class="function_type"> |
| 73 |
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 74 |
</td> |
| 75 |
<td class="function_name"> |
| 76 |
<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> |
| 77 |
</td> |
| 78 |
</tr> |
| 79 |
<tr> |
| 80 |
<td class="function_type"> |
| 81 |
<span class="returnvalue">void</span> |
| 82 |
</td> |
| 83 |
<td class="function_name"> |
| 84 |
<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> |
| 85 |
</td> |
| 86 |
</tr> |
| 87 |
<tr> |
| 88 |
<td class="function_type"> |
| 89 |
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 90 |
</td> |
| 91 |
<td class="function_name"> |
| 92 |
<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> |
| 93 |
</td> |
| 94 |
</tr> |
| 95 |
<tr> |
| 96 |
<td class="function_type"> |
| 97 |
<span class="returnvalue">void</span> |
| 98 |
</td> |
| 99 |
<td class="function_name"> |
| 100 |
<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> |
| 101 |
</td> |
| 102 |
</tr> |
| 103 |
<tr> |
| 104 |
<td class="function_type"> |
| 105 |
<span class="returnvalue">void</span> |
| 106 |
</td> |
| 107 |
<td class="function_name"> |
| 108 |
<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> |
| 109 |
</td> |
| 110 |
</tr> |
| 111 |
<tr> |
| 112 |
<td class="function_type">const <span class="returnvalue">gchar</span> * |
| 113 |
</td> |
| 114 |
<td class="function_name"> |
| 115 |
<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> |
| 116 |
</td> |
| 117 |
</tr> |
| 118 |
<tr> |
| 119 |
<td class="function_type"> |
| 120 |
<span class="returnvalue">void</span> |
| 121 |
</td> |
| 122 |
<td class="function_name"> |
| 123 |
<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> |
| 124 |
</td> |
| 125 |
</tr> |
| 126 |
</tbody> |
| 127 |
</table></div> |
| 128 |
</div> |
| 129 |
<div class="refsect1"> |
| 130 |
<a name="XfceTitledDialog.properties"></a><h2>Properties</h2> |
| 131 |
<div class="informaltable"><table class="informaltable" border="0"> |
| 132 |
<colgroup> |
| 133 |
<col width="150px" class="properties_type"> |
| 134 |
<col width="300px" class="properties_name"> |
| 135 |
<col width="200px" class="properties_flags"> |
| 136 |
</colgroup> |
| 137 |
<tbody><tr> |
| 138 |
<td class="property_type"> |
| 139 |
<span class="type">char</span> *</td> |
| 140 |
<td class="property_name"><a class="link" href="XfceTitledDialog.html#XfceTitledDialog--subtitle" title="The “subtitle” property">subtitle</a></td> |
| 141 |
<td class="property_flags">Read / Write</td> |
| 142 |
</tr></tbody> |
| 143 |
</table></div> |
| 144 |
</div> |
| 145 |
<div class="refsect1"> |
| 146 |
<a name="XfceTitledDialog.other"></a><h2>Types and Values</h2> |
| 147 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 148 |
<colgroup> |
| 149 |
<col width="150px" class="other_proto_type"> |
| 150 |
<col class="other_proto_name"> |
| 151 |
</colgroup> |
| 152 |
<tbody><tr> |
| 153 |
<td class="datatype_keyword">struct</td> |
| 154 |
<td class="function_name"><a class="link" href="XfceTitledDialog.html#XfceTitledDialog-struct" title="struct XfceTitledDialog">XfceTitledDialog</a></td> |
| 155 |
</tr></tbody> |
| 156 |
</table></div> |
| 157 |
</div> |
| 158 |
<div class="refsect1"> |
| 159 |
<a name="XfceTitledDialog.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| 160 |
<pre class="screen"> GObject |
| 161 |
<span class="lineart">╰──</span> GInitiallyUnowned |
| 162 |
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a> |
| 163 |
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a> |
| 164 |
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkBin.html#GtkBin-struct">GtkBin</a> |
| 165 |
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkWindow.html#GtkWindow-struct">GtkWindow</a> |
| 166 |
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#GtkDialog-struct">GtkDialog</a> |
| 167 |
<span class="lineart">╰──</span> XfceTitledDialog |
| 168 |
</pre> |
| 169 |
</div> |
| 170 |
<div class="refsect1"> |
| 171 |
<a name="XfceTitledDialog.implemented-interfaces"></a><h2>Implemented Interfaces</h2> |
| 172 |
<p> |
| 173 |
XfceTitledDialog implements |
| 174 |
AtkImplementorIface and <a href="/usr/share/gtk-doc/html/gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a>.</p> |
| 175 |
</div> |
| 176 |
<div class="refsect1"> |
| 177 |
<a name="XfceTitledDialog.includes"></a><h2>Includes</h2> |
| 178 |
<pre class="synopsis">#include <libxfce4ui/libxfce4ui.h> |
| 179 |
</pre> |
| 180 |
</div> |
| 181 |
<div class="refsect1"> |
| 182 |
<a name="XfceTitledDialog.description"></a><h2>Description</h2> |
| 183 |
<p><a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> is a titled dialog window supporting an optional |
| 184 |
subtitle and mixed or pixbuf buttons.</p> |
| 185 |
</div> |
| 186 |
<div class="refsect1"> |
| 187 |
<a name="XfceTitledDialog.functions_details"></a><h2>Functions</h2> |
| 188 |
<div class="refsect2"> |
| 189 |
<a name="xfce-titled-dialog-new"></a><h3>xfce_titled_dialog_new ()</h3> |
| 190 |
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 191 |
xfce_titled_dialog_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> |
| 192 |
<p>Allocates a new <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> instance.</p> |
| 193 |
<div class="refsect3"> |
| 194 |
<a name="xfce-titled-dialog-new.returns"></a><h4>Returns</h4> |
| 195 |
<p> the newly allocated <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p> |
| 196 |
</div> |
| 197 |
</div> |
| 198 |
<hr> |
| 199 |
<div class="refsect2"> |
| 200 |
<a name="xfce-titled-dialog-new-with-buttons"></a><h3>xfce_titled_dialog_new_with_buttons ()</h3> |
| 201 |
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 202 |
xfce_titled_dialog_new_with_buttons (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>, |
| 203 |
<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>, |
| 204 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#GtkDialogFlags"><span class="type">GtkDialogFlags</span></a> flags</code></em>, |
| 205 |
<em class="parameter"><code>const <span class="type">gchar</span> *first_button_text</code></em>, |
| 206 |
<em class="parameter"><code>...</code></em>);</pre> |
| 207 |
<div class="warning"> |
| 208 |
<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> |
| 209 |
<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> |
| 210 |
</div> |
| 211 |
<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 |
| 212 |
parameters and the returned dialog.</p> |
| 213 |
<div class="refsect3"> |
| 214 |
<a name="xfce-titled-dialog-new-with-buttons.parameters"></a><h4>Parameters</h4> |
| 215 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 216 |
<colgroup> |
| 217 |
<col width="150px" class="parameters_name"> |
| 218 |
<col class="parameters_description"> |
| 219 |
<col width="200px" class="parameters_annotations"> |
| 220 |
</colgroup> |
| 221 |
<tbody> |
| 222 |
<tr> |
| 223 |
<td class="parameter_name"><p>title</p></td> |
| 224 |
<td class="parameter_description"><p>title of the dialog, or <code class="literal">NULL</code>. </p></td> |
| 225 |
<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> |
| 226 |
</tr> |
| 227 |
<tr> |
| 228 |
<td class="parameter_name"><p>parent</p></td> |
| 229 |
<td class="parameter_description"><p>transient parent window of the dialog, or <code class="literal">NULL</code>. </p></td> |
| 230 |
<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> |
| 231 |
</tr> |
| 232 |
<tr> |
| 233 |
<td class="parameter_name"><p>flags</p></td> |
| 234 |
<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> |
| 235 |
<td class="parameter_annotations"> </td> |
| 236 |
</tr> |
| 237 |
<tr> |
| 238 |
<td class="parameter_name"><p>first_button_text</p></td> |
| 239 |
<td class="parameter_description"><p>stock ID or text to go in first, or <code class="literal">NULL</code>. </p></td> |
| 240 |
<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> |
| 241 |
</tr> |
| 242 |
<tr> |
| 243 |
<td class="parameter_name"><p>...</p></td> |
| 244 |
<td class="parameter_description"><p>response ID for the first button, then additional buttons, ending with <code class="literal">NULL</code>.</p></td> |
| 245 |
<td class="parameter_annotations"> </td> |
| 246 |
</tr> |
| 247 |
</tbody> |
| 248 |
</table></div> |
| 249 |
</div> |
| 250 |
<div class="refsect3"> |
| 251 |
<a name="xfce-titled-dialog-new-with-buttons.returns"></a><h4>Returns</h4> |
| 252 |
<p> the newly allocated <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p> |
| 253 |
</div> |
| 254 |
</div> |
| 255 |
<hr> |
| 256 |
<div class="refsect2"> |
| 257 |
<a name="xfce-titled-dialog-new-with-mixed-buttons"></a><h3>xfce_titled_dialog_new_with_mixed_buttons ()</h3> |
| 258 |
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 259 |
xfce_titled_dialog_new_with_mixed_buttons |
| 260 |
(<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>, |
| 261 |
<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>, |
| 262 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#GtkDialogFlags"><span class="type">GtkDialogFlags</span></a> flags</code></em>, |
| 263 |
<em class="parameter"><code>const <span class="type">gchar</span> *first_button_icon_name</code></em>, |
| 264 |
<em class="parameter"><code>const <span class="type">gchar</span> *first_button_text</code></em>, |
| 265 |
<em class="parameter"><code>...</code></em>);</pre> |
| 266 |
<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 |
| 267 |
the buttons to use an optional named or stock icon.</p> |
| 268 |
<div class="refsect3"> |
| 269 |
<a name="xfce-titled-dialog-new-with-mixed-buttons.parameters"></a><h4>Parameters</h4> |
| 270 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 271 |
<colgroup> |
| 272 |
<col width="150px" class="parameters_name"> |
| 273 |
<col class="parameters_description"> |
| 274 |
<col width="200px" class="parameters_annotations"> |
| 275 |
</colgroup> |
| 276 |
<tbody> |
| 277 |
<tr> |
| 278 |
<td class="parameter_name"><p>title</p></td> |
| 279 |
<td class="parameter_description"><p>title of the dialog, or <code class="literal">NULL</code>. </p></td> |
| 280 |
<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> |
| 281 |
</tr> |
| 282 |
<tr> |
| 283 |
<td class="parameter_name"><p>parent</p></td> |
| 284 |
<td class="parameter_description"><p>transient parent window of the dialog, or <code class="literal">NULL</code>. </p></td> |
| 285 |
<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> |
| 286 |
</tr> |
| 287 |
<tr> |
| 288 |
<td class="parameter_name"><p>flags</p></td> |
| 289 |
<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> |
| 290 |
<td class="parameter_annotations"> </td> |
| 291 |
</tr> |
| 292 |
<tr> |
| 293 |
<td class="parameter_name"><p>first_button_icon_name</p></td> |
| 294 |
<td class="parameter_description"><p>icon name to go in first, or "" for no icon.</p></td> |
| 295 |
<td class="parameter_annotations"> </td> |
| 296 |
</tr> |
| 297 |
<tr> |
| 298 |
<td class="parameter_name"><p>first_button_text</p></td> |
| 299 |
<td class="parameter_description"><p>text to go in first, or <code class="literal">NULL</code>. </p></td> |
| 300 |
<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> |
| 301 |
</tr> |
| 302 |
<tr> |
| 303 |
<td class="parameter_name"><p>...</p></td> |
| 304 |
<td class="parameter_description"><p>response ID for the first button, then additional buttons, ending with <code class="literal">NULL</code>.</p></td> |
| 305 |
<td class="parameter_annotations"> </td> |
| 306 |
</tr> |
| 307 |
</tbody> |
| 308 |
</table></div> |
| 309 |
</div> |
| 310 |
<div class="refsect3"> |
| 311 |
<a name="xfce-titled-dialog-new-with-mixed-buttons.returns"></a><h4>Returns</h4> |
| 312 |
<p> the newly allocated <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p> |
| 313 |
</div> |
| 314 |
<p class="since">Since: <a class="link" href="api-index-4-14.html#api-index-4.14">4.14</a></p> |
| 315 |
</div> |
| 316 |
<hr> |
| 317 |
<div class="refsect2"> |
| 318 |
<a name="xfce-titled-dialog-create-action-area"></a><h3>xfce_titled_dialog_create_action_area ()</h3> |
| 319 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 320 |
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> |
| 321 |
<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> |
| 322 |
<p>This function is a no-op since 4.19.3.</p> |
| 323 |
<div class="refsect3"> |
| 324 |
<a name="xfce-titled-dialog-create-action-area.parameters"></a><h4>Parameters</h4> |
| 325 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 326 |
<colgroup> |
| 327 |
<col width="150px" class="parameters_name"> |
| 328 |
<col class="parameters_description"> |
| 329 |
<col width="200px" class="parameters_annotations"> |
| 330 |
</colgroup> |
| 331 |
<tbody><tr> |
| 332 |
<td class="parameter_name"><p>titled_dialog</p></td> |
| 333 |
<td class="parameter_description"><p>a <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p></td> |
| 334 |
<td class="parameter_annotations"> </td> |
| 335 |
</tr></tbody> |
| 336 |
</table></div> |
| 337 |
</div> |
| 338 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 339 |
</div> |
| 340 |
<hr> |
| 341 |
<div class="refsect2"> |
| 342 |
<a name="xfce-titled-dialog-add-button"></a><h3>xfce_titled_dialog_add_button ()</h3> |
| 343 |
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * |
| 344 |
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>, |
| 345 |
<em class="parameter"><code>const <span class="type">gchar</span> *button_text</code></em>, |
| 346 |
<em class="parameter"><code><span class="type">gint</span> response_id</code></em>);</pre> |
| 347 |
<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> |
| 348 |
<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 |
| 349 |
(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> |
| 350 |
<div class="refsect3"> |
| 351 |
<a name="xfce-titled-dialog-add-button.parameters"></a><h4>Parameters</h4> |
| 352 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 353 |
<colgroup> |
| 354 |
<col width="150px" class="parameters_name"> |
| 355 |
<col class="parameters_description"> |
| 356 |
<col width="200px" class="parameters_annotations"> |
| 357 |
</colgroup> |
| 358 |
<tbody> |
| 359 |
<tr> |
| 360 |
<td class="parameter_name"><p>titled_dialog</p></td> |
| 361 |
<td class="parameter_description"><p>a <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p></td> |
| 362 |
<td class="parameter_annotations"> </td> |
| 363 |
</tr> |
| 364 |
<tr> |
| 365 |
<td class="parameter_name"><p>button_text</p></td> |
| 366 |
<td class="parameter_description"><p>text of button.</p></td> |
| 367 |
<td class="parameter_annotations"> </td> |
| 368 |
</tr> |
| 369 |
<tr> |
| 370 |
<td class="parameter_name"><p>response_id</p></td> |
| 371 |
<td class="parameter_description"><p>response ID for <em class="parameter"><code>child</code></em> |
| 372 |
.</p></td> |
| 373 |
<td class="parameter_annotations"> </td> |
| 374 |
</tr> |
| 375 |
</tbody> |
| 376 |
</table></div> |
| 377 |
</div> |
| 378 |
<div class="refsect3"> |
| 379 |
<a name="xfce-titled-dialog-add-button.returns"></a><h4>Returns</h4> |
| 380 |
<p>the GtkButton widget that was added. </p> |
| 381 |
<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> |
| 382 |
</div> |
| 383 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 384 |
</div> |
| 385 |
<hr> |
| 386 |
<div class="refsect2"> |
| 387 |
<a name="xfce-titled-dialog-add-action-widget"></a><h3>xfce_titled_dialog_add_action_widget ()</h3> |
| 388 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 389 |
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>, |
| 390 |
<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>, |
| 391 |
<em class="parameter"><code><span class="type">gint</span> response_id</code></em>);</pre> |
| 392 |
<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> |
| 393 |
<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 |
| 394 |
(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> |
| 395 |
<div class="refsect3"> |
| 396 |
<a name="xfce-titled-dialog-add-action-widget.parameters"></a><h4>Parameters</h4> |
| 397 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 398 |
<colgroup> |
| 399 |
<col width="150px" class="parameters_name"> |
| 400 |
<col class="parameters_description"> |
| 401 |
<col width="200px" class="parameters_annotations"> |
| 402 |
</colgroup> |
| 403 |
<tbody> |
| 404 |
<tr> |
| 405 |
<td class="parameter_name"><p>titled_dialog</p></td> |
| 406 |
<td class="parameter_description"><p>a <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p></td> |
| 407 |
<td class="parameter_annotations"> </td> |
| 408 |
</tr> |
| 409 |
<tr> |
| 410 |
<td class="parameter_name"><p>child</p></td> |
| 411 |
<td class="parameter_description"><p>an activatable widget.</p></td> |
| 412 |
<td class="parameter_annotations"> </td> |
| 413 |
</tr> |
| 414 |
<tr> |
| 415 |
<td class="parameter_name"><p>response_id</p></td> |
| 416 |
<td class="parameter_description"><p>response ID for <em class="parameter"><code>child</code></em> |
| 417 |
.</p></td> |
| 418 |
<td class="parameter_annotations"> </td> |
| 419 |
</tr> |
| 420 |
</tbody> |
| 421 |
</table></div> |
| 422 |
</div> |
| 423 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 424 |
</div> |
| 425 |
<hr> |
| 426 |
<div class="refsect2"> |
| 427 |
<a name="xfce-titled-dialog-set-default-response"></a><h3>xfce_titled_dialog_set_default_response ()</h3> |
| 428 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 429 |
xfce_titled_dialog_set_default_response |
| 430 |
(<em class="parameter"><code><a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> *titled_dialog</code></em>, |
| 431 |
<em class="parameter"><code><span class="type">gint</span> response_id</code></em>);</pre> |
| 432 |
<p>Sets the last widget in the dialog’s action area with the given <em class="parameter"><code>response_id</code></em> |
| 433 |
|
| 434 |
as the default widget for the dialog. Pressing “Enter” normally activates |
| 435 |
the default widget.</p> |
| 436 |
<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 |
| 437 |
not work with <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p> |
| 438 |
<div class="refsect3"> |
| 439 |
<a name="xfce-titled-dialog-set-default-response.parameters"></a><h4>Parameters</h4> |
| 440 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 441 |
<colgroup> |
| 442 |
<col width="150px" class="parameters_name"> |
| 443 |
<col class="parameters_description"> |
| 444 |
<col width="200px" class="parameters_annotations"> |
| 445 |
</colgroup> |
| 446 |
<tbody> |
| 447 |
<tr> |
| 448 |
<td class="parameter_name"><p>titled_dialog</p></td> |
| 449 |
<td class="parameter_description"><p>a <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p></td> |
| 450 |
<td class="parameter_annotations"> </td> |
| 451 |
</tr> |
| 452 |
<tr> |
| 453 |
<td class="parameter_name"><p>response_id</p></td> |
| 454 |
<td class="parameter_description"><p>a response ID</p></td> |
| 455 |
<td class="parameter_annotations"> </td> |
| 456 |
</tr> |
| 457 |
</tbody> |
| 458 |
</table></div> |
| 459 |
</div> |
| 460 |
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p> |
| 461 |
</div> |
| 462 |
<hr> |
| 463 |
<div class="refsect2"> |
| 464 |
<a name="xfce-titled-dialog-get-subtitle"></a><h3>xfce_titled_dialog_get_subtitle ()</h3> |
| 465 |
<pre class="programlisting">const <span class="returnvalue">gchar</span> * |
| 466 |
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> |
| 467 |
<p>Returns the subtitle of the <em class="parameter"><code>titled_dialog</code></em> |
| 468 |
, or <code class="literal">NULL</code> |
| 469 |
if no subtitle is displayed in the <em class="parameter"><code>titled_dialog</code></em> |
| 470 |
. |
| 471 |
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> |
| 472 |
<div class="refsect3"> |
| 473 |
<a name="xfce-titled-dialog-get-subtitle.parameters"></a><h4>Parameters</h4> |
| 474 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 475 |
<colgroup> |
| 476 |
<col width="150px" class="parameters_name"> |
| 477 |
<col class="parameters_description"> |
| 478 |
<col width="200px" class="parameters_annotations"> |
| 479 |
</colgroup> |
| 480 |
<tbody><tr> |
| 481 |
<td class="parameter_name"><p>titled_dialog</p></td> |
| 482 |
<td class="parameter_description"><p>a <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p></td> |
| 483 |
<td class="parameter_annotations"> </td> |
| 484 |
</tr></tbody> |
| 485 |
</table></div> |
| 486 |
</div> |
| 487 |
<div class="refsect3"> |
| 488 |
<a name="xfce-titled-dialog-get-subtitle.returns"></a><h4>Returns</h4> |
| 489 |
<p> the subtitle of <em class="parameter"><code>titled_dialog</code></em> |
| 490 |
, or <code class="literal">NULL</code>.</p> |
| 491 |
</div> |
| 492 |
</div> |
| 493 |
<hr> |
| 494 |
<div class="refsect2"> |
| 495 |
<a name="xfce-titled-dialog-set-subtitle"></a><h3>xfce_titled_dialog_set_subtitle ()</h3> |
| 496 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 497 |
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>, |
| 498 |
<em class="parameter"><code>const <span class="type">gchar</span> *subtitle</code></em>);</pre> |
| 499 |
<p>Sets the subtitle displayed by <em class="parameter"><code>titled_dialog</code></em> |
| 500 |
to <em class="parameter"><code>subtitle</code></em> |
| 501 |
; if |
| 502 |
<em class="parameter"><code>subtitle</code></em> |
| 503 |
is <code class="literal">NULL</code> no subtitle will be displayed by the <em class="parameter"><code>titled_dialog</code></em> |
| 504 |
. |
| 505 |
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> |
| 506 |
when dialogs use header bars. Otherwise a simple label and separator are |
| 507 |
shown at the top of dialog.</p> |
| 508 |
<div class="refsect3"> |
| 509 |
<a name="xfce-titled-dialog-set-subtitle.parameters"></a><h4>Parameters</h4> |
| 510 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 511 |
<colgroup> |
| 512 |
<col width="150px" class="parameters_name"> |
| 513 |
<col class="parameters_description"> |
| 514 |
<col width="200px" class="parameters_annotations"> |
| 515 |
</colgroup> |
| 516 |
<tbody> |
| 517 |
<tr> |
| 518 |
<td class="parameter_name"><p>titled_dialog</p></td> |
| 519 |
<td class="parameter_description"><p>a <a class="link" href="XfceTitledDialog.html" title="XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p></td> |
| 520 |
<td class="parameter_annotations"> </td> |
| 521 |
</tr> |
| 522 |
<tr> |
| 523 |
<td class="parameter_name"><p>subtitle</p></td> |
| 524 |
<td class="parameter_description"><p>the new subtitle for the <em class="parameter"><code>titled_dialog</code></em> |
| 525 |
, or <code class="literal">NULL</code>. </p></td> |
| 526 |
<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> |
| 527 |
</tr> |
| 528 |
</tbody> |
| 529 |
</table></div> |
| 530 |
</div> |
| 531 |
</div> |
| 532 |
</div> |
| 533 |
<div class="refsect1"> |
| 534 |
<a name="XfceTitledDialog.other_details"></a><h2>Types and Values</h2> |
| 535 |
<div class="refsect2"> |
| 536 |
<a name="XfceTitledDialog-struct"></a><h3>struct XfceTitledDialog</h3> |
| 537 |
<pre class="programlisting">struct XfceTitledDialog;</pre> |
| 538 |
<p>An opaque struct with only private fields.</p> |
| 539 |
</div> |
| 540 |
</div> |
| 541 |
<div class="refsect1"> |
| 542 |
<a name="XfceTitledDialog.property-details"></a><h2>Property Details</h2> |
| 543 |
<div class="refsect2"> |
| 544 |
<a name="XfceTitledDialog--subtitle"></a><h3>The <code class="literal">“subtitle”</code> property</h3> |
| 545 |
<pre class="programlisting"> “subtitle” <span class="type">char</span> *</pre> |
| 546 |
<p>The subtitle displayed below the main dialog title.</p> |
| 547 |
<p>Owner: XfceTitledDialog</p> |
| 548 |
<p>Flags: Read / Write</p> |
| 549 |
<p>Default value: NULL</p> |
| 550 |
</div> |
| 551 |
</div> |
| 552 |
</div> |
| 553 |
<div class="footer"> |
| 554 |
<hr>Generated by GTK-Doc V1.34.0</div> |
| 555 |
</body> |
| 556 |
</html> |