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

This file is indexed.

/usr/share/gtk-doc/html/libbonobo/libbonobo-bonobo-moniker-simple.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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BonoboMonikerSimple</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.html" title="BonoboMoniker">
<link rel="next" href="libbonobo-bonobo-moniker-util.html" title="bonobo-moniker-util">
<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.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">
<a href="#libbonobo-bonobo-moniker-simple.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libbonobo-bonobo-moniker-simple.description" class="shortcut">Description</a>
                   | 
                  <a href="#libbonobo-bonobo-moniker-simple.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="libbonobo-bonobo-moniker-simple"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libbonobo-bonobo-moniker-simple.top_of_page"></a>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">
<a name="libbonobo-bonobo-moniker-simple.synopsis"></a><h2>Synopsis</h2>
<a name="BonoboMonikerSimple"></a><pre class="synopsis">struct              <a class="link" href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimple-struct" title="struct BonoboMonikerSimple">BonoboMonikerSimple</a>;
                    <a class="link" href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimpleClass" title="BonoboMonikerSimpleClass">BonoboMonikerSimpleClass</a>;
<span class="returnvalue">Bonobo_Unknown</span>      (<a class="link" href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimpleResolveFn" title="BonoboMonikerSimpleResolveFn ()">*BonoboMonikerSimpleResolveFn</a>)     (<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> *ev</code></em>);
<a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="returnvalue">BonoboMoniker</span></a> *     <a class="link" href="libbonobo-bonobo-moniker-simple.html#bonobo-moniker-simple-construct" title="bonobo_moniker_simple_construct ()">bonobo_moniker_simple_construct</a>     (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimple"><span class="type">BonoboMonikerSimple</span></a> *moniker</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *resolve_closure</code></em>);
<a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="returnvalue">BonoboMoniker</span></a> *     <a class="link" href="libbonobo-bonobo-moniker-simple.html#bonobo-moniker-simple-new" title="bonobo_moniker_simple_new ()">bonobo_moniker_simple_new</a>           (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimpleResolveFn" title="BonoboMonikerSimpleResolveFn ()"><span class="type">BonoboMonikerSimpleResolveFn</span></a> resolve_fn</code></em>);
<a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="returnvalue">BonoboMoniker</span></a> *     <a class="link" href="libbonobo-bonobo-moniker-simple.html#bonobo-moniker-simple-new-closure" title="bonobo_moniker_simple_new_closure ()">bonobo_moniker_simple_new_closure</a>   (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *resolve_closure</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-moniker-simple.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>
         +----<a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker">BonoboMoniker</a>
               +----BonoboMonikerSimple
</pre>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-moniker-simple.description"></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="id-1.5.4.5.3.1"></a><p class="title"><b>Example 15. A cut down file: moniker implementation</b></p>
<div class="example-contents"><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 '%s'", 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 '%s'", 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>
</div>
<p><br class="example-break">
  After implementing the resolve function, you need to create the new moniker
in your standard factory:
  </p>
<div class="example">
<a name="id-1.5.4.5.3.2"></a><p class="title"><b>Example 16. 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_Moniker_File"))
		return BONOBO_OBJECT (bonobo_moniker_simple_new (
			"file:", bonobo_moniker_file_resolve));
	else
		return NULL;
}
    </pre></div>
</div>
<p><br class="example-break">
</p>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-moniker-simple.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="BonoboMonikerSimple-struct"></a><h3>struct BonoboMonikerSimple</h3>
<pre class="programlisting">struct BonoboMonikerSimple;</pre>
<p>
A simplified <a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="type">BonoboMoniker</span></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="BonoboMonikerSimpleClass"></a><h3>BonoboMonikerSimpleClass</h3>
<pre class="programlisting">typedef struct {
	BonoboMonikerClass parent_class;
} BonoboMonikerSimpleClass;
</pre>
<p>
BonoboMonikerSimple's class.
</p>
</div>
<hr>
<div class="refsect2">
<a name="BonoboMonikerSimpleResolveFn"></a><h3>BonoboMonikerSimpleResolveFn ()</h3>
<pre class="programlisting"><span class="returnvalue">Bonobo_Unknown</span>      (*BonoboMonikerSimpleResolveFn)     (<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> *ev</code></em>);</pre>
<p>
Type of callback function that implements a simple moniker resolution.
</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>moniker</code></em> :</span></p></td>
<td>the 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>requested_interface</code></em> :</span></p></td>
<td>the requested interface (repoid string)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ev</code></em> :</span></p></td>
<td>CORBA environment, in case an exception needs to be raised</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a Bonobo_Unknown as the result of the resolution</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-moniker-simple-construct"></a><h3>bonobo_moniker_simple_construct ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="returnvalue">BonoboMoniker</span></a> *     bonobo_moniker_simple_construct     (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimple"><span class="type">BonoboMonikerSimple</span></a> *moniker</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *resolve_closure</code></em>);</pre>
<p>
Constructs a simple moniker
</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>moniker</code></em> :</span></p></td>
<td>the moniker to construct</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the name of the moniker eg. 'file:'</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>resolve_closure</code></em> :</span></p></td>
<td>the closure used to resolve the moniker</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the constructed moniker or NULL on failure.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-moniker-simple-new"></a><h3>bonobo_moniker_simple_new ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="returnvalue">BonoboMoniker</span></a> *     bonobo_moniker_simple_new           (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimpleResolveFn" title="BonoboMonikerSimpleResolveFn ()"><span class="type">BonoboMonikerSimpleResolveFn</span></a> resolve_fn</code></em>);</pre>
<p>
Create a new instance of a simplified moniker.
</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 display name for the moniker</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>resolve_fn</code></em> :</span></p></td>
<td>a resolve function for the moniker</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the moniker object</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-moniker-simple-new-closure"></a><h3>bonobo_moniker_simple_new_closure ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="returnvalue">BonoboMoniker</span></a> *     bonobo_moniker_simple_new_closure   (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *resolve_closure</code></em>);</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>
<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 display name for the moniker</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>resolve_closure</code></em> :</span></p></td>
<td>a closure for the resolve process.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the moniker object</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-moniker-simple.see-also"></a><h2>See Also</h2>
<p>
<a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="type">BonoboMoniker</span></a>, <a class="link" href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimple"><span class="type">BonoboMonikerSimple</span></a>, <span class="type">bonobo-moniker-util</span>, <a class="link" href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtender"><span class="type">BonoboMonikerExtender</span></a>
</p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.