~ubuntu-branches/ubuntu/trusty/libbonobo/trusty-proposed
» Revision
26
: doc/api/html/libbonobo-bonobo-generic-factory.html
« back to all changes in this revision
Viewing changes to doc/api/html/libbonobo-bonobo-generic-factory.html
- browse files at revision 26
- compare with another revision
- download diff
- download tarball
- view history from revision 26
- Committer: Bazaar Package Importer
- Author(s): Sebastien Bacher
- Date: 2007-09-17 16:38:13 UTC
- mfrom: (1.1.16 upstream)
- Revision ID: james.westby@ubuntu.com-20070917163813-sg2l3nt1q6s3lybq
Tags: 2.20.0-0ubuntu1
* New upstream version:
- Add unit test for bug 427992.
- Align configure switches
- Updated translations
- Add unit test for bug 427992.
- Align configure switches
- Updated translations
- files added:
- tests/test-activation/bonobo-activation-env-test.c
- files modified:
- ChangeLog
added
removed
doc/api/html/libbonobo-bonobo-generic-factory.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>BonoboGenericFactory</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
7
<link rel="start" href="index.html" title="Libbonobo Reference Manual">
8
8
<link rel="up" href="factories.html" title="Objects, Factories, Reference Counting">
9
9
<link rel="prev" href="libbonobo-bonobo-object.html" title="BonoboObject">
28
28
<th width="100%" align="center">Libbonobo Reference Manual</th>
29
29
<td><a accesskey="n" href="libbonobo-bonobo-shlib-factory.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
30
30
</tr>
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2585832" class="shortcut">Top</a>
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3068552" class="shortcut">Top</a>
32
32
 | 
33
<a href="#id2586177" class="shortcut">Description</a></nobr></td></tr>
33
<a href="#id3068897" class="shortcut">Description</a></nobr></td></tr>
34
34
</table>
35
35
<div class="refentry" lang="en">
36
36
<a name="libbonobo-bonobo-generic-factory"></a><div class="titlepage"></div>
37
37
<div class="refnamediv"><table width="100%"><tr>
38
38
<td valign="top">
39
39
<h2>
40
<a name="id2585832"></a><span class="refentrytitle">BonoboGenericFactory</span>
40
<a name="id3068552"></a><span class="refentrytitle">BonoboGenericFactory</span>
41
41
</h2>
42
42
<p>BonoboGenericFactory — The basic, generic Bonobo object factory implementation</p>
43
43
</td>
49
49
50
50
51
51
52
<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>* (<a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">*BonoboFactoryCallback</a>) (BonoboGenericFactory *factory,
52
<a class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>* (<a class="link" href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">*BonoboFactoryCallback</a>) (BonoboGenericFactory *factory,
53
53
const char *component_id,
54
gpointer closure);
55
BonoboGenericFactory* <a href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-new">bonobo_generic_factory_new</a> (const char *act_iid,
56
<a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
57
gpointer user_data);
58
BonoboGenericFactory* <a href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-new-closure">bonobo_generic_factory_new_closure</a>
54
<a
55
href="../glib/glib-Basic-Types.html#gpointer"
56
>gpointer</a> closure);
57
BonoboGenericFactory* <a class="link" href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-new">bonobo_generic_factory_new</a> (const char *act_iid,
58
<a class="link" href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
59
<a
60
href="../glib/glib-Basic-Types.html#gpointer"
61
>gpointer</a> user_data);
62
BonoboGenericFactory* <a class="link" href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-new-closure">bonobo_generic_factory_new_closure</a>
59
63
(const char *act_iid,
60
GClosure *factory_closure);
61
BonoboGenericFactory* <a href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-construct">bonobo_generic_factory_construct</a> (BonoboGenericFactory *factory,
64
<a
65
href="../gobject/gobject-Closures.html#GClosure"
66
>GClosure</a> *factory_closure);
67
BonoboGenericFactory* <a class="link" href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-construct">bonobo_generic_factory_construct</a> (BonoboGenericFactory *factory,
62
68
const char *act_iid,
63
GClosure *factory_closure);
64
void <a href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-construct-noreg">bonobo_generic_factory_construct_noreg</a>
69
<a
70
href="../gobject/gobject-Closures.html#GClosure"
71
>GClosure</a> *factory_closure);
72
void <a class="link" href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-construct-noreg">bonobo_generic_factory_construct_noreg</a>
65
73
(BonoboGenericFactory *factory,
66
74
const char *act_iid,
67
GClosure *factory_closure);
68
int <a href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-main">bonobo_generic_factory_main</a> (const char *act_iid,
69
<a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
70
gpointer user_data);
71
int <a href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-main-timeout">bonobo_generic_factory_main_timeout</a> (const char *act_iid,
72
<a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
73
gpointer user_data,
74
guint quit_timeout);
75
#define <a href="libbonobo-bonobo-generic-factory.html#BONOBO-FACTORY-INIT:CAPS">BONOBO_FACTORY_INIT</a> (descr, version, argcp, argv)
76
#define <a href="libbonobo-bonobo-generic-factory.html#BONOBO-OAF-FACTORY:CAPS">BONOBO_OAF_FACTORY</a> (oafiid, descr, version, callback, data)
77
#define <a href="libbonobo-bonobo-generic-factory.html#BONOBO-OAF-FACTORY-MULTI:CAPS">BONOBO_OAF_FACTORY_MULTI</a> (oafiid, descr, version, callback, data)
78
#define <a href="libbonobo-bonobo-generic-factory.html#BONOBO-ACTIVATION-FACTORY:CAPS">BONOBO_ACTIVATION_FACTORY</a> (oafiid, descr, version, callback, data)
79
#define <a href="libbonobo-bonobo-generic-factory.html#BONOBO-ACTIVATION-FACTORY-TIMEOUT:CAPS">BONOBO_ACTIVATION_FACTORY_TIMEOUT</a> (oafiid, descr, version, callback, data, quit_timeout)
75
<a
76
href="../gobject/gobject-Closures.html#GClosure"
77
>GClosure</a> *factory_closure);
78
int <a class="link" href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-main">bonobo_generic_factory_main</a> (const char *act_iid,
79
<a class="link" href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
80
<a
81
href="../glib/glib-Basic-Types.html#gpointer"
82
>gpointer</a> user_data);
83
int <a class="link" href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-main-timeout">bonobo_generic_factory_main_timeout</a> (const char *act_iid,
84
<a class="link" href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
85
<a
86
href="../glib/glib-Basic-Types.html#gpointer"
87
>gpointer</a> user_data,
88
<a
89
href="../glib/glib-Basic-Types.html#guint"
90
>guint</a> quit_timeout);
91
#define <a class="link" href="libbonobo-bonobo-generic-factory.html#BONOBO-FACTORY-INIT:CAPS">BONOBO_FACTORY_INIT</a> (descr, version, argcp, argv)
92
#define <a class="link" href="libbonobo-bonobo-generic-factory.html#BONOBO-OAF-FACTORY:CAPS">BONOBO_OAF_FACTORY</a> (oafiid, descr, version, callback, data)
93
#define <a class="link" href="libbonobo-bonobo-generic-factory.html#BONOBO-OAF-FACTORY-MULTI:CAPS">BONOBO_OAF_FACTORY_MULTI</a> (oafiid, descr, version, callback, data)
94
#define <a class="link" href="libbonobo-bonobo-generic-factory.html#BONOBO-ACTIVATION-FACTORY:CAPS">BONOBO_ACTIVATION_FACTORY</a> (oafiid, descr, version, callback, data)
95
#define <a class="link" href="libbonobo-bonobo-generic-factory.html#BONOBO-ACTIVATION-FACTORY-TIMEOUT:CAPS">BONOBO_ACTIVATION_FACTORY_TIMEOUT</a> (oafiid, descr, version, callback, data, quit_timeout)
80
96
81
97
82
98
</pre>
83
99
</div>
84
100
<div class="refsect1" lang="en">
85
<a name="id2586177"></a><h2>Description</h2>
101
<a name="id3068897"></a><h2>Description</h2>
86
102
<p>
87
103
The vast majority of Bonobo objects are created by the
88
104
<span class="type">BonoboGenericFactory</span> implementation. This provides a
94
110
Bonobo object factory with OAF, this can be done like this:
95
111
</p>
96
112
<div class="example">
97
<a name="id2586207"></a><p class="title"><b>Example 7. How to register a factory with OAF</b></p>
113
<a name="id3068926"></a><p class="title"><b>Example 7. How to register a factory with OAF</b></p>
98
114
<div class="example-contents"><pre class="programlisting">
99
115
BonoboGenericFactory *factory;
100
116
116
132
OAF the my_factory_function will be called:
117
133
</p>
118
134
<div class="example">
119
<a name="id2586233"></a><p class="title"><b>Example 8. A simple factory</b></p>
135
<a name="id3068953"></a><p class="title"><b>Example 8. A simple factory</b></p>
120
136
<div class="example-contents"><pre class="programlisting">
121
137
static BonoboObject *
122
138
my_factory_fn (BonoboGenericFactory *this,
143
159
<p>
144
160
There is a macro that can be used for simple components to remove the
145
161
burden of writing the main function and getting the initialization
146
correct, see <a href="libbonobo-bonobo-generic-factory.html#BONOBO-ACTIVATION-FACTORY:CAPS"><span class="type">BONOBO_ACTIVATION_FACTORY</span></a>. </p>
162
correct, see <a class="link" href="libbonobo-bonobo-generic-factory.html#BONOBO-ACTIVATION-FACTORY:CAPS"><span class="type">BONOBO_ACTIVATION_FACTORY</span></a>. </p>
147
163
</div>
148
164
<div class="refsect1" lang="en">
149
<a name="id2586272"></a><h2>Details</h2>
165
<a name="id3068992"></a><h2>Details</h2>
150
166
<div class="refsect2" lang="en">
151
<a name="id2586282"></a><h3>
167
<a name="id3069002"></a><h3>
152
168
<a name="BonoboFactoryCallback"></a>BonoboFactoryCallback ()</h3>
153
<a class="indexterm" name="id2586296"></a><pre class="programlisting"><a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>* (*BonoboFactoryCallback) (BonoboGenericFactory *factory,
169
<a class="indexterm" name="id3069015"></a><pre class="programlisting"><a class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>* (*BonoboFactoryCallback) (BonoboGenericFactory *factory,
154
170
const char *component_id,
155
gpointer closure);</pre>
171
<a
172
href="../glib/glib-Basic-Types.html#gpointer"
173
>gpointer</a> closure);</pre>
156
174
<p>
157
175
Type of function that is called when it's time for the factory to create a new instance.
158
176
</p>
160
178
<col align="left" valign="top">
161
179
<tbody>
162
180
<tr>
163
<td><span class="term"><em class="parameter"><code>factory</code></em> :</span></td>
181
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
164
182
<td>the factory that invoked this callback
165
183
</td>
166
184
</tr>
167
185
<tr>
168
<td><span class="term"><em class="parameter"><code>component_id</code></em> :</span></td>
186
<td><p><span class="term"><em class="parameter"><code>component_id</code></em> :</span></p></td>
169
187
<td>OAFIID of the component that should be activated
170
188
</td>
171
189
</tr>
172
190
<tr>
173
<td><span class="term"><em class="parameter"><code>closure</code></em> :</span></td>
191
<td><p><span class="term"><em class="parameter"><code>closure</code></em> :</span></p></td>
174
192
<td>user data
175
193
</td>
176
194
</tr>
177
195
<tr>
178
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
179
<td>the newly created <a href="libbonobo-bonobo-object.html#BonoboObject"><span class="type">BonoboObject</span></a>
196
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
197
<td>the newly created <a class="link" href="libbonobo-bonobo-object.html#BonoboObject"><span class="type">BonoboObject</span></a>
180
198
181
199
182
200
</td>
186
204
</div>
187
205
<hr>
188
206
<div class="refsect2" lang="en">
189
<a name="id2586408"></a><h3>
207
<a name="id3069127"></a><h3>
190
208
<a name="bonobo-generic-factory-new"></a>bonobo_generic_factory_new ()</h3>
191
<a class="indexterm" name="id2586421"></a><pre class="programlisting">BonoboGenericFactory* bonobo_generic_factory_new (const char *act_iid,
192
<a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
193
gpointer user_data);</pre>
209
<a class="indexterm" name="id3069140"></a><pre class="programlisting">BonoboGenericFactory* bonobo_generic_factory_new (const char *act_iid,
210
<a class="link" href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
211
<a
212
href="../glib/glib-Basic-Types.html#gpointer"
213
>gpointer</a> user_data);</pre>
194
214
<p>
195
215
This is a helper routine that simplifies the creation of factory
196
216
objects for GNOME objects. The <em class="parameter"><code>factory</code></em> function will be
205
225
<col align="left" valign="top">
206
226
<tbody>
207
227
<tr>
208
<td><span class="term"><em class="parameter"><code>act_iid</code></em> :</span></td>
228
<td><p><span class="term"><em class="parameter"><code>act_iid</code></em> :</span></p></td>
209
229
<td> The GOAD id that this factory implements
210
230
</td>
211
231
</tr>
212
232
<tr>
213
<td><span class="term"><em class="parameter"><code>factory_cb</code></em> :</span></td>
233
<td><p><span class="term"><em class="parameter"><code>factory_cb</code></em> :</span></p></td>
214
234
<td> A callback which is used to create new BonoboObject instances.
215
235
</td>
216
236
</tr>
217
237
<tr>
218
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
238
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
219
239
<td> The closure data to be passed to the <em class="parameter"><code>factory</code></em> callback routine.
220
240
</td>
221
241
</tr>
222
242
<tr>
223
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
243
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
224
244
<td> A BonoboGenericFactory object that has an activated
225
245
Bonobo::GenericFactory object that has registered with the GNOME
226
246
name server.
231
251
</div>
232
252
<hr>
233
253
<div class="refsect2" lang="en">
234
<a name="id2586553"></a><h3>
254
<a name="id3069273"></a><h3>
235
255
<a name="bonobo-generic-factory-new-closure"></a>bonobo_generic_factory_new_closure ()</h3>
236
<a class="indexterm" name="id2586568"></a><pre class="programlisting">BonoboGenericFactory* bonobo_generic_factory_new_closure
256
<a class="indexterm" name="id3069288"></a><pre class="programlisting">BonoboGenericFactory* bonobo_generic_factory_new_closure
237
257
(const char *act_iid,
238
GClosure *factory_closure);</pre>
258
<a
259
href="../gobject/gobject-Closures.html#GClosure"
260
>GClosure</a> *factory_closure);</pre>
239
261
<p>
240
262
This is a helper routine that simplifies the creation of factory
241
263
objects for GNOME objects. The <em class="parameter"><code>factory_closure</code></em> closure will be
250
272
<col align="left" valign="top">
251
273
<tbody>
252
274
<tr>
253
<td><span class="term"><em class="parameter"><code>act_iid</code></em> :</span></td>
275
<td><p><span class="term"><em class="parameter"><code>act_iid</code></em> :</span></p></td>
254
276
<td> The GOAD id that this factory implements
255
277
</td>
256
278
</tr>
257
279
<tr>
258
<td><span class="term"><em class="parameter"><code>factory_closure</code></em> :</span></td>
280
<td><p><span class="term"><em class="parameter"><code>factory_closure</code></em> :</span></p></td>
259
281
<td> A closure which is used to create new BonoboObject instances.
260
282
</td>
261
283
</tr>
262
284
<tr>
263
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
285
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
264
286
<td> A BonoboGenericFactory object that has an activated
265
287
Bonobo::GenericFactory object that has registered with the GNOME
266
288
name server.
271
293
</div>
272
294
<hr>
273
295
<div class="refsect2" lang="en">
274
<a name="id2586673"></a><h3>
296
<a name="id3069392"></a><h3>
275
297
<a name="bonobo-generic-factory-construct"></a>bonobo_generic_factory_construct ()</h3>
276
<a class="indexterm" name="id2586686"></a><pre class="programlisting">BonoboGenericFactory* bonobo_generic_factory_construct (BonoboGenericFactory *factory,
298
<a class="indexterm" name="id3069405"></a><pre class="programlisting">BonoboGenericFactory* bonobo_generic_factory_construct (BonoboGenericFactory *factory,
277
299
const char *act_iid,
278
GClosure *factory_closure);</pre>
300
<a
301
href="../gobject/gobject-Closures.html#GClosure"
302
>GClosure</a> *factory_closure);</pre>
279
303
<p>
280
304
Initializes <em class="parameter"><code>c_factory</code></em> with and registers the new factory with
281
305
the name server.</p>
286
310
<col align="left" valign="top">
287
311
<tbody>
288
312
<tr>
289
<td><span class="term"><em class="parameter"><code>factory</code></em> :</span></td>
313
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
290
314
<td> The object to be initialized.
291
315
</td>
292
316
</tr>
293
317
<tr>
294
<td><span class="term"><em class="parameter"><code>act_iid</code></em> :</span></td>
318
<td><p><span class="term"><em class="parameter"><code>act_iid</code></em> :</span></p></td>
295
319
<td> The Bonobo activation id that the new factory will implement.
296
320
Bonobo::GenericFactory interface and which will be used to
297
321
construct this BonoboGenericFactory Gtk object.
298
322
</td>
299
323
</tr>
300
324
<tr>
301
<td><span class="term"><em class="parameter"><code>factory_closure</code></em> :</span></td>
325
<td><p><span class="term"><em class="parameter"><code>factory_closure</code></em> :</span></p></td>
302
326
<td> A Multi object factory closure.
303
327
</td>
304
328
</tr>
305
329
<tr>
306
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
330
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
307
331
<td> The initialized BonoboGenericFactory object or NULL
308
332
if already registered.
309
333
</td>
313
337
</div>
314
338
<hr>
315
339
<div class="refsect2" lang="en">
316
<a name="id2586803"></a><h3>
340
<a name="id3069523"></a><h3>
317
341
<a name="bonobo-generic-factory-construct-noreg"></a>bonobo_generic_factory_construct_noreg ()</h3>
318
<a class="indexterm" name="id2586817"></a><pre class="programlisting">void bonobo_generic_factory_construct_noreg
342
<a class="indexterm" name="id3069536"></a><pre class="programlisting">void bonobo_generic_factory_construct_noreg
319
343
(BonoboGenericFactory *factory,
320
344
const char *act_iid,
321
GClosure *factory_closure);</pre>
345
<a
346
href="../gobject/gobject-Closures.html#GClosure"
347
>GClosure</a> *factory_closure);</pre>
322
348
<p>
323
349
Initializes <em class="parameter"><code>c_factory</code></em> with the supplied closure and iid.</p>
324
350
<p>
328
354
<col align="left" valign="top">
329
355
<tbody>
330
356
<tr>
331
<td><span class="term"><em class="parameter"><code>factory</code></em> :</span></td>
357
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
332
358
<td> The object to be initialized.
333
359
</td>
334
360
</tr>
335
361
<tr>
336
<td><span class="term"><em class="parameter"><code>act_iid</code></em> :</span></td>
362
<td><p><span class="term"><em class="parameter"><code>act_iid</code></em> :</span></p></td>
337
363
<td> The GOAD id that the new factory will implement.
338
364
</td>
339
365
</tr>
340
366
<tr>
341
<td><span class="term"><em class="parameter"><code>factory_closure</code></em> :</span></td>
367
<td><p><span class="term"><em class="parameter"><code>factory_closure</code></em> :</span></p></td>
342
368
<td> A Multi object factory closure.
343
369
</td>
344
370
</tr>
347
373
</div>
348
374
<hr>
349
375
<div class="refsect2" lang="en">
350
<a name="id2586920"></a><h3>
376
<a name="id3069640"></a><h3>
351
377
<a name="bonobo-generic-factory-main"></a>bonobo_generic_factory_main ()</h3>
352
<a class="indexterm" name="id2586934"></a><pre class="programlisting">int bonobo_generic_factory_main (const char *act_iid,
353
<a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
354
gpointer user_data);</pre>
378
<a class="indexterm" name="id3069654"></a><pre class="programlisting">int bonobo_generic_factory_main (const char *act_iid,
379
<a class="link" href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
380
<a
381
href="../glib/glib-Basic-Types.html#gpointer"
382
>gpointer</a> user_data);</pre>
355
383
<p>
356
384
A Generic 'main' routine so we don't stick a load of code
357
inside a public macro. See also <a href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-main-timeout"><code class="function">bonobo_generic_factory_main_timeout()</code></a>.</p>
385
inside a public macro. See also <a class="link" href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-main-timeout"><code class="function">bonobo_generic_factory_main_timeout()</code></a>.</p>
358
386
<p>
359
387
360
388
</p>
362
390
<col align="left" valign="top">
363
391
<tbody>
364
392
<tr>
365
<td><span class="term"><em class="parameter"><code>act_iid</code></em> :</span></td>
393
<td><p><span class="term"><em class="parameter"><code>act_iid</code></em> :</span></p></td>
366
394
<td> the oaf iid of the factory
367
395
</td>
368
396
</tr>
369
397
<tr>
370
<td><span class="term"><em class="parameter"><code>factory_cb</code></em> :</span></td>
398
<td><p><span class="term"><em class="parameter"><code>factory_cb</code></em> :</span></p></td>
371
399
<td> the factory callback
372
400
</td>
373
401
</tr>
374
402
<tr>
375
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
403
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
376
404
<td> a user data pointer
377
405
</td>
378
406
</tr>
379
407
<tr>
380
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
408
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
381
409
<td> 0 on success, 1 on failure.
382
410
</td>
383
411
</tr>
386
414
</div>
387
415
<hr>
388
416
<div class="refsect2" lang="en">
389
<a name="id2587052"></a><h3>
417
<a name="id3069771"></a><h3>
390
418
<a name="bonobo-generic-factory-main-timeout"></a>bonobo_generic_factory_main_timeout ()</h3>
391
<a class="indexterm" name="id2587066"></a><pre class="programlisting">int bonobo_generic_factory_main_timeout (const char *act_iid,
392
<a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
393
gpointer user_data,
394
guint quit_timeout);</pre>
419
<a class="indexterm" name="id3069785"></a><pre class="programlisting">int bonobo_generic_factory_main_timeout (const char *act_iid,
420
<a class="link" href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
421
<a
422
href="../glib/glib-Basic-Types.html#gpointer"
423
>gpointer</a> user_data,
424
<a
425
href="../glib/glib-Basic-Types.html#guint"
426
>guint</a> quit_timeout);</pre>
395
427
<p>
396
428
A Generic 'main' routine so we don't stick a load of code
397
429
inside a public macro.</p>
402
434
<col align="left" valign="top">
403
435
<tbody>
404
436
<tr>
405
<td><span class="term"><em class="parameter"><code>act_iid</code></em> :</span></td>
437
<td><p><span class="term"><em class="parameter"><code>act_iid</code></em> :</span></p></td>
406
438
<td> the oaf iid of the factory
407
439
</td>
408
440
</tr>
409
441
<tr>
410
<td><span class="term"><em class="parameter"><code>factory_cb</code></em> :</span></td>
442
<td><p><span class="term"><em class="parameter"><code>factory_cb</code></em> :</span></p></td>
411
443
<td> the factory callback
412
444
</td>
413
445
</tr>
414
446
<tr>
415
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
447
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
416
448
<td> a user data pointer
417
449
</td>
418
450
</tr>
419
451
<tr>
420
<td><span class="term"><em class="parameter"><code>quit_timeout</code></em> :</span></td>
452
<td><p><span class="term"><em class="parameter"><code>quit_timeout</code></em> :</span></p></td>
421
453
<td> ammount of time to wait (miliseconds) after all
422
454
objects have been released before quitting the main loop.
423
455
</td>
424
456
</tr>
425
457
<tr>
426
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
458
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
427
459
<td> 0 on success, 1 on failure.
428
460
</td>
429
461
</tr>
432
464
</div>
433
465
<hr>
434
466
<div class="refsect2" lang="en">
435
<a name="id2587196"></a><h3>
467
<a name="id3069915"></a><h3>
436
468
<a name="BONOBO-FACTORY-INIT:CAPS"></a>BONOBO_FACTORY_INIT()</h3>
437
<a class="indexterm" name="id2587209"></a><pre class="programlisting">#define BONOBO_FACTORY_INIT(descr, version, argcp, argv)</pre>
469
<a class="indexterm" name="id3069929"></a><pre class="programlisting">#define BONOBO_FACTORY_INIT(descr, version, argcp, argv)</pre>
438
470
<p>
439
471
Macro that expands to the code need to initialize an exe factory. Should be placed at the beginning of the <code class="function">main()</code> function.
440
472
</p>
442
474
<col align="left" valign="top">
443
475
<tbody>
444
476
<tr>
445
<td><span class="term"><em class="parameter"><code>descr</code></em> :</span></td>
477
<td><p><span class="term"><em class="parameter"><code>descr</code></em> :</span></p></td>
446
478
<td>factory description string
447
479
</td>
448
480
</tr>
449
481
<tr>
450
<td><span class="term"><em class="parameter"><code>version</code></em> :</span></td>
482
<td><p><span class="term"><em class="parameter"><code>version</code></em> :</span></p></td>
451
483
<td>version string
452
484
</td>
453
485
</tr>
454
486
<tr>
455
<td><span class="term"><em class="parameter"><code>argcp</code></em> :</span></td>
487
<td><p><span class="term"><em class="parameter"><code>argcp</code></em> :</span></p></td>
456
488
<td>pointer to <code class="function">main()</code>'s argc
457
489
</td>
458
490
</tr>
459
491
<tr>
460
<td><span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
492
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
461
493
<td>
462
494
<code class="function">main()</code>'s argv
463
495
469
501
</div>
470
502
<hr>
471
503
<div class="refsect2" lang="en">
472
<a name="id2587317"></a><h3>
504
<a name="id3070037"></a><h3>
473
505
<a name="BONOBO-OAF-FACTORY:CAPS"></a>BONOBO_OAF_FACTORY()</h3>
474
<a class="indexterm" name="id2587331"></a><pre class="programlisting">#define BONOBO_OAF_FACTORY(oafiid, descr, version, callback, data)</pre>
506
<a class="indexterm" name="id3070050"></a><pre class="programlisting">#define BONOBO_OAF_FACTORY(oafiid, descr, version, callback, data)</pre>
475
507
<p>
476
Deprecated; see <a href="libbonobo-bonobo-generic-factory.html#BONOBO-ACTIVATION-FACTORY:CAPS"><code class="function">BONOBO_ACTIVATION_FACTORY()</code></a>.
508
Deprecated; see <a class="link" href="libbonobo-bonobo-generic-factory.html#BONOBO-ACTIVATION-FACTORY:CAPS"><code class="function">BONOBO_ACTIVATION_FACTORY()</code></a>.
477
509
</p>
478
510
<div class="variablelist"><table border="0">
479
511
<col align="left" valign="top">
480
512
<tbody>
481
513
<tr>
482
<td><span class="term"><em class="parameter"><code>oafiid</code></em> :</span></td>
483
<td>
484
</td>
485
</tr>
486
<tr>
487
<td><span class="term"><em class="parameter"><code>descr</code></em> :</span></td>
488
<td>
489
</td>
490
</tr>
491
<tr>
492
<td><span class="term"><em class="parameter"><code>version</code></em> :</span></td>
493
<td>
494
</td>
495
</tr>
496
<tr>
497
<td><span class="term"><em class="parameter"><code>callback</code></em> :</span></td>
498
<td>
499
</td>
500
</tr>
501
<tr>
502
<td><span class="term"><em class="parameter"><code>data</code></em> :</span></td>
514
<td><p><span class="term"><em class="parameter"><code>oafiid</code></em> :</span></p></td>
515
<td>
516
</td>
517
</tr>
518
<tr>
519
<td><p><span class="term"><em class="parameter"><code>descr</code></em> :</span></p></td>
520
<td>
521
</td>
522
</tr>
523
<tr>
524
<td><p><span class="term"><em class="parameter"><code>version</code></em> :</span></p></td>
525
<td>
526
</td>
527
</tr>
528
<tr>
529
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
530
<td>
531
</td>
532
</tr>
533
<tr>
534
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
503
535
<td>
504
536
505
537
510
542
</div>
511
543
<hr>
512
544
<div class="refsect2" lang="en">
513
<a name="id2587431"></a><h3>
545
<a name="id3070150"></a><h3>
514
546
<a name="BONOBO-OAF-FACTORY-MULTI:CAPS"></a>BONOBO_OAF_FACTORY_MULTI()</h3>
515
<a class="indexterm" name="id2587444"></a><pre class="programlisting">#define BONOBO_OAF_FACTORY_MULTI(oafiid, descr, version, callback, data)</pre>
547
<a class="indexterm" name="id3070164"></a><pre class="programlisting">#define BONOBO_OAF_FACTORY_MULTI(oafiid, descr, version, callback, data)</pre>
516
548
<p>
517
Deprecated; see <a href="libbonobo-bonobo-generic-factory.html#BONOBO-ACTIVATION-FACTORY:CAPS"><code class="function">BONOBO_ACTIVATION_FACTORY()</code></a>.
549
Deprecated; see <a class="link" href="libbonobo-bonobo-generic-factory.html#BONOBO-ACTIVATION-FACTORY:CAPS"><code class="function">BONOBO_ACTIVATION_FACTORY()</code></a>.
518
550
</p>
519
551
<div class="variablelist"><table border="0">
520
552
<col align="left" valign="top">
521
553
<tbody>
522
554
<tr>
523
<td><span class="term"><em class="parameter"><code>oafiid</code></em> :</span></td>
524
<td>
525
</td>
526
</tr>
527
<tr>
528
<td><span class="term"><em class="parameter"><code>descr</code></em> :</span></td>
529
<td>
530
</td>
531
</tr>
532
<tr>
533
<td><span class="term"><em class="parameter"><code>version</code></em> :</span></td>
534
<td>
535
</td>
536
</tr>
537
<tr>
538
<td><span class="term"><em class="parameter"><code>callback</code></em> :</span></td>
539
<td>
540
</td>
541
</tr>
542
<tr>
543
<td><span class="term"><em class="parameter"><code>data</code></em> :</span></td>
555
<td><p><span class="term"><em class="parameter"><code>oafiid</code></em> :</span></p></td>
556
<td>
557
</td>
558
</tr>
559
<tr>
560
<td><p><span class="term"><em class="parameter"><code>descr</code></em> :</span></p></td>
561
<td>
562
</td>
563
</tr>
564
<tr>
565
<td><p><span class="term"><em class="parameter"><code>version</code></em> :</span></p></td>
566
<td>
567
</td>
568
</tr>
569
<tr>
570
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
571
<td>
572
</td>
573
</tr>
574
<tr>
575
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
544
576
<td>
545
577
546
578
551
583
</div>
552
584
<hr>
553
585
<div class="refsect2" lang="en">
554
<a name="id2587544"></a><h3>
586
<a name="id3070263"></a><h3>
555
587
<a name="BONOBO-ACTIVATION-FACTORY:CAPS"></a>BONOBO_ACTIVATION_FACTORY()</h3>
556
<a class="indexterm" name="id2587557"></a><pre class="programlisting">#define BONOBO_ACTIVATION_FACTORY(oafiid, descr, version, callback, data)</pre>
588
<a class="indexterm" name="id3070276"></a><pre class="programlisting">#define BONOBO_ACTIVATION_FACTORY(oafiid, descr, version, callback, data)</pre>
557
589
<p>
558
590
Macro that includes all boiler-plate code necessary to create an exe
559
591
type factory, including a <code class="function">main()</code> function and a generic factory.
562
594
<col align="left" valign="top">
563
595
<tbody>
564
596
<tr>
565
<td><span class="term"><em class="parameter"><code>oafiid</code></em> :</span></td>
597
<td><p><span class="term"><em class="parameter"><code>oafiid</code></em> :</span></p></td>
566
598
<td>The factory's OAFIID
567
599
</td>
568
600
</tr>
569
601
<tr>
570
<td><span class="term"><em class="parameter"><code>descr</code></em> :</span></td>
602
<td><p><span class="term"><em class="parameter"><code>descr</code></em> :</span></p></td>
571
603
<td>Description of the factory
572
604
</td>
573
605
</tr>
574
606
<tr>
575
<td><span class="term"><em class="parameter"><code>version</code></em> :</span></td>
607
<td><p><span class="term"><em class="parameter"><code>version</code></em> :</span></p></td>
576
608
<td>Version string of the factory program
577
609
</td>
578
610
</tr>
579
611
<tr>
580
<td><span class="term"><em class="parameter"><code>callback</code></em> :</span></td>
581
<td>Function (<a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback"><span class="type">BonoboFactoryCallback</span></a>) responsible for intantiating components
612
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
613
<td>Function (<a class="link" href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback"><span class="type">BonoboFactoryCallback</span></a>) responsible for intantiating components
582
614
</td>
583
615
</tr>
584
616
<tr>
585
<td><span class="term"><em class="parameter"><code>data</code></em> :</span></td>
617
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
586
618
<td>Additional data to be passed to the callback
587
619
588
620
593
625
</div>
594
626
<hr>
595
627
<div class="refsect2" lang="en">
596
<a name="id2587669"></a><h3>
628
<a name="id3070389"></a><h3>
597
629
<a name="BONOBO-ACTIVATION-FACTORY-TIMEOUT:CAPS"></a>BONOBO_ACTIVATION_FACTORY_TIMEOUT()</h3>
598
<a class="indexterm" name="id2587684"></a><pre class="programlisting">#define BONOBO_ACTIVATION_FACTORY_TIMEOUT(oafiid, descr, version, callback, data, quit_timeout)</pre>
630
<a class="indexterm" name="id3070404"></a><pre class="programlisting">#define BONOBO_ACTIVATION_FACTORY_TIMEOUT(oafiid, descr, version, callback, data, quit_timeout)</pre>
599
631
<p>
600
Like <a href="libbonobo-bonobo-generic-factory.html#BONOBO-ACTIVATION-FACTORY:CAPS"><code class="function">BONOBO_ACTIVATION_FACTORY()</code></a>, but has an extra <em class="parameter"><code>quit_timeout</code></em> argument.
632
Like <a class="link" href="libbonobo-bonobo-generic-factory.html#BONOBO-ACTIVATION-FACTORY:CAPS"><code class="function">BONOBO_ACTIVATION_FACTORY()</code></a>, but has an extra <em class="parameter"><code>quit_timeout</code></em> argument.
601
633
</p>
602
634
<div class="variablelist"><table border="0">
603
635
<col align="left" valign="top">
604
636
<tbody>
605
637
<tr>
606
<td><span class="term"><em class="parameter"><code>oafiid</code></em> :</span></td>
638
<td><p><span class="term"><em class="parameter"><code>oafiid</code></em> :</span></p></td>
607
639
<td>The factory's OAFIID
608
640
</td>
609
641
</tr>
610
642
<tr>
611
<td><span class="term"><em class="parameter"><code>descr</code></em> :</span></td>
643
<td><p><span class="term"><em class="parameter"><code>descr</code></em> :</span></p></td>
612
644
<td>Description of the factory
613
645
</td>
614
646
</tr>
615
647
<tr>
616
<td><span class="term"><em class="parameter"><code>version</code></em> :</span></td>
648
<td><p><span class="term"><em class="parameter"><code>version</code></em> :</span></p></td>
617
649
<td>Version string of the factory program
618
650
</td>
619
651
</tr>
620
652
<tr>
621
<td><span class="term"><em class="parameter"><code>callback</code></em> :</span></td>
622
<td>Function (<a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback"><span class="type">BonoboFactoryCallback</span></a>) responsible for intantiating components
653
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
654
<td>Function (<a class="link" href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback"><span class="type">BonoboFactoryCallback</span></a>) responsible for intantiating components
623
655
</td>
624
656
</tr>
625
657
<tr>
626
<td><span class="term"><em class="parameter"><code>data</code></em> :</span></td>
658
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
627
659
<td>Additional data to be passed to the callback
628
660
</td>
629
661
</tr>
630
662
<tr>
631
<td><span class="term"><em class="parameter"><code>quit_timeout</code></em> :</span></td>
663
<td><p><span class="term"><em class="parameter"><code>quit_timeout</code></em> :</span></p></td>
632
664
<td>Ammount of time to wait (in milliseconds) before deciding to quit the factory. A larger value prevents frequent respawning of a new factory process when there are many consecutive one-time requests, so that your factory appears to start faster after the first time.
633
665
634
666
Loggerhead is a web-based interface for Breezy
Version: 2.0.1