This file is indexed.

/usr/share/gtk-doc/html/gdl-3.0/GdlDock.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
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdlDock</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="widget.html" title="Widgets">
<link rel="next" href="GdlDockNotebook.html" title="GdlDockNotebook">
<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="widget.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="GdlDockNotebook.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GdlDock.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GdlDock.description" class="shortcut">Description</a>
                   | 
                  <a href="#GdlDock.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GdlDock.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#GdlDock.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#GdlDock.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GdlDock"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdlDock.top_of_page"></a>GdlDock</span></h2>
<p>GdlDock — A docking area widget.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GdlDock.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="GdlDock.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="GdlDock.html#GdlDock-struct" title="struct GdlDock">GdlDock</a>;
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GdlDock.html#gdl-dock-new" title="gdl_dock_new ()">gdl_dock_new</a>                        (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GdlDock.html#gdl-dock-new-from" title="gdl_dock_new_from ()">gdl_dock_new_from</a>                   (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *original</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> floating</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GdlDock.html#gdl-dock-add-item" title="gdl_dock_add_item ()">gdl_dock_add_item</a>                   (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GdlDockItem.html" title="GdlDockItem"><span class="type">GdlDockItem</span></a> *item</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GdlDockObject.html#GdlDockPlacement"><span class="type">GdlDockPlacement</span></a> placement</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GdlDock.html#gdl-dock-add-floating-item" title="gdl_dock_add_floating_item ()">gdl_dock_add_floating_item</a>          (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GdlDockItem.html" title="GdlDockItem"><span class="type">GdlDockItem</span></a> *item</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GdlDock.html#gdl-dock-hide-preview" title="gdl_dock_hide_preview ()">gdl_dock_hide_preview</a>               (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GdlDock.html#gdl-dock-show-preview" title="gdl_dock_show_preview ()">gdl_dock_show_preview</a>               (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gdk3/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *rect</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GdlDock.html#gdl-dock-set-skip-taskbar" title="gdl_dock_set_skip_taskbar ()">gdl_dock_set_skip_taskbar</a>           (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> skip</code></em>);
<a class="link" href="GdlDockItem.html" title="GdlDockItem"><span class="returnvalue">GdlDockItem</span></a> *       <a class="link" href="GdlDock.html#gdl-dock-get-item-by-name" title="gdl_dock_get_item_by_name ()">gdl_dock_get_item_by_name</a>           (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="GdlDock.html#gdl-dock-get-named-items" title="gdl_dock_get_named_items ()">gdl_dock_get_named_items</a>            (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</code></em>);
<a class="link" href="GdlDockPlaceholder.html" title="GdlDockPlaceHolder"><span class="returnvalue">GdlDockPlaceholder</span></a> * <a class="link" href="GdlDock.html#gdl-dock-get-placeholder-by-name" title="gdl_dock_get_placeholder_by_name ()">gdl_dock_get_placeholder_by_name</a>   (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
<a class="link" href="GdlDock.html" title="GdlDock"><span class="returnvalue">GdlDock</span></a> *           <a class="link" href="GdlDock.html#gdl-dock-object-get-toplevel" title="gdl_dock_object_get_toplevel ()">gdl_dock_object_get_toplevel</a>        (<em class="parameter"><code><a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</span></a> *object</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GdlDock.html#gdl-dock-xor-rect" title="gdl_dock_xor_rect ()">gdl_dock_xor_rect</a>                   (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gdk3/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *rect</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GdlDock.html#gdl-dock-xor-rect-hide" title="gdl_dock_xor_rect_hide ()">gdl_dock_xor_rect_hide</a>              (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GdlDock.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 class="link" href="GdlDockObject.html" title="GdlDockObject">GdlDockObject</a>
                           +----GdlDock
</pre>
</div>
<div class="refsect1">
<a name="GdlDock.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GdlDock implements
 AtkImplementorIface and  <a href="/usr/share/gtk-doc/html/gtk3/GtkBuildable.html">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GdlDock.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="GdlDock.html#GdlDock--default-title" title='The "default-title" property'>default-title</a>"            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  "<a class="link" href="GdlDock.html#GdlDock--floating" title='The "floating" property'>floating</a>"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct Only
  "<a class="link" href="GdlDock.html#GdlDock--floatx" title='The "floatx" property'>floatx</a>"                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
  "<a class="link" href="GdlDock.html#GdlDock--floaty" title='The "floaty" property'>floaty</a>"                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
  "<a class="link" href="GdlDock.html#GdlDock--height" title='The "height" property'>height</a>"                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
  "<a class="link" href="GdlDock.html#GdlDock--skip-taskbar" title='The "skip-taskbar" property'>skip-taskbar</a>"             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct
  "<a class="link" href="GdlDock.html#GdlDock--width" title='The "width" property'>width</a>"                    <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
</pre>
</div>
<div class="refsect1">
<a name="GdlDock.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="GdlDock.html#GdlDock-layout-changed" title='The "layout-changed" signal'>layout-changed</a>"                                 : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="GdlDock.description"></a><h2>Description</h2>
<p>
A <a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> is the toplevel widget which in turn hold a tree of <a class="link" href="GdlDockItem.html" title="GdlDockItem"><span class="type">GdlDockItem</span></a>
widgets.
</p>
<p>
Several dock widgets can exchange widgets if they share the same master.
</p>
</div>
<div class="refsect1">
<a name="GdlDock.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GdlDock-struct"></a><h3>struct GdlDock</h3>
<pre class="programlisting">struct GdlDock;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-new"></a><h3>gdl_dock_new ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         gdl_dock_new                        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Create a new dock.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> widget. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-new-from"></a><h3>gdl_dock_new_from ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         gdl_dock_new_from                   (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *original</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> floating</code></em>);</pre>
<p>
Create a new dock widget having the same master than <em class="parameter"><code>original</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>original</code></em> :</span></p></td>
<td>The original <a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>floating</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to create a floating dock</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> widget. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-add-item"></a><h3>gdl_dock_add_item ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gdl_dock_add_item                   (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GdlDockItem.html" title="GdlDockItem"><span class="type">GdlDockItem</span></a> *item</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GdlDockObject.html#GdlDockPlacement"><span class="type">GdlDockPlacement</span></a> placement</code></em>);</pre>
<p>
Dock in <em class="parameter"><code>dock</code></em>, the widget <em class="parameter"><code>item</code></em> at the position defined by <em class="parameter"><code>placement</code></em>. The
function takes care of finding the right parent widget eventually creating
it if needed.
</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>dock</code></em> :</span></p></td>
<td>A <a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td>A <a class="link" href="GdlDockItem.html" title="GdlDockItem"><span class="type">GdlDockItem</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>placement</code></em> :</span></p></td>
<td>A position for the widget</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-add-floating-item"></a><h3>gdl_dock_add_floating_item ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gdl_dock_add_floating_item          (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GdlDockItem.html" title="GdlDockItem"><span class="type">GdlDockItem</span></a> *item</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>);</pre>
<p>
Dock an item as a floating item. It creates a new window containing a new
dock widget sharing the same master where the item is docked.
</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>dock</code></em> :</span></p></td>
<td>A <a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td>A <a class="link" href="GdlDockItem.html" title="GdlDockItem"><span class="type">GdlDockItem</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>X coordinate of the floating item</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>Y coordinate of the floating item</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>width of the floating item</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
<td>height of the floating item</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-hide-preview"></a><h3>gdl_dock_hide_preview ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gdl_dock_hide_preview               (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</code></em>);</pre>
<p>
Hide the preview window used to materialize the dock target.
</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>dock</code></em> :</span></p></td>
<td>A <a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> widget</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-show-preview"></a><h3>gdl_dock_show_preview ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gdl_dock_show_preview               (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gdk3/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *rect</code></em>);</pre>
<p>
Show a preview window used to materialize the dock target.
</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>dock</code></em> :</span></p></td>
<td>A <a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rect</code></em> :</span></p></td>
<td>The position and the size of the preview window</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-set-skip-taskbar"></a><h3>gdl_dock_set_skip_taskbar ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gdl_dock_set_skip_taskbar           (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> skip</code></em>);</pre>
<p>
Sets whether or not a floating dock window should be prevented from
appearing in the system taskbar.
</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>dock</code></em> :</span></p></td>
<td>The dock whose property should be set.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>skip</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if floating docks should be prevented from appearing in the taskbar</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-get-item-by-name"></a><h3>gdl_dock_get_item_by_name ()</h3>
<pre class="programlisting"><a class="link" href="GdlDockItem.html" title="GdlDockItem"><span class="returnvalue">GdlDockItem</span></a> *       gdl_dock_get_item_by_name           (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
Looks for an <a class="link" href="GdlDockItem.html" title="GdlDockItem"><span class="type">GdlDockItem</span></a> widget bound to the master of the dock item. It
does not search only in the children of this particular dock widget.
</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>dock</code></em> :</span></p></td>
<td>A <a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>An item name</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a class="link" href="GdlDockItem.html" title="GdlDockItem"><span class="type">GdlDockItem</span></a> widget or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-get-named-items"></a><h3>gdl_dock_get_named_items ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             gdl_dock_get_named_items            (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</code></em>);</pre>
<p>
Returns a list of all item bound to the master of the dock, not only
the children of this particular dock widget.
</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>dock</code></em> :</span></p></td>
<td>A <a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A list of <a class="link" href="GdlDockItem.html" title="GdlDockItem"><span class="type">GdlDockItem</span></a>. The list should be freedwith <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>,
but the item still belong to the master. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GdlDockObject][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-get-placeholder-by-name"></a><h3>gdl_dock_get_placeholder_by_name ()</h3>
<pre class="programlisting"><a class="link" href="GdlDockPlaceholder.html" title="GdlDockPlaceHolder"><span class="returnvalue">GdlDockPlaceholder</span></a> * gdl_dock_get_placeholder_by_name   (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</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_get_placeholder_by_name</code> has been deprecated since version 3.6 and should not be used in newly-written code. This function is always returning <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
</div>
<p>
Looks for an <a class="link" href="GdlDockPlaceholder.html" title="GdlDockPlaceHolder"><span class="type">GdlDockPlaceholder</span></a> object bound to the master of the dock item.
It does not search only in the children of this particular dock widget.
</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>dock</code></em> :</span></p></td>
<td>A <a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>An item name</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a class="link" href="GdlDockPlaceholder.html" title="GdlDockPlaceHolder"><span class="type">GdlDockPlaceholder</span></a> object or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-object-get-toplevel"></a><h3>gdl_dock_object_get_toplevel ()</h3>
<pre class="programlisting"><a class="link" href="GdlDock.html" title="GdlDock"><span class="returnvalue">GdlDock</span></a> *           gdl_dock_object_get_toplevel        (<em class="parameter"><code><a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</span></a> *object</code></em>);</pre>
<p>
Get the top level <a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> widget of <em class="parameter"><code>object</code></em> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if cannot be found.
</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>object</code></em> :</span></p></td>
<td>A <a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <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>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-xor-rect"></a><h3>gdl_dock_xor_rect ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gdl_dock_xor_rect                   (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gdk3/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *rect</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_xor_rect</code> has been deprecated since version 3.6 and should not be used in newly-written code. Use gdl_dock_show_preview instead.</p>
</div>
<p>
Show a preview window used to materialize the dock target.
</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>dock</code></em> :</span></p></td>
<td>A <a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rect</code></em> :</span></p></td>
<td>The position and the size of the preview window</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-xor-rect-hide"></a><h3>gdl_dock_xor_rect_hide ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gdl_dock_xor_rect_hide              (<em class="parameter"><code><a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *dock</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_xor_rect_hide</code> has been deprecated since version 3.6 and should not be used in newly-written code. Use gdl_dock_hide_preview instead.</p>
</div>
<p>
Hide the preview window used to materialize the dock target.
</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>dock</code></em> :</span></p></td>
<td>A <a class="link" href="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> widget</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GdlDock.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GdlDock--default-title"></a><h3>The <code class="literal">"default-title"</code> property</h3>
<pre class="programlisting">  "default-title"            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
<p>Default title for the newly created floating docks.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GdlDock--floating"></a><h3>The <code class="literal">"floating"</code> property</h3>
<pre class="programlisting">  "floating"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct Only</pre>
<p>Whether the dock is floating in its own window.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GdlDock--floatx"></a><h3>The <code class="literal">"floatx"</code> property</h3>
<pre class="programlisting">  "floatx"                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
<p>X coordinate for a floating dock.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GdlDock--floaty"></a><h3>The <code class="literal">"floaty"</code> property</h3>
<pre class="programlisting">  "floaty"                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
<p>Y coordinate for a floating dock.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GdlDock--height"></a><h3>The <code class="literal">"height"</code> property</h3>
<pre class="programlisting">  "height"                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
<p>Height for the dock when it's of floating type.</p>
<p>Allowed values: &gt;= -1</p>
<p>Default value: -1</p>
</div>
<hr>
<div class="refsect2">
<a name="GdlDock--skip-taskbar"></a><h3>The <code class="literal">"skip-taskbar"</code> property</h3>
<pre class="programlisting">  "skip-taskbar"             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct</pre>
<p>
Whether or not to prevent a floating dock window from appearing in the
taskbar. Note that this only affects floating windows that are created
after this flag is set; existing windows are not affected.  Usually,
this property is used when you create the dock.
</p>
<p>Default value: TRUE</p>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="GdlDock--width"></a><h3>The <code class="literal">"width"</code> property</h3>
<pre class="programlisting">  "width"                    <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
<p>Width for the dock when it's of floating type.</p>
<p>Allowed values: &gt;= -1</p>
<p>Default value: -1</p>
</div>
</div>
<div class="refsect1">
<a name="GdlDock.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GdlDock-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="GdlDock.html" title="GdlDock"><span class="type">GdlDock</span></a> *arg0,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)      : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
Signals that the layout has changed, one or more widgets have been moved,
added or removed.
</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>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GdlDock.see-also"></a><h2>See Also</h2>
<a class="link" href="GdlDockItem.html" title="GdlDockItem"><span class="type">GdlDockItem</span></a>, <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>