File: //usr/share/gtk-doc/html/libbonobo/libbonobo-bonobo-moniker-extender.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>BonoboMonikerExtender</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-moniker-util.html" title="bonobo-moniker-util">
<link rel="next" href="libbonobo-bonobo-item-handler.html" title="BonoboItemHandler">
<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-moniker-util.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-item-handler.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="#id2768902" class="shortcut">Top</a>
 | 
<a href="#id2769163" class="shortcut">Description</a>
 | 
<a href="#id2769131" class="shortcut">Object Hierarchy</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libbonobo-bonobo-moniker-extender"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2768902"></a><span class="refentrytitle">BonoboMonikerExtender</span>
</h2>
<p>BonoboMonikerExtender — A way to extend arbitary monikers</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="BonoboMonikerExtender"></a><pre class="synopsis">
<a href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtender-struct">BonoboMonikerExtender</a>;
<a href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtenderClass">BonoboMonikerExtenderClass</a>;
Bonobo_Unknown (<a href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtenderFn">*BonoboMonikerExtenderFn</a>) (<a href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtender">BonoboMonikerExtender</a> *extender,
const Bonobo_Moniker parent,
const Bonobo_ResolveOptions *options,
const CORBA_char *display_name,
const CORBA_char *requested_interface,
CORBA_Environment *ev);
<a href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtender">BonoboMonikerExtender</a>* <a href="libbonobo-bonobo-moniker-extender.html#bonobo-moniker-extender-new">bonobo_moniker_extender_new</a>
(<a href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtenderFn">BonoboMonikerExtenderFn</a> resolve,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);
Bonobo_MonikerExtender <a href="libbonobo-bonobo-moniker-extender.html#bonobo-moniker-find-extender">bonobo_moniker_find_extender</a>
(const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *interface,
CORBA_Environment *opt_ev);
Bonobo_Unknown <a href="libbonobo-bonobo-moniker-extender.html#bonobo-moniker-use-extender">bonobo_moniker_use_extender</a> (const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *extender_oafiid,
<a href="libbonobo-bonobo-moniker.html#BonoboMoniker">BonoboMoniker</a> *moniker,
const Bonobo_ResolveOptions *options,
const CORBA_char *requested_interface,
CORBA_Environment *opt_ev);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2769131"></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>
+----BonoboMonikerExtender
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2769163"></a><h2>Description</h2>
<p>
A moniker extender is used to extend the functionality of a moniker.
There are two standard moniker extenders that cannot be system wide,
since they use the oaf database to expand the scope of a moniker to
arbitrarily many interfaces. These are invoked explicitely by monikers
implementing the stream interface in the following way:
</p>
<div class="example">
<a name="id2769181"></a><p class="title"><b>Example 4. Explicit Stream extender usage example</b></p>
<pre class="programlisting">
Bonobo_Unknown
example_moniker_resolve (BonoboMoniker *moniker,
const Bonobo_ResolveOptions *options,
const CORBA_char *requested_interface,
CORBA_Environment *ev)
{
if (!strcmp (requested_interface, "IDL:Bonobo/Stream:1.0"))
return handle_stream (moniker, options, ev);
else
return bonobo_moniker_use_extender (
"OAFIID:Bonobo_MonikerExtender_stream",
moniker, options, requested_interface, ev);
}
</pre>
</div>
<p>
The moniker extender essentialy resolves 'moniker' against stream
and by some means ( not known when the moniker was written ) converts
this to a new exotic interface - via. the PersistStream interface.
</p>
<p>
All standard moniker extenders are registered by adding a fragment
like this:
</p>
<div class="example">
<a name="id2769210"></a><p class="title"><b>Example 5. Oaf information for an extender</b></p>
<pre class="programlisting">
<oaf_attribute name="bonobo:moniker_extender" type="stringv">
<item value="file:"/>
</oaf_attribute>
</pre>
</div>
<p>
to the .oaf file. This registers the extender with the system, such
that when a moniker resolve fails an extender can be found for any
of the monikers with prefix specified in the "bonobo:moniker_extender"
stringv.
</p>
<p>
Implementing your own extender is extremely simple, much like
<a href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimple"><span class="type">BonoboMonikerSimple</span></a>.
</p>
<div class="example">
<a name="id2769242"></a><p class="title"><b>Example 6. Oaf information for an extender</b></p>
<pre class="programlisting">
Bonobo_Unknown
example_extender_resolve (BonoboMonikerExtender *extender,
const Bonobo_Moniker m,
const Bonobo_ResolveOptions *options,
const CORBA_char *display_name,
const CORBA_char *requested_interface,
CORBA_Environment *ev)
{
... resolve 'm' against an interface we know it supports ...
... then use that interface to provide requested_interface ...
}
</pre>
</div>
<p>
It is registered again in much the same way in your factory:
</p>
<div class="example">
<a name="id2769262"></a><p class="title"><b>Example 7. Creating a new simple moniker</b></p>
<pre class="programlisting">
static BonoboObject *
bonobo_std_moniker_factory (BonoboGenericFactory *this,
const char *object_id,
void *data)
{
g_return_val_if_fail (object_id != NULL, NULL);
if (!strcmp (object_id, "OAFIID:Bonobo_MonikerExtender_file"))
return BONOBO_OBJECT (bonobo_moniker_extender_new (
example_extender_resolve, NULL));
else
return NULL;
}
</pre>
</div>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2769284"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2769294"></a><h3>
<a name="BonoboMonikerExtender-struct"></a>BonoboMonikerExtender</h3>
<a class="indexterm" name="id2769308"></a><pre class="programlisting">typedef struct _BonoboMonikerExtender BonoboMonikerExtender;</pre>
<p>
Implements a moniker extender: Bonobo::MonikerExtender.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2769325"></a><h3>
<a name="BonoboMonikerExtenderClass"></a>BonoboMonikerExtenderClass</h3>
<a class="indexterm" name="id2769338"></a><pre class="programlisting">typedef struct {
BonoboObjectClass parent_class;
POA_Bonobo_MonikerExtender__epv epv;
BonoboMonikerExtenderFn resolve;
} BonoboMonikerExtenderClass;
</pre>
<p>
BonoboMonikerExtender's class.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2769355"></a><h3>
<a name="BonoboMonikerExtenderFn"></a>BonoboMonikerExtenderFn ()</h3>
<a class="indexterm" name="id2769369"></a><pre class="programlisting">Bonobo_Unknown (*BonoboMonikerExtenderFn) (<a href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtender">BonoboMonikerExtender</a> *extender,
const Bonobo_Moniker parent,
const Bonobo_ResolveOptions *options,
const CORBA_char *display_name,
const CORBA_char *requested_interface,
CORBA_Environment *ev);</pre>
<p>
Moniker resolution callback function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>extender</code></em> :</span></td>
<td>extender (self)
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>parent</code></em> :</span></td>
<td>parent moniker
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>options</code></em> :</span></td>
<td>resolve options
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>display_name</code></em> :</span></td>
<td>? FIXME
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>requested_interface</code></em> :</span></td>
<td>? FIXME
</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>the resolution resulting object
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2769538"></a><h3>
<a name="bonobo-moniker-extender-new"></a>bonobo_moniker_extender_new ()</h3>
<a class="indexterm" name="id2769551"></a><pre class="programlisting"><a href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtender">BonoboMonikerExtender</a>* bonobo_moniker_extender_new
(<a href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtenderFn">BonoboMonikerExtenderFn</a> resolve,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);</pre>
<p>
This creates a new moniker extender.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>resolve</code></em> :</span></td>
<td> the resolve function that will be used to do the extension
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td> user data to be passed back to the resolve function.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the extender object
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2769637"></a><h3>
<a name="bonobo-moniker-find-extender"></a>bonobo_moniker_find_extender ()</h3>
<a class="indexterm" name="id2769650"></a><pre class="programlisting">Bonobo_MonikerExtender bonobo_moniker_find_extender
(const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *interface,
CORBA_Environment *opt_ev);</pre>
<p>
This routine tries to locate an extender for our moniker
by examining a registry of extenders that map new interfaces
to certain moniker names.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> the name of the moniker we want to extend eg. 'file:'
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>interface</code></em> :</span></td>
<td> the interface we want to resolve to
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>opt_ev</code></em> :</span></td>
<td> an optional corba exception environment.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> an appropriate extender or CORBA_OBJECT_NIL.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2769760"></a><h3>
<a name="bonobo-moniker-use-extender"></a>bonobo_moniker_use_extender ()</h3>
<a class="indexterm" name="id2769774"></a><pre class="programlisting">Bonobo_Unknown bonobo_moniker_use_extender (const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *extender_oafiid,
<a href="libbonobo-bonobo-moniker.html#BonoboMoniker">BonoboMoniker</a> *moniker,
const Bonobo_ResolveOptions *options,
const CORBA_char *requested_interface,
CORBA_Environment *opt_ev);</pre>
<p>
Locates a known extender via. OAFIID; eg.
OAFIID:Bonobo_Moniker_Extender_file</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>extender_oafiid</code></em> :</span></td>
<td> The IID of the extender to use
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>moniker</code></em> :</span></td>
<td> the moniker to extend
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>options</code></em> :</span></td>
<td> resolve options
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>requested_interface</code></em> :</span></td>
<td> the requested interface
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>opt_ev</code></em> :</span></td>
<td> optional corba environment
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the resolved result or CORBA_OBJECT_NIL.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>