File: //usr/local/ssl/share/gtk-doc/html/libbonoboui/libbonoboui-bonobo-ui-container.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>BonoboUIContainer</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="LibBonoboUI API Reference Manual">
<link rel="up" href="bonobo-ui.html" title="Bonobo UI">
<link rel="prev" href="libbonoboui-bonobo-ui-component.html" title="BonoboUIComponent">
<link rel="next" href="libbonoboui-bonobo-ui-util.html" title="bonobo-ui-util">
<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="Object Hierarchy">
<link rel="chapter" href="bonobo-controls.html" title="Controls">
<link rel="chapter" href="bonobo-ui.html" title="Bonobo UI">
<link rel="chapter" href="bonobo-support-utilities.html" title="Supporting Classes">
</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="libbonoboui-bonobo-ui-component.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="bonobo-ui.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">LibBonoboUI API Reference Manual</th>
<td><a accesskey="n" href="libbonoboui-bonobo-ui-util.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="#id2785306" class="shortcut">Top</a>
 | 
<a href="#id2785452" class="shortcut">Description</a>
 | 
<a href="#id2785420" class="shortcut">Object Hierarchy</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libbonoboui-bonobo-ui-container"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2785306"></a><span class="refentrytitle">BonoboUIContainer</span>
</h2>
<p>BonoboUIContainer — The container interface as implemented for BonoboWindow</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="BonoboUIContainer"></a><pre class="synopsis">
<a href="libbonoboui-bonobo-ui-container.html#BonoboUIContainer-struct">BonoboUIContainer</a>;
<a href="libbonoboui-bonobo-ui-container.html#BonoboUIContainerPrivate">BonoboUIContainerPrivate</a>;
<a href="libbonoboui-bonobo-ui-container.html#BonoboUIContainerClass">BonoboUIContainerClass</a>;
<a href="libbonoboui-bonobo-ui-container.html#BonoboUIContainer">BonoboUIContainer</a>* <a href="libbonoboui-bonobo-ui-container.html#bonobo-ui-container-new">bonobo_ui_container_new</a> (void);
void <a href="libbonoboui-bonobo-ui-container.html#bonobo-ui-container-set-engine">bonobo_ui_container_set_engine</a> (<a href="libbonoboui-bonobo-ui-container.html#BonoboUIContainer">BonoboUIContainer</a> *container,
<a href="libbonoboui-bonobo-ui-engine.html#BonoboUIEngine">BonoboUIEngine</a> *engine);
<a href="libbonoboui-bonobo-ui-engine.html#BonoboUIEngine">BonoboUIEngine</a>* <a href="libbonoboui-bonobo-ui-container.html#bonobo-ui-container-get-engine">bonobo_ui_container_get_engine</a>
(<a href="libbonoboui-bonobo-ui-container.html#BonoboUIContainer">BonoboUIContainer</a> *container);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2785420"></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/libbonobo/libbonobo-bonobo-object.html#BonoboObject"
>BonoboObject</a>
+----BonoboUIContainer
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2785452"></a><h2>Description</h2>
<p>
A BonoboUIContainer is a very thin object, it implements the CORBA
interface for doing UI merging, but none of the logic. In order
to achieve the effect it is associated with a BonoboUIEngine object.
Traditionaly the UI container was associated with a <a href="libbonoboui-bonobo-window.html#BonoboWindow"><span class="type">BonoboWindow</span></a>
however, this is now strongly deprecated, since the BonoboUIContainer
can be used with any <a href="libbonoboui-bonobo-ui-engine.html#BonoboUIEngine"><span class="type">BonoboUIEngine</span></a>, not just that used by BonoboWindow.
</p>
<p>
Here is how your code should interact with the BonoboUIContainer
</p>
<div class="example">
<a name="id2785492"></a><p class="title"><b>Example 3. How to setup a BonoboUIContainer</b></p>
<pre class="programlisting">
{
BonoboWindow *window;
BonoboUIEngine *engine;
BonoboUIContainer *container;
window = BONOBO_WINDOW (
bonobo_window_new ("Window", "My Test Application"));
container = <a href="libbonoboui-bonobo-ui-container.html#bonobo-ui-container-new"><code class="function">bonobo_ui_container_new()</code></a>;
engine = bonobo_window_get_ui_engine (window);
bonobo_ui_container_set_engine (container, engine);
return window;
}
</pre>
</div>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2785523"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2785533"></a><h3>
<a name="BonoboUIContainer-struct"></a>BonoboUIContainer</h3>
<a class="indexterm" name="id2785547"></a><pre class="programlisting">typedef struct _BonoboUIContainer BonoboUIContainer;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2785562"></a><h3>
<a name="BonoboUIContainerPrivate"></a>BonoboUIContainerPrivate</h3>
<a class="indexterm" name="id2785575"></a><pre class="programlisting">typedef struct _BonoboUIContainerPrivate BonoboUIContainerPrivate;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2785591"></a><h3>
<a name="BonoboUIContainerClass"></a>BonoboUIContainerClass</h3>
<a class="indexterm" name="id2785604"></a><pre class="programlisting">typedef struct {
BonoboObjectClass parent;
POA_Bonobo_UIContainer__epv epv;
gpointer dummy[2];
} BonoboUIContainerClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2785621"></a><h3>
<a name="bonobo-ui-container-new"></a>bonobo_ui_container_new ()</h3>
<a class="indexterm" name="id2785634"></a><pre class="programlisting"><a href="libbonoboui-bonobo-ui-container.html#BonoboUIContainer">BonoboUIContainer</a>* bonobo_ui_container_new (void);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a newly created BonoboUIContainer
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2785674"></a><h3>
<a name="bonobo-ui-container-set-engine"></a>bonobo_ui_container_set_engine ()</h3>
<a class="indexterm" name="id2785688"></a><pre class="programlisting">void bonobo_ui_container_set_engine (<a href="libbonoboui-bonobo-ui-container.html#BonoboUIContainer">BonoboUIContainer</a> *container,
<a href="libbonoboui-bonobo-ui-engine.html#BonoboUIEngine">BonoboUIEngine</a> *engine);</pre>
<p>
Associates the BonoboUIContainer with a <a href="libbonoboui-bonobo-ui-engine.html#BonoboUIEngine"><span class="type">BonoboUIEngine</span></a>
that it will use to handle all the UI merging requests.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>container</code></em> :</span></td>
<td> the container
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>engine</code></em> :</span></td>
<td> the engine
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2785770"></a><h3>
<a name="bonobo-ui-container-get-engine"></a>bonobo_ui_container_get_engine ()</h3>
<a class="indexterm" name="id2785783"></a><pre class="programlisting"><a href="libbonoboui-bonobo-ui-engine.html#BonoboUIEngine">BonoboUIEngine</a>* bonobo_ui_container_get_engine
(<a href="libbonoboui-bonobo-ui-container.html#BonoboUIContainer">BonoboUIContainer</a> *container);</pre>
<p>
Get the associated <a href="libbonoboui-bonobo-ui-engine.html#BonoboUIEngine"><span class="type">BonoboUIEngine</span></a></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>container</code></em> :</span></td>
<td> the UI container
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the engine
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2785854"></a><h2>See Also</h2>
<p>
<a href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent"><span class="type">BonoboUIComponent</span></a>, <a href="libbonoboui-bonobo-ui-engine.html#BonoboUIEngine"><span class="type">BonoboUIEngine</span></a>, <a href="libbonoboui-bonobo-window.html#BonoboWindow"><span class="type">BonoboWindow</span></a>, <a href="libbonoboui-bonobo-ui-sync.html#BonoboUISync"><span class="type">BonoboUISync</span></a>,
<a href="libbonoboui-bonobo-ui-util.html" title="bonobo-ui-util"><a name="id2786561"></a><span class="refentrytitle">bonobo-ui-util</span>(3)</a>
</p>
</div>
</div>
</body>
</html>