~ubuntu-branches/ubuntu/trusty/libzeitgeist/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/reference/html/zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2011-03-23 17:05:43 UTC
  • mfrom: (1.1.8 upstream)
  • Revision ID: james.westby@ubuntu.com-20110323170543-qks4dcl41i222izh
Tags: 0.3.8-0ubuntu1
* New upstream release
  - ZeitgeistLog missing implementation of get_property for "connected"
    (LP: #734080)
  - libzeitgeist vapi needs an update (LP: #739653)

Show diffs side-by-side

added added

removed removed

Lines of Context:
37
37
</tr></table></div>
38
38
<div class="refsynopsisdiv">
39
39
<a name="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.synopsis"></a><h2>Synopsis</h2>
40
 
<pre class="synopsis"><span class="returnvalue">void</span>                <a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-register-mimetype" title="zeitgeist_register_mimetype ()">zeitgeist_register_mimetype</a>         (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mimetype</code></em>,
41
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *interpretation_uri</code></em>);
42
 
<span class="returnvalue">void</span>                <a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-register-mimetype-regex" title="zeitgeist_register_mimetype_regex ()">zeitgeist_register_mimetype_regex</a>   (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mimetype_regex</code></em>,
43
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *interpretation_uri</code></em>);
44
 
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-interpretation-for-mimetype" title="zeitgeist_interpretation_for_mimetype ()">zeitgeist_interpretation_for_mimetype</a>
45
 
                                                        (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mimetype</code></em>);
46
 
<span class="returnvalue">void</span>                <a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-register-uri-scheme" title="zeitgeist_register_uri_scheme ()">zeitgeist_register_uri_scheme</a>       (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri_scheme</code></em>,
47
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *manifestation_type</code></em>);
48
 
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-manifestation-for-uri" title="zeitgeist_manifestation_for_uri ()">zeitgeist_manifestation_for_uri</a>     (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>);
 
40
<pre class="synopsis"><span class="returnvalue">void</span>                <a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-register-mimetype" title="zeitgeist_register_mimetype ()">zeitgeist_register_mimetype</a>         (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mimetype</code></em>,
 
41
                                                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *interpretation_uri</code></em>);
 
42
<span class="returnvalue">void</span>                <a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-register-mimetype-regex" title="zeitgeist_register_mimetype_regex ()">zeitgeist_register_mimetype_regex</a>   (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mimetype_regex</code></em>,
 
43
                                                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *interpretation_uri</code></em>);
 
44
const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-interpretation-for-mimetype" title="zeitgeist_interpretation_for_mimetype ()">zeitgeist_interpretation_for_mimetype</a>
 
45
                                                        (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mimetype</code></em>);
 
46
<span class="returnvalue">void</span>                <a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-register-uri-scheme" title="zeitgeist_register_uri_scheme ()">zeitgeist_register_uri_scheme</a>       (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri_scheme</code></em>,
 
47
                                                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *manifestation_type</code></em>);
 
48
const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-manifestation-for-uri" title="zeitgeist_manifestation_for_uri ()">zeitgeist_manifestation_for_uri</a>     (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>);
49
49
</pre>
50
50
</div>
51
51
<div class="refsect1">
57
57
<a name="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.details"></a><h2>Details</h2>
58
58
<div class="refsect2">
59
59
<a name="zeitgeist-register-mimetype"></a><h3>zeitgeist_register_mimetype ()</h3>
60
 
<pre class="programlisting"><span class="returnvalue">void</span>                zeitgeist_register_mimetype         (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mimetype</code></em>,
61
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *interpretation_uri</code></em>);</pre>
 
60
<pre class="programlisting"><span class="returnvalue">void</span>                zeitgeist_register_mimetype         (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mimetype</code></em>,
 
61
                                                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *interpretation_uri</code></em>);</pre>
62
62
<p>
63
63
Associate a mimetype with a given interpretation type. Registered mimetypes
64
64
can be looked up with <a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-interpretation-for-mimetype" title="zeitgeist_interpretation_for_mimetype ()"><code class="function">zeitgeist_interpretation_for_mimetype()</code></a>. You can
97
97
<hr>
98
98
<div class="refsect2">
99
99
<a name="zeitgeist-register-mimetype-regex"></a><h3>zeitgeist_register_mimetype_regex ()</h3>
100
 
<pre class="programlisting"><span class="returnvalue">void</span>                zeitgeist_register_mimetype_regex   (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mimetype_regex</code></em>,
101
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *interpretation_uri</code></em>);</pre>
 
100
<pre class="programlisting"><span class="returnvalue">void</span>                zeitgeist_register_mimetype_regex   (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mimetype_regex</code></em>,
 
101
                                                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *interpretation_uri</code></em>);</pre>
102
102
<p>
103
103
Associate a range of mimetypes with a given interpretation type.
104
104
Registered mimetypes can be looked up with
139
139
<hr>
140
140
<div class="refsect2">
141
141
<a name="zeitgeist-interpretation-for-mimetype"></a><h3>zeitgeist_interpretation_for_mimetype ()</h3>
142
 
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       zeitgeist_interpretation_for_mimetype
143
 
                                                        (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mimetype</code></em>);</pre>
 
142
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       zeitgeist_interpretation_for_mimetype
 
143
                                                        (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mimetype</code></em>);</pre>
144
144
<p>
145
145
Look up the interpretation type associated with <em class="parameter"><code>mimetype</code></em>. Please see the
146
146
list of common
157
157
<tr>
158
158
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
159
159
<td>A URI defining the interpretation type associated with <em class="parameter"><code>mimetype</code></em> or
160
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in case <em class="parameter"><code>mimetype</code></em> is unknown.</td>
 
160
<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in case <em class="parameter"><code>mimetype</code></em> is unknown.</td>
161
161
</tr>
162
162
</tbody>
163
163
</table></div>
165
165
<hr>
166
166
<div class="refsect2">
167
167
<a name="zeitgeist-register-uri-scheme"></a><h3>zeitgeist_register_uri_scheme ()</h3>
168
 
<pre class="programlisting"><span class="returnvalue">void</span>                zeitgeist_register_uri_scheme       (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri_scheme</code></em>,
169
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *manifestation_type</code></em>);</pre>
 
168
<pre class="programlisting"><span class="returnvalue">void</span>                zeitgeist_register_uri_scheme       (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri_scheme</code></em>,
 
169
                                                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *manifestation_type</code></em>);</pre>
170
170
<p>
171
171
Associate a URI scheme with a given manifestation type.
172
172
You can find the manifestation type of a given URI by passing it to
193
193
<hr>
194
194
<div class="refsect2">
195
195
<a name="zeitgeist-manifestation-for-uri"></a><h3>zeitgeist_manifestation_for_uri ()</h3>
196
 
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       zeitgeist_manifestation_for_uri     (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>);</pre>
 
196
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       zeitgeist_manifestation_for_uri     (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>);</pre>
197
197
<p>
198
198
Look up a manifestation type for a given URI. Eg. if you pass in
199
199
<span class="emphasis"><em>file:///tmp/foo.txt</em></span> you will get back
212
212
</tr>
213
213
<tr>
214
214
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
215
 
<td>A manifestation type for <em class="parameter"><code>uri</code></em> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in case no suitable
 
215
<td>A manifestation type for <em class="parameter"><code>uri</code></em> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in case no suitable
216
216
manifestation type is known</td>
217
217
</tr>
218
218
</tbody>