|
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 : /usr/share/gtk-doc/html/libbonobo/ |
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>BonoboObject</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="factories.html" title="Objects, Factories, Reference Counting">
<link rel="next" href="libbonobo-bonobo-generic-factory.html" title="BonoboGenericFactory">
<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="factories.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="libbonobo-bonobo-generic-factory.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="#id2698482" class="shortcut">Top</a>
 | 
<a href="#id2699523" class="shortcut">Description</a>
 | 
<a href="#id2699297" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2699390" class="shortcut">Properties</a>
 | 
<a href="#id2699422" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libbonobo-bonobo-object"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2698482"></a><span class="refentrytitle">BonoboObject</span>
</h2>
<p>BonoboObject — Base object for wrapping Bonobo::Unknown derived objects. Implements
<a href="libbonobo-bonobo-object.html#bonobo-unknown-img" title="Figure 1. The Bonobo::Unknown interface">Figure 1, “The Bonobo::Unknown interface”</a>.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="BonoboObject"></a><pre class="synopsis">
#define <a href="libbonobo-bonobo-object.html#BONOBO-OBJECT-TYPE:CAPS">BONOBO_OBJECT_TYPE</a>
#define <a href="libbonobo-bonobo-object.html#BONOBO-OBJREF:CAPS">BONOBO_OBJREF</a> (o)
void (<a href="libbonobo-bonobo-object.html#BonoboObjectPOAFn">*BonoboObjectPOAFn</a>) (PortableServer_Servant servant,
CORBA_Environment *ev);
<a href="libbonobo-bonobo-object.html#BonoboObject-struct">BonoboObject</a>;
<a href="libbonobo-bonobo-object.html#BonoboObjectClass">BonoboObjectClass</a>;
void <a href="libbonobo-bonobo-object.html#bonobo-object-add-interface">bonobo_object_add_interface</a> (<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object,
<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *newobj);
<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>* <a href="libbonobo-bonobo-object.html#bonobo-object-query-local-interface">bonobo_object_query_local_interface</a>
(<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object,
const char *repo_id);
Bonobo_Unknown <a href="libbonobo-bonobo-object.html#bonobo-object-query-interface">bonobo_object_query_interface</a>
(<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object,
const char *repo_id,
CORBA_Environment *opt_ev);
Bonobo_Unknown <a href="libbonobo-bonobo-object.html#bonobo-object-query-remote">bonobo_object_query_remote</a> (Bonobo_Unknown unknown,
const char *repo_id,
CORBA_Environment *opt_ev);
Bonobo_Unknown <a href="libbonobo-bonobo-object.html#bonobo-object-corba-objref">bonobo_object_corba_objref</a> (<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object);
Bonobo_Unknown <a href="libbonobo-bonobo-object.html#bonobo-object-dup-ref">bonobo_object_dup_ref</a> (Bonobo_Unknown object,
CORBA_Environment *opt_ev);
Bonobo_Unknown <a href="libbonobo-bonobo-object.html#bonobo-object-release-unref">bonobo_object_release_unref</a> (Bonobo_Unknown object,
CORBA_Environment *opt_ev);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> <a href="libbonobo-bonobo-object.html#bonobo-object-ref">bonobo_object_ref</a> (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> obj);
void <a href="libbonobo-bonobo-object.html#bonobo-object-idle-unref">bonobo_object_idle_unref</a> (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> obj);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> <a href="libbonobo-bonobo-object.html#bonobo-object-unref">bonobo_object_unref</a> (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> obj);
void <a href="libbonobo-bonobo-object.html#bonobo-object-set-immortal">bonobo_object_set_immortal</a> (<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> immortal);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> <a href="libbonobo-bonobo-object.html#bonobo-object-trace-refs">bonobo_object_trace_refs</a> (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> obj,
const char *fn,
int line,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> ref);
void <a href="libbonobo-bonobo-object.html#bonobo-object-dump-interfaces">bonobo_object_dump_interfaces</a> (<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object);
void <a href="libbonobo-bonobo-object.html#bonobo-object-check-env">bonobo_object_check_env</a> (<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object,
CORBA_Object corba_object,
CORBA_Environment *ev);
#define <a href="libbonobo-bonobo-object.html#BONOBO-OBJECT-CHECK:CAPS">BONOBO_OBJECT_CHECK</a> (o,c,e)
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libbonobo-bonobo-object.html#bonobo-unknown-ping">bonobo_unknown_ping</a> (Bonobo_Unknown object,
CORBA_Environment *opt_ev);
void <a href="libbonobo-bonobo-object.html#bonobo-object-list-unref-all">bonobo_object_list_unref_all</a> (<a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
>GList</a> **list);
void <a href="libbonobo-bonobo-object.html#bonobo-object-slist-unref-all">bonobo_object_slist_unref_all</a> (<a
href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> **list);
<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>* <a href="libbonobo-bonobo-object.html#bonobo-object">bonobo_object</a> (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> p);
#define <a href="libbonobo-bonobo-object.html#bonobo-object-fast">bonobo_object_fast</a> (o)
#define <a href="libbonobo-bonobo-object.html#bonobo-object-from-servant">bonobo_object_from_servant</a> (s)
#define <a href="libbonobo-bonobo-object.html#bonobo-object-get-servant">bonobo_object_get_servant</a> (o)
PortableServer_POA <a href="libbonobo-bonobo-object.html#bonobo-object-get-poa">bonobo_object_get_poa</a> (<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object);
<a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
>GType</a> <a href="libbonobo-bonobo-object.html#bonobo-type-unique">bonobo_type_unique</a> (<a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
>GType</a> parent_type,
<a href="libbonobo-bonobo-object.html#BonoboObjectPOAFn">BonoboObjectPOAFn</a> init_fn,
<a href="libbonobo-bonobo-object.html#BonoboObjectPOAFn">BonoboObjectPOAFn</a> fini_fn,
int epv_struct_offset,
const <a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GTypeInfo"
>GTypeInfo</a> *info,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *type_name);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libbonobo-bonobo-object.html#bonobo-type-setup">bonobo_type_setup</a> (<a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
>GType</a> type,
<a href="libbonobo-bonobo-object.html#BonoboObjectPOAFn">BonoboObjectPOAFn</a> init_fn,
<a href="libbonobo-bonobo-object.html#BonoboObjectPOAFn">BonoboObjectPOAFn</a> fini_fn,
int epv_struct_offset);
#define <a href="libbonobo-bonobo-object.html#BONOBO-TYPE-FUNC-FULL:CAPS">BONOBO_TYPE_FUNC_FULL</a> (class_name, corba_name, parent, prefix)
#define <a href="libbonobo-bonobo-object.html#BONOBO-TYPE-FUNC:CAPS">BONOBO_TYPE_FUNC</a> (class_name, parent, prefix)
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2699297"></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>
+----BonoboObject
+----BonoboGenericFactory
+----<a href="libbonobo-bonobo-persist.html#BonoboPersist">BonoboPersist</a>
+----<a href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtender">BonoboMonikerExtender</a>
+----<a href="libbonobo-bonobo-item-container.html#BonoboItemContainer">BonoboItemContainer</a>
+----<a href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem">BonoboStreamMem</a>
+----<a href="libbonobo-bonobo-item-handler.html#BonoboItemHandler">BonoboItemHandler</a>
+----<a href="libbonobo-bonobo-listener.html#BonoboListener">BonoboListener</a>
+----<a href="libbonobo-bonobo-moniker.html#BonoboMoniker">BonoboMoniker</a>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2699390"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="libbonobo-bonobo-object.html#BonoboObject--poa">poa</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2699422"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="libbonobo-bonobo-object.html#BonoboObject-destroy">destroy</a>" void user_function (<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *bonoboobject,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
"<a href="libbonobo-bonobo-object.html#BonoboObject-system-exception">system-exception</a>"
void user_function (<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *bonoboobject,
CorbaObject *arg1,
BonoboCorbaException *arg2,
<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="id2699523"></a><h2>Description</h2>
<p>
BonoboObject provides an easy to use way of writing CORBA servers. It
drastically simplifies the issues of epv and vepv construction by
automating these, and automatically instantiates a CORBA_Object on
g_object_new. This removes clutter from construction time. For
libbonobo-2.0, it strongly deprecates <span class="type">BonoboXObject</span>.
</p>
<div class="figure">
<a name="bonobo-unknown-img"></a><p class="title"><b>Figure 1. The Bonobo::Unknown interface</b></p>
<div class="mediaobject"><img src="unknown.png" alt="The Bonobo::Unknown interface"></div>
</div>
<p>
The <code class="classname">Bonobo::Unknown</code> interface (wrapped by
BonoboObject) is the foundation for the component system: it provides
life cycle management for objects as well as service discovery.
</p>
<p>
The Bonobo interfaces are all based on the
<code class="classname">Bonobo::Unknown</code> interface. This
interface is very simple and provides two basic services:
object lifetime management and object
functionality-discovery. This interface only contains three
methods, here it is:
</p>
<pre class="programlisting">
module Bonobo {
interface Unknown {
void void <code class="function">ref()</code>;
void void <code class="function">unref()</code>;
Object query_interface (in string repoid);
};
};
</pre>
<p>
</p>
<p>
The <code class="function"><code class="function">ref()</code></code> and <code class="function"><code class="function">unref()</code></code>
methods are used to control the lifetime of an object. The
<code class="function">query_interface</code> method is used to discover
optional functionality provided by the object implementation.
</p>
<p>
The lifetime management is based on reference counting: when a
component is initially launched, it starts life with a reference
count of one. This reference is held by the component invoker.
Each time a reference is kept to this object (say, you store a
copy of the object in an array), the reference count is
incremented. Every time a reference goes out of scope, the
reference count needs to be decremented. When the reference
count reaches zero, the component knows that there are no
outstanding references to it, and it is safe to shutdown. At
this point, the component shuts down.
</p>
<p>
It is possible to ask an object which implements the
<code class="classname">Bonobo::Unknown</code> interface if it supports
other CORBA interfaces. For example, it would be possible to
ask an object whether it supports the
"IDL:Bonobo/EmbeddablePrint:1.0" interface to find out if it is
possible to print its contents. If the return value from
invoking the <code class="function">query_interface</code> method on the
interface is CORBA_OBJECT_NIL, then we know that the requested interface
is not supported. Otherwise, we can invoke
IDL:Bonobo/EmbeddablePrint:1.0 methods on the returned CORBA
Object.
</p>
<p>
Clients of the <code class="function">query_interface</code> method use
it to discover dynamically if a component supports a given
interface. Sometimes the client code would require a specific
interface to exist, but many times it is possible to operate in
a "downgraded" mode. You should design your code to be able to
cope with the lack of interfaces in objects. This will allow
your program to deal with more components, and this also allows
components to work in more situations.
</p>
<p>
For example, a help browser can load an HTML renderer component and
ask this component which sort of features are supported by it:
</p>
<pre class="programlisting">
stop_animations (BrowserHTML html)
{
BrowserControl control
control = html->query_interface ("IDL:Browser/Control:1.0");
if (control)
control-><code class="function">stop_animations()</code>;
}
</pre>
<p>
</p>
<p>
The return value of the query_interface invocation contains a
reference to a CORBA object that is derived from the
<code class="classname">Bonobo::Unknown</code> interface or
CORBA_OBJECT_NIL if the interface is not supported by the
object. And this interface would have been already
<code class="function"><code class="function">ref()</code></code>ed before it was returned. It is up
to the caller to call <code class="function"><code class="function">unref()</code></code> when they are
done using the interface.
</p>
<p>
BonoboObject implements the Bonobo::Unknown interface and exports the
implementations of the methods in this class to simplify creating
new objects that inherit from Bonobo::Unknown. This base object
provides default implementations for the ref, unref and
query_interface methods.
</p>
<p>
Other implementations reuse this implementation by listing on their
VEPV tables the bonobo_object_epv entry point vector.
</p>
<p>
The <code class="classname">Bonobo::Unknown</code> interface is inspired
by the Microsoft COM <code class="classname">IUnknown</code> interface
but it has been translated into the CORBA world.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2699812"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2699823"></a><h3>
<a name="BONOBO-OBJECT-TYPE:CAPS"></a>BONOBO_OBJECT_TYPE</h3>
<a class="indexterm" name="id2699836"></a><pre class="programlisting">#define BONOBO_OBJECT_TYPE BONOBO_TYPE_OBJECT /* deprecated, you should use BONOBO_TYPE_OBJECT */
</pre>
<p>
Returns the <a
href="/usr/share/gtk-doc/html/gtk/gtk-Types.html#GtkType"
><span class="type">GtkType</span></a> for the BonoboObject object.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2699862"></a><h3>
<a name="BONOBO-OBJREF:CAPS"></a>BONOBO_OBJREF()</h3>
<a class="indexterm" name="id2699874"></a><pre class="programlisting">#define BONOBO_OBJREF(o) (bonobo_object_corba_objref(BONOBO_OBJECT(o)))
</pre>
<p>
This macro returns the CORBA object reference inside a <a href="libbonobo-bonobo-object.html#BonoboObject"><span class="type">BonoboObject</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>o</code></em> :</span></td>
<td>a <a href="libbonobo-bonobo-object.html#BonoboObject"><span class="type">BonoboObject</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2699926"></a><h3>
<a name="BonoboObjectPOAFn"></a>BonoboObjectPOAFn ()</h3>
<a class="indexterm" name="id2699939"></a><pre class="programlisting">void (*BonoboObjectPOAFn) (PortableServer_Servant servant,
CORBA_Environment *ev);</pre>
<p>
Signature of POA initialization and finalization functions
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>servant</code></em> :</span></td>
<td>the object's servant
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>ev</code></em> :</span></td>
<td>CORBA environment
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2700008"></a><h3>
<a name="BonoboObject-struct"></a>BonoboObject</h3>
<a class="indexterm" name="id2700021"></a><pre class="programlisting">typedef struct _BonoboObject BonoboObject;</pre>
<p>
Implements Bonobo::Unknown.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2700038"></a><h3>
<a name="BonoboObjectClass"></a>BonoboObjectClass</h3>
<a class="indexterm" name="id2700050"></a><pre class="programlisting">typedef struct {
GObjectClass parent_class;
/* signals. */
void (*destroy) (BonoboObject *object);
void (*system_exception) (BonoboObject *object,
CORBA_Object cobject,
CORBA_Environment *ev);
BonoboObjectPOAFn poa_init_fn;
BonoboObjectPOAFn poa_fini_fn;
POA_Bonobo_Unknown__vepv *vepv;
/* The offset of this class' additional epv */
int epv_struct_offset;
PortableServer_ServantBase__epv base_epv;
POA_Bonobo_Unknown__epv epv;
gpointer dummy[4];
} BonoboObjectClass;
</pre>
<p>
BonoboObject's class.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2700076"></a><h3>
<a name="bonobo-object-add-interface"></a>bonobo_object_add_interface ()</h3>
<a class="indexterm" name="id2700090"></a><pre class="programlisting">void bonobo_object_add_interface (<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object,
<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *newobj);</pre>
<p>
Adds the interfaces supported by <em class="parameter"><code>newobj</code></em> to the list of interfaces
for <em class="parameter"><code>object</code></em>. This function adds the interfaces supported by
<em class="parameter"><code>newobj</code></em> to the list of interfaces support by <em class="parameter"><code>object</code></em>. It should never
be used when the object has been exposed to the world. This is a firm
part of the contract.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>object</code></em> :</span></td>
<td> The BonoboObject to which an interface is going to be added.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>newobj</code></em> :</span></td>
<td> The BonoboObject containing the new interface to be added.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2700191"></a><h3>
<a name="bonobo-object-query-local-interface"></a>bonobo_object_query_local_interface ()</h3>
<a class="indexterm" name="id2700206"></a><pre class="programlisting"><a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>* bonobo_object_query_local_interface
(<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object,
const char *repo_id);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>object</code></em> :</span></td>
<td> A <a href="libbonobo-bonobo-object.html#BonoboObject"><span class="type">BonoboObject</span></a> which is the aggregate of multiple objects.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>repo_id</code></em> :</span></td>
<td> The id of the interface being queried.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A <a href="libbonobo-bonobo-object.html#BonoboObject"><span class="type">BonoboObject</span></a> for the requested interface.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2700306"></a><h3>
<a name="bonobo-object-query-interface"></a>bonobo_object_query_interface ()</h3>
<a class="indexterm" name="id2700319"></a><pre class="programlisting">Bonobo_Unknown bonobo_object_query_interface
(<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object,
const char *repo_id,
CORBA_Environment *opt_ev);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>object</code></em> :</span></td>
<td> A BonoboObject to be queried for a given interface.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>repo_id</code></em> :</span></td>
<td> The name of the interface to be queried.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>opt_ev</code></em> :</span></td>
<td> optional exception environment
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The CORBA interface named <em class="parameter"><code>repo_id</code></em> for <em class="parameter"><code>object</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2700438"></a><h3>
<a name="bonobo-object-query-remote"></a>bonobo_object_query_remote ()</h3>
<a class="indexterm" name="id2700451"></a><pre class="programlisting">Bonobo_Unknown bonobo_object_query_remote (Bonobo_Unknown unknown,
const char *repo_id,
CORBA_Environment *opt_ev);</pre>
<p>
A helper wrapper for query interface</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>unknown</code></em> :</span></td>
<td> an unknown object ref ( or NIL )
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>repo_id</code></em> :</span></td>
<td> the interface to query for
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>opt_ev</code></em> :</span></td>
<td> an optional exception environment
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the interface or CORBA_OBJECT_NIL
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2700557"></a><h3>
<a name="bonobo-object-corba-objref"></a>bonobo_object_corba_objref ()</h3>
<a class="indexterm" name="id2700571"></a><pre class="programlisting">Bonobo_Unknown bonobo_object_corba_objref (<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>object</code></em> :</span></td>
<td> A BonoboObject whose CORBA object is requested.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The CORBA interface object for which <em class="parameter"><code>object</code></em> is a wrapper.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2700638"></a><h3>
<a name="bonobo-object-dup-ref"></a>bonobo_object_dup_ref ()</h3>
<a class="indexterm" name="id2700652"></a><pre class="programlisting">Bonobo_Unknown bonobo_object_dup_ref (Bonobo_Unknown object,
CORBA_Environment *opt_ev);</pre>
<p>
This function returns a duplicated CORBA Object reference;
it also bumps the ref count on the object. This is ideal to
use in any method returning a Bonobo_Object in a CORBA impl.
If object is CORBA_OBJECT_NIL it is returned unaffected.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>object</code></em> :</span></td>
<td> a Bonobo_Unknown corba object
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>opt_ev</code></em> :</span></td>
<td> an optional exception environment
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> duplicated & ref'd corba object reference.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2700741"></a><h3>
<a name="bonobo-object-release-unref"></a>bonobo_object_release_unref ()</h3>
<a class="indexterm" name="id2700754"></a><pre class="programlisting">Bonobo_Unknown bonobo_object_release_unref (Bonobo_Unknown object,
CORBA_Environment *opt_ev);</pre>
<p>
This function releases a CORBA Object reference;
it also decrements the ref count on the bonobo object.
This is the converse of bonobo_object_dup_ref. We
tolerate object == CORBA_OBJECT_NIL silently.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>object</code></em> :</span></td>
<td> a Bonobo_Unknown corba object
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>opt_ev</code></em> :</span></td>
<td> an optional exception environment
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <code class="literal">CORBA_OBJECT_NIL</code>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2700852"></a><h3>
<a name="bonobo-object-ref"></a>bonobo_object_ref ()</h3>
<a class="indexterm" name="id2700865"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> bonobo_object_ref (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> obj);</pre>
<p>
Increments the reference count for the aggregate BonoboObject.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
<td> A BonoboObject you want to ref-count
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <em class="parameter"><code>object</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2700931"></a><h3>
<a name="bonobo-object-idle-unref"></a>bonobo_object_idle_unref ()</h3>
<a class="indexterm" name="id2700944"></a><pre class="programlisting">void bonobo_object_idle_unref (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> obj);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2700990"></a><h3>
<a name="bonobo-object-unref"></a>bonobo_object_unref ()</h3>
<a class="indexterm" name="id2701004"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> bonobo_object_unref (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> obj);</pre>
<p>
Decrements the reference count for the aggregate BonoboObject.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
<td> A BonoboObject you want to unref.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2701074"></a><h3>
<a name="bonobo-object-set-immortal"></a>bonobo_object_set_immortal ()</h3>
<a class="indexterm" name="id2701088"></a><pre class="programlisting">void bonobo_object_set_immortal (<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> immortal);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>object</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>immortal</code></em> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2701155"></a><h3>
<a name="bonobo-object-trace-refs"></a>bonobo_object_trace_refs ()</h3>
<a class="indexterm" name="id2701167"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> bonobo_object_trace_refs (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> obj,
const char *fn,
int line,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> ref);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>obj</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>line</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>ref</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2701286"></a><h3>
<a name="bonobo-object-dump-interfaces"></a>bonobo_object_dump_interfaces ()</h3>
<a class="indexterm" name="id2701299"></a><pre class="programlisting">void bonobo_object_dump_interfaces (<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>object</code></em> :</span></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2701346"></a><h3>
<a name="bonobo-object-check-env"></a>bonobo_object_check_env ()</h3>
<a class="indexterm" name="id2701359"></a><pre class="programlisting">void bonobo_object_check_env (<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object,
CORBA_Object corba_object,
CORBA_Environment *ev);</pre>
<p>
This routine verifies the <em class="parameter"><code>ev</code></em> environment for any fatal system
exceptions. If a system exception occurs, the object raises a
"system_exception" signal. The idea is that GObjects which are
used to wrap a CORBA interface can use this function to notify
the user if a fatal exception has occurred, causing the object
to become defunct.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>object</code></em> :</span></td>
<td> The object on which we operate
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>corba_object</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>ev</code></em> :</span></td>
<td> CORBA Environment to check
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2701464"></a><h3>
<a name="BONOBO-OBJECT-CHECK:CAPS"></a>BONOBO_OBJECT_CHECK()</h3>
<a class="indexterm" name="id2701477"></a><pre class="programlisting">#define BONOBO_OBJECT_CHECK(o,c,e)</pre>
<p>
Checks if the exception in <em class="parameter"><code>e</code></em> needs to be signaled. If so, then
the proper exception signal is generated on the BonoboObject object
<em class="parameter"><code>o</code></em> for the CORBA reference <em class="parameter"><code>c</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>o</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>c</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>e</code></em> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2701556"></a><h3>
<a name="bonobo-unknown-ping"></a>bonobo_unknown_ping ()</h3>
<a class="indexterm" name="id2701569"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> bonobo_unknown_ping (Bonobo_Unknown object,
CORBA_Environment *opt_ev);</pre>
<p>
Pings the object <em class="parameter"><code>object</code></em> using the ref/unref methods from Bonobo::Unknown.
You can use this one to see if a remote object has gone away.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>object</code></em> :</span></td>
<td> a CORBA object reference of type Bonobo::Unknown
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>opt_ev</code></em> :</span></td>
<td> optional exception environment
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the Bonobo::Unknown <em class="parameter"><code>object</code></em> is alive.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2701676"></a><h3>
<a name="bonobo-object-list-unref-all"></a>bonobo_object_list_unref_all ()</h3>
<a class="indexterm" name="id2701690"></a><pre class="programlisting">void bonobo_object_list_unref_all (<a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
>GList</a> **list);</pre>
<p>
This routine unrefs all valid objects in
the list and then removes them from <em class="parameter"><code>list</code></em> if
they have not already been so removed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>list</code></em> :</span></td>
<td> A list of BonoboObjects *s
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2701748"></a><h3>
<a name="bonobo-object-slist-unref-all"></a>bonobo_object_slist_unref_all ()</h3>
<a class="indexterm" name="id2701762"></a><pre class="programlisting">void bonobo_object_slist_unref_all (<a
href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> **list);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>list</code></em> :</span></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2701808"></a><h3>
<a name="bonobo-object"></a>bonobo_object ()</h3>
<a class="indexterm" name="id2701821"></a><pre class="programlisting"><a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>* bonobo_object (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> p);</pre>
<p>
This function can be passed a BonoboObject * or a
PortableServer_Servant, and it will return a BonoboObject *.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>p</code></em> :</span></td>
<td> a pointer to something
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a BonoboObject or NULL on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2701883"></a><h3>
<a name="bonobo-object-fast"></a>bonobo_object_fast()</h3>
<a class="indexterm" name="id2701896"></a><pre class="programlisting">#define bonobo_object_fast(o)</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>o</code></em> :</span></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2701929"></a><h3>
<a name="bonobo-object-from-servant"></a>bonobo_object_from_servant()</h3>
<a class="indexterm" name="id2701942"></a><pre class="programlisting">#define bonobo_object_from_servant(s) ((BonoboObject *)(((guchar *) (s)) - BONOBO_OBJECT_HEADER_SIZE))
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>s</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2701986"></a><h3>
<a name="bonobo-object-get-servant"></a>bonobo_object_get_servant()</h3>
<a class="indexterm" name="id2701999"></a><pre class="programlisting">#define bonobo_object_get_servant(o) ((PortableServer_Servant)((guchar *)(o) + BONOBO_OBJECT_HEADER_SIZE))
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>o</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2702044"></a><h3>
<a name="bonobo-object-get-poa"></a>bonobo_object_get_poa ()</h3>
<a class="indexterm" name="id2702056"></a><pre class="programlisting">PortableServer_POA bonobo_object_get_poa (<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object);</pre>
<p>
Gets the POA associated with this part of the
BonoboObject aggregate it is possible to have
different POAs per interface.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>object</code></em> :</span></td>
<td> the object associated with an interface
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the poa, never NIL.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2702120"></a><h3>
<a name="bonobo-type-unique"></a>bonobo_type_unique ()</h3>
<a class="indexterm" name="id2702133"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
>GType</a> bonobo_type_unique (<a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
>GType</a> parent_type,
<a href="libbonobo-bonobo-object.html#BonoboObjectPOAFn">BonoboObjectPOAFn</a> init_fn,
<a href="libbonobo-bonobo-object.html#BonoboObjectPOAFn">BonoboObjectPOAFn</a> fini_fn,
int epv_struct_offset,
const <a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GTypeInfo"
>GTypeInfo</a> *info,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *type_name);</pre>
<p>
This function is the main entry point for deriving bonobo
server interfaces.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>parent_type</code></em> :</span></td>
<td> the parent GType
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>init_fn</code></em> :</span></td>
<td> a POA initialization function
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>fini_fn</code></em> :</span></td>
<td> a POA finialization function or NULL
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>epv_struct_offset</code></em> :</span></td>
<td> the offset into the struct that the epv
commences at, or 0 if we are inheriting a plain GObject
from a BonoboObject, adding no new CORBA interfaces
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>info</code></em> :</span></td>
<td> the standard GTypeInfo.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>type_name</code></em> :</span></td>
<td> the name of the type being registered.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the constructed GType.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2702306"></a><h3>
<a name="bonobo-type-setup"></a>bonobo_type_setup ()</h3>
<a class="indexterm" name="id2702320"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> bonobo_type_setup (<a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
>GType</a> type,
<a href="libbonobo-bonobo-object.html#BonoboObjectPOAFn">BonoboObjectPOAFn</a> init_fn,
<a href="libbonobo-bonobo-object.html#BonoboObjectPOAFn">BonoboObjectPOAFn</a> fini_fn,
int epv_struct_offset);</pre>
<p>
This function initializes a type derived from BonoboObject, such that
when you instantiate a new object of this type with g_type_new the
CORBA object will be correctly created and embedded.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>type</code></em> :</span></td>
<td> The type to initialize
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>init_fn</code></em> :</span></td>
<td> the POA_init function for the CORBA interface or NULL
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>fini_fn</code></em> :</span></td>
<td> NULL or a custom POA free fn.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>epv_struct_offset</code></em> :</span></td>
<td> the offset in the class structure where the epv is or 0
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success, FALSE on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2702450"></a><h3>
<a name="BONOBO-TYPE-FUNC-FULL:CAPS"></a>BONOBO_TYPE_FUNC_FULL()</h3>
<a class="indexterm" name="id2702463"></a><pre class="programlisting">#define BONOBO_TYPE_FUNC_FULL(class_name, corba_name, parent, prefix)</pre>
<p>
Macro that includes all the boilerplate code need to register a
new BonoboObject-derived class. The programmer has to define two
functions only: <em class="parameter"><code>prefix_init</code></em> and <em class="parameter"><code>prefix_class_init</code></em>. As a result
of the macro expansion, a function named @<code class="function">prefix_get_type()</code> is
defined.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>class_name</code></em> :</span></td>
<td>Name of the GObject class, LikeThis
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>corba_name</code></em> :</span></td>
<td>Name of the CORBA interface, with IDL-to-C mapping, Like_This
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>parent</code></em> :</span></td>
<td>GType of the parent class, LIKE_TYPE_THIS
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>prefix</code></em> :</span></td>
<td>prefix of the implementation functions
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2702569"></a><h3>
<a name="BONOBO-TYPE-FUNC:CAPS"></a>BONOBO_TYPE_FUNC()</h3>
<a class="indexterm" name="id2702582"></a><pre class="programlisting">#define BONOBO_TYPE_FUNC(class_name, parent, prefix)</pre>
<p>
Like <a href="libbonobo-bonobo-object.html#BONOBO-TYPE-FUNC:CAPS"><span class="type">BONOBO_TYPE_FUNC</span></a>, but doesn't set POA ini and fini functions.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>class_name</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>parent</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>prefix</code></em> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2702653"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2702663"></a><h3>
<a name="BonoboObject--poa"></a>The "<code class="literal">poa</code>" property</h3>
<a class="indexterm" name="id2702679"></a><pre class="programlisting"> "poa" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> : Read / Write / Construct Only</pre>
<p>
Pass this property during construction to specify a custom POA for a BonoboObject. Example:
</p>
<div class="informalexample"><pre class="programlisting">
BonoboObject * my_bonobo_object_new (void)
{
BonoboObject *object;
object = g_object_new (MY_TYPE_BONOBO_OBJECT, "poa",
bonobo_poa_get_threaded (BONOBO_POA_ALL_AT_IDLE), NULL);
return object;
}
</pre></div>
<p>
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2702717"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2702727"></a><h3>
<a name="BonoboObject-destroy"></a>The "destroy" signal</h3>
<a class="indexterm" name="id2702738"></a><pre class="programlisting">void user_function (<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *bonoboobject,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
Signal emitted when the last reference of a BonoboObject has been
lost and the object is being destroyed / finalized / deactivated.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>bonoboobject</code></em> :</span></td>
<td>the object which received the signal.
</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>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2702809"></a><h3>
<a name="BonoboObject-system-exception"></a>The "system-exception" signal</h3>
<a class="indexterm" name="id2702820"></a><pre class="programlisting">void user_function (<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *bonoboobject,
CorbaObject *arg1,
BonoboCorbaException *arg2,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
Signal emitted from bonobo_object_check_env if a system exception is identified.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>bonoboobject</code></em> :</span></td>
<td>the <a href="libbonobo-bonobo-object.html#BonoboObject"><span class="type">BonoboObject</span></a> which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>arg1</code></em> :</span></td>
<td>the CORBA_Object contained in <em class="parameter"><code>bonoboobject</code></em>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>arg2</code></em> :</span></td>
<td>the exception that has just occurred.
</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>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2702952"></a><h2>See Also</h2>
<p>
<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a>
</p>
</div>
</div>
</body>
</html>