/usr/share/gtk-doc/html/gdl-3.0/GdlDockBar.html is in libgdl-3-doc 3.8.1-2ubuntu1.
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>GdlDockBar</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.19 (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="GdlDockItem.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="widget.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">GNOME Docking Library Reference Manual</th>
<td><a accesskey="n" href="private.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GdlDockBar.synopsis" class="shortcut">Top</a>
|
<a href="#GdlDockBar.description" class="shortcut">Description</a>
|
<a href="#GdlDockBar.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GdlDockBar.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#GdlDockBar.properties" class="shortcut">Properties</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 valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GdlDockBar.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="GdlDockBar.synopsis"></a><h2>Synopsis</h2>
<a name="GdlDockBarStyle"></a><pre class="synopsis">struct <a class="link" href="GdlDockBar.html#GdlDockBar-struct" title="struct GdlDockBar">GdlDockBar</a>;
enum <a class="link" href="GdlDockBar.html#GdlDockBarStyle-enum" title="enum GdlDockBarStyle">GdlDockBarStyle</a>;
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GdlDockBar.html#gdl-dock-bar-new" title="gdl_dock_bar_new ()">gdl_dock_bar_new</a> (<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>);
<span class="returnvalue">void</span> <a class="link" href="GdlDockBar.html#gdl-dock-bar-set-orientation" title="gdl_dock_bar_set_orientation ()">gdl_dock_bar_set_orientation</a> (<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>);
<a href="/usr/share/gtk-doc/html/gtk3/gtk3-Standard-Enumerations.html#GtkOrientation"><span class="returnvalue">GtkOrientation</span></a> <a class="link" href="GdlDockBar.html#gdl-dock-bar-get-orientation" title="gdl_dock_bar_get_orientation ()">gdl_dock_bar_get_orientation</a> (<em class="parameter"><code><a class="link" href="GdlDockBar.html" title="GdlDockBar"><span class="type">GdlDockBar</span></a> *dockbar</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdlDockBar.html#gdl-dock-bar-set-style" title="gdl_dock_bar_set_style ()">gdl_dock_bar_set_style</a> (<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"><span class="type">GdlDockBarStyle</span></a> style</code></em>);
<a class="link" href="GdlDockBar.html#GdlDockBarStyle"><span class="returnvalue">GdlDockBarStyle</span></a> <a class="link" href="GdlDockBar.html#gdl-dock-bar-get-style" title="gdl_dock_bar_get_style ()">gdl_dock_bar_get_style</a> (<em class="parameter"><code><a class="link" href="GdlDockBar.html" title="GdlDockBar"><span class="type">GdlDockBar</span></a> *dockbar</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GdlDockBar.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html">GtkWidget</a>
+----<a href="/usr/share/gtk-doc/html/gtk3/GtkContainer.html">GtkContainer</a>
+----<a href="/usr/share/gtk-doc/html/gtk3/GtkBox.html">GtkBox</a>
+----GdlDockBar
</pre>
<pre class="synopsis">
GEnum
+----GdlDockBarStyle
</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.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GdlDockBar.html#GdlDockBar--dockbar-style" title='The "dockbar-style" property'>dockbar-style</a>" <a class="link" href="GdlDockBar.html#GdlDockBarStyle"><span class="type">GdlDockBarStyle</span></a> : Read / Write / Construct
"<a class="link" href="GdlDockBar.html#GdlDockBar--master" title='The "master" property'>master</a>" <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>* : Read / Write
</pre>
</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.details"></a><h2>Details</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-enum"></a><h3>enum GdlDockBarStyle</h3>
<pre class="programlisting">typedef enum {
GDL_DOCK_BAR_ICONS,
GDL_DOCK_BAR_TEXT,
GDL_DOCK_BAR_BOTH,
GDL_DOCK_BAR_AUTO
} GdlDockBarStyle;
</pre>
<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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GDL-DOCK-BAR-ICONS:CAPS"></a><span class="term"><code class="literal">GDL_DOCK_BAR_ICONS</code></span></p></td>
<td>Buttons display only icons in the dockbar.
</td>
</tr>
<tr>
<td><p><a name="GDL-DOCK-BAR-TEXT:CAPS"></a><span class="term"><code class="literal">GDL_DOCK_BAR_TEXT</code></span></p></td>
<td>Buttons display only text labels in the dockbar.
</td>
</tr>
<tr>
<td><p><a name="GDL-DOCK-BAR-BOTH:CAPS"></a><span class="term"><code class="literal">GDL_DOCK_BAR_BOTH</code></span></p></td>
<td>Buttons display text and icons in the dockbar.
</td>
</tr>
<tr>
<td><p><a name="GDL-DOCK-BAR-AUTO:CAPS"></a><span class="term"><code class="literal">GDL_DOCK_BAR_AUTO</code></span></p></td>
<td>identical to <em class="parameter"><code>GDL_DOCK_BAR_BOTH</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>master</code></em> :</span></p></td>
<td>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. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The newly created dock bar.</td>
</tr>
</tbody>
</table></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" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<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. 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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dockbar</code></em> :</span></p></td>
<td>a <a class="link" href="GdlDockBar.html" title="GdlDockBar"><span class="type">GdlDockBar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>orientation</code></em> :</span></p></td>
<td>the new orientation</td>
</tr>
</tbody>
</table></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" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<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. 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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dockbar</code></em> :</span></p></td>
<td>a <a class="link" href="GdlDockBar.html" title="GdlDockBar"><span class="type">GdlDockBar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the orientation of the <em class="parameter"><code>docbar</code></em>
</td>
</tr>
</tbody>
</table></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"><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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dockbar</code></em> :</span></p></td>
<td>a <a class="link" href="GdlDockBar.html" title="GdlDockBar"><span class="type">GdlDockBar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>style</code></em> :</span></p></td>
<td>the new style</td>
</tr>
</tbody>
</table></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"><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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dockbar</code></em> :</span></p></td>
<td>a <a class="link" href="GdlDockBar.html" title="GdlDockBar"><span class="type">GdlDockBar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the style of the <em class="parameter"><code>docbar</code></em>
</td>
</tr>
</tbody>
</table></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"><span class="type">GdlDockBarStyle</span></a> : Read / Write / Construct</pre>
<p>Dockbar style to show items on it.</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>* : Read / Write</pre>
<p>
The <a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a> object attached to the dockbar.
</p>
</div>
</div>
<div class="refsect1">
<a name="GdlDockBar.see-also"></a><h2>See Also</h2>
<a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|