File: //usr/local/ssl/share/gtk-doc/html/libbonobo/libbonobo-bonobo-shlib-factory.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>bonobo-shlib-factory</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="factories.html" title="Objects, Factories, Reference Counting">
<link rel="prev" href="libbonobo-bonobo-generic-factory.html" title="BonoboGenericFactory">
<link rel="next" href="refcounting.html" title="Reference Counting">
<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-generic-factory.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="factories.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="refcounting.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="#id2711381" class="shortcut">Top</a>
 | 
<a href="#id2711706" class="shortcut">Description</a>
 | 
<a href="#id2711667" class="shortcut">Object Hierarchy</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libbonobo-bonobo-shlib-factory"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2711381"></a><span class="refentrytitle">bonobo-shlib-factory</span>
</h2>
<p>bonobo-shlib-factory — </p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="BonoboShlibFactory"></a><pre class="synopsis">
<a href="libbonobo-bonobo-shlib-factory.html#BonoboShlibFactory-struct">BonoboShlibFactory</a>;
<a href="libbonobo-bonobo-shlib-factory.html#BonoboShlibFactoryClass">BonoboShlibFactoryClass</a>;
<a href="libbonobo-bonobo-shlib-factory.html#BonoboShlibFactory">BonoboShlibFactory</a>* <a href="libbonobo-bonobo-shlib-factory.html#bonobo-shlib-factory-construct">bonobo_shlib_factory_construct</a>
(<a href="libbonobo-bonobo-shlib-factory.html#BonoboShlibFactory">BonoboShlibFactory</a> *factory,
const char *act_iid,
PortableServer_POA poa,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> act_impl_ptr,
<a
href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"
>GClosure</a> *closure);
<a href="libbonobo-bonobo-shlib-factory.html#BonoboShlibFactory">BonoboShlibFactory</a>* <a href="libbonobo-bonobo-shlib-factory.html#bonobo-shlib-factory-new">bonobo_shlib_factory_new</a>
(const char *component_id,
PortableServer_POA poa,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> act_impl_ptr,
<a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
<a href="libbonobo-bonobo-shlib-factory.html#BonoboShlibFactory">BonoboShlibFactory</a>* <a href="libbonobo-bonobo-shlib-factory.html#bonobo-shlib-factory-new-closure">bonobo_shlib_factory_new_closure</a>
(const char *act_iid,
PortableServer_POA poa,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> act_impl_ptr,
<a
href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"
>GClosure</a> *factory_closure);
Bonobo_Unknown <a href="libbonobo-bonobo-shlib-factory.html#bonobo-shlib-factory-std">bonobo_shlib_factory_std</a> (const char *component_id,
PortableServer_POA poa,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> act_impl_ptr,
<a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data,
CORBA_Environment *ev);
#define <a href="libbonobo-bonobo-shlib-factory.html#BONOBO-OAF-SHLIB-FACTORY:CAPS">BONOBO_OAF_SHLIB_FACTORY</a> (oafiid, descr, fn, data)
#define <a href="libbonobo-bonobo-shlib-factory.html#BONOBO-OAF-SHLIB-FACTORY-MULTI:CAPS">BONOBO_OAF_SHLIB_FACTORY_MULTI</a> (oafiid, descr, fn, data)
#define <a href="libbonobo-bonobo-shlib-factory.html#BONOBO-ACTIVATION-SHLIB-FACTORY:CAPS">BONOBO_ACTIVATION_SHLIB_FACTORY</a> (oafiid, descr, fn, data)
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2711667"></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>
+----BonoboGenericFactory
+----BonoboShlibFactory
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2711706"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2711720"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2711730"></a><h3>
<a name="BonoboShlibFactory-struct"></a>BonoboShlibFactory</h3>
<a class="indexterm" name="id2711744"></a><pre class="programlisting">typedef struct _BonoboShlibFactory BonoboShlibFactory;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2711759"></a><h3>
<a name="BonoboShlibFactoryClass"></a>BonoboShlibFactoryClass</h3>
<a class="indexterm" name="id2711772"></a><pre class="programlisting">typedef struct {
BonoboGenericFactoryClass parent_class;
} BonoboShlibFactoryClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2711789"></a><h3>
<a name="bonobo-shlib-factory-construct"></a>bonobo_shlib_factory_construct ()</h3>
<a class="indexterm" name="id2711802"></a><pre class="programlisting"><a href="libbonobo-bonobo-shlib-factory.html#BonoboShlibFactory">BonoboShlibFactory</a>* bonobo_shlib_factory_construct
(<a href="libbonobo-bonobo-shlib-factory.html#BonoboShlibFactory">BonoboShlibFactory</a> *factory,
const char *act_iid,
PortableServer_POA poa,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> act_impl_ptr,
<a
href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"
>GClosure</a> *closure);</pre>
<p>
Initializes <em class="parameter"><code>c_factory</code></em> with the supplied data.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>factory</code></em> :</span></td>
<td> The object to be initialized.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>act_iid</code></em> :</span></td>
<td> The GOAD id that the new factory will implement.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>poa</code></em> :</span></td>
<td> the poa.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>act_impl_ptr</code></em> :</span></td>
<td> Activation shlib handle
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>closure</code></em> :</span></td>
<td> The closure used to create new GnomeShlib object instances.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The initialized BonoboShlibFactory object.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2711959"></a><h3>
<a name="bonobo-shlib-factory-new"></a>bonobo_shlib_factory_new ()</h3>
<a class="indexterm" name="id2711972"></a><pre class="programlisting"><a href="libbonobo-bonobo-shlib-factory.html#BonoboShlibFactory">BonoboShlibFactory</a>* bonobo_shlib_factory_new
(const char *component_id,
PortableServer_POA poa,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> act_impl_ptr,
<a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre>
<p>
This is a helper routine that simplifies the creation of factory
objects for GNOME objects. The <em class="parameter"><code>factory</code></em> function will be
invoked by the CORBA server when a request arrives to create a new
instance of an object supporting the Bonobo::Shlib interface.
The factory callback routine is passed the <em class="parameter"><code>data</code></em> pointer to provide
the creation function with some state information.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>component_id</code></em> :</span></td>
<td> The GOAD id that this factory implements
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>poa</code></em> :</span></td>
<td> the poa.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>act_impl_ptr</code></em> :</span></td>
<td> Activation shlib handle
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>factory_cb</code></em> :</span></td>
<td> A callback which is used to create new BonoboObject instances.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td> The closure data to be passed to the <em class="parameter"><code>factory</code></em> callback routine.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A BonoboShlibFactory object that has an activated
Bonobo::ShlibFactory object that has registered with the GNOME
name server.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2712148"></a><h3>
<a name="bonobo-shlib-factory-new-closure"></a>bonobo_shlib_factory_new_closure ()</h3>
<a class="indexterm" name="id2712162"></a><pre class="programlisting"><a href="libbonobo-bonobo-shlib-factory.html#BonoboShlibFactory">BonoboShlibFactory</a>* bonobo_shlib_factory_new_closure
(const char *act_iid,
PortableServer_POA poa,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> act_impl_ptr,
<a
href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"
>GClosure</a> *factory_closure);</pre>
<p>
This is a helper routine that simplifies the creation of factory
objects for GNOME objects. The <em class="parameter"><code>factory_closure</code></em> closure will be
invoked by the CORBA server when a request arrives to create a new
instance of an object supporting the Bonobo::Shlib interface.
The factory callback routine is passed the <em class="parameter"><code>data</code></em> pointer to provide
the creation function with some state information.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>act_iid</code></em> :</span></td>
<td> The GOAD id that this factory implements
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>poa</code></em> :</span></td>
<td> the poa.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>act_impl_ptr</code></em> :</span></td>
<td> Activation shlib handle
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>factory_closure</code></em> :</span></td>
<td> A closure which is used to create new BonoboObject instances.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A BonoboShlibFactory object that has an activated
Bonobo::ShlibFactory object that has registered with the GNOME
name server.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2712310"></a><h3>
<a name="bonobo-shlib-factory-std"></a>bonobo_shlib_factory_std ()</h3>
<a class="indexterm" name="id2712322"></a><pre class="programlisting">Bonobo_Unknown bonobo_shlib_factory_std (const char *component_id,
PortableServer_POA poa,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> act_impl_ptr,
<a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data,
CORBA_Environment *ev);</pre>
<p>
A Generic std shlib routine so we don't stick a load of code
inside a public macro.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>component_id</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>poa</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>act_impl_ptr</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>factory_cb</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>ev</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> 0 on success, 1 on failure.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2712492"></a><h3>
<a name="BONOBO-OAF-SHLIB-FACTORY:CAPS"></a>BONOBO_OAF_SHLIB_FACTORY()</h3>
<a class="indexterm" name="id2712506"></a><pre class="programlisting">#define BONOBO_OAF_SHLIB_FACTORY(oafiid, descr, fn, data)</pre>
<p>
Deprecated. See <a href="libbonobo-bonobo-shlib-factory.html#BONOBO-ACTIVATION-SHLIB-FACTORY:CAPS"><code class="function">BONOBO_ACTIVATION_SHLIB_FACTORY()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>oafiid</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>descr</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>fn</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2712592"></a><h3>
<a name="BONOBO-OAF-SHLIB-FACTORY-MULTI:CAPS"></a>BONOBO_OAF_SHLIB_FACTORY_MULTI()</h3>
<a class="indexterm" name="id2712606"></a><pre class="programlisting">#define BONOBO_OAF_SHLIB_FACTORY_MULTI(oafiid, descr, fn, data)</pre>
<p>
Deprecated. See <a href="libbonobo-bonobo-shlib-factory.html#BONOBO-ACTIVATION-SHLIB-FACTORY:CAPS"><code class="function">BONOBO_ACTIVATION_SHLIB_FACTORY()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>oafiid</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>descr</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>fn</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2712692"></a><h3>
<a name="BONOBO-ACTIVATION-SHLIB-FACTORY:CAPS"></a>BONOBO_ACTIVATION_SHLIB_FACTORY()</h3>
<a class="indexterm" name="id2712706"></a><pre class="programlisting">#define BONOBO_ACTIVATION_SHLIB_FACTORY(oafiid, descr, fn, data)</pre>
<p>
Macro that includes all boiler-plate code necessary to create an shlib
type factory.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>oafiid</code></em> :</span></td>
<td>The factory's OAFIID
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>descr</code></em> :</span></td>
<td>Description of the factory
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>fn</code></em> :</span></td>
<td>Function (<a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback"><span class="type">BonoboFactoryCallback</span></a>) responsible for intantiating components
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td>Additional data to be passed to the callback
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>