This file is indexed.

/usr/share/gtk-doc/html/libbonobo/libbonobo-bonobo-moniker-extender.html is in libbonobo2-dev 2.32.1-0ubuntu5.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>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.19 (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="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">
<a href="#libbonobo-bonobo-moniker-extender.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libbonobo-bonobo-moniker-extender.description" class="shortcut">Description</a>
                   | 
                  <a href="#libbonobo-bonobo-moniker-extender.object-hierarchy" class="shortcut">Object Hierarchy</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 valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libbonobo-bonobo-moniker-extender.synopsis"></a><h2>Synopsis</h2>
<a name="BonoboMonikerExtender"></a><pre class="synopsis">struct              <a class="link" href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtender-struct" title="struct BonoboMonikerExtender">BonoboMonikerExtender</a>;
                    <a class="link" href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtenderClass" title="BonoboMonikerExtenderClass">BonoboMonikerExtenderClass</a>;
<span class="returnvalue">Bonobo_Unknown</span>      (<a class="link" href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtenderFn" title="BonoboMonikerExtenderFn ()">*BonoboMonikerExtenderFn</a>)          (<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>);
<a class="link" href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtender"><span class="returnvalue">BonoboMonikerExtender</span></a> * <a class="link" href="libbonobo-bonobo-moniker-extender.html#bonobo-moniker-extender-new" title="bonobo_moniker_extender_new ()">bonobo_moniker_extender_new</a>     (<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>);
<span class="returnvalue">Bonobo_MonikerExtender</span> <a class="link" href="libbonobo-bonobo-moniker-extender.html#bonobo-moniker-find-extender" title="bonobo_moniker_find_extender ()">bonobo_moniker_find_extender</a>     (<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>);
<span class="returnvalue">Bonobo_Unknown</span>      <a class="link" href="libbonobo-bonobo-moniker-extender.html#bonobo-moniker-use-extender" title="bonobo_moniker_use_extender ()">bonobo_moniker_use_extender</a>         (<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>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-moniker-extender.object-hierarchy"></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 class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>
         +----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.5.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.5.3.1"></a><p class="title"><b>Example 19. Oaf information for an extender</b></p>
<div class="example-contents"><pre class="programlisting">
&lt;oaf_attribute name="bonobo:moniker_extender" type="stringv"&gt;
	&lt;item value="file:"/&gt;
&lt;/oaf_attribute&gt;
    </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.5.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.5.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.details"></a><h2>Details</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>
<hr>
<div class="refsect2">
<a name="BonoboMonikerExtenderFn"></a><h3>BonoboMonikerExtenderFn ()</h3>
<pre class="programlisting"><span class="returnvalue">Bonobo_Unknown</span>      (*BonoboMonikerExtenderFn)          (<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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>extender</code></em> :</span></p></td>
<td>extender (self)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
<td>parent moniker</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>options</code></em> :</span></p></td>
<td>resolve options</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>display_name</code></em> :</span></p></td>
<td>? FIXME</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>requested_interface</code></em> :</span></p></td>
<td>? FIXME</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the resolution resulting object</td>
</tr>
</tbody>
</table></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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>resolve</code></em> :</span></p></td>
<td>the resolve function that will be used to do the extension</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>user data to be passed back to the resolve function.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the extender object</td>
</tr>
</tbody>
</table></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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the name of the moniker we want to extend eg. 'file:'</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>interface</code></em> :</span></p></td>
<td>the interface we want to resolve to</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>opt_ev</code></em> :</span></p></td>
<td>an optional corba exception environment.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an appropriate extender or CORBA_OBJECT_NIL.</td>
</tr>
</tbody>
</table></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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>extender_oafiid</code></em> :</span></p></td>
<td>The IID of the extender to use</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>moniker</code></em> :</span></p></td>
<td>the moniker to extend</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>options</code></em> :</span></p></td>
<td>resolve options</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>requested_interface</code></em> :</span></p></td>
<td>the requested interface</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>opt_ev</code></em> :</span></p></td>
<td>optional corba environment</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the resolved result or CORBA_OBJECT_NIL.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>