|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /proc/21585/root/usr/share/gtk-doc/html/libgnomeui/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GnomeApp</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GNOME UI Library Reference Manual">
<link rel="up" href="application-mgmt.html" title="Application management">
<link rel="prev" href="application-mgmt.html" title="Application management">
<link rel="next" href="GnomeAppBar.html" title="GnomeAppBar">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="GNOME UI Library (libgnomeui)">
</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="application-mgmt.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="application-mgmt.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 UI Library Reference Manual</th>
<td><a accesskey="n" href="GnomeAppBar.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2920653" class="shortcut">Top</a>
 | 
<a href="#id2921353" class="shortcut">Description</a>
 | 
<a href="#id2921223" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2921295" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id2921318" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GnomeApp"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2920653"></a><span class="refentrytitle">GnomeApp</span>
</h2>
<p>GnomeApp — The main application widget.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <libgnomeui/libgnomeui.h>
#define <a href="GnomeApp.html#GNOME-APP-MENUBAR-NAME:CAPS">GNOME_APP_MENUBAR_NAME</a>
#define <a href="GnomeApp.html#GNOME-APP-TOOLBAR-NAME:CAPS">GNOME_APP_TOOLBAR_NAME</a>
<a href="GnomeApp.html#GnomeApp-struct">GnomeApp</a>;
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* <a href="GnomeApp.html#gnome-app-new">gnome_app_new</a> (const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *appname,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *title);
void <a href="GnomeApp.html#gnome-app-construct">gnome_app_construct</a> (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *appname,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *title);
void <a href="GnomeApp.html#gnome-app-set-menus">gnome_app_set_menus</a> (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
<a
href="/usr/share/gtk-doc/html/gtk/GtkMenuBar.html"
>GtkMenuBar</a> *menubar);
void <a href="GnomeApp.html#gnome-app-set-toolbar">gnome_app_set_toolbar</a> (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
<a
href="/usr/share/gtk-doc/html/gtk/GtkToolbar.html"
>GtkToolbar</a> *toolbar);
void <a href="GnomeApp.html#gnome-app-set-statusbar">gnome_app_set_statusbar</a> (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *statusbar);
void <a href="GnomeApp.html#gnome-app-set-statusbar-custom">gnome_app_set_statusbar_custom</a> (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *container,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *statusbar);
void <a href="GnomeApp.html#gnome-app-set-contents">gnome_app_set_contents</a> (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *contents);
void <a href="GnomeApp.html#gnome-app-add-toolbar">gnome_app_add_toolbar</a> (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
<a
href="/usr/share/gtk-doc/html/gtk/GtkToolbar.html"
>GtkToolbar</a> *toolbar,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
BonoboDockItemBehavior behavior,
BonoboDockPlacement placement,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> band_num,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> band_position,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> offset);
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* <a href="GnomeApp.html#gnome-app-add-docked">gnome_app_add_docked</a> (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
BonoboDockItemBehavior behavior,
BonoboDockPlacement placement,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> band_num,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> band_position,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> offset);
void <a href="GnomeApp.html#gnome-app-add-dock-item">gnome_app_add_dock_item</a> (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
BonoboDockItem *item,
BonoboDockPlacement placement,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> band_num,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> band_position,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> offset);
void <a href="GnomeApp.html#gnome-app-enable-layout-config">gnome_app_enable_layout_config</a> (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> enable);
BonoboDock* <a href="GnomeApp.html#gnome-app-get-dock">gnome_app_get_dock</a> (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app);
BonoboDockItem* <a href="GnomeApp.html#gnome-app-get-dock-item-by-name">gnome_app_get_dock_item_by_name</a>
(<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2921223"></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/gtk/GtkObject.html"
>GtkObject</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkContainer.html"
>GtkContainer</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkBin.html"
>GtkBin</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
>GtkWindow</a>
+----GnomeApp
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2921295"></a><h2>Implemented Interfaces</h2>
<p>
GnomeApp implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2921318"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GnomeApp.html#GnomeApp--app-id">app-id</a>" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write / Construct
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2921353"></a><h2>Description</h2>
<p>
The <em class="parameter"><code>GnomeApp</code></em> 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 <a href="GnomeApp.html#gnome-app-set-contents"><code class="function">gnome_app_set_contents()</code></a>
and start the main loop (with <a
href="/usr/share/gtk-doc/html/gtk/gtk-General.html#gtk-main"
><code class="function">gtk_main()</code></a>).
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2921401"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2921412"></a><h3>
<a name="GNOME-APP-MENUBAR-NAME:CAPS"></a>GNOME_APP_MENUBAR_NAME</h3>
<a class="indexterm" name="id2921424"></a><pre class="programlisting">#define GNOME_APP_MENUBAR_NAME "Menubar"
</pre>
<p>
The name of the menubar as it is passed to libbonobo.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2921441"></a><h3>
<a name="GNOME-APP-TOOLBAR-NAME:CAPS"></a>GNOME_APP_TOOLBAR_NAME</h3>
<a class="indexterm" name="id2921454"></a><pre class="programlisting">#define GNOME_APP_TOOLBAR_NAME "Toolbar"
</pre>
<p>
The name of the default toolbar that is added to the application widget by
default.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2921472"></a><h3>
<a name="GnomeApp-struct"></a>GnomeApp</h3>
<a class="indexterm" name="id2921484"></a><pre class="programlisting">typedef struct _GnomeApp GnomeApp;</pre>
<p>
A widget representing an entire GNOME application, including the main window,
menus, toolbar(s) and status bar.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2921501"></a><h3>
<a name="gnome-app-new"></a>gnome_app_new ()</h3>
<a class="indexterm" name="id2921513"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* gnome_app_new (const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *appname,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *title);</pre>
<p>
Create a new (empty) application window. You must specify the <em class="parameter"><code>appname</code></em> (used
internally as an identifier). The <em class="parameter"><code>title</code></em> param can be left as NULL, in
which case the window's title will not be set.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>appname</code></em> :</span></td>
<td> Name of program, used in file names and paths.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>title</code></em> :</span></td>
<td> Window title for application.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> Pointer to new <a href="GnomeApp.html" title="GnomeApp"><span class="type">GnomeApp</span></a> object.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2921619"></a><h3>
<a name="gnome-app-construct"></a>gnome_app_construct ()</h3>
<a class="indexterm" name="id2921632"></a><pre class="programlisting">void gnome_app_construct (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *appname,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *title);</pre>
<p>
Constructor for language bindings; you don't normally need this.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app</code></em> :</span></td>
<td> A newly created <a href="GnomeApp.html" title="GnomeApp"><span class="type">GnomeApp</span></a> object.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>appname</code></em> :</span></td>
<td> Name of program, using in file names and paths.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>title</code></em> :</span></td>
<td> Window title for application.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2921735"></a><h3>
<a name="gnome-app-set-menus"></a>gnome_app_set_menus ()</h3>
<a class="indexterm" name="id2921748"></a><pre class="programlisting">void gnome_app_set_menus (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
<a
href="/usr/share/gtk-doc/html/gtk/GtkMenuBar.html"
>GtkMenuBar</a> *menubar);</pre>
<p>
Sets the menu bar of the application window.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app</code></em> :</span></td>
<td> A <a href="GnomeApp.html" title="GnomeApp"><span class="type">GnomeApp</span></a> instance.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>menubar</code></em> :</span></td>
<td> Menu bar widget for main application window.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2921828"></a><h3>
<a name="gnome-app-set-toolbar"></a>gnome_app_set_toolbar ()</h3>
<a class="indexterm" name="id2921841"></a><pre class="programlisting">void gnome_app_set_toolbar (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
<a
href="/usr/share/gtk-doc/html/gtk/GtkToolbar.html"
>GtkToolbar</a> *toolbar);</pre>
<p>
Sets the main toolbar of the application window.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app</code></em> :</span></td>
<td> A <a href="GnomeApp.html" title="GnomeApp"><span class="type">GnomeApp</span></a> instance.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>toolbar</code></em> :</span></td>
<td> Toolbar widget for main app window.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2921920"></a><h3>
<a name="gnome-app-set-statusbar"></a>gnome_app_set_statusbar ()</h3>
<a class="indexterm" name="id2921933"></a><pre class="programlisting">void gnome_app_set_statusbar (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *statusbar);</pre>
<p>
Sets the status bar of the application window.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app</code></em> :</span></td>
<td> A <a href="GnomeApp.html" title="GnomeApp"><span class="type">GnomeApp</span></a> instance
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>statusbar</code></em> :</span></td>
<td> Statusbar widget for main app window
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2922013"></a><h3>
<a name="gnome-app-set-statusbar-custom"></a>gnome_app_set_statusbar_custom ()</h3>
<a class="indexterm" name="id2922026"></a><pre class="programlisting">void gnome_app_set_statusbar_custom (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *container,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *statusbar);</pre>
<p>
Sets the status bar of the application window, but use <em class="parameter"><code>container</code></em>
as its container.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app</code></em> :</span></td>
<td> A <a href="GnomeApp.html" title="GnomeApp"><span class="type">GnomeApp</span></a> instance
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>container</code></em> :</span></td>
<td> container widget containing the statusbar
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>statusbar</code></em> :</span></td>
<td> Statusbar widget for main app window
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2922135"></a><h3>
<a name="gnome-app-set-contents"></a>gnome_app_set_contents ()</h3>
<a class="indexterm" name="id2922148"></a><pre class="programlisting">void gnome_app_set_contents (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *contents);</pre>
<p>
Sets the content area of the main window of <em class="parameter"><code>app</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app</code></em> :</span></td>
<td> A <a href="GnomeApp.html" title="GnomeApp"><span class="type">GnomeApp</span></a> instance.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>contents</code></em> :</span></td>
<td> Widget to be application content area.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2922233"></a><h3>
<a name="gnome-app-add-toolbar"></a>gnome_app_add_toolbar ()</h3>
<a class="indexterm" name="id2922246"></a><pre class="programlisting">void gnome_app_add_toolbar (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
<a
href="/usr/share/gtk-doc/html/gtk/GtkToolbar.html"
>GtkToolbar</a> *toolbar,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
BonoboDockItemBehavior behavior,
BonoboDockPlacement placement,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> band_num,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> band_position,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> offset);</pre>
<p>
Create a new <span class="type">BonoboDockItem</span> widget containing <em class="parameter"><code>toolbar</code></em>, and add it
to <em class="parameter"><code>app</code></em>'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.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app</code></em> :</span></td>
<td> A <a href="GnomeApp.html" title="GnomeApp"><span class="type">GnomeApp</span></a> widget
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>toolbar</code></em> :</span></td>
<td> Toolbar to be added to <em class="parameter"><code>app</code></em>'s dock
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> Name for the dock item that will contain <em class="parameter"><code>toolbar</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>behavior</code></em> :</span></td>
<td> Behavior for the new dock item
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>placement</code></em> :</span></td>
<td> Placement for the new dock item
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>band_num</code></em> :</span></td>
<td> Number of the band where the dock item should be placed
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>band_position</code></em> :</span></td>
<td> Position of the new dock item in band <em class="parameter"><code>band_num</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>offset</code></em> :</span></td>
<td> Offset from the previous dock item in the band; if there is
no previous item, offset from the beginning of the band.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2922500"></a><h3>
<a name="gnome-app-add-docked"></a>gnome_app_add_docked ()</h3>
<a class="indexterm" name="id2922513"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* gnome_app_add_docked (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
BonoboDockItemBehavior behavior,
BonoboDockPlacement placement,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> band_num,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> band_position,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> offset);</pre>
<p>
Add <em class="parameter"><code>widget</code></em> 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.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app</code></em> :</span></td>
<td> A <a href="GnomeApp.html" title="GnomeApp"><span class="type">GnomeApp</span></a> widget.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>widget</code></em> :</span></td>
<td> Widget to be added to the <a href="GnomeApp.html" title="GnomeApp"><span class="type">GnomeApp</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> Name for the new dock item.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>behavior</code></em> :</span></td>
<td> Behavior for the new dock item.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>placement</code></em> :</span></td>
<td> Placement for the new dock item.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>band_num</code></em> :</span></td>
<td> Number of the band where the dock item should be placed.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>band_position</code></em> :</span></td>
<td> Position of the new dock item in band <em class="parameter"><code>band_num</code></em>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>offset</code></em> :</span></td>
<td> Offset from the previous dock item in the band; if there is
no previous item, offset from the beginning of the band.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The dock item used to contain the widget.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2922760"></a><h3>
<a name="gnome-app-add-dock-item"></a>gnome_app_add_dock_item ()</h3>
<a class="indexterm" name="id2922773"></a><pre class="programlisting">void gnome_app_add_dock_item (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
BonoboDockItem *item,
BonoboDockPlacement placement,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> band_num,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> band_position,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> offset);</pre>
<p>
Add <em class="parameter"><code>item</code></em> according to the specified layout information. Notice
that, if automatic layout configuration is enabled, the layout is
overridden by the saved configuration, if any.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app</code></em> :</span></td>
<td> A <a href="GnomeApp.html" title="GnomeApp"><span class="type">GnomeApp</span></a> widget.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>item</code></em> :</span></td>
<td> Dock item to be added to <em class="parameter"><code>app</code></em>'s dock.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>placement</code></em> :</span></td>
<td> Placement for the dock item.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>band_num</code></em> :</span></td>
<td> Number of the band where the dock item should be placed.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>band_position</code></em> :</span></td>
<td> Position of the dock item in band <em class="parameter"><code>band_num</code></em>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>offset</code></em> :</span></td>
<td> Offset from the previous dock item in the band; if there is
no previous item, offset from the beginning of the band.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2922962"></a><h3>
<a name="gnome-app-enable-layout-config"></a>gnome_app_enable_layout_config ()</h3>
<a class="indexterm" name="id2922976"></a><pre class="programlisting">void gnome_app_enable_layout_config (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> enable);</pre>
<p>
Specify whether <em class="parameter"><code>app</code></em> should automatically save the dock's
layout configuration via gnome-config whenever it changes or not.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app</code></em> :</span></td>
<td> A <a href="GnomeApp.html" title="GnomeApp"><span class="type">GnomeApp</span></a> widget.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>enable</code></em> :</span></td>
<td> Boolean specifying whether automatic configuration saving
is enabled.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2923063"></a><h3>
<a name="gnome-app-get-dock"></a>gnome_app_get_dock ()</h3>
<a class="indexterm" name="id2923076"></a><pre class="programlisting">BonoboDock* gnome_app_get_dock (<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app);</pre>
<p>
Retrieves the <span class="type">BonoboDock</span> widget contained in <em class="parameter"><code>app</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app</code></em> :</span></td>
<td> A <a href="GnomeApp.html" title="GnomeApp"><span class="type">GnomeApp</span></a> widget
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The relevant <span class="type">BonoboDock</span> widget.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2923165"></a><h3>
<a name="gnome-app-get-dock-item-by-name"></a>gnome_app_get_dock_item_by_name ()</h3>
<a class="indexterm" name="id2923178"></a><pre class="programlisting">BonoboDockItem* gnome_app_get_dock_item_by_name
(<a href="GnomeApp.html" title="GnomeApp">GnomeApp</a> *app,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<p>
Retrieve the dock item whose name matches <em class="parameter"><code>name</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app</code></em> :</span></td>
<td> A <a href="GnomeApp.html" title="GnomeApp"><span class="type">GnomeApp</span></a> widget.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> Name of the dock item to retrieve.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The retrieved dock item.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2923276"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2923287"></a><h3>
<a name="GnomeApp--app-id"></a>The "<code class="literal">app-id</code>" property</h3>
<a class="indexterm" name="id2923303"></a><pre class="programlisting"> "app-id" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write / Construct</pre>
<p>The application ID string.</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
</body>
</html>