libgdl-3-doc 3.18.0-1 / usr / share / gtk-doc / html / gdl-3.0 / GdlDockBar.html

This file is indexed.

/usr/share/gtk-doc/html/gdl-3.0/GdlDockBar.html is in libgdl-3-doc 3.18.0-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
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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdlDockBar: GNOME Docking Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GNOME Docking Library Reference Manual">
<link rel="up" href="widget.html" title="Widgets">
<link rel="prev" href="GdlDockItem.html" title="GdlDockItem">
<link rel="next" href="private.html" title="Private Classes">
<meta name="generator" content="GTK-Doc V1.24 (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="#GdlDockBar.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GdlDockBar.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GdlDockBar.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GdlDockBar.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="widget.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GdlDockItem.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="private.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GdlDockBar"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdlDockBar.top_of_page"></a>GdlDockBar</span></h2>
<p>GdlDockBar — A docking bar</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GdlDockBar.stability-level"></a><h2>Stability Level</h2>
<acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.

The Unstable interface level is a warning that these interfaces are  subject to
change without warning and should not be used in unbundled products.

Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="GdlDockBar.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdlDockBar.html#gdl-dock-bar-new" title="gdl_dock_bar_new ()">gdl_dock_bar_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GdlDockBar.html#gdl-dock-bar-set-orientation" title="gdl_dock_bar_set_orientation ()">gdl_dock_bar_set_orientation</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk3/gtk3-Standard-Enumerations.html#GtkOrientation"><span class="returnvalue">GtkOrientation</span></a>
</td>
<td class="function_name">
<a class="link" href="GdlDockBar.html#gdl-dock-bar-get-orientation" title="gdl_dock_bar_get_orientation ()">gdl_dock_bar_get_orientation</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GdlDockBar.html#gdl-dock-bar-set-style" title="gdl_dock_bar_set_style ()">gdl_dock_bar_set_style</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GdlDockBar.html#GdlDockBarStyle" title="enum GdlDockBarStyle"><span class="returnvalue">GdlDockBarStyle</span></a>
</td>
<td class="function_name">
<a class="link" href="GdlDockBar.html#gdl-dock-bar-get-style" title="gdl_dock_bar_get_style ()">gdl_dock_bar_get_style</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdlDockBar.properties"></a><h2>Properties</h2>
<div class="informaltable"><table 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"><a class="link" href="GdlDockBar.html#GdlDockBarStyle" title="enum GdlDockBarStyle"><span class="type">GdlDockBarStyle</span></a></td>
<td class="property_name"><a class="link" href="GdlDockBar.html#GdlDockBar--dockbar-style" title="The “dockbar-style” property">dockbar-style</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *</td>
<td class="property_name"><a class="link" href="GdlDockBar.html#GdlDockBar--master" title="The “master” property">master</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdlDockBar.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GdlDockBar.html#GdlDockBar-struct" title="struct GdlDockBar">GdlDockBar</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GdlDockBar.html#GdlDockBarStyle" title="enum GdlDockBarStyle">GdlDockBarStyle</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdlDockBar.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GEnum
    <span class="lineart">╰──</span> GdlDockBarStyle
    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html">GtkWidget</a>
            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkContainer.html">GtkContainer</a>
                <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkBox.html">GtkBox</a>
                    <span class="lineart">╰──</span> GdlDockBar
</pre>
</div>
<div class="refsect1">
<a name="GdlDockBar.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GdlDockBar implements
 AtkImplementorIface,  <a href="/usr/share/gtk-doc/html/gtk3/GtkBuildable.html">GtkBuildable</a> and  <a href="/usr/share/gtk-doc/html/gtk3/gtk3-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
</div>
<div class="refsect1">
<a name="GdlDockBar.description"></a><h2>Description</h2>
<p>This docking bar is a widget containing a button for each iconified
<a class="link" href="GdlDockItem.html" title="GdlDockItem"><span class="type">GdlDockItem</span></a> widget. The widget can be re-opened by clicking on it.</p>
<p>A dock bar is associated with one <a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a> and will get all iconified
widgets of this master. This can includes widgets from several <a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a>
objects.</p>
</div>
<div class="refsect1">
<a name="GdlDockBar.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gdl-dock-bar-new"></a><h3>gdl_dock_bar_new ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
gdl_dock_bar_new (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *master</code></em>);</pre>
<p>Creates a new GDL dock bar. If a <a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</span></a> is used, the dock bar will
be associated with the master of this object.</p>
<div class="refsect3">
<a name="id-1.2.3.6.10.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>master</p></td>
<td class="parameter_description"><p> The associated <a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a> or <a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</span></a> object. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.6.10.2.6"></a><h4>Returns</h4>
<p> The newly created dock bar.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-bar-set-orientation"></a><h3>gdl_dock_bar_set_orientation ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdl_dock_bar_set_orientation (<em class="parameter"><code><a class="link" href="GdlDockBar.html" title="GdlDockBar"><span class="type">GdlDockBar</span></a> *dockbar</code></em>,
                              <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/gtk3-Standard-Enumerations.html#GtkOrientation"><span class="type">GtkOrientation</span></a> orientation</code></em>);</pre>
<div class="warning">
<p><code class="literal">gdl_dock_bar_set_orientation</code> has been deprecated since version 3.6 and should not be used in newly-written code.</p>
<p>Use <a href="/usr/share/gtk-doc/html/gtk3/gtk3-Orientable.html#gtk-orientable-set-orientation"><code class="function">gtk_orientable_set_orientation()</code></a> instead.</p>
</div>
<p>Set the orientation of the <em class="parameter"><code>dockbar</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.3.6.10.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>dockbar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdlDockBar.html" title="GdlDockBar"><span class="type">GdlDockBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>orientation</p></td>
<td class="parameter_description"><p>the new orientation</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-bar-get-orientation"></a><h3>gdl_dock_bar_get_orientation ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/gtk3-Standard-Enumerations.html#GtkOrientation"><span class="returnvalue">GtkOrientation</span></a>
gdl_dock_bar_get_orientation (<em class="parameter"><code><a class="link" href="GdlDockBar.html" title="GdlDockBar"><span class="type">GdlDockBar</span></a> *dockbar</code></em>);</pre>
<div class="warning">
<p><code class="literal">gdl_dock_bar_get_orientation</code> has been deprecated since version 3.6 and should not be used in newly-written code.</p>
<p>Use <a href="/usr/share/gtk-doc/html/gtk3/gtk3-Orientable.html#gtk-orientable-get-orientation"><code class="function">gtk_orientable_get_orientation()</code></a> instead.</p>
</div>
<p>Retrieves the orientation of the <em class="parameter"><code>dockbar</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.3.6.10.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>dockbar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdlDockBar.html" title="GdlDockBar"><span class="type">GdlDockBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.6.10.4.7"></a><h4>Returns</h4>
<p> the orientation of the <em class="parameter"><code>docbar</code></em>
</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-bar-set-style"></a><h3>gdl_dock_bar_set_style ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdl_dock_bar_set_style (<em class="parameter"><code><a class="link" href="GdlDockBar.html" title="GdlDockBar"><span class="type">GdlDockBar</span></a> *dockbar</code></em>,
                        <em class="parameter"><code><a class="link" href="GdlDockBar.html#GdlDockBarStyle" title="enum GdlDockBarStyle"><span class="type">GdlDockBarStyle</span></a> style</code></em>);</pre>
<p>Set the style of the <em class="parameter"><code>dockbar</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.3.6.10.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>dockbar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdlDockBar.html" title="GdlDockBar"><span class="type">GdlDockBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>style</p></td>
<td class="parameter_description"><p>the new style</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-bar-get-style"></a><h3>gdl_dock_bar_get_style ()</h3>
<pre class="programlisting"><a class="link" href="GdlDockBar.html#GdlDockBarStyle" title="enum GdlDockBarStyle"><span class="returnvalue">GdlDockBarStyle</span></a>
gdl_dock_bar_get_style (<em class="parameter"><code><a class="link" href="GdlDockBar.html" title="GdlDockBar"><span class="type">GdlDockBar</span></a> *dockbar</code></em>);</pre>
<p>Retrieves the style of the <em class="parameter"><code>dockbar</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.3.6.10.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>dockbar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdlDockBar.html" title="GdlDockBar"><span class="type">GdlDockBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.6.10.6.6"></a><h4>Returns</h4>
<p> the style of the <em class="parameter"><code>docbar</code></em>
</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GdlDockBar.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdlDockBar-struct"></a><h3>struct GdlDockBar</h3>
<pre class="programlisting">struct GdlDockBar;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GdlDockBarStyle"></a><h3>enum GdlDockBarStyle</h3>
<p>Used to customize the appearance of a <a class="link" href="GdlDockBar.html" title="GdlDockBar"><span class="type">GdlDockBar</span></a>.</p>
<div class="refsect3">
<a name="id-1.2.3.6.11.3.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GDL-DOCK-BAR-ICONS:CAPS"></a>GDL_DOCK_BAR_ICONS</p></td>
<td class="enum_member_description">
<p>Buttons display only icons in the dockbar.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDL-DOCK-BAR-TEXT:CAPS"></a>GDL_DOCK_BAR_TEXT</p></td>
<td class="enum_member_description">
<p>Buttons display only text labels in the dockbar.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDL-DOCK-BAR-BOTH:CAPS"></a>GDL_DOCK_BAR_BOTH</p></td>
<td class="enum_member_description">
<p>Buttons display text and icons in the dockbar.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDL-DOCK-BAR-AUTO:CAPS"></a>GDL_DOCK_BAR_AUTO</p></td>
<td class="enum_member_description">
<p>identical to <em class="parameter"><code>GDL_DOCK_BAR_BOTH</code></em>
.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GdlDockBar.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GdlDockBar--dockbar-style"></a><h3>The <code class="literal">“dockbar-style”</code> property</h3>
<pre class="programlisting">  “dockbar-style”            <a class="link" href="GdlDockBar.html#GdlDockBarStyle" title="enum GdlDockBarStyle"><span class="type">GdlDockBarStyle</span></a></pre>
<p>Dockbar style to show items on it.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: GDL_DOCK_BAR_BOTH</p>
</div>
<hr>
<div class="refsect2">
<a name="GdlDockBar--master"></a><h3>The <code class="literal">“master”</code> property</h3>
<pre class="programlisting">  “master”                   <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *</pre>
<p>The <a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a> object attached to the dockbar.</p>
<p>Flags: Read / Write</p>
</div>
</div>
<div class="refsect1">
<a name="GdlDockBar.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.