← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/api/sgml/bonobo-shlib-factory.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2005-02-18 14:40:51 UTC
  • mto: (3.1.1 etch) (1.1.25 upstream)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20050218144051-fo4h9qh2gim8x3wt
Tags: upstream-2.8.1
Import upstream version 2.8.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/sgml/bonobo-shlib-factory.sgml
1
 
<refentry id="libbonobo-bonobo-shlib-factory">
2
 
<refmeta>
3
 
<refentrytitle>bonobo-shlib-factory</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>LIBBONOBO Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>bonobo-shlib-factory</refname><refpurpose></refpurpose>
10
 
</refnamediv>
11
 
 
12
 
<refsynopsisdiv><title>Synopsis</title>
13
 
<synopsis>
14
 
 
15
 
 
16
 
 
17
 
#define     <link linkend="BONOBO-SHLIB-FACTORY-TYPE-CAPS">BONOBO_SHLIB_FACTORY_TYPE</link>
18
 
struct      <link linkend="BonoboShlibFactoryPrivate">BonoboShlibFactoryPrivate</link>;
19
 
typedef     <link linkend="BonoboShlibFactory">BonoboShlibFactory</link>;
20
 
typedef     <link linkend="BonoboShlibFactoryClass">BonoboShlibFactoryClass</link>;
21
 
<link linkend="BonoboShlibFactory">BonoboShlibFactory</link>* <link linkend="bonobo-shlib-factory-construct">bonobo_shlib_factory_construct</link>
22
 
                                            (<link linkend="BonoboShlibFactory">BonoboShlibFactory</link> *factory,
23
 
                                             const char *component_id,
24
 
                                             <link linkend="PortableServer-POA">PortableServer_POA</link> poa,
25
 
                                             <link linkend="gpointer">gpointer</link> act_impl_ptr,
26
 
                                             <link linkend="GClosure">GClosure</link> *closure);
27
 
<link linkend="BonoboShlibFactory">BonoboShlibFactory</link>* <link linkend="bonobo-shlib-factory-new">bonobo_shlib_factory_new</link>
28
 
                                            (const char *component_id,
29
 
                                             <link linkend="PortableServer-POA">PortableServer_POA</link> poa,
30
 
                                             <link linkend="gpointer">gpointer</link> act_impl_ptr,
31
 
                                             <link linkend="BonoboFactoryCallback">BonoboFactoryCallback</link> factory_cb,
32
 
                                             <link linkend="gpointer">gpointer</link> user_data);
33
 
<link linkend="BonoboShlibFactory">BonoboShlibFactory</link>* <link linkend="bonobo-shlib-factory-new-closure">bonobo_shlib_factory_new_closure</link>
34
 
                                            (const char *component_id,
35
 
                                             <link linkend="PortableServer-POA">PortableServer_POA</link> poa,
36
 
                                             <link linkend="gpointer">gpointer</link> act_impl_ptr,
37
 
                                             <link linkend="GClosure">GClosure</link> *factory_closure);
38
 
<link linkend="Bonobo-Unknown">Bonobo_Unknown</link> <link linkend="bonobo-shlib-factory-std">bonobo_shlib_factory_std</link>     (const char *component_id,
39
 
                                             <link linkend="PortableServer-POA">PortableServer_POA</link> poa,
40
 
                                             <link linkend="gpointer">gpointer</link> act_impl_ptr,
41
 
                                             <link linkend="BonoboFactoryCallback">BonoboFactoryCallback</link> factory_cb,
42
 
                                             <link linkend="gpointer">gpointer</link> user_data,
43
 
                                             <link linkend="CORBA-Environment">CORBA_Environment</link> *ev);
44
 
#define     <link linkend="BONOBO-OAF-SHLIB-FACTORY-CAPS">BONOBO_OAF_SHLIB_FACTORY</link>        (oafiid, descr, fn, data)
45
 
#define     <link linkend="BONOBO-OAF-SHLIB-FACTORY-MULTI-CAPS">BONOBO_OAF_SHLIB_FACTORY_MULTI</link>  (oafiid, descr, fn, data)
46
 
#define     <link linkend="BONOBO-ACTIVATION-SHLIB-FACTORY-CAPS">BONOBO_ACTIVATION_SHLIB_FACTORY</link> (oafiid, descr, fn, data)
47
 
 
48
 
</synopsis>
49
 
</refsynopsisdiv>
50
 
 
51
 
 
52
 
 
53
 
 
54
 
 
55
 
<refsect1>
56
 
<title>Description</title>
57
 
<para>
58
 
 
59
 
</para>
60
 
</refsect1>
61
 
 
62
 
<refsect1>
63
 
<title>Details</title>
64
 
<refsect2>
65
 
<title><anchor id="BONOBO-SHLIB-FACTORY-TYPE-CAPS">BONOBO_SHLIB_FACTORY_TYPE</title>
66
 
<programlisting>#define BONOBO_SHLIB_FACTORY_TYPE        BONOBO_TYPE_SHLIB_FACTORY /* deprecated, you should use BONOBO_TYPE_SHLIB_FACTORY */
67
 
</programlisting>
68
 
<para>
69
 
 
70
 
</para></refsect2>
71
 
<refsect2>
72
 
<title><anchor id="BonoboShlibFactoryPrivate">struct BonoboShlibFactoryPrivate</title>
73
 
<programlisting>struct BonoboShlibFactoryPrivate;</programlisting>
74
 
<para>
75
 
 
76
 
</para></refsect2>
77
 
<refsect2>
78
 
<title><anchor id="BonoboShlibFactory">BonoboShlibFactory</title>
79
 
<programlisting>typedef struct {
80
 
        BonoboGenericFactory base;
81
 
 
82
 
        BonoboShlibFactoryPrivate *priv;
83
 
} BonoboShlibFactory;
84
 
</programlisting>
85
 
<para>
86
 
 
87
 
</para></refsect2>
88
 
<refsect2>
89
 
<title><anchor id="BonoboShlibFactoryClass">BonoboShlibFactoryClass</title>
90
 
<programlisting>typedef struct {
91
 
        BonoboGenericFactoryClass parent_class;
92
 
} BonoboShlibFactoryClass;
93
 
</programlisting>
94
 
<para>
95
 
 
96
 
</para></refsect2>
97
 
<refsect2>
98
 
<title><anchor id="bonobo-shlib-factory-construct">bonobo_shlib_factory_construct ()</title>
99
 
<programlisting><link linkend="BonoboShlibFactory">BonoboShlibFactory</link>* bonobo_shlib_factory_construct
100
 
                                            (<link linkend="BonoboShlibFactory">BonoboShlibFactory</link> *factory,
101
 
                                             const char *component_id,
102
 
                                             <link linkend="PortableServer-POA">PortableServer_POA</link> poa,
103
 
                                             <link linkend="gpointer">gpointer</link> act_impl_ptr,
104
 
                                             <link linkend="GClosure">GClosure</link> *closure);</programlisting>
105
 
<para>
106
 
Initializes <parameter>c_factory</parameter> with the supplied data.</para>
107
 
<para>
108
 
 
109
 
</para><informaltable pgwide="1" frame="none" role="params">
110
 
<tgroup cols="2">
111
 
<colspec colwidth="2*">
112
 
<colspec colwidth="8*">
113
 
<tbody>
114
 
<row><entry align="right"><parameter>factory</parameter>&nbsp;:</entry>
115
 
<entry> The object to be initialized.
116
 
</entry></row>
117
 
<row><entry align="right"><parameter>component_id</parameter>&nbsp;:</entry>
118
 
<entry>
119
 
</entry></row>
120
 
<row><entry align="right"><parameter>poa</parameter>&nbsp;:</entry>
121
 
<entry>
122
 
</entry></row>
123
 
<row><entry align="right"><parameter>act_impl_ptr</parameter>&nbsp;:</entry>
124
 
<entry> Activation shlib handle
125
 
</entry></row>
126
 
<row><entry align="right"><parameter>closure</parameter>&nbsp;:</entry>
127
 
<entry> The closure used to create new GnomeShlib object instances.
128
 
</entry></row>
129
 
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The initialized BonoboShlibFactory object.
130
 
</entry></row>
131
 
</tbody></tgroup></informaltable></refsect2>
132
 
<refsect2>
133
 
<title><anchor id="bonobo-shlib-factory-new">bonobo_shlib_factory_new ()</title>
134
 
<programlisting><link linkend="BonoboShlibFactory">BonoboShlibFactory</link>* bonobo_shlib_factory_new
135
 
                                            (const char *component_id,
136
 
                                             <link linkend="PortableServer-POA">PortableServer_POA</link> poa,
137
 
                                             <link linkend="gpointer">gpointer</link> act_impl_ptr,
138
 
                                             <link linkend="BonoboFactoryCallback">BonoboFactoryCallback</link> factory_cb,
139
 
                                             <link linkend="gpointer">gpointer</link> user_data);</programlisting>
140
 
<para>
141
 
This is a helper routine that simplifies the creation of factory
142
 
objects for GNOME objects.  The <parameter>factory</parameter> function will be
143
 
invoked by the CORBA server when a request arrives to create a new
144
 
instance of an object supporting the Bonobo::Shlib interface.
145
 
The factory callback routine is passed the <parameter>data</parameter> pointer to provide
146
 
the creation function with some state information.</para>
147
 
<para>
148
 
 
149
 
</para><informaltable pgwide="1" frame="none" role="params">
150
 
<tgroup cols="2">
151
 
<colspec colwidth="2*">
152
 
<colspec colwidth="8*">
153
 
<tbody>
154
 
<row><entry align="right"><parameter>component_id</parameter>&nbsp;:</entry>
155
 
<entry>
156
 
</entry></row>
157
 
<row><entry align="right"><parameter>poa</parameter>&nbsp;:</entry>
158
 
<entry> the poa.
159
 
</entry></row>
160
 
<row><entry align="right"><parameter>act_impl_ptr</parameter>&nbsp;:</entry>
161
 
<entry> Activation shlib handle
162
 
</entry></row>
163
 
<row><entry align="right"><parameter>factory_cb</parameter>&nbsp;:</entry>
164
 
<entry> A callback which is used to create new BonoboObject instances.
165
 
</entry></row>
166
 
<row><entry align="right"><parameter>user_data</parameter>&nbsp;:</entry>
167
 
<entry> The closure data to be passed to the <parameter>factory</parameter> callback routine.
168
 
</entry></row>
169
 
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> A BonoboShlibFactory object that has an activated
170
 
Bonobo::ShlibFactory object that has registered with the GNOME
171
 
name server.
172
 
</entry></row>
173
 
</tbody></tgroup></informaltable></refsect2>
174
 
<refsect2>
175
 
<title><anchor id="bonobo-shlib-factory-new-closure">bonobo_shlib_factory_new_closure ()</title>
176
 
<programlisting><link linkend="BonoboShlibFactory">BonoboShlibFactory</link>* bonobo_shlib_factory_new_closure
177
 
                                            (const char *component_id,
178
 
                                             <link linkend="PortableServer-POA">PortableServer_POA</link> poa,
179
 
                                             <link linkend="gpointer">gpointer</link> act_impl_ptr,
180
 
                                             <link linkend="GClosure">GClosure</link> *factory_closure);</programlisting>
181
 
<para>
182
 
This is a helper routine that simplifies the creation of factory
183
 
objects for GNOME objects.  The <parameter>factory_closure</parameter> closure will be
184
 
invoked by the CORBA server when a request arrives to create a new
185
 
instance of an object supporting the Bonobo::Shlib interface.
186
 
The factory callback routine is passed the <parameter>data</parameter> pointer to provide
187
 
the creation function with some state information.</para>
188
 
<para>
189
 
 
190
 
</para><informaltable pgwide="1" frame="none" role="params">
191
 
<tgroup cols="2">
192
 
<colspec colwidth="2*">
193
 
<colspec colwidth="8*">
194
 
<tbody>
195
 
<row><entry align="right"><parameter>component_id</parameter>&nbsp;:</entry>
196
 
<entry>
197
 
</entry></row>
198
 
<row><entry align="right"><parameter>poa</parameter>&nbsp;:</entry>
199
 
<entry> the poa.
200
 
</entry></row>
201
 
<row><entry align="right"><parameter>act_impl_ptr</parameter>&nbsp;:</entry>
202
 
<entry> Activation shlib handle
203
 
</entry></row>
204
 
<row><entry align="right"><parameter>factory_closure</parameter>&nbsp;:</entry>
205
 
<entry> A closure which is used to create new BonoboObject instances.
206
 
</entry></row>
207
 
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> A BonoboShlibFactory object that has an activated
208
 
Bonobo::ShlibFactory object that has registered with the GNOME
209
 
name server.
210
 
</entry></row>
211
 
</tbody></tgroup></informaltable></refsect2>
212
 
<refsect2>
213
 
<title><anchor id="bonobo-shlib-factory-std">bonobo_shlib_factory_std ()</title>
214
 
<programlisting><link linkend="Bonobo-Unknown">Bonobo_Unknown</link> bonobo_shlib_factory_std     (const char *component_id,
215
 
                                             <link linkend="PortableServer-POA">PortableServer_POA</link> poa,
216
 
                                             <link linkend="gpointer">gpointer</link> act_impl_ptr,
217
 
                                             <link linkend="BonoboFactoryCallback">BonoboFactoryCallback</link> factory_cb,
218
 
                                             <link linkend="gpointer">gpointer</link> user_data,
219
 
                                             <link linkend="CORBA-Environment">CORBA_Environment</link> *ev);</programlisting>
220
 
<para>
221
 
A Generic std shlib routine so we don't stick a load of code
222
 
inside a public macro.</para>
223
 
<para>
224
 
 
225
 
</para><informaltable pgwide="1" frame="none" role="params">
226
 
<tgroup cols="2">
227
 
<colspec colwidth="2*">
228
 
<colspec colwidth="8*">
229
 
<tbody>
230
 
<row><entry align="right"><parameter>component_id</parameter>&nbsp;:</entry>
231
 
<entry>
232
 
</entry></row>
233
 
<row><entry align="right"><parameter>poa</parameter>&nbsp;:</entry>
234
 
<entry>
235
 
</entry></row>
236
 
<row><entry align="right"><parameter>act_impl_ptr</parameter>&nbsp;:</entry>
237
 
<entry>
238
 
</entry></row>
239
 
<row><entry align="right"><parameter>factory_cb</parameter>&nbsp;:</entry>
240
 
<entry>
241
 
</entry></row>
242
 
<row><entry align="right"><parameter>user_data</parameter>&nbsp;:</entry>
243
 
<entry>
244
 
</entry></row>
245
 
<row><entry align="right"><parameter>ev</parameter>&nbsp;:</entry>
246
 
<entry>
247
 
</entry></row>
248
 
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> 0 on success, 1 on failure.
249
 
</entry></row>
250
 
</tbody></tgroup></informaltable></refsect2>
251
 
<refsect2>
252
 
<title><anchor id="BONOBO-OAF-SHLIB-FACTORY-CAPS">BONOBO_OAF_SHLIB_FACTORY()</title>
253
 
<programlisting>#define     BONOBO_OAF_SHLIB_FACTORY(oafiid, descr, fn, data)</programlisting>
254
 
<para>
255
 
 
256
 
</para><informaltable pgwide="1" frame="none" role="params">
257
 
<tgroup cols="2">
258
 
<colspec colwidth="2*">
259
 
<colspec colwidth="8*">
260
 
<tbody>
261
 
<row><entry align="right"><parameter>oafiid</parameter>&nbsp;:</entry>
262
 
<entry>
263
 
</entry></row>
264
 
<row><entry align="right"><parameter>descr</parameter>&nbsp;:</entry>
265
 
<entry>
266
 
</entry></row>
267
 
<row><entry align="right"><parameter>fn</parameter>&nbsp;:</entry>
268
 
<entry>
269
 
</entry></row>
270
 
<row><entry align="right"><parameter>data</parameter>&nbsp;:</entry>
271
 
<entry>
272
 
 
273
 
 
274
 
</entry></row>
275
 
</tbody></tgroup></informaltable></refsect2>
276
 
<refsect2>
277
 
<title><anchor id="BONOBO-OAF-SHLIB-FACTORY-MULTI-CAPS">BONOBO_OAF_SHLIB_FACTORY_MULTI()</title>
278
 
<programlisting>#define     BONOBO_OAF_SHLIB_FACTORY_MULTI(oafiid, descr, fn, data)</programlisting>
279
 
<para>
280
 
 
281
 
</para><informaltable pgwide="1" frame="none" role="params">
282
 
<tgroup cols="2">
283
 
<colspec colwidth="2*">
284
 
<colspec colwidth="8*">
285
 
<tbody>
286
 
<row><entry align="right"><parameter>oafiid</parameter>&nbsp;:</entry>
287
 
<entry>
288
 
</entry></row>
289
 
<row><entry align="right"><parameter>descr</parameter>&nbsp;:</entry>
290
 
<entry>
291
 
</entry></row>
292
 
<row><entry align="right"><parameter>fn</parameter>&nbsp;:</entry>
293
 
<entry>
294
 
</entry></row>
295
 
<row><entry align="right"><parameter>data</parameter>&nbsp;:</entry>
296
 
<entry>
297
 
 
298
 
 
299
 
</entry></row>
300
 
</tbody></tgroup></informaltable></refsect2>
301
 
<refsect2>
302
 
<title><anchor id="BONOBO-ACTIVATION-SHLIB-FACTORY-CAPS">BONOBO_ACTIVATION_SHLIB_FACTORY()</title>
303
 
<programlisting>#define     BONOBO_ACTIVATION_SHLIB_FACTORY(oafiid, descr, fn, data)</programlisting>
304
 
<para>
305
 
 
306
 
</para><informaltable pgwide="1" frame="none" role="params">
307
 
<tgroup cols="2">
308
 
<colspec colwidth="2*">
309
 
<colspec colwidth="8*">
310
 
<tbody>
311
 
<row><entry align="right"><parameter>oafiid</parameter>&nbsp;:</entry>
312
 
<entry>
313
 
</entry></row>
314
 
<row><entry align="right"><parameter>descr</parameter>&nbsp;:</entry>
315
 
<entry>
316
 
</entry></row>
317
 
<row><entry align="right"><parameter>fn</parameter>&nbsp;:</entry>
318
 
<entry>
319
 
</entry></row>
320
 
<row><entry align="right"><parameter>data</parameter>&nbsp;:</entry>
321
 
<entry>
322
 
 
323
 
 
324
 
</entry></row>
325
 
</tbody></tgroup></informaltable></refsect2>
326
 
 
327
 
</refsect1>
328
 
 
329
 
 
330
 
 
331
 
 
332
 
</refentry>