libdazzle-doc 3.28.1-1 / usr / share / gtk-doc / html / libdazzle / libdazzle-dzl-path-element.html

This file is indexed.

/usr/share/gtk-doc/html/libdazzle/libdazzle-dzl-path-element.html is in libdazzle-doc 3.28.1-1.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>dzl-path-element: Dazzle Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Dazzle Reference Manual">
<link rel="up" href="dazzle-pathbar.html" title="Part XI. Path Bars">
<link rel="prev" href="libdazzle-dzl-path-bar.html" title="dzl-path-bar">
<link rel="next" href="libdazzle-dzl-path.html" title="dzl-path">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libdazzle-dzl-path-element.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#libdazzle-dzl-path-element.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#libdazzle-dzl-path-element.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="dazzle-pathbar.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libdazzle-dzl-path-bar.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libdazzle-dzl-path.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libdazzle-dzl-path-element"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libdazzle-dzl-path-element.top_of_page"></a>dzl-path-element</span></h2>
<p>dzl-path-element</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libdazzle-dzl-path-element.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="libdazzle-dzl-path-element.html#DzlPathElement"><span class="returnvalue">DzlPathElement</span></a> *
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-path-element.html#dzl-path-element-new" title="dzl_path_element_new ()">dzl_path_element_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-path-element.html#dzl-path-element-get-title" title="dzl_path_element_get_title ()">dzl_path_element_get_title</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-path-element.html#dzl-path-element-get-id" title="dzl_path_element_get_id ()">dzl_path_element_get_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-path-element.html#dzl-path-element-get-icon-name" title="dzl_path_element_get_icon_name ()">dzl_path_element_get_icon_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-path-element.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="libdazzle-dzl-path-element.html#DzlPathElement--icon-name" title="The “icon-name” property">icon-name</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="libdazzle-dzl-path-element.html#DzlPathElement--id" title="The “id” property">id</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="libdazzle-dzl-path-element.html#DzlPathElement--title" title="The “title” property">title</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<a name="DzlPathElement"></a><div class="refsect1">
<a name="libdazzle-dzl-path-element.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libdazzle-dzl-path-element.html#DZL-TYPE-PATH-ELEMENT:CAPS" title="DZL_TYPE_PATH_ELEMENT">DZL_TYPE_PATH_ELEMENT</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libdazzle-dzl-path-element.html#DzlPathElement-struct" title="DzlPathElement">DzlPathElement</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-path-element.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> DzlPathElement
</pre>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-path-element.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-path-element.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="dzl-path-element-new"></a><h3>dzl_path_element_new ()</h3>
<pre class="programlisting"><a class="link" href="libdazzle-dzl-path-element.html#DzlPathElement"><span class="returnvalue">DzlPathElement</span></a> *
dzl_path_element_new (<em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>,
                      <em class="parameter"><code>const <span class="type">gchar</span> *icon_name</code></em>,
                      <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>);</pre>
<p>Creates a new path element for an <a class="link" href="libdazzle-dzl-path.html#DzlPath"><span class="type">DzlPath</span></a>.</p>
<div class="refsect3">
<a name="dzl-path-element-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>id</p></td>
<td class="parameter_description"><p>An id for the path element. </p></td>
<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>
</tr>
<tr>
<td class="parameter_name"><p>icon_name</p></td>
<td class="parameter_description"><p>An optional icon name for the element. </p></td>
<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>
</tr>
<tr>
<td class="parameter_name"><p>title</p></td>
<td class="parameter_description"><p>The title of the element.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dzl-path-element-new.returns"></a><h4>Returns</h4>
<p>A <a class="link" href="libdazzle-dzl-path-element.html#DzlPathElement"><span class="type">DzlPathElement</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: 3.26</p>
</div>
<hr>
<div class="refsect2">
<a name="dzl-path-element-get-title"></a><h3>dzl_path_element_get_title ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
dzl_path_element_get_title (<em class="parameter"><code><a class="link" href="libdazzle-dzl-path-element.html#DzlPathElement"><span class="type">DzlPathElement</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="libdazzle-dzl-path-element.html#DzlPathElement--title" title="The “title” property"><span class="type">“title”</span></a> property. This is used by the
path bar to display text representing the element of the path.</p>
<div class="refsect3">
<a name="dzl-path-element-get-title.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="libdazzle-dzl-path-element.html#DzlPathElement"><span class="type">DzlPathElement</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dzl-path-element-get-title.returns"></a><h4>Returns</h4>
<p>The title for the <a class="link" href="libdazzle-dzl-path-element.html#DzlPathElement"><span class="type">DzlPathElement</span></a>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<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></p>
</div>
<p class="since">Since: 3.26</p>
</div>
<hr>
<div class="refsect2">
<a name="dzl-path-element-get-id"></a><h3>dzl_path_element_get_id ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
dzl_path_element_get_id (<em class="parameter"><code><a class="link" href="libdazzle-dzl-path-element.html#DzlPathElement"><span class="type">DzlPathElement</span></a> *self</code></em>);</pre>
<p>Gets the id for the element. Generally, a path is built of
multiple elements and each element should have an id that
is useful to the application that it using it. You might store
the name of a directory, or some other key as the id.</p>
<div class="refsect3">
<a name="dzl-path-element-get-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="libdazzle-dzl-path-element.html#DzlPathElement"><span class="type">DzlPathElement</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dzl-path-element-get-id.returns"></a><h4>Returns</h4>
<p>The id for the <a class="link" href="libdazzle-dzl-path-element.html#DzlPathElement"><span class="type">DzlPathElement</span></a>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: 3.26</p>
</div>
<hr>
<div class="refsect2">
<a name="dzl-path-element-get-icon-name"></a><h3>dzl_path_element_get_icon_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
dzl_path_element_get_icon_name (<em class="parameter"><code><a class="link" href="libdazzle-dzl-path-element.html#DzlPathElement"><span class="type">DzlPathElement</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="libdazzle-dzl-path-element.html#DzlPathElement--icon-name" title="The “icon-name” property"><span class="type">“icon-name”</span></a> property. This is used by the
path bar to display an icon next to the element of the path.</p>
<div class="refsect3">
<a name="dzl-path-element-get-icon-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="libdazzle-dzl-path-element.html#DzlPathElement"><span class="type">DzlPathElement</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dzl-path-element-get-icon-name.returns"></a><h4>Returns</h4>
<p>The icon-name for the <a class="link" href="libdazzle-dzl-path-element.html#DzlPathElement"><span class="type">DzlPathElement</span></a>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<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></p>
</div>
<p class="since">Since: 3.26</p>
</div>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-path-element.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="DZL-TYPE-PATH-ELEMENT:CAPS"></a><h3>DZL_TYPE_PATH_ELEMENT</h3>
<pre class="programlisting">#define DZL_TYPE_PATH_ELEMENT (dzl_path_element_get_type())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DzlPathElement-struct"></a><h3>DzlPathElement</h3>
<pre class="programlisting">typedef struct _DzlPathElement DzlPathElement;</pre>
</div>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-path-element.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="DzlPathElement--icon-name"></a><h3>The <code class="literal">“icon-name”</code> property</h3>
<pre class="programlisting">  “icon-name”                <span class="type">gchar</span> *</pre>
<p>The icon-name of the icon to display next to the path element
in the path bar. Set to <code class="literal">NULL</code> for no icon.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
<p class="since">Since: 3.26</p>
</div>
<hr>
<div class="refsect2">
<a name="DzlPathElement--id"></a><h3>The <code class="literal">“id”</code> property</h3>
<pre class="programlisting">  “id”                       <span class="type">gchar</span> *</pre>
<p>The id property is an application specific identifier for the
element within the path.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
<p class="since">Since: 3.26</p>
</div>
<hr>
<div class="refsect2">
<a name="DzlPathElement--title"></a><h3>The <code class="literal">“title”</code> property</h3>
<pre class="programlisting">  “title”                    <span class="type">gchar</span> *</pre>
<p>The title property should contain the display text that should
be shown to represent the element in the <a class="link" href="libdazzle-dzl-path-bar.html#DzlPathBar"><span class="type">DzlPathBar</span></a>.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
<p class="since">Since: 3.26</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.