File: //usr/share/gtk-doc/html/libbonobo/libbonobo-bonobo-moniker-simple.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>BonoboMonikerSimple</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.html" title="BonoboMoniker">
<link rel="next" href="libbonobo-bonobo-moniker-util.html" title="bonobo-moniker-util">
<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.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-util.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2760619" class="shortcut">Top</a>
 | 
<a href="#id2760847" class="shortcut">Description</a>
 | 
<a href="#id2760807" class="shortcut">Object Hierarchy</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libbonobo-bonobo-moniker-simple"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2760619"></a><span class="refentrytitle">BonoboMonikerSimple</span>
</h2>
<p>BonoboMonikerSimple — A super easy to use moniker implementation wrapper</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="BonoboMonikerSimple"></a><pre class="synopsis">
<a href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimple-struct">BonoboMonikerSimple</a>;
<a href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimpleClass">BonoboMonikerSimpleClass</a>;
Bonobo_Unknown (<a href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimpleResolveFn">*BonoboMonikerSimpleResolveFn</a>)
(<a href="libbonobo-bonobo-moniker.html#BonoboMoniker">BonoboMoniker</a> *moniker,
const Bonobo_ResolveOptions *options,
const CORBA_char *requested_interface,
CORBA_Environment *ev);
<a href="libbonobo-bonobo-moniker.html#BonoboMoniker">BonoboMoniker</a>* <a href="libbonobo-bonobo-moniker-simple.html#bonobo-moniker-simple-construct">bonobo_moniker_simple_construct</a>
(<a href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimple">BonoboMonikerSimple</a> *moniker,
const char *name,
<a
href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"
>GClosure</a> *resolve_closure);
<a href="libbonobo-bonobo-moniker.html#BonoboMoniker">BonoboMoniker</a>* <a href="libbonobo-bonobo-moniker-simple.html#bonobo-moniker-simple-new">bonobo_moniker_simple_new</a> (const char *name,
<a href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimpleResolveFn">BonoboMonikerSimpleResolveFn</a> resolve_fn);
<a href="libbonobo-bonobo-moniker.html#BonoboMoniker">BonoboMoniker</a>* <a href="libbonobo-bonobo-moniker-simple.html#bonobo-moniker-simple-new-closure">bonobo_moniker_simple_new_closure</a>
(const char *name,
<a
href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"
>GClosure</a> *resolve_closure);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2760807"></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>
+----<a href="libbonobo-bonobo-moniker.html#BonoboMoniker">BonoboMoniker</a>
+----BonoboMonikerSimple
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2760847"></a><h2>Description</h2>
<p>
BonoboMonikerSimple makes writing monikers really extremely
easy. To implement a moniker you only have to write 1 function.
To register create the moniker object you have to use only 1
call. It can't get much simpler. If you want to use monikers
instead of implementing them, you probably want to see
<span class="type">bonobo-moniker-util</span> instead.
</p>
<p>
Few people need to implement monikers, but if they do, this
is how they should do it:
</p>
<div class="example">
<a name="id2760878"></a><p class="title"><b>Example 1. A cut down file: moniker implementation</b></p>
<pre class="programlisting">
Bonobo_Unknown
bonobo_moniker_file_resolve (BonoboMoniker *moniker,
const Bonobo_ResolveOptions *options,
const CORBA_char *requested_interface,
CORBA_Environment *ev)
{
const char *fname = bonobo_moniker_get_name (moniker);
Bonobo_Unknown retval;
g_warning ("Fname '<code class="literal">s</code>'", fname);
if (!strcmp (requested_interface, "IDL:Bonobo/Stream:1.0")) {
BonoboStream *stream;
stream = bonobo_stream_open ("fs", fname,
Bonobo_Storage_READ, 0664);
if (!stream) {
g_warning ("Failed to open stream '<code class="literal">s</code>'", fname);
CORBA_exception_set (ev, CORBA_USER_EXCEPTION,
ex_Bonobo_Moniker_InterfaceNotFound, NULL);
return CORBA_OBJECT_NIL;
}
return CORBA_Object_duplicate (BONOBO_OBJREF (stream), ev);
}
return CORBA_OBJECT_NIL;
}
</pre>
</div>
<p>
After implementing the resolve function, you need to create the new moniker
in your standard factory:
</p>
<div class="example">
<a name="id2760925"></a><p class="title"><b>Example 2. 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_Moniker_File"))
return BONOBO_OBJECT (bonobo_moniker_simple_new (
"file:", bonobo_moniker_file_resolve));
else
return NULL;
}
</pre>
</div>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2760947"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2760957"></a><h3>
<a name="BonoboMonikerSimple-struct"></a>BonoboMonikerSimple</h3>
<a class="indexterm" name="id2760971"></a><pre class="programlisting">typedef struct _BonoboMonikerSimple BonoboMonikerSimple;</pre>
<p>
A simplified <a href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="type">BonoboMoniker</span></a>.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2760995"></a><h3>
<a name="BonoboMonikerSimpleClass"></a>BonoboMonikerSimpleClass</h3>
<a class="indexterm" name="id2761008"></a><pre class="programlisting">typedef struct {
BonoboMonikerClass parent_class;
} BonoboMonikerSimpleClass;
</pre>
<p>
BonoboMonikerSimple's class.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2761025"></a><h3>
<a name="BonoboMonikerSimpleResolveFn"></a>BonoboMonikerSimpleResolveFn ()</h3>
<a class="indexterm" name="id2761038"></a><pre class="programlisting">Bonobo_Unknown (*BonoboMonikerSimpleResolveFn)
(<a href="libbonobo-bonobo-moniker.html#BonoboMoniker">BonoboMoniker</a> *moniker,
const Bonobo_ResolveOptions *options,
const CORBA_char *requested_interface,
CORBA_Environment *ev);</pre>
<p>
Type of callback function that implements a simple moniker resolution.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>moniker</code></em> :</span></td>
<td>the 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>requested_interface</code></em> :</span></td>
<td>the requested interface (repoid string)
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>ev</code></em> :</span></td>
<td>CORBA environment, in case an exception needs to be raised
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>a Bonobo_Unknown as the result of the resolution
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2761166"></a><h3>
<a name="bonobo-moniker-simple-construct"></a>bonobo_moniker_simple_construct ()</h3>
<a class="indexterm" name="id2761179"></a><pre class="programlisting"><a href="libbonobo-bonobo-moniker.html#BonoboMoniker">BonoboMoniker</a>* bonobo_moniker_simple_construct
(<a href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimple">BonoboMonikerSimple</a> *moniker,
const char *name,
<a
href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"
>GClosure</a> *resolve_closure);</pre>
<p>
Constructs a simple moniker</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>moniker</code></em> :</span></td>
<td> the moniker to construct
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> the name of the moniker eg. 'file:'
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>resolve_closure</code></em> :</span></td>
<td> the closure used to resolve the moniker
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the constructed moniker or NULL on failure.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2761287"></a><h3>
<a name="bonobo-moniker-simple-new"></a>bonobo_moniker_simple_new ()</h3>
<a class="indexterm" name="id2761301"></a><pre class="programlisting"><a href="libbonobo-bonobo-moniker.html#BonoboMoniker">BonoboMoniker</a>* bonobo_moniker_simple_new (const char *name,
<a href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimpleResolveFn">BonoboMonikerSimpleResolveFn</a> resolve_fn);</pre>
<p>
Create a new instance of a simplified moniker.</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 display name for the moniker
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>resolve_fn</code></em> :</span></td>
<td> a resolve function for the moniker
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the moniker object
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2761386"></a><h3>
<a name="bonobo-moniker-simple-new-closure"></a>bonobo_moniker_simple_new_closure ()</h3>
<a class="indexterm" name="id2761400"></a><pre class="programlisting"><a href="libbonobo-bonobo-moniker.html#BonoboMoniker">BonoboMoniker</a>* bonobo_moniker_simple_new_closure
(const char *name,
<a
href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"
>GClosure</a> *resolve_closure);</pre>
<p>
Create a new instance of a simplified moniker.
</p>
<p>
Instead of the Bonobo_ResolveOptions struct, the closure takes its
contents as two arguments: BONOBO_TYPE_RESOLVE_FLAG and G_TYPE_LONG.</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 display name for the moniker
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>resolve_closure</code></em> :</span></td>
<td> a closure for the resolve process.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the moniker object
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2761491"></a><h2>See Also</h2>
<p>
<a href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="type">BonoboMoniker</span></a>, <a href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimple"><span class="type">BonoboMonikerSimple</span></a>, <span class="type">bonobo-moniker-util</span>, <a href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtender"><span class="type">BonoboMonikerExtender</span></a>
</p>
</div>
</div>
</body>
</html>