← Back to branch summary

~ubuntu-branches/debian/experimental/gupnp/experimental

« back to all changes in this revision

Viewing changes to doc/xml/xdgmime.xml

  • Committer: Bazaar Package Importer
  • Author(s): Ross Burton
  • Date: 2008-06-30 09:32:18 UTC
  • mfrom: (1.2.1 upstream) (2.1.5 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080630093218-vmb4elru8cn18579
Tags: 0.12.1-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/xml/xdgmime.xml
5
5
]>
6
6
<refentry id="gupnp-xdgmime">
7
7
<refmeta>
8
 
<refentrytitle role="top_of_page">xdgmime</refentrytitle>
 
8
<refentrytitle role="top_of_page" id="gupnp-xdgmime.top_of_page">xdgmime</refentrytitle>
9
9
<manvolnum>3</manvolnum>
10
10
<refmiscinfo>GUPNP Library</refmiscinfo>
11
11
</refmeta>
16
16
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
17
17
</refnamediv>
18
18
 
19
 
<refsynopsisdiv role="synopsis">
 
19
<refsynopsisdiv id="gupnp-xdgmime.synopsis" role="synopsis">
20
20
<title role="synopsis.title">Synopsis</title>
21
21
 
22
22
<synopsis>
23
 
 
24
 
 
25
 
 
26
 
#define             <link linkend="XDG-ENTRY:CAPS">XDG_ENTRY</link>                           (func)
27
 
#define             <link linkend="XDG-RESERVED-ENTRY:CAPS">XDG_RESERVED_ENTRY</link>                  (func)
28
 
<link linkend="void">void</link>                (<link linkend="XdgMimeCallback">*XdgMimeCallback</link>)                  (<link linkend="void">void</link> *user_data);
29
 
<link linkend="void">void</link>                (<link linkend="XdgMimeDestroy">*XdgMimeDestroy</link>)                   (<link linkend="void">void</link> *user_data);
30
 
const <link linkend="char">char</link>*         <link linkend="xdg-mime-get-mime-type-for-data">xdg_mime_get_mime_type_for_data</link>     (const <link linkend="void">void</link> *data,
31
 
                                                         <link linkend="size-t">size_t</link> len);
32
 
const <link linkend="char">char</link>*         <link linkend="xdg-mime-get-mime-type-for-file">xdg_mime_get_mime_type_for_file</link>     (const <link linkend="char">char</link> *file_name,
33
 
                                                         <link linkend="struct-stat">struct stat</link> *statbuf);
34
 
const <link linkend="char">char</link>*         <link linkend="xdg-mime-get-mime-type-from-file-name">xdg_mime_get_mime_type_from_file_name</link>
35
 
                                                        (const <link linkend="char">char</link> *file_name);
36
 
<link linkend="int">int</link>                 <link linkend="xdg-mime-is-valid-mime-type">xdg_mime_is_valid_mime_type</link>         (const <link linkend="char">char</link> *mime_type);
37
 
<link linkend="int">int</link>                 <link linkend="xdg-mime-mime-type-equal">xdg_mime_mime_type_equal</link>            (const <link linkend="char">char</link> *mime_a,
38
 
                                                         const <link linkend="char">char</link> *mime_b);
39
 
<link linkend="int">int</link>                 <link linkend="xdg-mime-media-type-equal">xdg_mime_media_type_equal</link>           (const <link linkend="char">char</link> *mime_a,
40
 
                                                         const <link linkend="char">char</link> *mime_b);
41
 
<link linkend="int">int</link>                 <link linkend="xdg-mime-mime-type-subclass">xdg_mime_mime_type_subclass</link>         (const <link linkend="char">char</link> *mime_a,
42
 
                                                         const <link linkend="char">char</link> *mime_b);
43
 
const <link linkend="char">char</link>**        <link linkend="xdg-mime-get-mime-parents">xdg_mime_get_mime_parents</link>           (const <link linkend="char">char</link> *mime);
44
 
<link linkend="char">char</link>**              <link linkend="xdg-mime-list-mime-parents">xdg_mime_list_mime_parents</link>          (const <link linkend="char">char</link> *mime);
45
 
const <link linkend="char">char</link>*         <link linkend="xdg-mime-unalias-mime-type">xdg_mime_unalias_mime_type</link>          (const <link linkend="char">char</link> *mime);
46
 
<link linkend="int">int</link>                 <link linkend="xdg-mime-get-max-buffer-extents">xdg_mime_get_max_buffer_extents</link>     (void);
47
 
<link linkend="void">void</link>                <link linkend="xdg-mime-shutdown">xdg_mime_shutdown</link>                   (void);
48
 
<link linkend="void">void</link>                <link linkend="xdg-mime-dump">xdg_mime_dump</link>                       (void);
49
 
<link linkend="int">int</link>                 <link linkend="xdg-mime-register-reload-callback">xdg_mime_register_reload_callback</link>   (<link linkend="XdgMimeCallback">XdgMimeCallback</link> callback,
50
 
                                                         <link linkend="void">void</link> *data,
51
 
                                                         <link linkend="XdgMimeDestroy">XdgMimeDestroy</link> destroy);
52
 
<link linkend="void">void</link>                <link linkend="xdg-mime-remove-callback">xdg_mime_remove_callback</link>            (<link linkend="int">int</link> callback_id);
53
 
#define             <link linkend="xdg-mime-type-unknown">xdg_mime_type_unknown</link>
54
 
#define             <link linkend="XDG-MIME-TYPE-UNKNOWN:CAPS">XDG_MIME_TYPE_UNKNOWN</link>
55
23
</synopsis>
56
24
</refsynopsisdiv>
57
25
 
63
31
 
64
32
 
65
33
 
66
 
<refsect1 role="desc">
 
34
<refsect1 id="gupnp-xdgmime.description" role="desc">
67
35
<title role="desc.title">Description</title>
68
36
<para>
69
37
 
70
38
</para>
71
39
</refsect1>
72
40
 
73
 
<refsect1 role="details">
 
41
<refsect1 id="gupnp-xdgmime.details" role="details">
74
42
<title role="details.title">Details</title>
75
 
<refsect2>
76
 
<title><anchor id="XDG-ENTRY:CAPS" role="macro"/>XDG_ENTRY()</title>
77
 
<indexterm><primary>XDG_ENTRY</primary></indexterm><programlisting>#define XDG_ENTRY(func) _XDG_ENTRY2(XDG_PREFIX,func)
78
 
</programlisting>
79
 
<para>
80
 
 
81
 
</para><variablelist role="params">
82
 
<varlistentry><term><parameter>func</parameter>&nbsp;:</term>
83
 
<listitem><simpara>
84
 
 
85
 
 
86
 
</simpara></listitem></varlistentry>
87
 
</variablelist></refsect2>
88
 
<refsect2>
89
 
<title><anchor id="XDG-RESERVED-ENTRY:CAPS" role="macro"/>XDG_RESERVED_ENTRY()</title>
90
 
<indexterm><primary>XDG_RESERVED_ENTRY</primary></indexterm><programlisting>#define XDG_RESERVED_ENTRY(func) _XDG_RESERVED_ENTRY2(XDG_PREFIX,func)
91
 
</programlisting>
92
 
<para>
93
 
 
94
 
</para><variablelist role="params">
95
 
<varlistentry><term><parameter>func</parameter>&nbsp;:</term>
96
 
<listitem><simpara>
97
 
 
98
 
 
99
 
</simpara></listitem></varlistentry>
100
 
</variablelist></refsect2>
101
 
<refsect2>
102
 
<title><anchor id="XdgMimeCallback" role="function"/>XdgMimeCallback ()</title>
103
 
<indexterm><primary>XdgMimeCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*XdgMimeCallback)                  (<link linkend="void">void</link> *user_data);</programlisting>
104
 
<para>
105
 
 
106
 
</para><variablelist role="params">
107
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
108
 
<listitem><simpara>
109
 
 
110
 
 
111
 
</simpara></listitem></varlistentry>
112
 
</variablelist></refsect2>
113
 
<refsect2>
114
 
<title><anchor id="XdgMimeDestroy" role="function"/>XdgMimeDestroy ()</title>
115
 
<indexterm><primary>XdgMimeDestroy</primary></indexterm><programlisting><link linkend="void">void</link>                (*XdgMimeDestroy)                   (<link linkend="void">void</link> *user_data);</programlisting>
116
 
<para>
117
 
 
118
 
</para><variablelist role="params">
119
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
120
 
<listitem><simpara>
121
 
 
122
 
 
123
 
</simpara></listitem></varlistentry>
124
 
</variablelist></refsect2>
125
 
<refsect2>
126
 
<title><anchor id="xdg-mime-get-mime-type-for-data" role="function"/>xdg_mime_get_mime_type_for_data ()</title>
127
 
<indexterm><primary>xdg_mime_get_mime_type_for_data</primary></indexterm><programlisting>const <link linkend="char">char</link>*         xdg_mime_get_mime_type_for_data     (const <link linkend="void">void</link> *data,
128
 
                                                         <link linkend="size-t">size_t</link> len);</programlisting>
129
 
<para>
130
 
 
131
 
</para><variablelist role="params">
132
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
133
 
<listitem><simpara>
134
 
</simpara></listitem></varlistentry>
135
 
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
136
 
<listitem><simpara>
137
 
</simpara></listitem></varlistentry>
138
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
139
 
 
140
 
 
141
 
</simpara></listitem></varlistentry>
142
 
</variablelist></refsect2>
143
 
<refsect2>
144
 
<title><anchor id="xdg-mime-get-mime-type-for-file" role="function"/>xdg_mime_get_mime_type_for_file ()</title>
145
 
<indexterm><primary>xdg_mime_get_mime_type_for_file</primary></indexterm><programlisting>const <link linkend="char">char</link>*         xdg_mime_get_mime_type_for_file     (const <link linkend="char">char</link> *file_name,
146
 
                                                         <link linkend="struct-stat">struct stat</link> *statbuf);</programlisting>
147
 
<para>
148
 
 
149
 
</para><variablelist role="params">
150
 
<varlistentry><term><parameter>file_name</parameter>&nbsp;:</term>
151
 
<listitem><simpara>
152
 
</simpara></listitem></varlistentry>
153
 
<varlistentry><term><parameter>statbuf</parameter>&nbsp;:</term>
154
 
<listitem><simpara>
155
 
</simpara></listitem></varlistentry>
156
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
157
 
 
158
 
 
159
 
</simpara></listitem></varlistentry>
160
 
</variablelist></refsect2>
161
 
<refsect2>
162
 
<title><anchor id="xdg-mime-get-mime-type-from-file-name" role="function"/>xdg_mime_get_mime_type_from_file_name ()</title>
163
 
<indexterm><primary>xdg_mime_get_mime_type_from_file_name</primary></indexterm><programlisting>const <link linkend="char">char</link>*         xdg_mime_get_mime_type_from_file_name
164
 
                                                        (const <link linkend="char">char</link> *file_name);</programlisting>
165
 
<para>
166
 
 
167
 
</para><variablelist role="params">
168
 
<varlistentry><term><parameter>file_name</parameter>&nbsp;:</term>
169
 
<listitem><simpara>
170
 
</simpara></listitem></varlistentry>
171
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
172
 
 
173
 
 
174
 
</simpara></listitem></varlistentry>
175
 
</variablelist></refsect2>
176
 
<refsect2>
177
 
<title><anchor id="xdg-mime-is-valid-mime-type" role="function"/>xdg_mime_is_valid_mime_type ()</title>
178
 
<indexterm><primary>xdg_mime_is_valid_mime_type</primary></indexterm><programlisting><link linkend="int">int</link>                 xdg_mime_is_valid_mime_type         (const <link linkend="char">char</link> *mime_type);</programlisting>
179
 
<para>
180
 
 
181
 
</para><variablelist role="params">
182
 
<varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
183
 
<listitem><simpara>
184
 
</simpara></listitem></varlistentry>
185
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
186
 
 
187
 
 
188
 
</simpara></listitem></varlistentry>
189
 
</variablelist></refsect2>
190
 
<refsect2>
191
 
<title><anchor id="xdg-mime-mime-type-equal" role="function"/>xdg_mime_mime_type_equal ()</title>
192
 
<indexterm><primary>xdg_mime_mime_type_equal</primary></indexterm><programlisting><link linkend="int">int</link>                 xdg_mime_mime_type_equal            (const <link linkend="char">char</link> *mime_a,
193
 
                                                         const <link linkend="char">char</link> *mime_b);</programlisting>
194
 
<para>
195
 
 
196
 
</para><variablelist role="params">
197
 
<varlistentry><term><parameter>mime_a</parameter>&nbsp;:</term>
198
 
<listitem><simpara>
199
 
</simpara></listitem></varlistentry>
200
 
<varlistentry><term><parameter>mime_b</parameter>&nbsp;:</term>
201
 
<listitem><simpara>
202
 
</simpara></listitem></varlistentry>
203
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
204
 
 
205
 
 
206
 
</simpara></listitem></varlistentry>
207
 
</variablelist></refsect2>
208
 
<refsect2>
209
 
<title><anchor id="xdg-mime-media-type-equal" role="function"/>xdg_mime_media_type_equal ()</title>
210
 
<indexterm><primary>xdg_mime_media_type_equal</primary></indexterm><programlisting><link linkend="int">int</link>                 xdg_mime_media_type_equal           (const <link linkend="char">char</link> *mime_a,
211
 
                                                         const <link linkend="char">char</link> *mime_b);</programlisting>
212
 
<para>
213
 
 
214
 
</para><variablelist role="params">
215
 
<varlistentry><term><parameter>mime_a</parameter>&nbsp;:</term>
216
 
<listitem><simpara>
217
 
</simpara></listitem></varlistentry>
218
 
<varlistentry><term><parameter>mime_b</parameter>&nbsp;:</term>
219
 
<listitem><simpara>
220
 
</simpara></listitem></varlistentry>
221
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
222
 
 
223
 
 
224
 
</simpara></listitem></varlistentry>
225
 
</variablelist></refsect2>
226
 
<refsect2>
227
 
<title><anchor id="xdg-mime-mime-type-subclass" role="function"/>xdg_mime_mime_type_subclass ()</title>
228
 
<indexterm><primary>xdg_mime_mime_type_subclass</primary></indexterm><programlisting><link linkend="int">int</link>                 xdg_mime_mime_type_subclass         (const <link linkend="char">char</link> *mime_a,
229
 
                                                         const <link linkend="char">char</link> *mime_b);</programlisting>
230
 
<para>
231
 
 
232
 
</para><variablelist role="params">
233
 
<varlistentry><term><parameter>mime_a</parameter>&nbsp;:</term>
234
 
<listitem><simpara>
235
 
</simpara></listitem></varlistentry>
236
 
<varlistentry><term><parameter>mime_b</parameter>&nbsp;:</term>
237
 
<listitem><simpara>
238
 
</simpara></listitem></varlistentry>
239
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
240
 
 
241
 
 
242
 
</simpara></listitem></varlistentry>
243
 
</variablelist></refsect2>
244
 
<refsect2>
245
 
<title><anchor id="xdg-mime-get-mime-parents" role="function"/>xdg_mime_get_mime_parents ()</title>
246
 
<indexterm><primary>xdg_mime_get_mime_parents</primary></indexterm><programlisting>const <link linkend="char">char</link>**        xdg_mime_get_mime_parents           (const <link linkend="char">char</link> *mime);</programlisting>
247
 
<para>
248
 
 
249
 
</para><variablelist role="params">
250
 
<varlistentry><term><parameter>mime</parameter>&nbsp;:</term>
251
 
<listitem><simpara>
252
 
</simpara></listitem></varlistentry>
253
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
254
 
 
255
 
 
256
 
</simpara></listitem></varlistentry>
257
 
</variablelist></refsect2>
258
 
<refsect2>
259
 
<title><anchor id="xdg-mime-list-mime-parents" role="function"/>xdg_mime_list_mime_parents ()</title>
260
 
<indexterm><primary>xdg_mime_list_mime_parents</primary></indexterm><programlisting><link linkend="char">char</link>**              xdg_mime_list_mime_parents          (const <link linkend="char">char</link> *mime);</programlisting>
261
 
<para>
262
 
 
263
 
</para><variablelist role="params">
264
 
<varlistentry><term><parameter>mime</parameter>&nbsp;:</term>
265
 
<listitem><simpara>
266
 
</simpara></listitem></varlistentry>
267
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
268
 
 
269
 
 
270
 
</simpara></listitem></varlistentry>
271
 
</variablelist></refsect2>
272
 
<refsect2>
273
 
<title><anchor id="xdg-mime-unalias-mime-type" role="function"/>xdg_mime_unalias_mime_type ()</title>
274
 
<indexterm><primary>xdg_mime_unalias_mime_type</primary></indexterm><programlisting>const <link linkend="char">char</link>*         xdg_mime_unalias_mime_type          (const <link linkend="char">char</link> *mime);</programlisting>
275
 
<para>
276
 
 
277
 
</para><variablelist role="params">
278
 
<varlistentry><term><parameter>mime</parameter>&nbsp;:</term>
279
 
<listitem><simpara>
280
 
</simpara></listitem></varlistentry>
281
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
282
 
 
283
 
 
284
 
</simpara></listitem></varlistentry>
285
 
</variablelist></refsect2>
286
 
<refsect2>
287
 
<title><anchor id="xdg-mime-get-max-buffer-extents" role="function"/>xdg_mime_get_max_buffer_extents ()</title>
288
 
<indexterm><primary>xdg_mime_get_max_buffer_extents</primary></indexterm><programlisting><link linkend="int">int</link>                 xdg_mime_get_max_buffer_extents     (void);</programlisting>
289
 
<para>
290
 
 
291
 
</para><variablelist role="params">
292
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
293
 
 
294
 
 
295
 
</simpara></listitem></varlistentry>
296
 
</variablelist></refsect2>
297
 
<refsect2>
298
 
<title><anchor id="xdg-mime-shutdown" role="function"/>xdg_mime_shutdown ()</title>
299
 
<indexterm><primary>xdg_mime_shutdown</primary></indexterm><programlisting><link linkend="void">void</link>                xdg_mime_shutdown                   (void);</programlisting>
300
 
<para>
301
 
 
302
 
</para></refsect2>
303
 
<refsect2>
304
 
<title><anchor id="xdg-mime-dump" role="function"/>xdg_mime_dump ()</title>
305
 
<indexterm><primary>xdg_mime_dump</primary></indexterm><programlisting><link linkend="void">void</link>                xdg_mime_dump                       (void);</programlisting>
306
 
<para>
307
 
 
308
 
</para></refsect2>
309
 
<refsect2>
310
 
<title><anchor id="xdg-mime-register-reload-callback" role="function"/>xdg_mime_register_reload_callback ()</title>
311
 
<indexterm><primary>xdg_mime_register_reload_callback</primary></indexterm><programlisting><link linkend="int">int</link>                 xdg_mime_register_reload_callback   (<link linkend="XdgMimeCallback">XdgMimeCallback</link> callback,
312
 
                                                         <link linkend="void">void</link> *data,
313
 
                                                         <link linkend="XdgMimeDestroy">XdgMimeDestroy</link> destroy);</programlisting>
314
 
<para>
315
 
 
316
 
</para><variablelist role="params">
317
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
318
 
<listitem><simpara>
319
 
</simpara></listitem></varlistentry>
320
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
321
 
<listitem><simpara>
322
 
</simpara></listitem></varlistentry>
323
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
324
 
<listitem><simpara>
325
 
</simpara></listitem></varlistentry>
326
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
327
 
 
328
 
 
329
 
</simpara></listitem></varlistentry>
330
 
</variablelist></refsect2>
331
 
<refsect2>
332
 
<title><anchor id="xdg-mime-remove-callback" role="function"/>xdg_mime_remove_callback ()</title>
333
 
<indexterm><primary>xdg_mime_remove_callback</primary></indexterm><programlisting><link linkend="void">void</link>                xdg_mime_remove_callback            (<link linkend="int">int</link> callback_id);</programlisting>
334
 
<para>
335
 
 
336
 
</para><variablelist role="params">
337
 
<varlistentry><term><parameter>callback_id</parameter>&nbsp;:</term>
338
 
<listitem><simpara>
339
 
 
340
 
 
341
 
</simpara></listitem></varlistentry>
342
 
</variablelist></refsect2>
343
 
<refsect2>
344
 
<title><anchor id="xdg-mime-type-unknown" role="macro"/>xdg_mime_type_unknown</title>
345
 
<indexterm><primary>xdg_mime_type_unknown</primary></indexterm><programlisting>#define xdg_mime_type_unknown                 XDG_ENTRY(mime_type_unknown)
346
 
</programlisting>
347
 
<para>
348
 
 
349
 
</para></refsect2>
350
 
<refsect2>
351
 
<title><anchor id="XDG-MIME-TYPE-UNKNOWN:CAPS" role="macro"/>XDG_MIME_TYPE_UNKNOWN</title>
352
 
<indexterm><primary>XDG_MIME_TYPE_UNKNOWN</primary></indexterm><programlisting>#define XDG_MIME_TYPE_UNKNOWN xdg_mime_type_unknown
353
 
</programlisting>
354
 
<para>
355
 
 
356
 
</para></refsect2>
357
43
 
358
44
</refsect1>
359
45