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
|
<refentry id="GnomeApp">
<refmeta>
<refentrytitle role="top_of_page">GnomeApp</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGNOMEUI Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GnomeApp</refname>
<refpurpose>The main application widget.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <libgnomeui/libgnomeui.h>
#define <link linkend="GNOME-APP-MENUBAR-NAME:CAPS">GNOME_APP_MENUBAR_NAME</link>
#define <link linkend="GNOME-APP-TOOLBAR-NAME:CAPS">GNOME_APP_TOOLBAR_NAME</link>
<link linkend="GnomeApp-struct">GnomeApp</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gnome-app-new">gnome_app_new</link> (const <link linkend="gchar">gchar</link> *appname,
const <link linkend="gchar">gchar</link> *title);
<link linkend="void">void</link> <link linkend="gnome-app-construct">gnome_app_construct</link> (<link linkend="GnomeApp">GnomeApp</link> *app,
const <link linkend="gchar">gchar</link> *appname,
const <link linkend="gchar">gchar</link> *title);
<link linkend="void">void</link> <link linkend="gnome-app-set-menus">gnome_app_set_menus</link> (<link linkend="GnomeApp">GnomeApp</link> *app,
<link linkend="GtkMenuBar">GtkMenuBar</link> *menubar);
<link linkend="void">void</link> <link linkend="gnome-app-set-toolbar">gnome_app_set_toolbar</link> (<link linkend="GnomeApp">GnomeApp</link> *app,
<link linkend="GtkToolbar">GtkToolbar</link> *toolbar);
<link linkend="void">void</link> <link linkend="gnome-app-set-statusbar">gnome_app_set_statusbar</link> (<link linkend="GnomeApp">GnomeApp</link> *app,
<link linkend="GtkWidget">GtkWidget</link> *statusbar);
<link linkend="void">void</link> <link linkend="gnome-app-set-statusbar-custom">gnome_app_set_statusbar_custom</link> (<link linkend="GnomeApp">GnomeApp</link> *app,
<link linkend="GtkWidget">GtkWidget</link> *container,
<link linkend="GtkWidget">GtkWidget</link> *statusbar);
<link linkend="void">void</link> <link linkend="gnome-app-set-contents">gnome_app_set_contents</link> (<link linkend="GnomeApp">GnomeApp</link> *app,
<link linkend="GtkWidget">GtkWidget</link> *contents);
<link linkend="void">void</link> <link linkend="gnome-app-add-toolbar">gnome_app_add_toolbar</link> (<link linkend="GnomeApp">GnomeApp</link> *app,
<link linkend="GtkToolbar">GtkToolbar</link> *toolbar,
const <link linkend="gchar">gchar</link> *name,
<link linkend="BonoboDockItemBehavior">BonoboDockItemBehavior</link> behavior,
<link linkend="BonoboDockPlacement">BonoboDockPlacement</link> placement,
<link linkend="gint">gint</link> band_num,
<link linkend="gint">gint</link> band_position,
<link linkend="gint">gint</link> offset);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gnome-app-add-docked">gnome_app_add_docked</link> (<link linkend="GnomeApp">GnomeApp</link> *app,
<link linkend="GtkWidget">GtkWidget</link> *widget,
const <link linkend="gchar">gchar</link> *name,
<link linkend="BonoboDockItemBehavior">BonoboDockItemBehavior</link> behavior,
<link linkend="BonoboDockPlacement">BonoboDockPlacement</link> placement,
<link linkend="gint">gint</link> band_num,
<link linkend="gint">gint</link> band_position,
<link linkend="gint">gint</link> offset);
<link linkend="void">void</link> <link linkend="gnome-app-add-dock-item">gnome_app_add_dock_item</link> (<link linkend="GnomeApp">GnomeApp</link> *app,
<link linkend="BonoboDockItem">BonoboDockItem</link> *item,
<link linkend="BonoboDockPlacement">BonoboDockPlacement</link> placement,
<link linkend="gint">gint</link> band_num,
<link linkend="gint">gint</link> band_position,
<link linkend="gint">gint</link> offset);
<link linkend="void">void</link> <link linkend="gnome-app-enable-layout-config">gnome_app_enable_layout_config</link> (<link linkend="GnomeApp">GnomeApp</link> *app,
<link linkend="gboolean">gboolean</link> enable);
<link linkend="BonoboDock">BonoboDock</link>* <link linkend="gnome-app-get-dock">gnome_app_get_dock</link> (<link linkend="GnomeApp">GnomeApp</link> *app);
<link linkend="BonoboDockItem">BonoboDockItem</link>* <link linkend="gnome-app-get-dock-item-by-name">gnome_app_get_dock_item_by_name</link> (<link linkend="GnomeApp">GnomeApp</link> *app,
const <link linkend="gchar">gchar</link> *name);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkContainer">GtkContainer</link>
+----<link linkend="GtkBin">GtkBin</link>
+----<link linkend="GtkWindow">GtkWindow</link>
+----GnomeApp
</synopsis>
</refsect1>
<refsect1 role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GnomeApp implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="GnomeApp--app-id">app-id</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
The <parameter>GnomeApp</parameter> widget and associated functions provides the easiest way to
create an almost complete GNOME application in libgnomeui. Simple create an
instance of the widget, append any menus, toolbar(s) and a status bar, as
required (this will probably be done with some functions from the following
pages). Then fill in the main contents with a call to <link linkend="gnome-app-set-contents"><function>gnome_app_set_contents()</function></link>
and start the main loop (with <link linkend="gtk-main"><function>gtk_main()</function></link>).
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GNOME-APP-MENUBAR-NAME:CAPS" role="macro"/>GNOME_APP_MENUBAR_NAME</title>
<indexterm><primary>GNOME_APP_MENUBAR_NAME</primary></indexterm><programlisting>#define GNOME_APP_MENUBAR_NAME "Menubar"
</programlisting>
<para>
The name of the menubar as it is passed to libbonobo.
</para></refsect2>
<refsect2>
<title><anchor id="GNOME-APP-TOOLBAR-NAME:CAPS" role="macro"/>GNOME_APP_TOOLBAR_NAME</title>
<indexterm><primary>GNOME_APP_TOOLBAR_NAME</primary></indexterm><programlisting>#define GNOME_APP_TOOLBAR_NAME "Toolbar"
</programlisting>
<para>
The name of the default toolbar that is added to the application widget by
default.
</para></refsect2>
<refsect2>
<title><anchor id="GnomeApp-struct" role="struct"/>GnomeApp</title>
<indexterm><primary>GnomeApp</primary></indexterm><programlisting>typedef struct _GnomeApp GnomeApp;</programlisting>
<para>
A widget representing an entire GNOME application, including the main window,
menus, toolbar(s) and status bar.
</para></refsect2>
<refsect2>
<title><anchor id="gnome-app-new" role="function"/>gnome_app_new ()</title>
<indexterm><primary>gnome_app_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gnome_app_new (const <link linkend="gchar">gchar</link> *appname,
const <link linkend="gchar">gchar</link> *title);</programlisting>
<para>
Create a new (empty) application window. You must specify the <parameter>appname</parameter> (used
internally as an identifier). The <parameter>title</parameter> param can be left as NULL, in
which case the window's title will not be set.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>appname</parameter> :</term>
<listitem><simpara> Name of program, used in file names and paths.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>title</parameter> :</term>
<listitem><simpara> Window title for application.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to new <link linkend="GnomeApp"><type>GnomeApp</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-app-construct" role="function"/>gnome_app_construct ()</title>
<indexterm><primary>gnome_app_construct</primary></indexterm><programlisting><link linkend="void">void</link> gnome_app_construct (<link linkend="GnomeApp">GnomeApp</link> *app,
const <link linkend="gchar">gchar</link> *appname,
const <link linkend="gchar">gchar</link> *title);</programlisting>
<para>
Constructor for language bindings; you don't normally need this.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>app</parameter> :</term>
<listitem><simpara> A newly created <link linkend="GnomeApp"><type>GnomeApp</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>appname</parameter> :</term>
<listitem><simpara> Name of program, using in file names and paths.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>title</parameter> :</term>
<listitem><simpara> Window title for application.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-app-set-menus" role="function"/>gnome_app_set_menus ()</title>
<indexterm><primary>gnome_app_set_menus</primary></indexterm><programlisting><link linkend="void">void</link> gnome_app_set_menus (<link linkend="GnomeApp">GnomeApp</link> *app,
<link linkend="GtkMenuBar">GtkMenuBar</link> *menubar);</programlisting>
<para>
Sets the menu bar of the application window.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>app</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeApp"><type>GnomeApp</type></link> instance.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>menubar</parameter> :</term>
<listitem><simpara> Menu bar widget for main application window.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-app-set-toolbar" role="function"/>gnome_app_set_toolbar ()</title>
<indexterm><primary>gnome_app_set_toolbar</primary></indexterm><programlisting><link linkend="void">void</link> gnome_app_set_toolbar (<link linkend="GnomeApp">GnomeApp</link> *app,
<link linkend="GtkToolbar">GtkToolbar</link> *toolbar);</programlisting>
<para>
Sets the main toolbar of the application window.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>app</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeApp"><type>GnomeApp</type></link> instance.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>toolbar</parameter> :</term>
<listitem><simpara> Toolbar widget for main app window.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-app-set-statusbar" role="function"/>gnome_app_set_statusbar ()</title>
<indexterm><primary>gnome_app_set_statusbar</primary></indexterm><programlisting><link linkend="void">void</link> gnome_app_set_statusbar (<link linkend="GnomeApp">GnomeApp</link> *app,
<link linkend="GtkWidget">GtkWidget</link> *statusbar);</programlisting>
<para>
Sets the status bar of the application window.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>app</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeApp"><type>GnomeApp</type></link> instance
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>statusbar</parameter> :</term>
<listitem><simpara> Statusbar widget for main app window
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-app-set-statusbar-custom" role="function"/>gnome_app_set_statusbar_custom ()</title>
<indexterm><primary>gnome_app_set_statusbar_custom</primary></indexterm><programlisting><link linkend="void">void</link> gnome_app_set_statusbar_custom (<link linkend="GnomeApp">GnomeApp</link> *app,
<link linkend="GtkWidget">GtkWidget</link> *container,
<link linkend="GtkWidget">GtkWidget</link> *statusbar);</programlisting>
<para>
Sets the status bar of the application window, but use <parameter>container</parameter>
as its container.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>app</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeApp"><type>GnomeApp</type></link> instance
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>container</parameter> :</term>
<listitem><simpara> container widget containing the statusbar
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>statusbar</parameter> :</term>
<listitem><simpara> Statusbar widget for main app window
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-app-set-contents" role="function"/>gnome_app_set_contents ()</title>
<indexterm><primary>gnome_app_set_contents</primary></indexterm><programlisting><link linkend="void">void</link> gnome_app_set_contents (<link linkend="GnomeApp">GnomeApp</link> *app,
<link linkend="GtkWidget">GtkWidget</link> *contents);</programlisting>
<para>
Sets the content area of the main window of <parameter>app</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>app</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeApp"><type>GnomeApp</type></link> instance.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>contents</parameter> :</term>
<listitem><simpara> Widget to be application content area.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-app-add-toolbar" role="function"/>gnome_app_add_toolbar ()</title>
<indexterm><primary>gnome_app_add_toolbar</primary></indexterm><programlisting><link linkend="void">void</link> gnome_app_add_toolbar (<link linkend="GnomeApp">GnomeApp</link> *app,
<link linkend="GtkToolbar">GtkToolbar</link> *toolbar,
const <link linkend="gchar">gchar</link> *name,
<link linkend="BonoboDockItemBehavior">BonoboDockItemBehavior</link> behavior,
<link linkend="BonoboDockPlacement">BonoboDockPlacement</link> placement,
<link linkend="gint">gint</link> band_num,
<link linkend="gint">gint</link> band_position,
<link linkend="gint">gint</link> offset);</programlisting>
<para>
Create a new <link linkend="BonoboDockItem"><type>BonoboDockItem</type></link> widget containing <parameter>toolbar</parameter>, and add it
to <parameter>app</parameter>'s dock with the specified layout information. Notice that,
if automatic layout configuration is enabled, the layout is
overridden by the saved configuration, if any.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>app</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeApp"><type>GnomeApp</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>toolbar</parameter> :</term>
<listitem><simpara> Toolbar to be added to <parameter>app</parameter>'s dock
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> Name for the dock item that will contain <parameter>toolbar</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>behavior</parameter> :</term>
<listitem><simpara> Behavior for the new dock item
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>placement</parameter> :</term>
<listitem><simpara> Placement for the new dock item
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>band_num</parameter> :</term>
<listitem><simpara> Number of the band where the dock item should be placed
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>band_position</parameter> :</term>
<listitem><simpara> Position of the new dock item in band <parameter>band_num</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offset</parameter> :</term>
<listitem><simpara> Offset from the previous dock item in the band; if there is
no previous item, offset from the beginning of the band.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-app-add-docked" role="function"/>gnome_app_add_docked ()</title>
<indexterm><primary>gnome_app_add_docked</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gnome_app_add_docked (<link linkend="GnomeApp">GnomeApp</link> *app,
<link linkend="GtkWidget">GtkWidget</link> *widget,
const <link linkend="gchar">gchar</link> *name,
<link linkend="BonoboDockItemBehavior">BonoboDockItemBehavior</link> behavior,
<link linkend="BonoboDockPlacement">BonoboDockPlacement</link> placement,
<link linkend="gint">gint</link> band_num,
<link linkend="gint">gint</link> band_position,
<link linkend="gint">gint</link> offset);</programlisting>
<para>
Add <parameter>widget</parameter> as a dock item according to the specified layout
information. Notice that, if automatic layout configuration is
enabled, the layout is overridden by the saved configuration, if
any.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>app</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeApp"><type>GnomeApp</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> Widget to be added to the <link linkend="GnomeApp"><type>GnomeApp</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> Name for the new dock item.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>behavior</parameter> :</term>
<listitem><simpara> Behavior for the new dock item.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>placement</parameter> :</term>
<listitem><simpara> Placement for the new dock item.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>band_num</parameter> :</term>
<listitem><simpara> Number of the band where the dock item should be placed.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>band_position</parameter> :</term>
<listitem><simpara> Position of the new dock item in band <parameter>band_num</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offset</parameter> :</term>
<listitem><simpara> Offset from the previous dock item in the band; if there is
no previous item, offset from the beginning of the band.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The dock item used to contain the widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-app-add-dock-item" role="function"/>gnome_app_add_dock_item ()</title>
<indexterm><primary>gnome_app_add_dock_item</primary></indexterm><programlisting><link linkend="void">void</link> gnome_app_add_dock_item (<link linkend="GnomeApp">GnomeApp</link> *app,
<link linkend="BonoboDockItem">BonoboDockItem</link> *item,
<link linkend="BonoboDockPlacement">BonoboDockPlacement</link> placement,
<link linkend="gint">gint</link> band_num,
<link linkend="gint">gint</link> band_position,
<link linkend="gint">gint</link> offset);</programlisting>
<para>
Add <parameter>item</parameter> according to the specified layout information. Notice
that, if automatic layout configuration is enabled, the layout is
overridden by the saved configuration, if any.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>app</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeApp"><type>GnomeApp</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>item</parameter> :</term>
<listitem><simpara> Dock item to be added to <parameter>app</parameter>'s dock.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>placement</parameter> :</term>
<listitem><simpara> Placement for the dock item.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>band_num</parameter> :</term>
<listitem><simpara> Number of the band where the dock item should be placed.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>band_position</parameter> :</term>
<listitem><simpara> Position of the dock item in band <parameter>band_num</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offset</parameter> :</term>
<listitem><simpara> Offset from the previous dock item in the band; if there is
no previous item, offset from the beginning of the band.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-app-enable-layout-config" role="function"/>gnome_app_enable_layout_config ()</title>
<indexterm><primary>gnome_app_enable_layout_config</primary></indexterm><programlisting><link linkend="void">void</link> gnome_app_enable_layout_config (<link linkend="GnomeApp">GnomeApp</link> *app,
<link linkend="gboolean">gboolean</link> enable);</programlisting>
<para>
Specify whether <parameter>app</parameter> should automatically save the dock's
layout configuration via gnome-config whenever it changes or not.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>app</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeApp"><type>GnomeApp</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>enable</parameter> :</term>
<listitem><simpara> Boolean specifying whether automatic configuration saving
is enabled.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-app-get-dock" role="function"/>gnome_app_get_dock ()</title>
<indexterm><primary>gnome_app_get_dock</primary></indexterm><programlisting><link linkend="BonoboDock">BonoboDock</link>* gnome_app_get_dock (<link linkend="GnomeApp">GnomeApp</link> *app);</programlisting>
<para>
Retrieves the <link linkend="BonoboDock"><type>BonoboDock</type></link> widget contained in <parameter>app</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>app</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeApp"><type>GnomeApp</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The relevant <link linkend="BonoboDock"><type>BonoboDock</type></link> widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-app-get-dock-item-by-name" role="function"/>gnome_app_get_dock_item_by_name ()</title>
<indexterm><primary>gnome_app_get_dock_item_by_name</primary></indexterm><programlisting><link linkend="BonoboDockItem">BonoboDockItem</link>* gnome_app_get_dock_item_by_name (<link linkend="GnomeApp">GnomeApp</link> *app,
const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Retrieve the dock item whose name matches <parameter>name</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>app</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeApp"><type>GnomeApp</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> Name of the dock item to retrieve.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The retrieved dock item.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="GnomeApp--app-id"/>The <literal>"app-id"</literal> property</title>
<indexterm><primary>GnomeApp:app-id</primary></indexterm><programlisting> "app-id" <link linkend="gchararray">gchararray</link> : Read / Write / Construct</programlisting>
<para>The application ID string.</para><para>Default value: NULL</para>
</refsect2>
</refsect1>
</refentry>
|
