~ubuntu-branches/ubuntu/quantal/libbonobo/quantal-201207170711

« back to all changes in this revision

Viewing changes to doc/api/html/libbonobo-bonobo-generic-factory.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-03-12 15:39:17 UTC
  • mfrom: (1.1.13 upstream)
  • Revision ID: james.westby@ubuntu.com-20070312153917-u4efw149urh2enej
Tags: 2.18.0-0ubuntu1
* New upstream release:
  - Code cleanups
  - Build fix
  - Updated translations.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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">
10
10
<link rel="next" href="libbonobo-bonobo-shlib-factory.html" title="bonobo-shlib-factory">
11
 
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="general.html" title="General">
14
14
<link rel="chapter" href="factories.html" title="Objects, Factories, Reference Counting">
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="#id2603824" class="shortcut">Top</a>
 
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2687047" class="shortcut">Top</a>
32
32
                  &#160;|&#160;
33
 
                  <a href="#id2604166" class="shortcut">Description</a></nobr></td></tr>
 
33
                  <a href="#id2687392" 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="id2603824"></a><span class="refentrytitle">BonoboGenericFactory</span>
 
40
<a name="id2687047"></a><span class="refentrytitle">BonoboGenericFactory</span>
41
41
</h2>
42
42
<p>BonoboGenericFactory &#8212; 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,
53
 
                                             const char *component_id,
54
 
                                             <a
 
52
<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>*       (<a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">*BonoboFactoryCallback</a>)            (BonoboGenericFactory *factory,
 
53
                                                         const char *component_id,
 
54
                                                         <a
55
55
href="../glib/glib-Basic-Types.html#gpointer"
56
56
>gpointer</a> closure);
57
 
BonoboGenericFactory* <a href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-new">bonobo_generic_factory_new</a>
58
 
                                            (const char *act_iid,
59
 
                                             <a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
60
 
                                             <a
 
57
BonoboGenericFactory* <a href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-new">bonobo_generic_factory_new</a>        (const char *act_iid,
 
58
                                                         <a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
 
59
                                                         <a
61
60
href="../glib/glib-Basic-Types.html#gpointer"
62
61
>gpointer</a> user_data);
63
62
BonoboGenericFactory* <a href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-new-closure">bonobo_generic_factory_new_closure</a>
64
 
                                            (const char *act_iid,
65
 
                                             <a
66
 
href="../gobject/gobject-Closures.html#GClosure"
67
 
>GClosure</a> *factory_closure);
68
 
BonoboGenericFactory* <a href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-construct">bonobo_generic_factory_construct</a>
69
 
                                            (BonoboGenericFactory *factory,
70
 
                                             const char *act_iid,
71
 
                                             <a
72
 
href="../gobject/gobject-Closures.html#GClosure"
73
 
>GClosure</a> *factory_closure);
74
 
void        <a href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-construct-noreg">bonobo_generic_factory_construct_noreg</a>
75
 
                                            (BonoboGenericFactory *factory,
76
 
                                             const char *act_iid,
77
 
                                             <a
78
 
href="../gobject/gobject-Closures.html#GClosure"
79
 
>GClosure</a> *factory_closure);
80
 
int         <a href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-main">bonobo_generic_factory_main</a>     (const char *act_iid,
81
 
                                             <a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
82
 
                                             <a
 
63
                                                        (const char *act_iid,
 
64
                                                         <a
 
65
href="../gobject/gobject-Closures.html#GClosure"
 
66
>GClosure</a> *factory_closure);
 
67
BonoboGenericFactory* <a href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-construct">bonobo_generic_factory_construct</a>  (BonoboGenericFactory *factory,
 
68
                                                         const char *act_iid,
 
69
                                                         <a
 
70
href="../gobject/gobject-Closures.html#GClosure"
 
71
>GClosure</a> *factory_closure);
 
72
void                <a href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-construct-noreg">bonobo_generic_factory_construct_noreg</a>
 
73
                                                        (BonoboGenericFactory *factory,
 
74
                                                         const char *act_iid,
 
75
                                                         <a
 
76
href="../gobject/gobject-Closures.html#GClosure"
 
77
>GClosure</a> *factory_closure);
 
78
int                 <a href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-main">bonobo_generic_factory_main</a>         (const char *act_iid,
 
79
                                                         <a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
 
80
                                                         <a
83
81
href="../glib/glib-Basic-Types.html#gpointer"
84
82
>gpointer</a> user_data);
85
 
int         <a href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-main-timeout">bonobo_generic_factory_main_timeout</a>
86
 
                                            (const char *act_iid,
87
 
                                             <a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
88
 
                                             <a
 
83
int                 <a href="libbonobo-bonobo-generic-factory.html#bonobo-generic-factory-main-timeout">bonobo_generic_factory_main_timeout</a> (const char *act_iid,
 
84
                                                         <a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
 
85
                                                         <a
89
86
href="../glib/glib-Basic-Types.html#gpointer"
90
87
>gpointer</a> user_data,
91
 
                                             <a
 
88
                                                         <a
92
89
href="../glib/glib-Basic-Types.html#guint"
93
90
>guint</a> quit_timeout);
94
 
#define     <a href="libbonobo-bonobo-generic-factory.html#BONOBO-FACTORY-INIT:CAPS">BONOBO_FACTORY_INIT</a>             (descr, version, argcp, argv)
95
 
#define     <a href="libbonobo-bonobo-generic-factory.html#BONOBO-OAF-FACTORY:CAPS">BONOBO_OAF_FACTORY</a>              (oafiid, descr, version, callback, data)
96
 
#define     <a href="libbonobo-bonobo-generic-factory.html#BONOBO-OAF-FACTORY-MULTI:CAPS">BONOBO_OAF_FACTORY_MULTI</a>        (oafiid, descr, version, callback, data)
97
 
#define     <a href="libbonobo-bonobo-generic-factory.html#BONOBO-ACTIVATION-FACTORY:CAPS">BONOBO_ACTIVATION_FACTORY</a>       (oafiid, descr, version, callback, data)
98
 
#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)
 
91
#define             <a href="libbonobo-bonobo-generic-factory.html#BONOBO-FACTORY-INIT:CAPS">BONOBO_FACTORY_INIT</a>                 (descr, version, argcp, argv)
 
92
#define             <a href="libbonobo-bonobo-generic-factory.html#BONOBO-OAF-FACTORY:CAPS">BONOBO_OAF_FACTORY</a>                  (oafiid, descr, version, callback, data)
 
93
#define             <a href="libbonobo-bonobo-generic-factory.html#BONOBO-OAF-FACTORY-MULTI:CAPS">BONOBO_OAF_FACTORY_MULTI</a>            (oafiid, descr, version, callback, data)
 
94
#define             <a href="libbonobo-bonobo-generic-factory.html#BONOBO-ACTIVATION-FACTORY:CAPS">BONOBO_ACTIVATION_FACTORY</a>           (oafiid, descr, version, callback, data)
 
95
#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)
99
96
 
100
97
 
101
98
</pre>
102
99
</div>
103
100
<div class="refsect1" lang="en">
104
 
<a name="id2604166"></a><h2>Description</h2>
 
101
<a name="id2687392"></a><h2>Description</h2>
105
102
<p>
106
103
The vast majority of Bonobo objects are created by the
107
104
<span class="type">BonoboGenericFactory</span> implementation. This provides a
113
110
Bonobo object factory with OAF, this can be done like this:
114
111
  </p>
115
112
<div class="example">
116
 
<a name="id2604196"></a><p class="title"><b>Example&#160;7.&#160;How to register a factory with OAF</b></p>
 
113
<a name="id2687422"></a><p class="title"><b>Example&#160;7.&#160;How to register a factory with OAF</b></p>
117
114
<div class="example-contents"><pre class="programlisting">
118
115
BonoboGenericFactory *factory;
119
116
 
135
132
OAF the my_factory_function will be called:
136
133
  </p>
137
134
<div class="example">
138
 
<a name="id2604222"></a><p class="title"><b>Example&#160;8.&#160;A simple factory</b></p>
 
135
<a name="id2687448"></a><p class="title"><b>Example&#160;8.&#160;A simple factory</b></p>
139
136
<div class="example-contents"><pre class="programlisting">
140
137
static BonoboObject *
141
138
my_factory_fn (BonoboGenericFactory *this,
147
144
        g_return_val_if_fail (object_id != NULL, NULL);
148
145
 
149
146
        if (!strcmp (object_id, "OAFIID:Bonobo_Sample_Clock"))
150
 
                object = <code class="function">bonobo_clock_control_new()</code>;
 
147
                object = bonobo_clock_control_new ();
151
148
        else
152
 
                g_warning ("Unknown OAFIID '<code class="literal">s</code>'", object_id);
 
149
                g_warning ("Unknown OAFIID '%s'", object_id);
153
150
 
154
151
        return object;
155
152
}
165
162
correct, see <a href="libbonobo-bonobo-generic-factory.html#BONOBO-ACTIVATION-FACTORY:CAPS"><span class="type">BONOBO_ACTIVATION_FACTORY</span></a>.  </p>
166
163
</div>
167
164
<div class="refsect1" lang="en">
168
 
<a name="id2604282"></a><h2>Details</h2>
 
165
<a name="id2687487"></a><h2>Details</h2>
169
166
<div class="refsect2" lang="en">
170
 
<a name="id2604292"></a><h3>
 
167
<a name="id2687497"></a><h3>
171
168
<a name="BonoboFactoryCallback"></a>BonoboFactoryCallback ()</h3>
172
 
<a class="indexterm" name="id2604306"></a><pre class="programlisting"><a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>* (*BonoboFactoryCallback)      (BonoboGenericFactory *factory,
173
 
                                             const char *component_id,
174
 
                                             <a
 
169
<a class="indexterm" name="id2687511"></a><pre class="programlisting"><a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>*       (*BonoboFactoryCallback)            (BonoboGenericFactory *factory,
 
170
                                                         const char *component_id,
 
171
                                                         <a
175
172
href="../glib/glib-Basic-Types.html#gpointer"
176
173
>gpointer</a> closure);</pre>
177
174
<p>
207
204
</div>
208
205
<hr>
209
206
<div class="refsect2" lang="en">
210
 
<a name="id2604417"></a><h3>
 
207
<a name="id2687622"></a><h3>
211
208
<a name="bonobo-generic-factory-new"></a>bonobo_generic_factory_new ()</h3>
212
 
<a class="indexterm" name="id2604431"></a><pre class="programlisting">BonoboGenericFactory* bonobo_generic_factory_new
213
 
                                            (const char *act_iid,
214
 
                                             <a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
215
 
                                             <a
 
209
<a class="indexterm" name="id2687636"></a><pre class="programlisting">BonoboGenericFactory* bonobo_generic_factory_new        (const char *act_iid,
 
210
                                                         <a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
 
211
                                                         <a
216
212
href="../glib/glib-Basic-Types.html#gpointer"
217
213
>gpointer</a> user_data);</pre>
218
214
<p>
255
251
</div>
256
252
<hr>
257
253
<div class="refsect2" lang="en">
258
 
<a name="id2604564"></a><h3>
 
254
<a name="id2687768"></a><h3>
259
255
<a name="bonobo-generic-factory-new-closure"></a>bonobo_generic_factory_new_closure ()</h3>
260
 
<a class="indexterm" name="id2604578"></a><pre class="programlisting">BonoboGenericFactory* bonobo_generic_factory_new_closure
261
 
                                            (const char *act_iid,
262
 
                                             <a
 
256
<a class="indexterm" name="id2687783"></a><pre class="programlisting">BonoboGenericFactory* bonobo_generic_factory_new_closure
 
257
                                                        (const char *act_iid,
 
258
                                                         <a
263
259
href="../gobject/gobject-Closures.html#GClosure"
264
260
>GClosure</a> *factory_closure);</pre>
265
261
<p>
297
293
</div>
298
294
<hr>
299
295
<div class="refsect2" lang="en">
300
 
<a name="id2604682"></a><h3>
 
296
<a name="id2687888"></a><h3>
301
297
<a name="bonobo-generic-factory-construct"></a>bonobo_generic_factory_construct ()</h3>
302
 
<a class="indexterm" name="id2604696"></a><pre class="programlisting">BonoboGenericFactory* bonobo_generic_factory_construct
303
 
                                            (BonoboGenericFactory *factory,
304
 
                                             const char *act_iid,
305
 
                                             <a
 
298
<a class="indexterm" name="id2687901"></a><pre class="programlisting">BonoboGenericFactory* bonobo_generic_factory_construct  (BonoboGenericFactory *factory,
 
299
                                                         const char *act_iid,
 
300
                                                         <a
306
301
href="../gobject/gobject-Closures.html#GClosure"
307
302
>GClosure</a> *factory_closure);</pre>
308
303
<p>
342
337
</div>
343
338
<hr>
344
339
<div class="refsect2" lang="en">
345
 
<a name="id2604813"></a><h3>
 
340
<a name="id2688018"></a><h3>
346
341
<a name="bonobo-generic-factory-construct-noreg"></a>bonobo_generic_factory_construct_noreg ()</h3>
347
 
<a class="indexterm" name="id2604827"></a><pre class="programlisting">void        bonobo_generic_factory_construct_noreg
348
 
                                            (BonoboGenericFactory *factory,
349
 
                                             const char *act_iid,
350
 
                                             <a
 
342
<a class="indexterm" name="id2688032"></a><pre class="programlisting">void                bonobo_generic_factory_construct_noreg
 
343
                                                        (BonoboGenericFactory *factory,
 
344
                                                         const char *act_iid,
 
345
                                                         <a
351
346
href="../gobject/gobject-Closures.html#GClosure"
352
347
>GClosure</a> *factory_closure);</pre>
353
348
<p>
378
373
</div>
379
374
<hr>
380
375
<div class="refsect2" lang="en">
381
 
<a name="id2604930"></a><h3>
 
376
<a name="id2688135"></a><h3>
382
377
<a name="bonobo-generic-factory-main"></a>bonobo_generic_factory_main ()</h3>
383
 
<a class="indexterm" name="id2604943"></a><pre class="programlisting">int         bonobo_generic_factory_main     (const char *act_iid,
384
 
                                             <a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
385
 
                                             <a
 
378
<a class="indexterm" name="id2688149"></a><pre class="programlisting">int                 bonobo_generic_factory_main         (const char *act_iid,
 
379
                                                         <a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
 
380
                                                         <a
386
381
href="../glib/glib-Basic-Types.html#gpointer"
387
382
>gpointer</a> user_data);</pre>
388
383
<p>
419
414
</div>
420
415
<hr>
421
416
<div class="refsect2" lang="en">
422
 
<a name="id2605060"></a><h3>
 
417
<a name="id2688267"></a><h3>
423
418
<a name="bonobo-generic-factory-main-timeout"></a>bonobo_generic_factory_main_timeout ()</h3>
424
 
<a class="indexterm" name="id2605074"></a><pre class="programlisting">int         bonobo_generic_factory_main_timeout
425
 
                                            (const char *act_iid,
426
 
                                             <a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
427
 
                                             <a
 
419
<a class="indexterm" name="id2688281"></a><pre class="programlisting">int                 bonobo_generic_factory_main_timeout (const char *act_iid,
 
420
                                                         <a href="libbonobo-bonobo-generic-factory.html#BonoboFactoryCallback">BonoboFactoryCallback</a> factory_cb,
 
421
                                                         <a
428
422
href="../glib/glib-Basic-Types.html#gpointer"
429
423
>gpointer</a> user_data,
430
 
                                             <a
 
424
                                                         <a
431
425
href="../glib/glib-Basic-Types.html#guint"
432
426
>guint</a> quit_timeout);</pre>
433
427
<p>
470
464
</div>
471
465
<hr>
472
466
<div class="refsect2" lang="en">
473
 
<a name="id2605204"></a><h3>
 
467
<a name="id2688411"></a><h3>
474
468
<a name="BONOBO-FACTORY-INIT:CAPS"></a>BONOBO_FACTORY_INIT()</h3>
475
 
<a class="indexterm" name="id2605217"></a><pre class="programlisting">#define     BONOBO_FACTORY_INIT(descr, version, argcp, argv)</pre>
 
469
<a class="indexterm" name="id2688424"></a><pre class="programlisting">#define             BONOBO_FACTORY_INIT(descr, version, argcp, argv)</pre>
476
470
<p>
477
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.
478
472
</p>
507
501
</div>
508
502
<hr>
509
503
<div class="refsect2" lang="en">
510
 
<a name="id2605325"></a><h3>
 
504
<a name="id2688532"></a><h3>
511
505
<a name="BONOBO-OAF-FACTORY:CAPS"></a>BONOBO_OAF_FACTORY()</h3>
512
 
<a class="indexterm" name="id2605339"></a><pre class="programlisting">#define     BONOBO_OAF_FACTORY(oafiid, descr, version, callback, data)</pre>
 
506
<a class="indexterm" name="id2688546"></a><pre class="programlisting">#define             BONOBO_OAF_FACTORY(oafiid, descr, version, callback, data)</pre>
513
507
<p>
514
508
Deprecated; see <a href="libbonobo-bonobo-generic-factory.html#BONOBO-ACTIVATION-FACTORY:CAPS"><code class="function">BONOBO_ACTIVATION_FACTORY()</code></a>.
515
509
</p>
548
542
</div>
549
543
<hr>
550
544
<div class="refsect2" lang="en">
551
 
<a name="id2605439"></a><h3>
 
545
<a name="id2688646"></a><h3>
552
546
<a name="BONOBO-OAF-FACTORY-MULTI:CAPS"></a>BONOBO_OAF_FACTORY_MULTI()</h3>
553
 
<a class="indexterm" name="id2605452"></a><pre class="programlisting">#define     BONOBO_OAF_FACTORY_MULTI(oafiid, descr, version, callback, data)</pre>
 
547
<a class="indexterm" name="id2688659"></a><pre class="programlisting">#define             BONOBO_OAF_FACTORY_MULTI(oafiid, descr, version, callback, data)</pre>
554
548
<p>
555
549
Deprecated; see <a href="libbonobo-bonobo-generic-factory.html#BONOBO-ACTIVATION-FACTORY:CAPS"><code class="function">BONOBO_ACTIVATION_FACTORY()</code></a>.
556
550
</p>
589
583
</div>
590
584
<hr>
591
585
<div class="refsect2" lang="en">
592
 
<a name="id2605552"></a><h3>
 
586
<a name="id2688759"></a><h3>
593
587
<a name="BONOBO-ACTIVATION-FACTORY:CAPS"></a>BONOBO_ACTIVATION_FACTORY()</h3>
594
 
<a class="indexterm" name="id2605565"></a><pre class="programlisting">#define     BONOBO_ACTIVATION_FACTORY(oafiid, descr, version, callback, data)</pre>
 
588
<a class="indexterm" name="id2688772"></a><pre class="programlisting">#define             BONOBO_ACTIVATION_FACTORY(oafiid, descr, version, callback, data)</pre>
595
589
<p>
596
590
    Macro that includes all boiler-plate code necessary to create an exe
597
591
    type factory, including a <code class="function">main()</code> function and a generic factory.
631
625
</div>
632
626
<hr>
633
627
<div class="refsect2" lang="en">
634
 
<a name="id2605677"></a><h3>
 
628
<a name="id2688884"></a><h3>
635
629
<a name="BONOBO-ACTIVATION-FACTORY-TIMEOUT:CAPS"></a>BONOBO_ACTIVATION_FACTORY_TIMEOUT()</h3>
636
 
<a class="indexterm" name="id2605692"></a><pre class="programlisting">#define     BONOBO_ACTIVATION_FACTORY_TIMEOUT(oafiid, descr, version, callback, data, quit_timeout)</pre>
 
630
<a class="indexterm" name="id2688899"></a><pre class="programlisting">#define             BONOBO_ACTIVATION_FACTORY_TIMEOUT(oafiid, descr, version, callback, data, quit_timeout)</pre>
637
631
<p>
638
632
    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.
639
633
</p>