Update to version 2.33.1
[profile/ivi/glib2.git] / docs / reference / glib / html / glib-Bookmark-file-parser.html
index 259ec6b..6f5de9b 100644 (file)
@@ -207,61 +207,30 @@ the bookmark as "private" to the applications and groups that has it
 registered; the URI and MIME type of an icon, to be used when displaying
 the bookmark inside a GUI.
 </p>
-<div class="informalexample">
-  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
-    <tbody>
-      <tr>
-        <td class="listing_lines" align="right"><pre>1
-2
-3
-4
-5
-6
-7
-8
-9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23</pre></td>
-        <td class="listing_code"><pre class="programlisting"><span class="symbol">&lt;?</span><span class="usertype">xml</span><span class="normal"> version</span><span class="symbol">=</span><span class="string">"1.0"</span><span class="symbol">?&gt;</span>
-<span class="symbol">&lt;!</span><span class="normal">DOCTYPE xbel PUBLIC</span>
-<span class="normal">  </span><span class="string">"+//IDN python.org//DTD XML Bookmark Exchange Language 1.0//EN//XML"</span>
-<span class="normal">  </span><span class="string">"http://www.python.org/topics/xml/dtds/xbel-1.0.dtd"</span><span class="symbol">&gt;</span>
-<span class="symbol">&lt;</span><span class="usertype">xbel</span><span class="normal"> version</span><span class="symbol">=</span><span class="string">"1.0"</span>
-<span class="normal">      xmlns</span><span class="symbol">:</span><span class="normal">mime</span><span class="symbol">=</span><span class="string">"http://www.freedesktop.org/standards/shared-mime-info"</span>
-<span class="normal">      xmlns</span><span class="symbol">:</span><span class="normal">bookmark</span><span class="symbol">=</span><span class="string">"http://www.freedesktop.org/standards/desktop-bookmarks"</span><span class="symbol">&gt;</span>
-<span class="normal">  </span><span class="symbol">&lt;</span><span class="usertype">bookmark</span><span class="normal"> href</span><span class="symbol">=</span><span class="string">"file:///home/ebassi/bookmark-spec/bookmark-spec.xml"</span><span class="symbol">&gt;</span>
-<span class="normal">    </span><span class="symbol">&lt;</span><span class="normal">title</span><span class="symbol">&gt;</span><span class="normal">Desktop </span><span class="usertype">Bookmarks</span><span class="normal"> Spec</span><span class="symbol">&lt;/</span><span class="normal">title</span><span class="symbol">&gt;</span>
-<span class="normal">    </span><span class="symbol">&lt;</span><span class="normal">info</span><span class="symbol">&gt;</span>
-<span class="normal">      </span><span class="symbol">&lt;</span><span class="usertype">metadata</span><span class="normal"> owner</span><span class="symbol">=</span><span class="string">"http://freedesktop.org"</span><span class="symbol">&gt;</span>
-<span class="normal">        </span><span class="symbol">&lt;</span><span class="normal">mime</span><span class="symbol">:</span><span class="normal">mime</span><span class="symbol">-</span><span class="normal">type</span><span class="symbol">&gt;</span><span class="normal">text</span><span class="symbol">/</span><span class="normal">xml</span><span class="symbol">&lt;/</span><span class="normal">mime</span><span class="symbol">:</span><span class="normal">mime</span><span class="symbol">-</span><span class="normal">type</span><span class="symbol">&gt;</span>
-<span class="normal">        </span><span class="symbol">&lt;</span><span class="normal">bookmark</span><span class="symbol">:</span><span class="normal">applications</span><span class="symbol">&gt;</span>
-<span class="normal">          </span><span class="symbol">&lt;</span><span class="normal">bookmark</span><span class="symbol">:</span><span class="usertype">application</span><span class="normal"> name</span><span class="symbol">=</span><span class="string">"GEdit"</span><span class="normal"> count</span><span class="symbol">=</span><span class="string">"2"</span><span class="normal"> exec</span><span class="symbol">=</span><span class="string">"gedit %u"</span><span class="normal"> timestamp</span><span class="symbol">=</span><span class="string">"1115726763"</span><span class="symbol">/&gt;</span>
-<span class="normal">          </span><span class="symbol">&lt;</span><span class="normal">bookmark</span><span class="symbol">:</span><span class="usertype">application</span><span class="normal"> name</span><span class="symbol">=</span><span class="string">"GViM"</span><span class="normal"> count</span><span class="symbol">=</span><span class="string">"7"</span><span class="normal"> exec</span><span class="symbol">=</span><span class="string">"gvim %f"</span><span class="normal"> timestamp</span><span class="symbol">=</span><span class="string">"1115726812"</span><span class="symbol">/&gt;</span>
-<span class="normal">        </span><span class="symbol">&lt;/</span><span class="normal">bookmark</span><span class="symbol">:</span><span class="normal">applications</span><span class="symbol">&gt;</span>
-<span class="normal">        </span><span class="symbol">&lt;</span><span class="normal">bookmark</span><span class="symbol">:</span><span class="normal">groups</span><span class="symbol">&gt;</span>
-<span class="normal">          </span><span class="symbol">&lt;</span><span class="normal">bookmark</span><span class="symbol">:</span><span class="normal">group</span><span class="symbol">&gt;</span><span class="normal">Editors</span><span class="symbol">&lt;/</span><span class="normal">bookmark</span><span class="symbol">:</span><span class="normal">group</span><span class="symbol">&gt;</span>
-<span class="normal">        </span><span class="symbol">&lt;/</span><span class="normal">bookmark</span><span class="symbol">:</span><span class="normal">groups</span><span class="symbol">&gt;</span>
-<span class="normal">      </span><span class="symbol">&lt;/</span><span class="normal">metadata</span><span class="symbol">&gt;</span>
-<span class="normal">    </span><span class="symbol">&lt;/</span><span class="normal">info</span><span class="symbol">&gt;</span>
-<span class="normal">  </span><span class="symbol">&lt;/</span><span class="normal">bookmark</span><span class="symbol">&gt;</span>
-<span class="symbol">&lt;/</span><span class="normal">xbel</span></pre></td>
-      </tr>
-    </tbody>
-  </table>
-</div>
-
+<div class="informalexample"><pre class="programlisting">&lt;?xml version="1.0"?&gt;
+&lt;!DOCTYPE xbel PUBLIC
+  "+//IDN python.org//DTD XML Bookmark Exchange Language 1.0//EN//XML"
+  "http://www.python.org/topics/xml/dtds/xbel-1.0.dtd"&gt;
+&lt;xbel version="1.0"
+      xmlns:mime="http://www.freedesktop.org/standards/shared-mime-info"
+      xmlns:bookmark="http://www.freedesktop.org/standards/desktop-bookmarks"&gt;
+  &lt;bookmark href="file:///home/ebassi/bookmark-spec/bookmark-spec.xml"&gt;
+    &lt;title&gt;Desktop Bookmarks Spec&lt;/title&gt;
+    &lt;info&gt;
+      &lt;metadata owner="http://freedesktop.org"&gt;
+        &lt;mime:mime-type&gt;text/xml&lt;/mime:mime-type&gt;
+        &lt;bookmark:applications&gt;
+          &lt;bookmark:application name="GEdit" count="2" exec="gedit %u" timestamp="1115726763"/&gt;
+          &lt;bookmark:application name="GViM" count="7" exec="gvim %f" timestamp="1115726812"/&gt;
+        &lt;/bookmark:applications&gt;
+        &lt;bookmark:groups&gt;
+          &lt;bookmark:group&gt;Editors&lt;/bookmark:group&gt;
+        &lt;/bookmark:groups&gt;
+      &lt;/metadata&gt;
+    &lt;/info&gt;
+  &lt;/bookmark&gt;
+&lt;/xbel
+</pre></div>
 <p>
 </p>
 <p>
@@ -511,7 +480,7 @@ set to either a <a class="link" href="glib-File-Utilities.html#GFileError" title
 <tr>
 <td><p><span class="term"><em class="parameter"><code>full_path</code></em> :</span></p></td>
 <td>return location for a string containing the full path
-of the file, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
+of the file, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 </td>
 </tr>
 <tr>
@@ -547,7 +516,7 @@ This function outputs <em class="parameter"><code>bookmark</code></em> as a stri
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
-<td>return location for the length of the returned string, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
+<td>return location for the length of the returned string, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 </td>
 </tr>
 <tr>
@@ -763,7 +732,7 @@ optionally be <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
-<td>return location for the number of returned URIs, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
+<td>return location for the number of returned URIs, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 </td>
 </tr>
 <tr>
@@ -801,7 +770,7 @@ In the event the URI cannot be found, <a class="link" href="glib-Standard-Macros
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
-<td>a valid URI or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
+<td>a valid URI or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 </td>
 </tr>
 <tr>
@@ -968,12 +937,12 @@ In the event the URI cannot be found, <a class="link" href="glib-Standard-Macros
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>href</code></em> :</span></p></td>
-<td>return location for the icon's location or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
+<td>return location for the icon's location or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td>
-<td>return location for the icon's MIME type or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
+<td>return location for the icon's MIME type or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 </td>
 </tr>
 <tr>
@@ -1137,7 +1106,7 @@ be <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
-<td>return location for the length of the returned string, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
+<td>return location for the length of the returned string, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 </td>
 </tr>
 <tr>
@@ -1183,7 +1152,7 @@ In the event the URI cannot be found, <a class="link" href="glib-Standard-Macros
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
-<td>return location of the length of the returned list, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
+<td>return location of the length of the returned list, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 </td>
 </tr>
 <tr>
@@ -1245,17 +1214,17 @@ set and <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>exec</code></em> :</span></p></td>
-<td>location for the command line of the application, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
+<td>location for the command line of the application, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
-<td>return location for the registration count, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
+<td>return location for the registration count, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>stamp</code></em> :</span></p></td>
-<td>return location for the last registration time, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
+<td>return location for the last registration time, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 </td>
 </tr>
 <tr>
@@ -1298,7 +1267,7 @@ If a bookmark for <em class="parameter"><code>uri</code></em> cannot be found th
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
-<td>a valid URI or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
+<td>a valid URI or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 </td>
 </tr>
 <tr>
@@ -1334,7 +1303,7 @@ If a bookmark for <em class="parameter"><code>uri</code></em> cannot be found th
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
-<td>a valid URI or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
+<td>a valid URI or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 </td>
 </tr>
 <tr>
@@ -1439,7 +1408,7 @@ If no bookmark for <em class="parameter"><code>uri</code></em> is found one is c
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>href</code></em> :</span></p></td>
-<td>the URI of the icon for the bookmark, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
+<td>the URI of the icon for the bookmark, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 </td>
 </tr>
 <tr>
@@ -1510,7 +1479,8 @@ If <em class="parameter"><code>uri</code></em> cannot be found then an item for
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>groups</code></em> :</span></p></td>
-<td>an array of group names, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> to remove all groups</td>
+<td>an array of group names, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> to remove all groups. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
+</td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
@@ -1767,12 +1737,12 @@ If no bookmark for <em class="parameter"><code>uri</code></em> is found, one is
 <tr>
 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 <td>the name of the application registering the bookmark
-or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
+or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>exec</code></em> :</span></p></td>
-<td>command line to be used to launch the bookmark or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
+<td>command line to be used to launch the bookmark or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 </td>
 </tr>
 </tbody>
@@ -1939,7 +1909,7 @@ In the event the URI cannot be found, <a class="link" href="glib-Standard-Macros
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>new_uri</code></em> :</span></p></td>
-<td>a valid URI, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
+<td>a valid URI, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 </td>
 </tr>
 <tr>