← Back to branch summary

~ubuntu-branches/ubuntu/dapper/libgnomeui/dapper-updates

« back to all changes in this revision

Viewing changes to doc/reference/xml/gnome-app.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2006-04-11 17:46:10 UTC
  • mfrom: (1.1.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20060411174610-yb9v0rvx60x0mdli
Tags: 2.14.1-0ubuntu1
* New upstream release:
  - Fix --disable-crash-dialog 
  - Fix leaks 
  - Fix gettext initialization 
* Resynchronized with Debian, only Ubuntu changes are:
  - debian/libgnomeui-0.shlibs: bumped for added interfaces.
  - debian/rules: added stuff for cleaning.
  - debian/patches/30_crash-dialog.patch: dropped, fixed upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/gnome-app.xml
1
1
<refentry id="GnomeApp">
2
2
<refmeta>
3
 
<refentrytitle id="top_of_page">GnomeApp</refentrytitle>
 
3
<refentrytitle>GnomeApp</refentrytitle>
4
4
<manvolnum>3</manvolnum>
5
5
<refmiscinfo>LIBGNOMEUI Library</refmiscinfo>
6
6
</refmeta>
7
7
 
8
8
<refnamediv>
9
 
<refname>GnomeApp</refname>
10
 
<refpurpose>The main application widget.</refpurpose>
11
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
9
<refname>GnomeApp</refname><refpurpose>The main application widget.</refpurpose>
12
10
</refnamediv>
13
11
 
14
 
<refsynopsisdiv id="synopsis">
15
 
<title id="synopsis.title">Synopsis</title>
 
12
<refsynopsisdiv><title>Synopsis</title>
16
13
 
17
14
<synopsis>
18
15
 
71
68
</synopsis>
72
69
</refsynopsisdiv>
73
70
 
74
 
<refsect1 id="object_hierarchy">
75
 
<title id="object_hierarchy.title">Object Hierarchy</title>
 
71
<refsect1>
 
72
<title>Object Hierarchy</title>
76
73
<synopsis>
77
74
 
78
75
  <link linkend="GObject">GObject</link>
89
86
 
90
87
 
91
88
 
92
 
<refsect1 id="impl_interfaces">
93
 
<title id="impl_interfaces.title">Implemented Interfaces</title>
 
89
<refsect1>
 
90
<title>Implemented Interfaces</title>
94
91
<para>
95
92
GnomeApp implements
96
93
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
98
95
</refsect1>
99
96
 
100
97
 
101
 
<refsect1 id="properties">
102
 
<title id="properties.title">Properties</title>
 
98
<refsect1>
 
99
<title>Properties</title>
103
100
<synopsis>
104
101
 
105
102
  &quot;<link linkend="GnomeApp--app-id">app-id</link>&quot;               <link linkend="gchararray">gchararray</link>            : Read / Write / Construct
108
105
 
109
106
 
110
107
 
111
 
<refsect1 id="desc">
112
 
<title id="desc.title">Description</title>
 
108
<refsect1>
 
109
<title>Description</title>
113
110
<para>
114
111
The <parameter>GnomeApp</parameter> widget and associated functions provides the easiest way to
115
112
create an almost complete GNOME application in libgnomeui. Simple create an
120
117
</para>
121
118
</refsect1>
122
119
 
123
 
<refsect1 id="details">
124
 
<title id="details.title">Details</title>
 
120
<refsect1>
 
121
<title>Details</title>
125
122
<refsect2>
126
 
<title><anchor id="GNOME-APP-MENUBAR-NAME:CAPS" role="macro"/>GNOME_APP_MENUBAR_NAME</title>
 
123
<title><anchor id="GNOME-APP-MENUBAR-NAME:CAPS"/>GNOME_APP_MENUBAR_NAME</title>
127
124
<indexterm><primary>GNOME_APP_MENUBAR_NAME</primary></indexterm><programlisting>#define GNOME_APP_MENUBAR_NAME "Menubar"
128
125
</programlisting>
129
126
<para>
130
127
The name of the menubar as it is passed to libbonobo.
131
128
</para></refsect2>
132
129
<refsect2>
133
 
<title><anchor id="GNOME-APP-TOOLBAR-NAME:CAPS" role="macro"/>GNOME_APP_TOOLBAR_NAME</title>
 
130
<title><anchor id="GNOME-APP-TOOLBAR-NAME:CAPS"/>GNOME_APP_TOOLBAR_NAME</title>
134
131
<indexterm><primary>GNOME_APP_TOOLBAR_NAME</primary></indexterm><programlisting>#define GNOME_APP_TOOLBAR_NAME "Toolbar"
135
132
</programlisting>
136
133
<para>
138
135
default.
139
136
</para></refsect2>
140
137
<refsect2>
141
 
<title><anchor id="GnomeApp-struct" role="struct"/>GnomeApp</title>
 
138
<title><anchor id="GnomeApp-struct"/>GnomeApp</title>
142
139
<indexterm><primary>GnomeApp</primary></indexterm><programlisting>typedef struct _GnomeApp GnomeApp;</programlisting>
143
140
<para>
144
141
A widget representing an entire GNOME application, including the main window,
145
142
menus, toolbar(s) and status bar.
146
143
</para></refsect2>
147
144
<refsect2>
148
 
<title><anchor id="gnome-app-new" role="function"/>gnome_app_new ()</title>
 
145
<title><anchor id="gnome-app-new"/>gnome_app_new ()</title>
149
146
<indexterm><primary>gnome_app_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gnome_app_new                   (const <link linkend="gchar">gchar</link> *appname,
150
147
                                             const <link linkend="gchar">gchar</link> *title);</programlisting>
151
148
<para>
165
162
</simpara></listitem></varlistentry>
166
163
</variablelist></refsect2>
167
164
<refsect2>
168
 
<title><anchor id="gnome-app-construct" role="function"/>gnome_app_construct ()</title>
 
165
<title><anchor id="gnome-app-construct"/>gnome_app_construct ()</title>
169
166
<indexterm><primary>gnome_app_construct</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_app_construct             (<link linkend="GnomeApp">GnomeApp</link> *app,
170
167
                                             const <link linkend="gchar">gchar</link> *appname,
171
168
                                             const <link linkend="gchar">gchar</link> *title);</programlisting>
185
182
</simpara></listitem></varlistentry>
186
183
</variablelist></refsect2>
187
184
<refsect2>
188
 
<title><anchor id="gnome-app-set-menus" role="function"/>gnome_app_set_menus ()</title>
 
185
<title><anchor id="gnome-app-set-menus"/>gnome_app_set_menus ()</title>
189
186
<indexterm><primary>gnome_app_set_menus</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_app_set_menus             (<link linkend="GnomeApp">GnomeApp</link> *app,
190
187
                                             <link linkend="GtkMenuBar">GtkMenuBar</link> *menubar);</programlisting>
191
188
<para>
201
198
</simpara></listitem></varlistentry>
202
199
</variablelist></refsect2>
203
200
<refsect2>
204
 
<title><anchor id="gnome-app-set-toolbar" role="function"/>gnome_app_set_toolbar ()</title>
 
201
<title><anchor id="gnome-app-set-toolbar"/>gnome_app_set_toolbar ()</title>
205
202
<indexterm><primary>gnome_app_set_toolbar</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_app_set_toolbar           (<link linkend="GnomeApp">GnomeApp</link> *app,
206
203
                                             <link linkend="GtkToolbar">GtkToolbar</link> *toolbar);</programlisting>
207
204
<para>
217
214
</simpara></listitem></varlistentry>
218
215
</variablelist></refsect2>
219
216
<refsect2>
220
 
<title><anchor id="gnome-app-set-statusbar" role="function"/>gnome_app_set_statusbar ()</title>
 
217
<title><anchor id="gnome-app-set-statusbar"/>gnome_app_set_statusbar ()</title>
221
218
<indexterm><primary>gnome_app_set_statusbar</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_app_set_statusbar         (<link linkend="GnomeApp">GnomeApp</link> *app,
222
219
                                             <link linkend="GtkWidget">GtkWidget</link> *statusbar);</programlisting>
223
220
<para>
233
230
</simpara></listitem></varlistentry>
234
231
</variablelist></refsect2>
235
232
<refsect2>
236
 
<title><anchor id="gnome-app-set-statusbar-custom" role="function"/>gnome_app_set_statusbar_custom ()</title>
 
233
<title><anchor id="gnome-app-set-statusbar-custom"/>gnome_app_set_statusbar_custom ()</title>
237
234
<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,
238
235
                                             <link linkend="GtkWidget">GtkWidget</link> *container,
239
236
                                             <link linkend="GtkWidget">GtkWidget</link> *statusbar);</programlisting>
254
251
</simpara></listitem></varlistentry>
255
252
</variablelist></refsect2>
256
253
<refsect2>
257
 
<title><anchor id="gnome-app-set-contents" role="function"/>gnome_app_set_contents ()</title>
 
254
<title><anchor id="gnome-app-set-contents"/>gnome_app_set_contents ()</title>
258
255
<indexterm><primary>gnome_app_set_contents</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_app_set_contents          (<link linkend="GnomeApp">GnomeApp</link> *app,
259
256
                                             <link linkend="GtkWidget">GtkWidget</link> *contents);</programlisting>
260
257
<para>
270
267
</simpara></listitem></varlistentry>
271
268
</variablelist></refsect2>
272
269
<refsect2>
273
 
<title><anchor id="gnome-app-add-toolbar" role="function"/>gnome_app_add_toolbar ()</title>
 
270
<title><anchor id="gnome-app-add-toolbar"/>gnome_app_add_toolbar ()</title>
274
271
<indexterm><primary>gnome_app_add_toolbar</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_app_add_toolbar           (<link linkend="GnomeApp">GnomeApp</link> *app,
275
272
                                             <link linkend="GtkToolbar">GtkToolbar</link> *toolbar,
276
273
                                             const <link linkend="gchar">gchar</link> *name,
314
311
</simpara></listitem></varlistentry>
315
312
</variablelist></refsect2>
316
313
<refsect2>
317
 
<title><anchor id="gnome-app-add-docked" role="function"/>gnome_app_add_docked ()</title>
 
314
<title><anchor id="gnome-app-add-docked"/>gnome_app_add_docked ()</title>
318
315
<indexterm><primary>gnome_app_add_docked</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gnome_app_add_docked            (<link linkend="GnomeApp">GnomeApp</link> *app,
319
316
                                             <link linkend="GtkWidget">GtkWidget</link> *widget,
320
317
                                             const <link linkend="gchar">gchar</link> *name,
360
357
</simpara></listitem></varlistentry>
361
358
</variablelist></refsect2>
362
359
<refsect2>
363
 
<title><anchor id="gnome-app-add-dock-item" role="function"/>gnome_app_add_dock_item ()</title>
 
360
<title><anchor id="gnome-app-add-dock-item"/>gnome_app_add_dock_item ()</title>
364
361
<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,
365
362
                                             <link linkend="BonoboDockItem">BonoboDockItem</link> *item,
366
363
                                             <link linkend="BonoboDockPlacement">BonoboDockPlacement</link> placement,
395
392
</simpara></listitem></varlistentry>
396
393
</variablelist></refsect2>
397
394
<refsect2>
398
 
<title><anchor id="gnome-app-enable-layout-config" role="function"/>gnome_app_enable_layout_config ()</title>
 
395
<title><anchor id="gnome-app-enable-layout-config"/>gnome_app_enable_layout_config ()</title>
399
396
<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,
400
397
                                             <link linkend="gboolean">gboolean</link> enable);</programlisting>
401
398
<para>
413
410
</simpara></listitem></varlistentry>
414
411
</variablelist></refsect2>
415
412
<refsect2>
416
 
<title><anchor id="gnome-app-get-dock" role="function"/>gnome_app_get_dock ()</title>
 
413
<title><anchor id="gnome-app-get-dock"/>gnome_app_get_dock ()</title>
417
414
<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>
418
415
<para>
419
416
Retrieves the <link linkend="BonoboDock"><type>BonoboDock</type></link> widget contained in <parameter>app</parameter>.</para>
427
424
</simpara></listitem></varlistentry>
428
425
</variablelist></refsect2>
429
426
<refsect2>
430
 
<title><anchor id="gnome-app-get-dock-item-by-name" role="function"/>gnome_app_get_dock_item_by_name ()</title>
 
427
<title><anchor id="gnome-app-get-dock-item-by-name"/>gnome_app_get_dock_item_by_name ()</title>
431
428
<indexterm><primary>gnome_app_get_dock_item_by_name</primary></indexterm><programlisting><link linkend="BonoboDockItem">BonoboDockItem</link>* gnome_app_get_dock_item_by_name
432
429
                                            (<link linkend="GnomeApp">GnomeApp</link> *app,
433
430
                                             const <link linkend="gchar">gchar</link> *name);</programlisting>
447
444
</variablelist></refsect2>
448
445
 
449
446
</refsect1>
450
 
<refsect1 id="property_details">
451
 
<title id="property_details.title">Property Details</title>
 
447
<refsect1>
 
448
<title>Properties</title>
452
449
<refsect2><title><anchor id="GnomeApp--app-id"/>The &quot;<literal>app-id</literal>&quot; property</title>
453
450
<programlisting>  &quot;app-id&quot;               <link linkend="gchararray">gchararray</link>            : Read / Write / Construct</programlisting>
454
451
<para>The application ID string.</para><para>Default value: NULL</para>