libgdl-3-doc 3.28.0-1 / usr / share / gtk-doc / html / gdl-3.0 / GdlDockLayout.html

This file is indexed.

/usr/share/gtk-doc/html/gdl-3.0/GdlDockLayout.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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdlDockLayout: 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="GdlDockMaster.html" title="GdlDockMaster">
<link rel="next" href="widget.html" title="Widgets">
<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="#GdlDockLayout.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GdlDockLayout.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GdlDockLayout.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="core.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GdlDockMaster.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="widget.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GdlDockLayout"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdlDockLayout.top_of_page"></a>GdlDockLayout</span></h2>
<p>GdlDockLayout — save and restore dock widgets.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GdlDockLayout.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="GdlDockLayout.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GdlDockLayout.html" title="GdlDockLayout"><span class="returnvalue">GdlDockLayout</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdlDockLayout.html#gdl-dock-layout-new" title="gdl_dock_layout_new ()">gdl_dock_layout_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GdlDockLayout.html#gdl-dock-layout-attach" title="gdl_dock_layout_attach ()">gdl_dock_layout_attach</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="GdlDockLayout.html#gdl-dock-layout-delete-layout" title="gdl_dock_layout_delete_layout ()">gdl_dock_layout_delete_layout</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdlDockLayout.html#gdl-dock-layout-get-layouts" title="gdl_dock_layout_get_layouts ()">gdl_dock_layout_get_layouts</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GdlDockLayout.html#gdl-dock-layout-is-dirty" title="gdl_dock_layout_is_dirty ()">gdl_dock_layout_is_dirty</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GdlDockLayout.html#gdl-dock-layout-load-layout" title="gdl_dock_layout_load_layout ()">gdl_dock_layout_load_layout</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GdlDockLayout.html#gdl-dock-layout-load-from-file" title="gdl_dock_layout_load_from_file ()">gdl_dock_layout_load_from_file</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="GdlDockLayout.html#gdl-dock-layout-save-layout" title="gdl_dock_layout_save_layout ()">gdl_dock_layout_save_layout</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GdlDockLayout.html#gdl-dock-layout-save-to-file" title="gdl_dock_layout_save_to_file ()">gdl_dock_layout_save_to_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdlDockLayout.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#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GdlDockLayout.html#GdlDockLayout--dirty" title="The “dirty” property">dirty</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> *</td>
<td class="property_name"><a class="link" href="GdlDockLayout.html#GdlDockLayout--master" title="The “master” property">master</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdlDockLayout.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="GdlDockLayout.html#GdlDockLayout-struct" title="struct GdlDockLayout">GdlDockLayout</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdlDockLayout.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> GdlDockLayout
</pre>
</div>
<div class="refsect1">
<a name="GdlDockLayout.description"></a><h2>Description</h2>
<p>The layout of all docking widgets can be saved using this <a class="link" href="GdlDockLayout.html" title="GdlDockLayout"><span class="type">GdlDockLayout</span></a>
object. It automatically monitors the layout_changed signal of the
dock master and stores the position of all widgets in memory after each
change.</p>
<p>The layout "dirty" property is set to <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> when the widget position in
memory is updated.
To keep an external file in sync with the dock, monitor this "dirty"
property and call gdl_dock_layout_save_to_file when
this changes to <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>. Informations are stored in XML format.</p>
</div>
<div class="refsect1">
<a name="GdlDockLayout.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gdl-dock-layout-new"></a><h3>gdl_dock_layout_new ()</h3>
<pre class="programlisting"><a class="link" href="GdlDockLayout.html" title="GdlDockLayout"><span class="returnvalue">GdlDockLayout</span></a> *
gdl_dock_layout_new (<em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> *master</code></em>);</pre>
<p>Creates a new <a class="link" href="GdlDockLayout.html" title="GdlDockLayout"><span class="type">GdlDockLayout</span></a>. Instead of setting <em class="parameter"><code>master</code></em>

directly with a master object, it is possible to use a <a class="link" href="GdlDockObject.html" title="GdlDockObject"><span class="type">GdlDockObject</span></a>, in
this case the layout will be attached to the same master than the dock
object.</p>
<div class="refsect3">
<a name="gdl-dock-layout-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>master</p></td>
<td class="parameter_description"><p>A master or a dock object to which the layout will be attached.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdl-dock-layout-new.returns"></a><h4>Returns</h4>
<p> New <a class="link" href="GdlDockLayout.html" title="GdlDockLayout"><span class="type">GdlDockLayout</span></a> item.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-layout-attach"></a><h3>gdl_dock_layout_attach ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdl_dock_layout_attach (<em class="parameter"><code><a class="link" href="GdlDockLayout.html" title="GdlDockLayout"><span class="type">GdlDockLayout</span></a> *layout</code></em>,
                        <em class="parameter"><code><a class="link" href="GdlDockMaster.html" title="GdlDockMaster"><span class="type">GdlDockMaster</span></a> *master</code></em>);</pre>
<div class="warning"><p><code class="literal">gdl_dock_layout_attach</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Attach the <em class="parameter"><code>layout</code></em>
 to the <em class="parameter"><code>master</code></em>
 and delete the reference to
the master that the layout attached previously.</p>
<p>Deprecated 3.6: Use <code class="function">gdl_dock_layout_set_master()</code> instead.</p>
<div class="refsect3">
<a name="gdl-dock-layout-attach.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>layout</p></td>
<td class="parameter_description"><p>The layout object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>master</p></td>
<td class="parameter_description"><p>The master object to which the layout will be attached</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-layout-delete-layout"></a><h3>gdl_dock_layout_delete_layout ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdl_dock_layout_delete_layout (<em class="parameter"><code><a class="link" href="GdlDockLayout.html" title="GdlDockLayout"><span class="type">GdlDockLayout</span></a> *layout</code></em>,
                               <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>Deletes the layout with the given name from the memory.
This will set <a class="link" href="GdlDockLayout.html#GdlDockLayout--dirty" title="The “dirty” property"><span class="type">“dirty”</span></a> to <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p>
<div class="refsect3">
<a name="gdl-dock-layout-delete-layout.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>layout</p></td>
<td class="parameter_description"><p>The dock item.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The name of the layout to delete.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-layout-get-layouts"></a><h3>gdl_dock_layout_get_layouts ()</h3>
<pre class="programlisting"><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
gdl_dock_layout_get_layouts (<em class="parameter"><code><a class="link" href="GdlDockLayout.html" title="GdlDockLayout"><span class="type">GdlDockLayout</span></a> *layout</code></em>,
                             <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> include_default</code></em>);</pre>
<p>Get the list of layout names including or not the default layout.</p>
<div class="refsect3">
<a name="gdl-dock-layout-get-layouts.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>layout</p></td>
<td class="parameter_description"><p>The layout item.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>include_default</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 default layout.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdl-dock-layout-get-layouts.returns"></a><h4>Returns</h4>
<p>a <a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> list
holding the layout names. You must first free each element in the list
with <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>, then free the list itself with <a href="../glib/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-layout-is-dirty"></a><h3>gdl_dock_layout_is_dirty ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gdl_dock_layout_is_dirty (<em class="parameter"><code><a class="link" href="GdlDockLayout.html" title="GdlDockLayout"><span class="type">GdlDockLayout</span></a> *layout</code></em>);</pre>
<p>Checks whether the XML tree in memory is different from the file where the layout was saved.</p>
<div class="refsect3">
<a name="gdl-dock-layout-is-dirty.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>layout</p></td>
<td class="parameter_description"><p>The layout item.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdl-dock-layout-is-dirty.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is the layout in the memory is different from the file, else <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-layout-load-layout"></a><h3>gdl_dock_layout_load_layout ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gdl_dock_layout_load_layout (<em class="parameter"><code><a class="link" href="GdlDockLayout.html" title="GdlDockLayout"><span class="type">GdlDockLayout</span></a> *layout</code></em>,
                             <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>Loads the layout with the given name from the memory.
This will set <a class="link" href="GdlDockLayout.html#GdlDockLayout--dirty" title="The “dirty” property"><span class="type">“dirty”</span></a> to <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p>
<p>See also <a class="link" href="GdlDockLayout.html#gdl-dock-layout-load-from-file" title="gdl_dock_layout_load_from_file ()"><code class="function">gdl_dock_layout_load_from_file()</code></a></p>
<div class="refsect3">
<a name="gdl-dock-layout-load-layout.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>layout</p></td>
<td class="parameter_description"><p>The dock item.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The name of the layout to load or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for a default layout name. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdl-dock-layout-load-layout.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if layout successfully loaded else <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-layout-load-from-file"></a><h3>gdl_dock_layout_load_from_file ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gdl_dock_layout_load_from_file (<em class="parameter"><code><a class="link" href="GdlDockLayout.html" title="GdlDockLayout"><span class="type">GdlDockLayout</span></a> *layout</code></em>,
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
<p>Loads the layout from file with the given <em class="parameter"><code>filename</code></em>
.
This will set <a class="link" href="GdlDockLayout.html#GdlDockLayout--dirty" title="The “dirty” property"><span class="type">“dirty”</span></a> to <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
<div class="refsect3">
<a name="gdl-dock-layout-load-from-file.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>layout</p></td>
<td class="parameter_description"><p>The layout item.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>The name of the file to load.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdl-dock-layout-load-from-file.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>layout</code></em>
successfully loaded else <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-layout-save-layout"></a><h3>gdl_dock_layout_save_layout ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdl_dock_layout_save_layout (<em class="parameter"><code><a class="link" href="GdlDockLayout.html" title="GdlDockLayout"><span class="type">GdlDockLayout</span></a> *layout</code></em>,
                             <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>Saves the <em class="parameter"><code>layout</code></em>
 with the given name to the memory.
This will set <a class="link" href="GdlDockLayout.html#GdlDockLayout--dirty" title="The “dirty” property"><span class="type">“dirty”</span></a> to <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p>
<p>See also <a class="link" href="GdlDockLayout.html#gdl-dock-layout-save-to-file" title="gdl_dock_layout_save_to_file ()"><code class="function">gdl_dock_layout_save_to_file()</code></a>.</p>
<div class="refsect3">
<a name="gdl-dock-layout-save-layout.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>layout</p></td>
<td class="parameter_description"><p>The dock item.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The name of the layout to save or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for a default layout name. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdl-dock-layout-save-to-file"></a><h3>gdl_dock_layout_save_to_file ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gdl_dock_layout_save_to_file (<em class="parameter"><code><a class="link" href="GdlDockLayout.html" title="GdlDockLayout"><span class="type">GdlDockLayout</span></a> *layout</code></em>,
                              <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
<p>This function saves the current layout in XML format to
the file with the given <em class="parameter"><code>filename</code></em>
.</p>
<div class="refsect3">
<a name="gdl-dock-layout-save-to-file.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>layout</p></td>
<td class="parameter_description"><p>The layout item.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>Name of the file we want to save in layout</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdl-dock-layout-save-to-file.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>layout</code></em>
successfuly save to the file, otherwise <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GdlDockLayout.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdlDockLayout-struct"></a><h3>struct GdlDockLayout</h3>
<pre class="programlisting">struct GdlDockLayout;</pre>
<p>The GdlDockLayout struct contains only private fields
and should not be directly accessed.</p>
</div>
</div>
<div class="refsect1">
<a name="GdlDockLayout.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GdlDockLayout--dirty"></a><h3>The <code class="literal">“dirty”</code> property</h3>
<pre class="programlisting">  “dirty”                    <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>True if the layouts have changed and need to be saved to a file.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GdlDockLayout--master"></a><h3>The <code class="literal">“master”</code> property</h3>
<pre class="programlisting">  “master”                   <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> *</pre>
<p>GdlDockMaster or GdlDockObject object which the layout object is attached to.</p>
<p>Flags: Read / Write</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.