/usr/share/gtk-doc/html/libbonobo/libbonobo-bonobo-moniker-extender.html is in libbonobo2-dev 2.32.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Libbonobo Reference Manual: BonoboMonikerExtender</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" 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.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libbonobo-bonobo-moniker-extender.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#libbonobo-bonobo-moniker-extender.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="monikers.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libbonobo-bonobo-moniker-util.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libbonobo-bonobo-item-handler.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libbonobo-bonobo-moniker-extender"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libbonobo-bonobo-moniker-extender.top_of_page"></a>BonoboMonikerExtender</span></h2>
<p>BonoboMonikerExtender — A way to extend arbitary monikers</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libbonobo-bonobo-moniker-extender.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">Bonobo_Unknown</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtenderFn" title="BonoboMonikerExtenderFn ()">*BonoboMonikerExtenderFn</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtender"><span class="returnvalue">BonoboMonikerExtender</span></a> *
</td>
<td class="function_name">
<a class="link" href="libbonobo-bonobo-moniker-extender.html#bonobo-moniker-extender-new" title="bonobo_moniker_extender_new ()">bonobo_moniker_extender_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">Bonobo_MonikerExtender</span>
</td>
<td class="function_name">
<a class="link" href="libbonobo-bonobo-moniker-extender.html#bonobo-moniker-find-extender" title="bonobo_moniker_find_extender ()">bonobo_moniker_find_extender</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">Bonobo_Unknown</span>
</td>
<td class="function_name">
<a class="link" href="libbonobo-bonobo-moniker-extender.html#bonobo-moniker-use-extender" title="bonobo_moniker_use_extender ()">bonobo_moniker_use_extender</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<a name="BonoboMonikerExtender"></a><div class="refsect1">
<a name="libbonobo-bonobo-moniker-extender.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtender-struct" title="struct BonoboMonikerExtender">BonoboMonikerExtender</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtenderClass" title="BonoboMonikerExtenderClass">BonoboMonikerExtenderClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-moniker-extender.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
<span class="lineart">╰──</span> <a class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>
<span class="lineart">╰──</span> BonoboMonikerExtender
</pre>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-moniker-extender.description"></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="id-1.5.6.7.2.1"></a><p class="title"><b>Example 18. Explicit Stream extender usage example</b></p>
<div class="example-contents"><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>
</div>
<p><br class="example-break">
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="id-1.5.6.7.3.1"></a><p class="title"><b>Example 19. Oaf information for an extender</b></p>
<div class="example-contents"><pre class="programlisting">
<oaf_attribute name="bonobo:moniker_extender" type="stringv">
<item value="file:"/>
</oaf_attribute>
</pre></div>
</div>
<p><br class="example-break">
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 class="link" href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimple"><span class="type">BonoboMonikerSimple</span></a>.
</p>
<div class="example">
<a name="id-1.5.6.7.4.2"></a><p class="title"><b>Example 20. Oaf information for an extender</b></p>
<div class="example-contents"><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>
</div>
<p><br class="example-break">
It is registered again in much the same way in your factory:
</p>
<div class="example">
<a name="id-1.5.6.7.4.3"></a><p class="title"><b>Example 21. Creating a new simple moniker</b></p>
<div class="example-contents"><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>
</div>
<p><br class="example-break">
</p>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-moniker-extender.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="BonoboMonikerExtenderFn"></a><h3>BonoboMonikerExtenderFn ()</h3>
<pre class="programlisting"><span class="returnvalue">Bonobo_Unknown</span>
<span class="c_punctuation">(</span>*BonoboMonikerExtenderFn<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtender"><span class="type">BonoboMonikerExtender</span></a> *extender</code></em>,
<em class="parameter"><code>const <span class="type">Bonobo_Moniker</span> parent</code></em>,
<em class="parameter"><code>const <span class="type">Bonobo_ResolveOptions</span> *options</code></em>,
<em class="parameter"><code>const <span class="type">CORBA_char</span> *display_name</code></em>,
<em class="parameter"><code>const <span class="type">CORBA_char</span> *requested_interface</code></em>,
<em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>);</pre>
<p>
Moniker resolution callback function.
</p>
<div class="refsect3">
<a name="id-1.5.6.8.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>extender</p></td>
<td class="parameter_description"><p>extender (self)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>parent</p></td>
<td class="parameter_description"><p>parent moniker</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>options</p></td>
<td class="parameter_description"><p>resolve options</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>display_name</p></td>
<td class="parameter_description"><p>? FIXME</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>requested_interface</p></td>
<td class="parameter_description"><p>? FIXME</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.6.8.2.6"></a><h4>Returns</h4>
<p>the resolution resulting object</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-moniker-extender-new"></a><h3>bonobo_moniker_extender_new ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtender"><span class="returnvalue">BonoboMonikerExtender</span></a> *
bonobo_moniker_extender_new (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtenderFn" title="BonoboMonikerExtenderFn ()"><span class="type">BonoboMonikerExtenderFn</span></a> resolve</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>This creates a new moniker extender.</p>
<div class="refsect3">
<a name="id-1.5.6.8.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>resolve</p></td>
<td class="parameter_description"><p>the resolve function that will be used to do the extension</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>user data to be passed back to the resolve function.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.6.8.3.6"></a><h4>Returns</h4>
<p> the extender object</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-moniker-find-extender"></a><h3>bonobo_moniker_find_extender ()</h3>
<pre class="programlisting"><span class="returnvalue">Bonobo_MonikerExtender</span>
bonobo_moniker_find_extender (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *interface</code></em>,
<em class="parameter"><code><span class="type">CORBA_Environment</span> *opt_ev</code></em>);</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>
<div class="refsect3">
<a name="id-1.5.6.8.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>the name of the moniker we want to extend eg. 'file:'</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>interface</p></td>
<td class="parameter_description"><p>the interface we want to resolve to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>opt_ev</p></td>
<td class="parameter_description"><p>an optional corba exception environment.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.6.8.4.6"></a><h4>Returns</h4>
<p> an appropriate extender or CORBA_OBJECT_NIL.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-moniker-use-extender"></a><h3>bonobo_moniker_use_extender ()</h3>
<pre class="programlisting"><span class="returnvalue">Bonobo_Unknown</span>
bonobo_moniker_use_extender (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *extender_oafiid</code></em>,
<em class="parameter"><code><a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="type">BonoboMoniker</span></a> *moniker</code></em>,
<em class="parameter"><code>const <span class="type">Bonobo_ResolveOptions</span> *options</code></em>,
<em class="parameter"><code>const <span class="type">CORBA_char</span> *requested_interface</code></em>,
<em class="parameter"><code><span class="type">CORBA_Environment</span> *opt_ev</code></em>);</pre>
<p>Locates a known extender via. OAFIID; eg.
OAFIID:Bonobo_Moniker_Extender_file</p>
<div class="refsect3">
<a name="id-1.5.6.8.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>extender_oafiid</p></td>
<td class="parameter_description"><p>The IID of the extender to use</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>moniker</p></td>
<td class="parameter_description"><p>the moniker to extend</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>options</p></td>
<td class="parameter_description"><p>resolve options</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>requested_interface</p></td>
<td class="parameter_description"><p>the requested interface</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>opt_ev</p></td>
<td class="parameter_description"><p>optional corba environment</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.6.8.5.6"></a><h4>Returns</h4>
<p> the resolved result or CORBA_OBJECT_NIL.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-moniker-extender.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="BonoboMonikerExtender-struct"></a><h3>struct BonoboMonikerExtender</h3>
<pre class="programlisting">struct BonoboMonikerExtender;</pre>
<p>
Implements a moniker extender: Bonobo::MonikerExtender.
</p>
</div>
<hr>
<div class="refsect2">
<a name="BonoboMonikerExtenderClass"></a><h3>BonoboMonikerExtenderClass</h3>
<pre class="programlisting">typedef struct {
BonoboObjectClass parent_class;
POA_Bonobo_MonikerExtender__epv epv;
BonoboMonikerExtenderFn resolve;
} BonoboMonikerExtenderClass;
</pre>
<p>
BonoboMonikerExtender's class.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|