← Back to branch summary

~ubuntu-branches/ubuntu/natty/gnome-vfs/natty

« back to all changes in this revision

Viewing changes to doc/xml/gnome-vfs-mime-utils.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-03-17 16:12:58 UTC
  • mfrom: (0.2.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20090317161258-px3a2czt9g2ktjz3
Tags: 1:2.24.1-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/xml/gnome-vfs-mime-utils.xml
1
 
<refentry id="gnome-vfs-20-gnome-vfs-mime-utils">
 
1
<refentry id="gnome-vfs-2.0-gnome-vfs-mime-utils">
2
2
<refmeta>
3
 
<refentrytitle role="top_of_page" id="gnome-vfs-20-gnome-vfs-mime-utils.top_of_page">gnome-vfs-mime-utils</refentrytitle>
 
3
<refentrytitle role="top_of_page" id="gnome-vfs-2.0-gnome-vfs-mime-utils.top_of_page">gnome-vfs-mime-utils</refentrytitle>
4
4
<manvolnum>3</manvolnum>
5
5
<refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
6
6
</refmeta>
10
10
<refpurpose></refpurpose>
11
11
</refnamediv>
12
12
 
13
 
<refsynopsisdiv id="gnome-vfs-20-gnome-vfs-mime-utils.synopsis" role="synopsis">
 
13
<refsynopsisdiv id="gnome-vfs-2.0-gnome-vfs-mime-utils.synopsis" role="synopsis">
14
14
<title role="synopsis.title">Synopsis</title>
15
15
 
16
16
<synopsis>
17
 
#define             <link linkend="GNOME-VFS-MIME-TYPE-UNKNOWN--CAPS">GNOME_VFS_MIME_TYPE_UNKNOWN</link>
 
17
#define             <link linkend="GNOME-VFS-MIME-TYPE-UNKNOWN:CAPS">GNOME_VFS_MIME_TYPE_UNKNOWN</link>
18
18
enum                <link linkend="GnomeVFSMimeEquivalence">GnomeVFSMimeEquivalence</link>;
19
19
<link linkend="GnomeVFSMimeEquivalence">GnomeVFSMimeEquivalence</link>  <link linkend="gnome-vfs-mime-type-get-equivalence">gnome_vfs_mime_type_get_equivalence</link>
20
20
                                                        (const <link linkend="char">char</link> *mime_type,
41
41
 
42
42
 
43
43
 
44
 
<refsect1 id="gnome-vfs-20-gnome-vfs-mime-utils.description" role="desc">
 
44
<refsect1 id="gnome-vfs-2.0-gnome-vfs-mime-utils.description" role="desc">
45
45
<title role="desc.title">Description</title>
 
46
 
46
47
<para>
47
48
</para>
48
49
</refsect1>
49
50
 
50
 
<refsect1 id="gnome-vfs-20-gnome-vfs-mime-utils.details" role="details">
 
51
<refsect1 id="gnome-vfs-2.0-gnome-vfs-mime-utils.details" role="details">
51
52
<title role="details.title">Details</title>
52
 
<refsect2 id="GNOME-VFS-MIME-TYPE-UNKNOWN--CAPS" role="macro">
 
53
<refsect2 id="GNOME-VFS-MIME-TYPE-UNKNOWN:CAPS" role="macro">
53
54
<title>GNOME_VFS_MIME_TYPE_UNKNOWN</title>
54
 
<indexterm zone="GNOME-VFS-MIME-TYPE-UNKNOWN--CAPS"><primary sortas="GNOME_VFS_MIME_TYPE_UNKNOWN">GNOME_VFS_MIME_TYPE_UNKNOWN</primary></indexterm><programlisting>#define GNOME_VFS_MIME_TYPE_UNKNOWN "application/octet-stream"
 
55
<indexterm zone="GNOME-VFS-MIME-TYPE-UNKNOWN:CAPS"><primary>GNOME_VFS_MIME_TYPE_UNKNOWN</primary></indexterm>
 
56
<programlisting>#define GNOME_VFS_MIME_TYPE_UNKNOWN "application/octet-stream"
55
57
</programlisting>
56
58
<para>
57
59
The value returned for the MIME type when a file did
61
63
</para></refsect2>
62
64
<refsect2 id="GnomeVFSMimeEquivalence" role="enum">
63
65
<title>enum GnomeVFSMimeEquivalence</title>
64
 
<indexterm zone="GnomeVFSMimeEquivalence"><primary sortas="GnomeVFSMimeEquivalence">GnomeVFSMimeEquivalence</primary></indexterm><programlisting>typedef enum {
 
66
<indexterm zone="GnomeVFSMimeEquivalence"><primary>GnomeVFSMimeEquivalence</primary></indexterm>
 
67
<programlisting>typedef enum {
65
68
  GNOME_VFS_MIME_UNRELATED,
66
69
  GNOME_VFS_MIME_IDENTICAL,
67
70
  GNOME_VFS_MIME_PARENT
72
75
<link linkend="gnome-vfs-mime-type-get-equivalence"><function>gnome_vfs_mime_type_get_equivalence()</function></link>.</para>
73
76
<para>
74
77
</para><variablelist role="enum">
75
 
<varlistentry id="GNOME-VFS-MIME-UNRELATED--CAPS" role="constant">
 
78
<varlistentry id="GNOME-VFS-MIME-UNRELATED:CAPS" role="constant">
76
79
<term><literal>GNOME_VFS_MIME_UNRELATED</literal></term>
77
80
<listitem><simpara> The two MIME types are not related.
78
81
</simpara></listitem>
79
82
</varlistentry>
80
 
<varlistentry id="GNOME-VFS-MIME-IDENTICAL--CAPS" role="constant">
 
83
<varlistentry id="GNOME-VFS-MIME-IDENTICAL:CAPS" role="constant">
81
84
<term><literal>GNOME_VFS_MIME_IDENTICAL</literal></term>
82
85
<listitem><simpara> The two MIME types are identical.
83
86
</simpara></listitem>
84
87
</varlistentry>
85
 
<varlistentry id="GNOME-VFS-MIME-PARENT--CAPS" role="constant">
 
88
<varlistentry id="GNOME-VFS-MIME-PARENT:CAPS" role="constant">
86
89
<term><literal>GNOME_VFS_MIME_PARENT</literal></term>
87
90
<listitem><simpara> One of the two MIME types is a parent of the other one.
88
91
                           Note that this relationship is transient, i.e. if
93
96
</variablelist></refsect2>
94
97
<refsect2 id="gnome-vfs-mime-type-get-equivalence" role="function">
95
98
<title>gnome_vfs_mime_type_get_equivalence ()</title>
96
 
<indexterm zone="gnome-vfs-mime-type-get-equivalence"><primary sortas="gnome_vfs_mime_type_get_equivalence">gnome_vfs_mime_type_get_equivalence</primary></indexterm><programlisting><link linkend="GnomeVFSMimeEquivalence">GnomeVFSMimeEquivalence</link>  gnome_vfs_mime_type_get_equivalence
 
99
<indexterm zone="gnome-vfs-mime-type-get-equivalence"><primary>gnome_vfs_mime_type_get_equivalence</primary></indexterm>
 
100
<programlisting><link linkend="GnomeVFSMimeEquivalence">GnomeVFSMimeEquivalence</link>  gnome_vfs_mime_type_get_equivalence
97
101
                                                        (const <link linkend="char">char</link> *mime_type,
98
102
                                                         const <link linkend="char">char</link> *base_mime_type);</programlisting>
99
103
<para>
104
108
<itemizedlist>
105
109
<listitem><para>
106
110
 If they are identical and <parameter>mime_type</parameter> is the same as <parameter>base_mime_type</parameter>,
107
 
 then <link linkend="GNOME-VFS-MIME-IDENTICAL--CAPS"><literal>GNOME_VFS_MIME_IDENTICAL</literal></link> is returned. This would be the case if
 
111
 then <link linkend="GNOME-VFS-MIME-IDENTICAL:CAPS"><literal>GNOME_VFS_MIME_IDENTICAL</literal></link> is returned. This would be the case if
108
112
 "audio/midi" and "audio/x-midi" are passed in.
109
113
</para></listitem>
110
114
<listitem><para>
111
115
If <parameter>base_mime_type</parameter> is a parent type of <parameter>mime_type</parameter>, then
112
 
<link linkend="GNOME-VFS-MIME-PARENT--CAPS"><literal>GNOME_VFS_MIME_PARENT</literal></link> is returned.  As an example, "text/plain" is a parent
 
116
<link linkend="GNOME-VFS-MIME-PARENT:CAPS"><literal>GNOME_VFS_MIME_PARENT</literal></link> is returned.  As an example, "text/plain" is a parent
113
117
of "text/rss", "image" is a parent of "image/png", and
114
118
"application/octet-stream" is a parent of almost all types.
115
119
</para></listitem>
116
120
<listitem><para>
117
 
Finally, if the two mime types are unrelated, then <link linkend="GNOME-VFS-MIME-UNRELATED--CAPS"><literal>GNOME_VFS_MIME_UNRELATED</literal></link>
 
121
Finally, if the two mime types are unrelated, then <link linkend="GNOME-VFS-MIME-UNRELATED:CAPS"><literal>GNOME_VFS_MIME_UNRELATED</literal></link>
118
122
is returned.
119
123
</para></listitem>
120
124
</itemizedlist></para>
131
135
</variablelist></refsect2>
132
136
<refsect2 id="gnome-vfs-mime-type-is-equal" role="function">
133
137
<title>gnome_vfs_mime_type_is_equal ()</title>
134
 
<indexterm zone="gnome-vfs-mime-type-is-equal"><primary sortas="gnome_vfs_mime_type_is_equal">gnome_vfs_mime_type_is_equal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gnome_vfs_mime_type_is_equal        (const <link linkend="char">char</link> *a,
 
138
<indexterm zone="gnome-vfs-mime-type-is-equal"><primary>gnome_vfs_mime_type_is_equal</primary></indexterm>
 
139
<programlisting><link linkend="gboolean">gboolean</link>            gnome_vfs_mime_type_is_equal        (const <link linkend="char">char</link> *a,
135
140
                                                         const <link linkend="char">char</link> *b);</programlisting>
136
141
<para>
137
142
Compares two mime types to determine if they are equivalent.  They are
144
149
<varlistentry><term><parameter>b</parameter>&#160;:</term>
145
150
<listitem><simpara> a const char * containing a mime type, e.g. "image/png".
146
151
</simpara></listitem></varlistentry>
147
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>, if a and b are equivalent mime types.
 
152
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, if a and b are equivalent mime types.
148
153
</simpara></listitem></varlistentry>
149
154
</variablelist></refsect2>
150
155
<refsect2 id="gnome-vfs-get-mime-type-for-name" role="function" condition="since:2.14">
151
156
<title>gnome_vfs_get_mime_type_for_name ()</title>
152
 
<indexterm zone="gnome-vfs-get-mime-type-for-name" role="2.14"><primary sortas="gnome_vfs_get_mime_type_for_name">gnome_vfs_get_mime_type_for_name</primary></indexterm><programlisting>const <link linkend="char">char</link> *        gnome_vfs_get_mime_type_for_name    (const <link linkend="char">char</link> *filename);</programlisting>
 
157
<indexterm zone="gnome-vfs-get-mime-type-for-name" role="2.14"><primary>gnome_vfs_get_mime_type_for_name</primary></indexterm>
 
158
<programlisting>const <link linkend="char">char</link> *        gnome_vfs_get_mime_type_for_name    (const <link linkend="char">char</link> *filename);</programlisting>
153
159
<para>
154
160
Determine the mime type for <parameter>filename</parameter>. The file <parameter>filename</parameter> may
155
161
not exist, this function does not access the actual file.
156
 
If the mime-type cannot be determined, <link linkend="GNOME-VFS-MIME-TYPE-UNKNOWN--CAPS"><literal>GNOME_VFS_MIME_TYPE_UNKNOWN</literal></link>
 
162
If the mime-type cannot be determined, <link linkend="GNOME-VFS-MIME-TYPE-UNKNOWN:CAPS"><literal>GNOME_VFS_MIME_TYPE_UNKNOWN</literal></link>
157
163
is returned.</para>
158
164
<para>
159
165
</para><variablelist role="params">
161
167
<listitem><simpara> a filename.
162
168
</simpara></listitem></varlistentry>
163
169
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the mime-type for this filename or
164
 
<link linkend="GNOME-VFS-MIME-TYPE-UNKNOWN--CAPS"><literal>GNOME_VFS_MIME_TYPE_UNKNOWN</literal></link> if mime-type could not be determined.
 
170
<link linkend="GNOME-VFS-MIME-TYPE-UNKNOWN:CAPS"><literal>GNOME_VFS_MIME_TYPE_UNKNOWN</literal></link> if mime-type could not be determined.
165
171
 
166
172
</simpara></listitem></varlistentry>
167
173
</variablelist><para role="since">Since 2.14</para></refsect2>
168
174
<refsect2 id="gnome-vfs-get-mime-type-for-data" role="function">
169
175
<title>gnome_vfs_get_mime_type_for_data ()</title>
170
 
<indexterm zone="gnome-vfs-get-mime-type-for-data"><primary sortas="gnome_vfs_get_mime_type_for_data">gnome_vfs_get_mime_type_for_data</primary></indexterm><programlisting>const <link linkend="char">char</link> *        gnome_vfs_get_mime_type_for_data    (<link linkend="gconstpointer">gconstpointer</link> data,
 
176
<indexterm zone="gnome-vfs-get-mime-type-for-data"><primary>gnome_vfs_get_mime_type_for_data</primary></indexterm>
 
177
<programlisting>const <link linkend="char">char</link> *        gnome_vfs_get_mime_type_for_data    (<link linkend="gconstpointer">gconstpointer</link> data,
171
178
                                                         <link linkend="int">int</link> data_size);</programlisting>
172
179
<para>
173
180
Tries to guess the mime type of the data in <parameter>data</parameter>
185
192
</variablelist></refsect2>
186
193
<refsect2 id="gnome-vfs-get-mime-type-for-name-and-data" role="function" condition="since:2.14">
187
194
<title>gnome_vfs_get_mime_type_for_name_and_data ()</title>
188
 
<indexterm zone="gnome-vfs-get-mime-type-for-name-and-data" role="2.14"><primary sortas="gnome_vfs_get_mime_type_for_name_and_data">gnome_vfs_get_mime_type_for_name_and_data</primary></indexterm><programlisting>const <link linkend="char">char</link> *        gnome_vfs_get_mime_type_for_name_and_data
 
195
<indexterm zone="gnome-vfs-get-mime-type-for-name-and-data" role="2.14"><primary>gnome_vfs_get_mime_type_for_name_and_data</primary></indexterm>
 
196
<programlisting>const <link linkend="char">char</link> *        gnome_vfs_get_mime_type_for_name_and_data
189
197
                                                        (const <link linkend="char">char</link> *filename,
190
198
                                                         <link linkend="gconstpointer">gconstpointer</link> data,
191
199
                                                         <link linkend="gssize">gssize</link> data_size);</programlisting>
194
202
to be smart (e.g. mime subclassing) about returning the right mime-type 
195
203
by looking at both the <parameter>data</parameter> and the <parameter>filename</parameter>. The file will not be 
196
204
accessed.
197
 
If the mime-type cannot be determined, <link linkend="GNOME-VFS-MIME-TYPE-UNKNOWN--CAPS"><literal>GNOME_VFS_MIME_TYPE_UNKNOWN</literal></link>
 
205
If the mime-type cannot be determined, <link linkend="GNOME-VFS-MIME-TYPE-UNKNOWN:CAPS"><literal>GNOME_VFS_MIME_TYPE_UNKNOWN</literal></link>
198
206
is returned.</para>
199
207
<para>
200
208
</para><variablelist role="params">
208
216
<listitem><simpara> the size of <parameter>data</parameter>
209
217
</simpara></listitem></varlistentry>
210
218
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the mime-type for this filename or
211
 
<link linkend="GNOME-VFS-MIME-TYPE-UNKNOWN--CAPS"><literal>GNOME_VFS_MIME_TYPE_UNKNOWN</literal></link> if mime-type could not be determined.
 
219
<link linkend="GNOME-VFS-MIME-TYPE-UNKNOWN:CAPS"><literal>GNOME_VFS_MIME_TYPE_UNKNOWN</literal></link> if mime-type could not be determined.
212
220
 
213
221
</simpara></listitem></varlistentry>
214
222
</variablelist><para role="since">Since 2.14</para></refsect2>
215
223
<refsect2 id="gnome-vfs-get-mime-type" role="function">
216
224
<title>gnome_vfs_get_mime_type ()</title>
217
 
<indexterm zone="gnome-vfs-get-mime-type"><primary sortas="gnome_vfs_get_mime_type">gnome_vfs_get_mime_type</primary></indexterm><programlisting><link linkend="char">char</link> *              gnome_vfs_get_mime_type             (const <link linkend="char">char</link> *text_uri);</programlisting>
 
225
<indexterm zone="gnome-vfs-get-mime-type"><primary>gnome_vfs_get_mime_type</primary></indexterm>
 
226
<programlisting><link linkend="char">char</link> *              gnome_vfs_get_mime_type             (const <link linkend="char">char</link> *text_uri);</programlisting>
218
227
<para>
219
228
Determine the mime type of <parameter>text_uri</parameter>. The mime type is determined
220
229
in the same way as by <link linkend="gnome-vfs-get-file-info"><function>gnome_vfs_get_file_info()</function></link>. This is meant as
224
233
<varlistentry><term><parameter>text_uri</parameter>&#160;:</term>
225
234
<listitem><simpara> path of the file for which to get the mime type.
226
235
</simpara></listitem></varlistentry>
227
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The mime type, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if there is an error reading
 
236
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The mime type, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if there is an error reading
228
237
the file.
229
238
</simpara></listitem></varlistentry>
230
239
</variablelist></refsect2>
231
240
<refsect2 id="gnome-vfs-get-slow-mime-type" role="function" condition="since:2.14">
232
241
<title>gnome_vfs_get_slow_mime_type ()</title>
233
 
<indexterm zone="gnome-vfs-get-slow-mime-type" role="2.14"><primary sortas="gnome_vfs_get_slow_mime_type">gnome_vfs_get_slow_mime_type</primary></indexterm><programlisting><link linkend="char">char</link> *              gnome_vfs_get_slow_mime_type        (const <link linkend="char">char</link> *text_uri);</programlisting>
 
242
<indexterm zone="gnome-vfs-get-slow-mime-type" role="2.14"><primary>gnome_vfs_get_slow_mime_type</primary></indexterm>
 
243
<programlisting><link linkend="char">char</link> *              gnome_vfs_get_slow_mime_type        (const <link linkend="char">char</link> *text_uri);</programlisting>
234
244
<para>
235
245
Determine the mime type of <parameter>text_uri</parameter>. The mime type is determined
236
246
in the same way as by <link linkend="gnome-vfs-get-file-info"><function>gnome_vfs_get_file_info()</function></link>. This is meant as