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

« back to all changes in this revision

Viewing changes to doc/activation-api/xml/utilities.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:
19
19
#include <bonobo-activation/bonobo-activation.h>
20
20
 
21
21
 
22
 
enum        <link linkend="Bonobo-ActivationPropertyType">Bonobo_ActivationPropertyType</link>;
23
 
<link linkend="Bonobo-ActivationProperty">Bonobo_ActivationProperty</link>* <link linkend="bonobo-server-info-prop-find">bonobo_server_info_prop_find</link>
24
 
                                            (<link linkend="Bonobo-ServerInfo">Bonobo_ServerInfo</link> *server,
25
 
                                             const <link linkend="char">char</link> *prop_name);
26
 
<link linkend="Bonobo-ActivationID">Bonobo_ActivationID</link> <link linkend="bonobo-activation-info-stringify">bonobo_activation_info_stringify</link>
27
 
                                            (const <link linkend="BonoboActivationInfo">BonoboActivationInfo</link> *actinfo);
 
22
enum                <link linkend="Bonobo-ActivationPropertyType">Bonobo_ActivationPropertyType</link>;
 
23
<link linkend="Bonobo-ActivationProperty">Bonobo_ActivationProperty</link>* <link linkend="bonobo-server-info-prop-find">bonobo_server_info_prop_find</link> (<link linkend="Bonobo-ServerInfo">Bonobo_ServerInfo</link> *server,
 
24
                                                         const <link linkend="char">char</link> *prop_name);
 
25
<link linkend="Bonobo-ActivationID">Bonobo_ActivationID</link> <link linkend="bonobo-activation-info-stringify">bonobo_activation_info_stringify</link>    (const <link linkend="BonoboActivationInfo">BonoboActivationInfo</link> *actinfo);
28
26
<link linkend="BonoboActivationInfo">BonoboActivationInfo</link>* <link linkend="bonobo-activation-servinfo-to-actinfo">bonobo_activation_servinfo_to_actinfo</link>
29
 
                                            (const <link linkend="Bonobo-ServerInfo">Bonobo_ServerInfo</link> *servinfo);
30
 
<link linkend="BonoboActivationInfo">BonoboActivationInfo</link>* <link linkend="bonobo-activation-id-parse">bonobo_activation_id_parse</link>
31
 
                                            (const <link linkend="CORBA-char">CORBA_char</link> *actid);
32
 
<link linkend="BonoboActivationInfo">BonoboActivationInfo</link>* <link linkend="bonobo-activation-info-new">bonobo_activation_info_new</link>
33
 
                                            (void);
34
 
<link linkend="void">void</link>        <link linkend="bonobo-activation-info-free">bonobo_activation_info_free</link>     (<link linkend="BonoboActivationInfo">BonoboActivationInfo</link> *actinfo);
35
 
const <link linkend="char">char</link>* <link linkend="bonobo-server-info-prop-lookup">bonobo_server_info_prop_lookup</link>  (<link linkend="Bonobo-ServerInfo">Bonobo_ServerInfo</link> *server,
36
 
                                             const <link linkend="char">char</link> *prop_name,
37
 
                                             <link linkend="GSList">GSList</link> *i18n_languages);
38
 
typedef     <link linkend="Bonobo-ServerInfoList">Bonobo_ServerInfoList</link>;
39
 
<link linkend="Bonobo-ServerInfo">Bonobo_ServerInfo</link>* <link linkend="bonobo-activation-get-default-component-for-mime-type">bonobo_activation_get_default_component_for_mime_type</link>
40
 
                                            (const <link linkend="char">char</link> *mime_type);
41
 
<link linkend="GList">GList</link>*      <link linkend="bonobo-activation-get-all-components-for-mime-type">bonobo_activation_get_all_components_for_mime_type</link>
42
 
                                            (const <link linkend="char">char</link> *mime_type);
 
27
                                                        (const <link linkend="Bonobo-ServerInfo">Bonobo_ServerInfo</link> *servinfo);
 
28
<link linkend="BonoboActivationInfo">BonoboActivationInfo</link>* <link linkend="bonobo-activation-id-parse">bonobo_activation_id_parse</link>        (const <link linkend="CORBA-char">CORBA_char</link> *actid);
 
29
<link linkend="BonoboActivationInfo">BonoboActivationInfo</link>* <link linkend="bonobo-activation-info-new">bonobo_activation_info_new</link>        (void);
 
30
<link linkend="void">void</link>                <link linkend="bonobo-activation-info-free">bonobo_activation_info_free</link>         (<link linkend="BonoboActivationInfo">BonoboActivationInfo</link> *actinfo);
 
31
const <link linkend="char">char</link>*         <link linkend="bonobo-server-info-prop-lookup">bonobo_server_info_prop_lookup</link>      (<link linkend="Bonobo-ServerInfo">Bonobo_ServerInfo</link> *server,
 
32
                                                         const <link linkend="char">char</link> *prop_name,
 
33
                                                         <link linkend="GSList">GSList</link> *i18n_languages);
 
34
typedef             <link linkend="Bonobo-ServerInfoList">Bonobo_ServerInfoList</link>;
 
35
<link linkend="Bonobo-ServerInfo">Bonobo_ServerInfo</link>*  <link linkend="bonobo-activation-get-default-component-for-mime-type">bonobo_activation_get_default_component_for_mime_type</link>
 
36
                                                        (const <link linkend="char">char</link> *mime_type);
 
37
<link linkend="GList">GList</link>*              <link linkend="bonobo-activation-get-all-components-for-mime-type">bonobo_activation_get_all_components_for_mime_type</link>
 
38
                                                        (const <link linkend="char">char</link> *mime_type);
43
39
 
44
40
</synopsis>
45
41
</refsynopsisdiv>
75
71
</para></refsect2>
76
72
<refsect2>
77
73
<title><anchor id="bonobo-server-info-prop-find" role="function"/>bonobo_server_info_prop_find ()</title>
78
 
<indexterm><primary>bonobo_server_info_prop_find</primary></indexterm><programlisting><link linkend="Bonobo-ActivationProperty">Bonobo_ActivationProperty</link>* bonobo_server_info_prop_find
79
 
                                            (<link linkend="Bonobo-ServerInfo">Bonobo_ServerInfo</link> *server,
80
 
                                             const <link linkend="char">char</link> *prop_name);</programlisting>
 
74
<indexterm><primary>bonobo_server_info_prop_find</primary></indexterm><programlisting><link linkend="Bonobo-ActivationProperty">Bonobo_ActivationProperty</link>* bonobo_server_info_prop_find (<link linkend="Bonobo-ServerInfo">Bonobo_ServerInfo</link> *server,
 
75
                                                         const <link linkend="char">char</link> *prop_name);</programlisting>
81
76
<para>
82
77
Tries to find a server with the given property. Returns
83
78
NULL if not found.</para>
95
90
</variablelist></refsect2>
96
91
<refsect2>
97
92
<title><anchor id="bonobo-activation-info-stringify" role="function" condition="deprecated:"/>bonobo_activation_info_stringify ()</title>
98
 
<indexterm role="deprecated"><primary>bonobo_activation_info_stringify</primary></indexterm><programlisting><link linkend="Bonobo-ActivationID">Bonobo_ActivationID</link> bonobo_activation_info_stringify
99
 
                                            (const <link linkend="BonoboActivationInfo">BonoboActivationInfo</link> *actinfo);</programlisting>
 
93
<indexterm role="deprecated"><primary>bonobo_activation_info_stringify</primary></indexterm><programlisting><link linkend="Bonobo-ActivationID">Bonobo_ActivationID</link> bonobo_activation_info_stringify    (const <link linkend="BonoboActivationInfo">BonoboActivationInfo</link> *actinfo);</programlisting>
100
94
<warning><para><literal>bonobo_activation_info_stringify</literal> is deprecated and should not be used in newly-written code.</para></warning>
101
95
<para>
102
96
Serializes <parameter>actinfo</parameter> into a char *. Should be freed with <link linkend="g-free"><function>g_free()</function></link>.</para>
112
106
<refsect2>
113
107
<title><anchor id="bonobo-activation-servinfo-to-actinfo" role="function" condition="deprecated:"/>bonobo_activation_servinfo_to_actinfo ()</title>
114
108
<indexterm role="deprecated"><primary>bonobo_activation_servinfo_to_actinfo</primary></indexterm><programlisting><link linkend="BonoboActivationInfo">BonoboActivationInfo</link>* bonobo_activation_servinfo_to_actinfo
115
 
                                            (const <link linkend="Bonobo-ServerInfo">Bonobo_ServerInfo</link> *servinfo);</programlisting>
 
109
                                                        (const <link linkend="Bonobo-ServerInfo">Bonobo_ServerInfo</link> *servinfo);</programlisting>
116
110
<warning><para><literal>bonobo_activation_servinfo_to_actinfo</literal> is deprecated and should not be used in newly-written code.</para></warning>
117
111
<para>
118
112
This function converts a <link linkend="Bonobo-ServerInfo"><literal>Bonobo_ServerInfo</literal></link> structure to a
129
123
</variablelist></refsect2>
130
124
<refsect2>
131
125
<title><anchor id="bonobo-activation-id-parse" role="function" condition="deprecated:"/>bonobo_activation_id_parse ()</title>
132
 
<indexterm role="deprecated"><primary>bonobo_activation_id_parse</primary></indexterm><programlisting><link linkend="BonoboActivationInfo">BonoboActivationInfo</link>* bonobo_activation_id_parse
133
 
                                            (const <link linkend="CORBA-char">CORBA_char</link> *actid);</programlisting>
 
126
<indexterm role="deprecated"><primary>bonobo_activation_id_parse</primary></indexterm><programlisting><link linkend="BonoboActivationInfo">BonoboActivationInfo</link>* bonobo_activation_id_parse        (const <link linkend="CORBA-char">CORBA_char</link> *actid);</programlisting>
134
127
<warning><para><literal>bonobo_activation_id_parse</literal> is deprecated and should not be used in newly-written code.</para></warning>
135
128
<para>
136
129
Returns a pointer to a newly allocated <link linkend="BonoboActivationInfo"><literal>BonoboActivationInfo</literal></link>
147
140
</variablelist></refsect2>
148
141
<refsect2>
149
142
<title><anchor id="bonobo-activation-info-new" role="function" condition="deprecated:"/>bonobo_activation_info_new ()</title>
150
 
<indexterm role="deprecated"><primary>bonobo_activation_info_new</primary></indexterm><programlisting><link linkend="BonoboActivationInfo">BonoboActivationInfo</link>* bonobo_activation_info_new
151
 
                                            (void);</programlisting>
 
143
<indexterm role="deprecated"><primary>bonobo_activation_info_new</primary></indexterm><programlisting><link linkend="BonoboActivationInfo">BonoboActivationInfo</link>* bonobo_activation_info_new        (void);</programlisting>
152
144
<warning><para><literal>bonobo_activation_info_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
153
145
<para>
154
146
This function allocates a <link linkend="BonoboActicationInfo"><literal>BonoboActicationInfo</literal></link> structure and returns it.
161
153
</variablelist></refsect2>
162
154
<refsect2>
163
155
<title><anchor id="bonobo-activation-info-free" role="function" condition="deprecated:"/>bonobo_activation_info_free ()</title>
164
 
<indexterm role="deprecated"><primary>bonobo_activation_info_free</primary></indexterm><programlisting><link linkend="void">void</link>        bonobo_activation_info_free     (<link linkend="BonoboActivationInfo">BonoboActivationInfo</link> *actinfo);</programlisting>
 
156
<indexterm role="deprecated"><primary>bonobo_activation_info_free</primary></indexterm><programlisting><link linkend="void">void</link>                bonobo_activation_info_free         (<link linkend="BonoboActivationInfo">BonoboActivationInfo</link> *actinfo);</programlisting>
165
157
<warning><para><literal>bonobo_activation_info_free</literal> is deprecated and should not be used in newly-written code.</para></warning>
166
158
<para>
167
159
Frees <parameter>actinfo</parameter>.</para>
174
166
</variablelist></refsect2>
175
167
<refsect2>
176
168
<title><anchor id="bonobo-server-info-prop-lookup" role="function"/>bonobo_server_info_prop_lookup ()</title>
177
 
<indexterm><primary>bonobo_server_info_prop_lookup</primary></indexterm><programlisting>const <link linkend="char">char</link>* bonobo_server_info_prop_lookup  (<link linkend="Bonobo-ServerInfo">Bonobo_ServerInfo</link> *server,
178
 
                                             const <link linkend="char">char</link> *prop_name,
179
 
                                             <link linkend="GSList">GSList</link> *i18n_languages);</programlisting>
 
169
<indexterm><primary>bonobo_server_info_prop_lookup</primary></indexterm><programlisting>const <link linkend="char">char</link>*         bonobo_server_info_prop_lookup      (<link linkend="Bonobo-ServerInfo">Bonobo_ServerInfo</link> *server,
 
170
                                                         const <link linkend="char">char</link> *prop_name,
 
171
                                                         <link linkend="GSList">GSList</link> *i18n_languages);</programlisting>
180
172
<para>
181
173
</para>
182
174
<para>
203
195
</para></refsect2>
204
196
<refsect2>
205
197
<title><anchor id="bonobo-activation-get-default-component-for-mime-type" role="function" condition="since:2.16.0"/>bonobo_activation_get_default_component_for_mime_type ()</title>
206
 
<indexterm role="2.16.0"><primary>bonobo_activation_get_default_component_for_mime_type</primary></indexterm><programlisting><link linkend="Bonobo-ServerInfo">Bonobo_ServerInfo</link>* bonobo_activation_get_default_component_for_mime_type
207
 
                                            (const <link linkend="char">char</link> *mime_type);</programlisting>
 
198
<indexterm role="2.16.0"><primary>bonobo_activation_get_default_component_for_mime_type</primary></indexterm><programlisting><link linkend="Bonobo-ServerInfo">Bonobo_ServerInfo</link>*  bonobo_activation_get_default_component_for_mime_type
 
199
                                                        (const <link linkend="char">char</link> *mime_type);</programlisting>
208
200
<para>
209
201
Query the MIME database for the default Bonobo component to be activated to 
210
202
view files of MIME type <parameter>mime_type</parameter>.</para>
218
210
to get a reference to the proper component.
219
211
 
220
212
</simpara></listitem></varlistentry>
221
 
</variablelist><para>Since  2.16.0
 
213
</variablelist><para role="since">Since  2.16.0
222
214
</para></refsect2>
223
215
<refsect2>
224
216
<title><anchor id="bonobo-activation-get-all-components-for-mime-type" role="function" condition="since:2.16.0"/>bonobo_activation_get_all_components_for_mime_type ()</title>
225
 
<indexterm role="2.16.0"><primary>bonobo_activation_get_all_components_for_mime_type</primary></indexterm><programlisting><link linkend="GList">GList</link>*      bonobo_activation_get_all_components_for_mime_type
226
 
                                            (const <link linkend="char">char</link> *mime_type);</programlisting>
 
217
<indexterm role="2.16.0"><primary>bonobo_activation_get_all_components_for_mime_type</primary></indexterm><programlisting><link linkend="GList">GList</link>*              bonobo_activation_get_all_components_for_mime_type
 
218
                                                        (const <link linkend="char">char</link> *mime_type);</programlisting>
227
219
<para>
228
220
Return an alphabetically sorted list of <link linkend="Bonobo-ServerInfo"><type>Bonobo_ServerInfo</type></link>
229
221
data structures representing all Bonobo components registered
238
230
representing components that can handle <parameter>mime_type</parameter>.
239
231
 
240
232
</simpara></listitem></varlistentry>
241
 
</variablelist><para>Since  2.16.0
 
233
</variablelist><para role="since">Since  2.16.0
242
234
</para></refsect2>
243
235
 
244
236
</refsect1>