/usr/share/gtk-doc/html/gdl-3.0/GdlDockMaster.html is in libgdl-3-doc 3.28.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 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdlDockMaster: GNOME Docking Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GNOME Docking Library Reference Manual">
<link rel="up" href="core.html" title="Core Classes">
<link rel="prev" href="GdlDockObject.html" title="GdlDockObject">
<link rel="next" href="GdlDockLayout.html" title="GdlDockLayout">
<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="#GdlDockMaster.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GdlDockMaster.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GdlDockMaster.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#GdlDockMaster.signals" class="shortcut">Signals</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="core.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GdlDockObject.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GdlDockLayout.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GdlDockMaster"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdlDockMaster.top_of_page"></a>GdlDockMaster</span></h2>
<p>GdlDockMaster — Manage all dock widgets</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GdlDockMaster.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="GdlDockMaster.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="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="GdlDockMaster.html#GDL-DOCK-OBJECT-GET-MASTER:CAPS" title="GDL_DOCK_OBJECT_GET_MASTER()">GDL_DOCK_OBJECT_GET_MASTER</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="GdlDockMaster.html#gdl-dock-master-add" title="gdl_dock_master_add ()">gdl_dock_master_add</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="GdlDockMaster.html#gdl-dock-master-remove" title="gdl_dock_master_remove ()">gdl_dock_master_remove</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="GdlDockMaster.html#gdl-dock-master-set-controller" title="gdl_dock_master_set_controller ()">gdl_dock_master_set_controller</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="returnvalue">GdlDockObject</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdlDockMaster.html#gdl-dock-master-get-controller" title="gdl_dock_master_get_controller ()">gdl_dock_master_get_controller</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="returnvalue">GdlDockObject</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdlDockMaster.html#gdl-dock-master-get-object" title="gdl_dock_master_get_object ()">gdl_dock_master_get_object</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="GdlDockMaster.html#gdl-dock-master-foreach" title="gdl_dock_master_foreach ()">gdl_dock_master_foreach</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="GdlDockMaster.html#gdl-dock-master-foreach-toplevel" title="gdl_dock_master_foreach_toplevel ()">gdl_dock_master_foreach_toplevel</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdlDockMaster.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">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GdlDockMaster.html#GdlDockMaster--default-title" title="The “default-title” property">default-title</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="GdlDockMaster.html#GdlDockMaster--locked" title="The “locked” property">locked</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="GdlDockMaster.html#GdlSwitcherStyle" title="enum GdlSwitcherStyle"><span class="type">GdlSwitcherStyle</span></a></td>
<td class="property_name"><a class="link" href="GdlDockMaster.html#GdlDockMaster--switcher-style" title="The “switcher-style” property">switcher-style</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="../gtk3/gtk3-Standard-Enumerations.html#GtkPositionType"><span class="type">GtkPositionType</span></a></td>
<td class="property_name"><a class="link" href="GdlDockMaster.html#GdlDockMaster--tab-pos" title="The “tab-pos” property">tab-pos</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GdlDockMaster.html#GdlDockMaster--tab-reorderable" title="The “tab-reorderable” property">tab-reorderable</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdlDockMaster.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GdlDockMaster.html#GdlDockMaster-layout-changed" title="The “layout-changed” signal">layout-changed</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdlDockMaster.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="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GdlDockMaster.html#GdlDockMaster-struct" title="struct GdlDockMaster">GdlDockMaster</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GdlDockMaster.html#GdlSwitcherStyle" title="enum GdlSwitcherStyle">GdlSwitcherStyle</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdlDockMaster.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a>
<span class="lineart">╰──</span> GdlSwitcherStyle
<a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> GdlDockMaster
</pre>
</div>
<div class="refsect1">
<a name="GdlDockMaster.description"></a><h2>Description</h2>
<p>For the toplevel docks to be able to interact with each other, when the user
drags items from one place to another, they're all kept in a user-invisible
and automatic object called the master. To participate in docking operations
every <a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</span></a> must have the same master, the binding to the master is
done automatically.</p>
<p>The master also keeps track of the manual items,
mostly those created with gdl_dock_*_new functions which are in the dock.
This is so the user doesn't need to keep track of them, but can perform
operations like hiding and such.</p>
<p>The master is responsible for creating automatically compound widgets.
When the user drops a widget on a simple one, a notebook or a paned compound
widget containing both widgets is created and replace it.
Such widgets are hidden automatically when they have less than two
children.</p>
<p>One of the top level dock item of the master is considered as the controller.
This controller is an user visible representation of the master. A floating
dock widget will use a dock object having the same properties than this
controller. You can show or hide all dock widgets of the master by showing
or hiding the controller. This controller is assigned to the master
automatically. If the controller dock widget is removed, a new top level dock
widget will be automatically used as controller. If there is no other dock
widget, the master will be destroyed.</p>
</div>
<div class="refsect1">
<a name="GdlDockMaster.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GDL-DOCK-OBJECT-GET-MASTER:CAPS"></a><h3>GDL_DOCK_OBJECT_GET_MASTER()</h3>
<pre class="programlisting">#define GDL_DOCK_OBJECT_GET_MASTER(object)</pre>
<div class="warning">
<p><code class="literal">GDL_DOCK_OBJECT_GET_MASTER</code> has been deprecated since version 3.6 and should not be used in newly-written code.</p>
<p>Use <code class="function">gdl_dock_object_get_master()</code></p>
</div>
<p>Retrieve the <a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a> object managing the object.</p>
<div class="refsect3">
<a name="GDL-DOCK-OBJECT-GET-MASTER.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>object</p></td>
<td class="parameter_description"><p>A <a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-master-add"></a><h3>gdl_dock_master_add ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdl_dock_master_add (<em class="parameter"><code><a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a> *master</code></em>,
<em class="parameter"><code><a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</span></a> *object</code></em>);</pre>
<p>Add a new dock widget to the master.</p>
<div class="refsect3">
<a name="gdl-dock-master-add.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>master</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-master-remove"></a><h3>gdl_dock_master_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdl_dock_master_remove (<em class="parameter"><code><a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a> *master</code></em>,
<em class="parameter"><code><a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</span></a> *object</code></em>);</pre>
<p>Remove one dock widget from the master.</p>
<div class="refsect3">
<a name="gdl-dock-master-remove.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>master</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-master-set-controller"></a><h3>gdl_dock_master_set_controller ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdl_dock_master_set_controller (<em class="parameter"><code><a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a> *master</code></em>,
<em class="parameter"><code><a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</span></a> *new_controller</code></em>);</pre>
<p>Set a new controller. The controller must be a top level <a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</span></a>.</p>
<div class="refsect3">
<a name="gdl-dock-master-set-controller.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>master</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>new_controller</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-master-get-controller"></a><h3>gdl_dock_master_get_controller ()</h3>
<pre class="programlisting"><a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="returnvalue">GdlDockObject</span></a> *
gdl_dock_master_get_controller (<em class="parameter"><code><a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a> *master</code></em>);</pre>
<p>Retrieves the <a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</span></a> acting as the controller.</p>
<div class="refsect3">
<a name="gdl-dock-master-get-controller.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>master</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdl-dock-master-get-controller.returns"></a><h4>Returns</h4>
<p>A <a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</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>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-master-get-object"></a><h3>gdl_dock_master_get_object ()</h3>
<pre class="programlisting"><a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="returnvalue">GdlDockObject</span></a> *
gdl_dock_master_get_object (<em class="parameter"><code><a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a> *master</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *nick_name</code></em>);</pre>
<p>Looks for a <a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</span></a> named <em class="parameter"><code>nick_name</code></em>
.</p>
<div class="refsect3">
<a name="gdl-dock-master-get-object.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>master</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>nick_name</p></td>
<td class="parameter_description"><p>the name of the dock widget.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdl-dock-master-get-object.returns"></a><h4>Returns</h4>
<p>A <a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</span></a> named <em class="parameter"><code>nick_name</code></em>
or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if it does not exist. </p>
<p><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-master-foreach"></a><h3>gdl_dock_master_foreach ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdl_dock_master_foreach (<em class="parameter"><code><a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a> *master</code></em>,
<em class="parameter"><code><a href="../glib/glib-Doubly-Linked-Lists.html#GFunc"><span class="type">GFunc</span></a> function</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>Call <em class="parameter"><code>function</code></em>
on each dock widget of the master.</p>
<div class="refsect3">
<a name="gdl-dock-master-foreach.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>master</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>function</p></td>
<td class="parameter_description"><p>the function to call with each element's data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data to pass to the function</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-master-foreach-toplevel"></a><h3>gdl_dock_master_foreach_toplevel ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdl_dock_master_foreach_toplevel (<em class="parameter"><code><a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a> *master</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> include_controller</code></em>,
<em class="parameter"><code><a href="../glib/glib-Doubly-Linked-Lists.html#GFunc"><span class="type">GFunc</span></a> function</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>Call <em class="parameter"><code>function</code></em>
on each top level dock widget of the master, including or not
the controller.</p>
<div class="refsect3">
<a name="gdl-dock-master-foreach-toplevel.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>master</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>include_controller</p></td>
<td class="parameter_description"><p><a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to include the controller</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>function</p></td>
<td class="parameter_description"><p>the function to call with each element's data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data to pass to the function</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GdlDockMaster.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdlDockMaster-struct"></a><h3>struct GdlDockMaster</h3>
<pre class="programlisting">struct GdlDockMaster;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GdlSwitcherStyle"></a><h3>enum GdlSwitcherStyle</h3>
<p>Used to customize the appearance of the tabs in <a class="link" href="GdlDockNotebook.html" title="GdlDockNotebook"><span class="type">GdlDockNotebook</span></a>.</p>
<div class="refsect3">
<a name="GdlSwitcherStyle.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" 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-SWITCHER-STYLE-TEXT:CAPS"></a>GDL_SWITCHER_STYLE_TEXT</p></td>
<td class="enum_member_description">
<p>Tabs display only text labels.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDL-SWITCHER-STYLE-ICON:CAPS"></a>GDL_SWITCHER_STYLE_ICON</p></td>
<td class="enum_member_description">
<p>Tabs display only icons.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDL-SWITCHER-STYLE-BOTH:CAPS"></a>GDL_SWITCHER_STYLE_BOTH</p></td>
<td class="enum_member_description">
<p>Tabs display text and icons.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDL-SWITCHER-STYLE-TOOLBAR:CAPS"></a>GDL_SWITCHER_STYLE_TOOLBAR</p></td>
<td class="enum_member_description">
<p>Same as <em class="parameter"><code>GDL_SWITCHER_STYLE_BOTH</code></em>
.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDL-SWITCHER-STYLE-TABS:CAPS"></a>GDL_SWITCHER_STYLE_TABS</p></td>
<td class="enum_member_description">
<p>Tabs display like notebook tabs.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDL-SWITCHER-STYLE-NONE:CAPS"></a>GDL_SWITCHER_STYLE_NONE</p></td>
<td class="enum_member_description">
<p>Do not display tabs.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GdlDockMaster.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GdlDockMaster--default-title"></a><h3>The <code class="literal">“default-title”</code> property</h3>
<pre class="programlisting"> “default-title” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Default title for newly created floating docks.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GdlDockMaster--locked"></a><h3>The <code class="literal">“locked”</code> property</h3>
<pre class="programlisting"> “locked” <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>If is set to 1, all the dock items bound to the master are locked; if it's 0, all are unlocked; -1 indicates inconsistency among the items.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [-1,1]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GdlDockMaster--switcher-style"></a><h3>The <code class="literal">“switcher-style”</code> property</h3>
<pre class="programlisting"> “switcher-style” <a class="link" href="GdlDockMaster.html#GdlSwitcherStyle" title="enum GdlSwitcherStyle"><span class="type">GdlSwitcherStyle</span></a></pre>
<p>Switcher buttons style.</p>
<p>Flags: Read / Write</p>
<p>Default value: GDL_SWITCHER_STYLE_BOTH</p>
</div>
<hr>
<div class="refsect2">
<a name="GdlDockMaster--tab-pos"></a><h3>The <code class="literal">“tab-pos”</code> property</h3>
<pre class="programlisting"> “tab-pos” <a href="../gtk3/gtk3-Standard-Enumerations.html#GtkPositionType"><span class="type">GtkPositionType</span></a></pre>
<p>Which side of the notebook holds the tabs.</p>
<p>Flags: Read / Write</p>
<p>Default value: GTK_POS_BOTTOM</p>
</div>
<hr>
<div class="refsect2">
<a name="GdlDockMaster--tab-reorderable"></a><h3>The <code class="literal">“tab-reorderable”</code> property</h3>
<pre class="programlisting"> “tab-reorderable” <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether the tab is reorderable by user action.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
</div>
<div class="refsect1">
<a name="GdlDockMaster.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GdlDockMaster-layout-changed"></a><h3>The <code class="literal">“layout-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a> *gdldockmaster,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Signals that the layout has changed, one or more widgets have been moved,
added or removed.</p>
<div class="refsect3">
<a name="GdlDockMaster-layout-changed.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>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
<div class="refsect1">
<a name="GdlDockMaster.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</span></a>, <a class="link" href="GdlDockNotebook.html" title="GdlDockNotebook"><span class="type">GdlDockNotebook</span></a>, <a class="link" href="GdlDockPaned.html" title="GdlDockPaned"><span class="type">GdlDockPaned</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|