File: //usr/share/gtk-doc/html/libbonobo/libbonobo-bonobo-item-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>BonoboItemContainer</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="Libbonobo Reference Manual">
<link rel="up" href="monikers.html" title="Monikers">
<link rel="prev" href="libbonobo-bonobo-item-handler.html" title="BonoboItemHandler">
<link rel="next" href="libbonobo-bonobo-moniker-context.html" title="bonobo-moniker-context">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="general.html" title="General">
<link rel="chapter" href="factories.html" title="Objects, Factories, Reference Counting">
<link rel="chapter" href="property-bags.html" title="Property Bags, Events, Listeners">
<link rel="chapter" href="monikers.html" title="Monikers">
<link rel="chapter" href="streams.html" title="Storages and Streams">
<link rel="chapter" href="persist.html" title="Persistency">
<link rel="chapter" href="misc.html" title="Miscellaneous">
</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="libbonobo-bonobo-item-handler.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="monikers.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">Libbonobo Reference Manual</th>
<td><a accesskey="n" href="libbonobo-bonobo-moniker-context.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="#id2773124" class="shortcut">Top</a>
 | 
<a href="#id2773354" class="shortcut">Description</a>
 | 
<a href="#id2773246" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2773278" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libbonobo-bonobo-item-container"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2773124"></a><span class="refentrytitle">BonoboItemContainer</span>
</h2>
<p>BonoboItemContainer — this implements a simple container interface for compound document containers</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="BonoboItemContainer"></a><pre class="synopsis">
<a href="libbonobo-bonobo-item-container.html#BonoboItemContainer-struct">BonoboItemContainer</a>;
<a href="libbonobo-bonobo-item-container.html#BonoboItemContainerClass">BonoboItemContainerClass</a>;
<a href="libbonobo-bonobo-item-container.html#BonoboItemContainer">BonoboItemContainer</a>* <a href="libbonobo-bonobo-item-container.html#bonobo-item-container-new">bonobo_item_container_new</a>
(void);
void <a href="libbonobo-bonobo-item-container.html#bonobo-item-container-add">bonobo_item_container_add</a> (<a href="libbonobo-bonobo-item-container.html#BonoboItemContainer">BonoboItemContainer</a> *container,
const char *name,
<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object);
void <a href="libbonobo-bonobo-item-container.html#bonobo-item-container-remove-by-name">bonobo_item_container_remove_by_name</a>
(<a href="libbonobo-bonobo-item-container.html#BonoboItemContainer">BonoboItemContainer</a> *container,
const char *name);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2773246"></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="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>
+----BonoboItemContainer
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2773278"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="libbonobo-bonobo-item-container.html#BonoboItemContainer-get-object">get-object</a>"
BonoboUnknown*user_function (<a href="libbonobo-bonobo-item-container.html#BonoboItemContainer">BonoboItemContainer</a> *bonoboitemcontainer,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *arg1,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> arg2,
BonoboCorbaException *arg3,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2773354"></a><h2>Description</h2>
<p>
This implementation is mostly deprecated, see <a href="libbonobo-bonobo-item-handler.html#BonoboItemHandler"><span class="type">BonoboItemHandler</span></a>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2773377"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2773388"></a><h3>
<a name="BonoboItemContainer-struct"></a>BonoboItemContainer</h3>
<a class="indexterm" name="id2773401"></a><pre class="programlisting">typedef struct _BonoboItemContainer BonoboItemContainer;</pre>
<p>
Object that implements Bonobo::ItemHandler
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2773418"></a><h3>
<a name="BonoboItemContainerClass"></a>BonoboItemContainerClass</h3>
<a class="indexterm" name="id2773431"></a><pre class="programlisting">typedef struct {
BonoboObjectClass parent_class;
POA_Bonobo_ItemContainer__epv epv;
Bonobo_Unknown (*get_object) (BonoboItemContainer *item_container,
CORBA_char *item_name,
CORBA_boolean only_if_exists,
CORBA_Environment *ev);
} BonoboItemContainerClass;
</pre>
<p>
<a href="libbonobo-bonobo-item-container.html#BonoboItemContainer"><span class="type">BonoboItemContainer</span></a>'s class
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2773459"></a><h3>
<a name="bonobo-item-container-new"></a>bonobo_item_container_new ()</h3>
<a class="indexterm" name="id2773472"></a><pre class="programlisting"><a href="libbonobo-bonobo-item-container.html#BonoboItemContainer">BonoboItemContainer</a>* bonobo_item_container_new
(void);</pre>
<p>
Creates a new BonoboItemContainer object. These are used to hold
client sites.</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> The newly created BonoboItemContainer object
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2773514"></a><h3>
<a name="bonobo-item-container-add"></a>bonobo_item_container_add ()</h3>
<a class="indexterm" name="id2773528"></a><pre class="programlisting">void bonobo_item_container_add (<a href="libbonobo-bonobo-item-container.html#BonoboItemContainer">BonoboItemContainer</a> *container,
const char *name,
<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object);</pre>
<p>
Adds the <em class="parameter"><code>object</code></em> to the list of objects managed by this
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>container</code></em> :</span></td>
<td> The object to operate on.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The name of the object
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>object</code></em> :</span></td>
<td> The object to add to the container
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2773629"></a><h3>
<a name="bonobo-item-container-remove-by-name"></a>bonobo_item_container_remove_by_name ()</h3>
<a class="indexterm" name="id2773643"></a><pre class="programlisting">void bonobo_item_container_remove_by_name
(<a href="libbonobo-bonobo-item-container.html#BonoboItemContainer">BonoboItemContainer</a> *container,
const char *name);</pre>
<p>
Removes the named object from the <em class="parameter"><code>container</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>container</code></em> :</span></td>
<td> The object to operate on.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The name of the object to remove from the container
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2773723"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2773733"></a><h3>
<a name="BonoboItemContainer-get-object"></a>The "get-object" signal</h3>
<a class="indexterm" name="id2773745"></a><pre class="programlisting">BonoboUnknown*user_function (<a href="libbonobo-bonobo-item-container.html#BonoboItemContainer">BonoboItemContainer</a> *bonoboitemcontainer,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *arg1,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> arg2,
BonoboCorbaException *arg3,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
Signal emitted when a sub-object is requested from the item container.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>bonoboitemcontainer</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>arg1</code></em> :</span></td>
<td>the item name, i.e. the string after the '!' character, usually a semicolon separated list of key=value options
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>arg2</code></em> :</span></td>
<td>the "only_if_exists" flag; if <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>, client requests that subobject be returned if it exists, but that it should not be created on demand if it doesn't
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>arg3</code></em> :</span></td>
<td>environment, in case the signal wishes to raise an exception
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>an object contained by the item container, or <code class="literal">CORBA_OBJECT_NIL</code>.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2773920"></a><h2>See Also</h2>
<p>
<a href="libbonobo-bonobo-item-handler.html#BonoboItemHandler"><span class="type">BonoboItemHandler</span></a>
</p>
</div>
</div>
</body>
</html>