libxfce4ui-1-dev 4.10.0-6 / usr / share / gtk-doc / html / libxfce4ui / libxfce4ui-xfce-titled-dialog.html

This file is indexed.

/usr/share/gtk-doc/html/libxfce4ui/libxfce4ui-xfce-titled-dialog.html is in libxfce4ui-1-dev 4.10.0-6.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Xfce Titled Dialog</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<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-xfce-dialogs.html" title="Xfce Dialogs">
<link rel="next" href="libxfce4ui-sm.html" title="Part V. Xfce Session Management Support">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="libxfce4ui-xfce-dialogs.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libxfce4ui-widgets.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Libxfce4ui Reference Manual</th>
<td><a accesskey="n" href="libxfce4ui-sm.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libxfce4ui-xfce-titled-dialog.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libxfce4ui-xfce-titled-dialog.description" class="shortcut">Description</a>
                   | 
                  <a href="#libxfce4ui-xfce-titled-dialog.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#libxfce4ui-xfce-titled-dialog.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#libxfce4ui-xfce-titled-dialog.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="libxfce4ui-xfce-titled-dialog"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libxfce4ui-xfce-titled-dialog.top_of_page"></a>Xfce Titled Dialog</span></h2>
<p>Xfce Titled Dialog — A <a href="http://library.gnome.org/devel/gtk3/GtkDialog.html"><span class="type">GtkDialog</span></a> with heading.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libxfce4ui-xfce-titled-dialog.synopsis"></a><h2>Synopsis</h2>
<a name="XfceTitledDialog"></a><pre class="synopsis">
#include &lt;libxfce4ui/libxfce4ui.h&gt;

                    <a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog-struct" title="XfceTitledDialog">XfceTitledDialog</a>;
<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="libxfce4ui-xfce-titled-dialog.html#xfce-titled-dialog-new" title="xfce_titled_dialog_new ()">xfce_titled_dialog_new</a>              (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="libxfce4ui-xfce-titled-dialog.html#xfce-titled-dialog-new-with-buttons" title="xfce_titled_dialog_new_with_buttons ()">xfce_titled_dialog_new_with_buttons</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkDialog.html#GtkDialogFlags"><span class="type">GtkDialogFlags</span></a> flags</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *first_button_text</code></em>,
                                                         <em class="parameter"><code>...</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="libxfce4ui-xfce-titled-dialog.html#xfce-titled-dialog-get-subtitle" title="xfce_titled_dialog_get_subtitle ()">xfce_titled_dialog_get_subtitle</a>     (<em class="parameter"><code><a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> *titled_dialog</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libxfce4ui-xfce-titled-dialog.html#xfce-titled-dialog-set-subtitle" title="xfce_titled_dialog_set_subtitle ()">xfce_titled_dialog_set_subtitle</a>     (<em class="parameter"><code><a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> *titled_dialog</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *subtitle</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libxfce4ui-xfce-titled-dialog.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
         +----<a href="http://library.gnome.org/devel/gtk3/GtkObject.html">GtkObject</a>
               +----<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html">GtkWidget</a>
                     +----<a href="http://library.gnome.org/devel/gtk3/GtkContainer.html">GtkContainer</a>
                           +----<a href="http://library.gnome.org/devel/gtk3/GtkBin.html">GtkBin</a>
                                 +----<a href="http://library.gnome.org/devel/gtk3/GtkWindow.html">GtkWindow</a>
                                       +----<a href="http://library.gnome.org/devel/gtk3/GtkDialog.html">GtkDialog</a>
                                             +----XfceTitledDialog
</pre>
</div>
<div class="refsect1">
<a name="libxfce4ui-xfce-titled-dialog.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
XfceTitledDialog implements
 AtkImplementorIface and  <a href="http://library.gnome.org/devel/gtk3/GtkBuildable.html">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="libxfce4ui-xfce-titled-dialog.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog--subtitle" title='The "subtitle" property'>subtitle</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="libxfce4ui-xfce-titled-dialog.description"></a><h2>Description</h2>
<p>
The <a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> is a normal <a href="http://library.gnome.org/devel/gtk3/GtkDialog.html"><span class="type">GtkDialog</span></a> with a heading. The icon
and title used in the heading are the same as the dialog title and icon
See <a href="http://library.gnome.org/devel/gtk3/GtkWindow.html#gtk-window-set-icon-name"><code class="function">gtk_window_set_icon_name()</code></a>.
</p>
<p>
To give the user more detailed information about the use of the dialog,
an optional subtitle and be set using <a class="link" href="libxfce4ui-xfce-titled-dialog.html#xfce-titled-dialog-set-subtitle" title="xfce_titled_dialog_set_subtitle ()"><code class="function">xfce_titled_dialog_set_subtitle()</code></a>.
</p>
</div>
<div class="refsect1">
<a name="libxfce4ui-xfce-titled-dialog.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="XfceTitledDialog-struct"></a><h3>XfceTitledDialog</h3>
<pre class="programlisting">typedef struct _XfceTitledDialog XfceTitledDialog;</pre>
<p>
Structure for the <a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-titled-dialog-new"></a><h3>xfce_titled_dialog_new ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         xfce_titled_dialog_new              (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Allocates a new <a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> instance.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the newly allocated <a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-titled-dialog-new-with-buttons"></a><h3>xfce_titled_dialog_new_with_buttons ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         xfce_titled_dialog_new_with_buttons (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkDialog.html#GtkDialogFlags"><span class="type">GtkDialogFlags</span></a> flags</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/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>
See the documentation of <a href="http://library.gnome.org/devel/gtk3/GtkDialog.html#gtk-dialog-new-with-buttons"><code class="function">gtk_dialog_new_with_buttons()</code></a> for details about the
parameters and the returned dialog.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
<td>title of the dialog, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
<td>transient parent window of the dialog, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>from <a href="http://library.gnome.org/devel/gtk3/GtkDialog.html#GtkDialogFlags"><span class="type">GtkDialogFlags</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>first_button_text</code></em> :</span></p></td>
<td>stock ID or text to go in first, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>response ID for the first button, then additional buttons, ending with <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the newly allocated <a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-titled-dialog-get-subtitle"></a><h3>xfce_titled_dialog_get_subtitle ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       xfce_titled_dialog_get_subtitle     (<em class="parameter"><code><a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> *titled_dialog</code></em>);</pre>
<p>
Returns the subtitle of the <em class="parameter"><code>titled_dialog</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
if no subtitle is displayed in the <em class="parameter"><code>titled_dialog</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>titled_dialog</code></em> :</span></p></td>
<td>a <a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the subtitle of <em class="parameter"><code>titled_dialog</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-titled-dialog-set-subtitle"></a><h3>xfce_titled_dialog_set_subtitle ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                xfce_titled_dialog_set_subtitle     (<em class="parameter"><code><a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> *titled_dialog</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *subtitle</code></em>);</pre>
<p>
Sets the subtitle displayed by <em class="parameter"><code>titled_dialog</code></em> to <em class="parameter"><code>subtitle</code></em>; if
<em class="parameter"><code>subtitle</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> no subtitle will be displayed by the <em class="parameter"><code>titled_dialog</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>titled_dialog</code></em> :</span></p></td>
<td>a <a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>subtitle</code></em> :</span></p></td>
<td>the new subtitle for the <em class="parameter"><code>titled_dialog</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="libxfce4ui-xfce-titled-dialog.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="XfceTitledDialog--subtitle"></a><h3>The <code class="literal">"subtitle"</code> property</h3>
<pre class="programlisting">  "subtitle"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
<p>
The subtitle displayed below the main dialog title.
</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="libxfce4ui-xfce-titled-dialog.see-also"></a><h2>See Also</h2>
<p>
<a href="http://library.gnome.org/devel/gtk3/GtkDialog.html"><span class="type">GtkDialog</span></a>, <a href="http://library.gnome.org/devel/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a>
</p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.