libxfcegui4-dev 4.10.0-3 / usr / share / gtk-doc / html / libxfcegui4 / XfceHeading.html

This file is indexed.

/usr/share/gtk-doc/html/libxfcegui4/XfceHeading.html is in libxfcegui4-dev 4.10.0-3.

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

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XfceHeading</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libxfcegui4 Reference Manual">
<link rel="up" href="libxfcegui4-core.html" title="Xfce GUI Core Reference">
<link rel="prev" href="XfceFramebox.html" title="XfceFramebox">
<link rel="next" href="XfceIconTheme.html" title="XfceIconTheme">
<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="XfceFramebox.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libxfcegui4-core.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">libxfcegui4 Reference Manual</th>
<td><a accesskey="n" href="XfceIconTheme.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#XfceHeading.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#XfceHeading.description" class="shortcut">Description</a>
                   | 
                  <a href="#XfceHeading.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#XfceHeading.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#XfceHeading.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="XfceHeading"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="XfceHeading.top_of_page"></a>XfceHeading</span></h2>
<p>XfceHeading</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="XfceHeading.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libxfcegui4/libxfcegui4.h&gt;

                    <a class="link" href="XfceHeading.html#XfceHeading-struct" title="XfceHeading">XfceHeading</a>;
<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="XfceHeading.html#xfce-heading-new" title="xfce_heading_new ()">xfce_heading_new</a>                    (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> *         <a class="link" href="XfceHeading.html#xfce-heading-get-icon" title="xfce_heading_get_icon ()">xfce_heading_get_icon</a>               (<em class="parameter"><code><a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a> *heading</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="XfceHeading.html#xfce-heading-set-icon" title="xfce_heading_set_icon ()">xfce_heading_set_icon</a>               (<em class="parameter"><code><a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a> *heading</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *icon</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="XfceHeading.html#xfce-heading-get-icon-name" title="xfce_heading_get_icon_name ()">xfce_heading_get_icon_name</a>          (<em class="parameter"><code><a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a> *heading</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="XfceHeading.html#xfce-heading-set-icon-name" title="xfce_heading_set_icon_name ()">xfce_heading_set_icon_name</a>          (<em class="parameter"><code><a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a> *heading</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> *icon_name</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="XfceHeading.html#xfce-heading-get-subtitle" title="xfce_heading_get_subtitle ()">xfce_heading_get_subtitle</a>           (<em class="parameter"><code><a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a> *heading</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="XfceHeading.html#xfce-heading-set-subtitle" title="xfce_heading_set_subtitle ()">xfce_heading_set_subtitle</a>           (<em class="parameter"><code><a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a> *heading</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>);
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="XfceHeading.html#xfce-heading-get-title" title="xfce_heading_get_title ()">xfce_heading_get_title</a>              (<em class="parameter"><code><a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a> *heading</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="XfceHeading.html#xfce-heading-set-title" title="xfce_heading_set_title ()">xfce_heading_set_title</a>              (<em class="parameter"><code><a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a> *heading</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> *title</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="XfceHeading.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>
                     +----XfceHeading
</pre>
</div>
<div class="refsect1">
<a name="XfceHeading.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
XfceHeading implements
 AtkImplementorIface and  <a href="http://library.gnome.org/devel/gtk3/GtkBuildable.html">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="XfceHeading.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="XfceHeading.html#XfceHeading--icon" title='The "icon" property'>icon</a>"                     <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>*            : Read / Write
  "<a class="link" href="XfceHeading.html#XfceHeading--icon-name" title='The "icon-name" property'>icon-name</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  "<a class="link" href="XfceHeading.html#XfceHeading--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
  "<a class="link" href="XfceHeading.html#XfceHeading--title" title='The "title" property'>title</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="XfceHeading.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="XfceHeading.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="XfceHeading-struct"></a><h3>XfceHeading</h3>
<pre class="programlisting">typedef struct _XfceHeading XfceHeading;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-heading-new"></a><h3>xfce_heading_new ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         xfce_heading_new                    (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Allocates a new <a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</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="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a>.</td>
</tr></tbody>
</table></div>
<p class="since">Since 4.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-heading-get-icon"></a><h3>xfce_heading_get_icon ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> *         xfce_heading_get_icon               (<em class="parameter"><code><a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a> *heading</code></em>);</pre>
<p>
Returns the <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> that was set as icon for
<em class="parameter"><code>heading</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 icon is set. The returned
<a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> object is owned by <em class="parameter"><code>heading</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>heading</code></em> :</span></p></td>
<td>a <a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the icon for <em class="parameter"><code>heading</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>
<p class="since">Since 4.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-heading-set-icon"></a><h3>xfce_heading_set_icon ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                xfce_heading_set_icon               (<em class="parameter"><code><a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a> *heading</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *icon</code></em>);</pre>
<p>
If <em class="parameter"><code>icon</code></em> is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, <em class="parameter"><code>heading</code></em> will display the new <em class="parameter"><code>icon</code></em>
aside the title. Else, if <em class="parameter"><code>icon</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 icon is displayed
unless an icon name was set with <a class="link" href="XfceHeading.html#xfce-heading-set-icon-name" title="xfce_heading_set_icon_name ()"><code class="function">xfce_heading_set_icon_name()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>heading</code></em> :</span></p></td>
<td>a <a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
<td>the new icon 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>
<p class="since">Since 4.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-heading-get-icon-name"></a><h3>xfce_heading_get_icon_name ()</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_heading_get_icon_name          (<em class="parameter"><code><a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a> *heading</code></em>);</pre>
<p>
Returns the icon name previously set by a call to
<a class="link" href="XfceHeading.html#xfce-heading-set-icon-name" title="xfce_heading_set_icon_name ()"><code class="function">xfce_heading_set_icon_name()</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no icon name
is set for <em class="parameter"><code>heading</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>heading</code></em> :</span></p></td>
<td>a <a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the icon name for <em class="parameter"><code>heading</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>
<p class="since">Since 4.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-heading-set-icon-name"></a><h3>xfce_heading_set_icon_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                xfce_heading_set_icon_name          (<em class="parameter"><code><a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a> *heading</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> *icon_name</code></em>);</pre>
<p>
If <em class="parameter"><code>icon_name</code></em> is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and the "icon" property is set to
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, see <a class="link" href="XfceHeading.html#xfce-heading-set-icon" title="xfce_heading_set_icon ()"><code class="function">xfce_heading_set_icon()</code></a>, the <em class="parameter"><code>heading</code></em> will display
the name icon identified by the <em class="parameter"><code>icon_name</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>heading</code></em> :</span></p></td>
<td>a <a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon_name</code></em> :</span></p></td>
<td>the new icon name, 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>
<p class="since">Since 4.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-heading-get-subtitle"></a><h3>xfce_heading_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_heading_get_subtitle           (<em class="parameter"><code><a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a> *heading</code></em>);</pre>
<p>
Returns the sub title displayed below the
main title of the <em class="parameter"><code>heading</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 set.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>heading</code></em> :</span></p></td>
<td>a <a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</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>heading</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>
<p class="since">Since 4.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-heading-set-subtitle"></a><h3>xfce_heading_set_subtitle ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                xfce_heading_set_subtitle           (<em class="parameter"><code><a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a> *heading</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>
If <em class="parameter"><code>subtitle</code></em> is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and not the empty string, it
will be displayed by <em class="parameter"><code>heading</code></em> below the main title.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>heading</code></em> :</span></p></td>
<td>a <a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</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 <em class="parameter"><code>heading</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>
<p class="since">Since 4.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-heading-get-title"></a><h3>xfce_heading_get_title ()</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_heading_get_title              (<em class="parameter"><code><a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a> *heading</code></em>);</pre>
<p>
Returns the title displayed by the <em class="parameter"><code>heading</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>heading</code></em> :</span></p></td>
<td>a <a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the title displayed by the <em class="parameter"><code>heading</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-heading-set-title"></a><h3>xfce_heading_set_title ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                xfce_heading_set_title              (<em class="parameter"><code><a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a> *heading</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> *title</code></em>);</pre>
<p>
Sets the title displayed by the <em class="parameter"><code>heading</code></em> to the
specified <em class="parameter"><code>title</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>heading</code></em> :</span></p></td>
<td>a <a class="link" href="XfceHeading.html" title="XfceHeading"><span class="type">XfceHeading</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
<td>the new title for the <em class="parameter"><code>heading</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.4.0</p>
</div>
</div>
<div class="refsect1">
<a name="XfceHeading.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="XfceHeading--icon"></a><h3>The <code class="literal">"icon"</code> property</h3>
<pre class="programlisting">  "icon"                     <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>*            : Read / Write</pre>
<p>
The <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> to display as icon, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the
"icon-name" property.
</p>
<p class="since">Since 4.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="XfceHeading--icon-name"></a><h3>The <code class="literal">"icon-name"</code> property</h3>
<pre class="programlisting">  "icon-name"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
<p>
If the "icon" property value is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> this is the name of
the icon to display instead (looked up using the icon theme).
If this property is also <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or the specified icon does not
exist in the selected icon theme, no icon will be displayed.
</p>
<p>Default value: NULL</p>
<p class="since">Since 4.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="XfceHeading--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 sub title that should be displayed below the
title. May be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or the empty string to display
only the title.
</p>
<p>Default value: NULL</p>
<p class="since">Since 4.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="XfceHeading--title"></a><h3>The <code class="literal">"title"</code> property</h3>
<pre class="programlisting">  "title"                    <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 title text to display in the heading.
</p>
<p>Default value: NULL</p>
<p class="since">Since 4.4.0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.