← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/api/xml/bonobo-application.xml

  • 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:
doc/api/xml/bonobo-application.xml
18
18
 
19
19
 
20
20
 
21
 
<link linkend="void">void</link>        (<link linkend="BonoboAppHookFunc">*BonoboAppHookFunc</link>)            (<link linkend="BonoboApplication">BonoboApplication</link> *app,
22
 
                                             <link linkend="gpointer">gpointer</link> data);
23
 
<link linkend="BonoboApplication">BonoboApplication</link>* <link linkend="bonobo-application-new">bonobo_application_new</link>   (const <link linkend="char">char</link> *name);
24
 
<link linkend="void">void</link>        <link linkend="bonobo-application-register-message">bonobo_application_register_message</link>
25
 
                                            (<link linkend="BonoboApplication">BonoboApplication</link> *app,
26
 
                                             const <link linkend="gchar">gchar</link> *name,
27
 
                                             const <link linkend="gchar">gchar</link> *description,
28
 
                                             <link linkend="GClosure">GClosure</link> *opt_closure,
29
 
                                             <link linkend="GType">GType</link> return_type,
30
 
                                             <link linkend="GType">GType</link> first_arg_type,
31
 
                                             ...);
32
 
<link linkend="void">void</link>        <link linkend="bonobo-application-register-message-v">bonobo_application_register_message_v</link>
33
 
                                            (<link linkend="BonoboApplication">BonoboApplication</link> *app,
34
 
                                             const <link linkend="gchar">gchar</link> *name,
35
 
                                             const <link linkend="gchar">gchar</link> *description,
36
 
                                             <link linkend="GClosure">GClosure</link> *opt_closure,
37
 
                                             <link linkend="GType">GType</link> return_type);
38
 
<link linkend="void">void</link>        <link linkend="bonobo-application-register-message-va">bonobo_application_register_message_va</link>
39
 
                                            (<link linkend="BonoboApplication">BonoboApplication</link> *app,
40
 
                                             const <link linkend="gchar">gchar</link> *name,
41
 
                                             const <link linkend="gchar">gchar</link> *description,
42
 
                                             <link linkend="GClosure">GClosure</link> *opt_closure,
43
 
                                             <link linkend="GType">GType</link> return_type,
44
 
                                             <link linkend="GType">GType</link> first_arg_type,
45
 
                                             <link linkend="va-list">va_list</link> var_args);
46
 
<link linkend="gint">gint</link>        <link linkend="bonobo-application-new-instance">bonobo_application_new_instance</link> (<link linkend="BonoboApplication">BonoboApplication</link> *app,
47
 
                                             <link linkend="gint">gint</link> argc,
48
 
                                             <link linkend="gchar">gchar</link> *argv[]);
49
 
<link linkend="gchar">gchar</link>*      <link linkend="bonobo-application-create-serverinfo">bonobo_application_create_serverinfo</link>
50
 
                                            (<link linkend="BonoboApplication">BonoboApplication</link> *app,
51
 
                                             <link linkend="gchar">gchar</link> const *envp[]);
 
21
<link linkend="void">void</link>                (<link linkend="BonoboAppHookFunc">*BonoboAppHookFunc</link>)                (<link linkend="BonoboApplication">BonoboApplication</link> *app,
 
22
                                                         <link linkend="gpointer">gpointer</link> data);
 
23
<link linkend="BonoboApplication">BonoboApplication</link>*  <link linkend="bonobo-application-new">bonobo_application_new</link>              (const <link linkend="char">char</link> *name);
 
24
<link linkend="void">void</link>                <link linkend="bonobo-application-register-message">bonobo_application_register_message</link> (<link linkend="BonoboApplication">BonoboApplication</link> *app,
 
25
                                                         const <link linkend="gchar">gchar</link> *name,
 
26
                                                         const <link linkend="gchar">gchar</link> *description,
 
27
                                                         <link linkend="GClosure">GClosure</link> *opt_closure,
 
28
                                                         <link linkend="GType">GType</link> return_type,
 
29
                                                         <link linkend="GType">GType</link> first_arg_type,
 
30
                                                         ...);
 
31
<link linkend="void">void</link>                <link linkend="bonobo-application-register-message-v">bonobo_application_register_message_v</link>
 
32
                                                        (<link linkend="BonoboApplication">BonoboApplication</link> *app,
 
33
                                                         const <link linkend="gchar">gchar</link> *name,
 
34
                                                         const <link linkend="gchar">gchar</link> *description,
 
35
                                                         <link linkend="GClosure">GClosure</link> *opt_closure,
 
36
                                                         <link linkend="GType">GType</link> return_type);
 
37
<link linkend="void">void</link>                <link linkend="bonobo-application-register-message-va">bonobo_application_register_message_va</link>
 
38
                                                        (<link linkend="BonoboApplication">BonoboApplication</link> *app,
 
39
                                                         const <link linkend="gchar">gchar</link> *name,
 
40
                                                         const <link linkend="gchar">gchar</link> *description,
 
41
                                                         <link linkend="GClosure">GClosure</link> *opt_closure,
 
42
                                                         <link linkend="GType">GType</link> return_type,
 
43
                                                         <link linkend="GType">GType</link> first_arg_type,
 
44
                                                         <link linkend="va-list">va_list</link> var_args);
 
45
<link linkend="gint">gint</link>                <link linkend="bonobo-application-new-instance">bonobo_application_new_instance</link>     (<link linkend="BonoboApplication">BonoboApplication</link> *app,
 
46
                                                         <link linkend="gint">gint</link> argc,
 
47
                                                         <link linkend="gchar">gchar</link> *argv[]);
 
48
<link linkend="gchar">gchar</link>*              <link linkend="bonobo-application-create-serverinfo">bonobo_application_create_serverinfo</link>
 
49
                                                        (<link linkend="BonoboApplication">BonoboApplication</link> *app,
 
50
                                                         <link linkend="gchar">gchar</link> const *envp[]);
52
51
<link linkend="Bonobo-RegistrationResult">Bonobo_RegistrationResult</link> <link linkend="bonobo-application-register-unique">bonobo_application_register_unique</link>
53
 
                                            (<link linkend="BonoboApplication">BonoboApplication</link> *app,
54
 
                                             <link linkend="gchar">gchar</link> const *serverinfo,
55
 
                                             <link linkend="BonoboAppClient">BonoboAppClient</link> **client);
56
 
<link linkend="void">void</link>        <link linkend="bonobo-application-add-hook">bonobo_application_add_hook</link>     (<link linkend="BonoboAppHookFunc">BonoboAppHookFunc</link> func,
57
 
                                             <link linkend="gpointer">gpointer</link> data);
58
 
<link linkend="void">void</link>        <link linkend="bonobo-application-remove-hook">bonobo_application_remove_hook</link>  (<link linkend="BonoboAppHookFunc">BonoboAppHookFunc</link> func,
59
 
                                             <link linkend="gpointer">gpointer</link> data);
 
52
                                                        (<link linkend="BonoboApplication">BonoboApplication</link> *app,
 
53
                                                         <link linkend="gchar">gchar</link> const *serverinfo,
 
54
                                                         <link linkend="BonoboAppClient">BonoboAppClient</link> **client);
 
55
<link linkend="void">void</link>                <link linkend="bonobo-application-add-hook">bonobo_application_add_hook</link>         (<link linkend="BonoboAppHookFunc">BonoboAppHookFunc</link> func,
 
56
                                                         <link linkend="gpointer">gpointer</link> data);
 
57
<link linkend="void">void</link>                <link linkend="bonobo-application-remove-hook">bonobo_application_remove_hook</link>      (<link linkend="BonoboAppHookFunc">BonoboAppHookFunc</link> func,
 
58
                                                         <link linkend="gpointer">gpointer</link> data);
60
59
 
61
60
</synopsis>
62
61
</refsynopsisdiv>
80
79
<title role="details.title">Details</title>
81
80
<refsect2>
82
81
<title><anchor id="BonoboAppHookFunc" role="function"/>BonoboAppHookFunc ()</title>
83
 
<indexterm><primary>BonoboAppHookFunc</primary></indexterm><programlisting><link linkend="void">void</link>        (*BonoboAppHookFunc)            (<link linkend="BonoboApplication">BonoboApplication</link> *app,
84
 
                                             <link linkend="gpointer">gpointer</link> data);</programlisting>
 
82
<indexterm><primary>BonoboAppHookFunc</primary></indexterm><programlisting><link linkend="void">void</link>                (*BonoboAppHookFunc)                (<link linkend="BonoboApplication">BonoboApplication</link> *app,
 
83
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
85
84
<para>
86
85
 
87
86
</para><variablelist role="params">
96
95
</variablelist></refsect2>
97
96
<refsect2>
98
97
<title><anchor id="bonobo-application-new" role="function"/>bonobo_application_new ()</title>
99
 
<indexterm><primary>bonobo_application_new</primary></indexterm><programlisting><link linkend="BonoboApplication">BonoboApplication</link>* bonobo_application_new   (const <link linkend="char">char</link> *name);</programlisting>
 
98
<indexterm><primary>bonobo_application_new</primary></indexterm><programlisting><link linkend="BonoboApplication">BonoboApplication</link>*  bonobo_application_new              (const <link linkend="char">char</link> *name);</programlisting>
100
99
<para>
101
100
Creates a new <link linkend="BonoboApplication"><type>BonoboApplication</type></link> object.</para>
102
101
<para>
110
109
</variablelist></refsect2>
111
110
<refsect2>
112
111
<title><anchor id="bonobo-application-register-message" role="function"/>bonobo_application_register_message ()</title>
113
 
<indexterm><primary>bonobo_application_register_message</primary></indexterm><programlisting><link linkend="void">void</link>        bonobo_application_register_message
114
 
                                            (<link linkend="BonoboApplication">BonoboApplication</link> *app,
115
 
                                             const <link linkend="gchar">gchar</link> *name,
116
 
                                             const <link linkend="gchar">gchar</link> *description,
117
 
                                             <link linkend="GClosure">GClosure</link> *opt_closure,
118
 
                                             <link linkend="GType">GType</link> return_type,
119
 
                                             <link linkend="GType">GType</link> first_arg_type,
120
 
                                             ...);</programlisting>
 
112
<indexterm><primary>bonobo_application_register_message</primary></indexterm><programlisting><link linkend="void">void</link>                bonobo_application_register_message (<link linkend="BonoboApplication">BonoboApplication</link> *app,
 
113
                                                         const <link linkend="gchar">gchar</link> *name,
 
114
                                                         const <link linkend="gchar">gchar</link> *description,
 
115
                                                         <link linkend="GClosure">GClosure</link> *opt_closure,
 
116
                                                         <link linkend="GType">GType</link> return_type,
 
117
                                                         <link linkend="GType">GType</link> first_arg_type,
 
118
                                                         ...);</programlisting>
121
119
<para>
122
120
Registers a new message type that the application supports.</para>
123
121
<para>
212
210
</variablelist></refsect2>
213
211
<refsect2>
214
212
<title><anchor id="bonobo-application-register-message-v" role="function"/>bonobo_application_register_message_v ()</title>
215
 
<indexterm><primary>bonobo_application_register_message_v</primary></indexterm><programlisting><link linkend="void">void</link>        bonobo_application_register_message_v
216
 
                                            (<link linkend="BonoboApplication">BonoboApplication</link> *app,
217
 
                                             const <link linkend="gchar">gchar</link> *name,
218
 
                                             const <link linkend="gchar">gchar</link> *description,
219
 
                                             <link linkend="GClosure">GClosure</link> *opt_closure,
220
 
                                             <link linkend="GType">GType</link> return_type);</programlisting>
 
213
<indexterm><primary>bonobo_application_register_message_v</primary></indexterm><programlisting><link linkend="void">void</link>                bonobo_application_register_message_v
 
214
                                                        (<link linkend="BonoboApplication">BonoboApplication</link> *app,
 
215
                                                         const <link linkend="gchar">gchar</link> *name,
 
216
                                                         const <link linkend="gchar">gchar</link> *description,
 
217
                                                         <link linkend="GClosure">GClosure</link> *opt_closure,
 
218
                                                         <link linkend="GType">GType</link> return_type);</programlisting>
221
219
<para>
222
220
See <link linkend="bonobo-application-register-message"><function>bonobo_application_register_message()</function></link>.</para>
223
221
<para>
242
240
</variablelist></refsect2>
243
241
<refsect2>
244
242
<title><anchor id="bonobo-application-register-message-va" role="function"/>bonobo_application_register_message_va ()</title>
245
 
<indexterm><primary>bonobo_application_register_message_va</primary></indexterm><programlisting><link linkend="void">void</link>        bonobo_application_register_message_va
246
 
                                            (<link linkend="BonoboApplication">BonoboApplication</link> *app,
247
 
                                             const <link linkend="gchar">gchar</link> *name,
248
 
                                             const <link linkend="gchar">gchar</link> *description,
249
 
                                             <link linkend="GClosure">GClosure</link> *opt_closure,
250
 
                                             <link linkend="GType">GType</link> return_type,
251
 
                                             <link linkend="GType">GType</link> first_arg_type,
252
 
                                             <link linkend="va-list">va_list</link> var_args);</programlisting>
 
243
<indexterm><primary>bonobo_application_register_message_va</primary></indexterm><programlisting><link linkend="void">void</link>                bonobo_application_register_message_va
 
244
                                                        (<link linkend="BonoboApplication">BonoboApplication</link> *app,
 
245
                                                         const <link linkend="gchar">gchar</link> *name,
 
246
                                                         const <link linkend="gchar">gchar</link> *description,
 
247
                                                         <link linkend="GClosure">GClosure</link> *opt_closure,
 
248
                                                         <link linkend="GType">GType</link> return_type,
 
249
                                                         <link linkend="GType">GType</link> first_arg_type,
 
250
                                                         <link linkend="va-list">va_list</link> var_args);</programlisting>
253
251
<para>
254
252
See <link linkend="bonobo-application-register-message"><function>bonobo_application_register_message()</function></link>.</para>
255
253
<para>
280
278
</variablelist></refsect2>
281
279
<refsect2>
282
280
<title><anchor id="bonobo-application-new-instance" role="function"/>bonobo_application_new_instance ()</title>
283
 
<indexterm><primary>bonobo_application_new_instance</primary></indexterm><programlisting><link linkend="gint">gint</link>        bonobo_application_new_instance (<link linkend="BonoboApplication">BonoboApplication</link> *app,
284
 
                                             <link linkend="gint">gint</link> argc,
285
 
                                             <link linkend="gchar">gchar</link> *argv[]);</programlisting>
 
281
<indexterm><primary>bonobo_application_new_instance</primary></indexterm><programlisting><link linkend="gint">gint</link>                bonobo_application_new_instance     (<link linkend="BonoboApplication">BonoboApplication</link> *app,
 
282
                                                         <link linkend="gint">gint</link> argc,
 
283
                                                         <link linkend="gchar">gchar</link> *argv[]);</programlisting>
286
284
<para>
287
285
Emit the "new-instance" signal of the <link linkend="BonoboApplication"><type>BonoboApplication</type></link> with the
288
286
given arguments.</para>
303
301
</variablelist></refsect2>
304
302
<refsect2>
305
303
<title><anchor id="bonobo-application-create-serverinfo" role="function"/>bonobo_application_create_serverinfo ()</title>
306
 
<indexterm><primary>bonobo_application_create_serverinfo</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      bonobo_application_create_serverinfo
307
 
                                            (<link linkend="BonoboApplication">BonoboApplication</link> *app,
308
 
                                             <link linkend="gchar">gchar</link> const *envp[]);</programlisting>
 
304
<indexterm><primary>bonobo_application_create_serverinfo</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              bonobo_application_create_serverinfo
 
305
                                                        (<link linkend="BonoboApplication">BonoboApplication</link> *app,
 
306
                                                         <link linkend="gchar">gchar</link> const *envp[]);</programlisting>
309
307
<para>
310
308
This utility function provides a simple way to contruct a valid
311
309
serverinfo XML string.</para>
325
323
<refsect2>
326
324
<title><anchor id="bonobo-application-register-unique" role="function"/>bonobo_application_register_unique ()</title>
327
325
<indexterm><primary>bonobo_application_register_unique</primary></indexterm><programlisting><link linkend="Bonobo-RegistrationResult">Bonobo_RegistrationResult</link> bonobo_application_register_unique
328
 
                                            (<link linkend="BonoboApplication">BonoboApplication</link> *app,
329
 
                                             <link linkend="gchar">gchar</link> const *serverinfo,
330
 
                                             <link linkend="BonoboAppClient">BonoboAppClient</link> **client);</programlisting>
 
326
                                                        (<link linkend="BonoboApplication">BonoboApplication</link> *app,
 
327
                                                         <link linkend="gchar">gchar</link> const *serverinfo,
 
328
                                                         <link linkend="BonoboAppClient">BonoboAppClient</link> **client);</programlisting>
331
329
<para>
332
330
Try to register the running application, or check for an existing
333
331
application already registered and get a reference to it.
366
364
</variablelist></refsect2>
367
365
<refsect2>
368
366
<title><anchor id="bonobo-application-add-hook" role="function"/>bonobo_application_add_hook ()</title>
369
 
<indexterm><primary>bonobo_application_add_hook</primary></indexterm><programlisting><link linkend="void">void</link>        bonobo_application_add_hook     (<link linkend="BonoboAppHookFunc">BonoboAppHookFunc</link> func,
370
 
                                             <link linkend="gpointer">gpointer</link> data);</programlisting>
 
367
<indexterm><primary>bonobo_application_add_hook</primary></indexterm><programlisting><link linkend="void">void</link>                bonobo_application_add_hook         (<link linkend="BonoboAppHookFunc">BonoboAppHookFunc</link> func,
 
368
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
371
369
<para>
372
370
Add a hook function to be called whenever a new <link linkend="BonoboApplication"><type>BonoboApplication</type></link>
373
371
instance is created.</para>
383
381
</variablelist></refsect2>
384
382
<refsect2>
385
383
<title><anchor id="bonobo-application-remove-hook" role="function"/>bonobo_application_remove_hook ()</title>
386
 
<indexterm><primary>bonobo_application_remove_hook</primary></indexterm><programlisting><link linkend="void">void</link>        bonobo_application_remove_hook  (<link linkend="BonoboAppHookFunc">BonoboAppHookFunc</link> func,
387
 
                                             <link linkend="gpointer">gpointer</link> data);</programlisting>
 
384
<indexterm><primary>bonobo_application_remove_hook</primary></indexterm><programlisting><link linkend="void">void</link>                bonobo_application_remove_hook      (<link linkend="BonoboAppHookFunc">BonoboAppHookFunc</link> func,
 
385
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
388
386
<para>
389
387
Removes a hook function previously set with <link linkend="bonobo-application-add-hook"><function>bonobo_application_add_hook()</function></link>.</para>
390
388
<para>