From 76e9dc74ac706a9207f9d31f887d6e38df2a678f Mon Sep 17 00:00:00 2001
From: Gian Mario Tagliaretti <gianmt@gnome.org>
Date: Mon, 25 May 2009 20:20:38 +0200
Subject: Update the docs with new 2.20 API

---
 docs/reference/pygio-icon.xml | 99 +++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 96 insertions(+), 3 deletions(-)

(limited to 'docs/reference/pygio-icon.xml')

diff --git a/docs/reference/pygio-icon.xml b/docs/reference/pygio-icon.xml
index 2e3c285..5a32d28 100644
--- a/docs/reference/pygio-icon.xml
+++ b/docs/reference/pygio-icon.xml
@@ -19,9 +19,21 @@
         <methodname><link linkend="method-gioicon--equal">equal</link></methodname>
         <methodparam><parameter role="keyword">icon2</parameter></methodparam>
     </methodsynopsis>
+    <methodsynopsis language="python">
+        <methodname><link linkend="method-gioicon--to-string">to_string</link></methodname>
+        <methodparam></methodparam>
+    </methodsynopsis>
     
     </classsynopsis>
 
+<programlisting>
+<emphasis role="bold">Functions</emphasis>
+ 
+<methodsynopsis language="python">
+    <methodname><link linkend="function-gio--icon-new-from-string">gio.icon_new_from_string</link></methodname>
+    <methodparam></methodparam>
+</methodsynopsis></programlisting>
+
     </refsect1>
 
     <refsect1>
@@ -80,7 +92,6 @@
             To check if two GIcons are equal, see
             <methodname><link linkend="method-gioicon--equal">gio.Icon.equal</link></methodname>().
         </para>
-        <!--
         <para>
             For serializing a <link linkend="class-gioicon"><classname>gio.Icon</classname></link>,
             use <methodname><link linkend="method-gioicon- -to-string">gio.Icon.to_string</link></methodname>() and
@@ -91,9 +102,8 @@
             <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
             implementations you need to ensure that each GType is registered
             with the type system prior to calling
-            <methodname><link linkend="method-gioicon- -new-from-string">gio.Icon.new_from_string</link></methodname>(). 
+            <methodname><link linkend="function-gioicon--new-from-string">gio.icon_new_from_string</link></methodname>(). 
         </para>
-        -->
     </refsect1>
 
     <refsect1>
@@ -120,5 +130,88 @@
                 The <methodname>equal</methodname>() method checks if two icons are equal.
             </para>
         </refsect2>
+
+        <refsect2 id="method-gioicon--to-string">
+            <title>gio.Icon.to_string</title>
+
+            <programlisting><methodsynopsis language="python">
+                <methodname>to_string</methodname>
+                <methodparam></methodparam>
+            </methodsynopsis></programlisting>
+            
+            <variablelist>
+                <varlistentry>
+                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
+                    <listitem><simpara>An UTF8 string or <literal>None</literal>
+		    if icon can't be serialized.
+                    </simpara></listitem>
+                </varlistentry>
+            </variablelist>
+    
+            <para>
+                The <methodname>to_string</methodname>() method generates a textual
+		representation of icon that can be used for serialization such as when
+		passing icon to a different process or saving it to persistent storage. Use
+		<methodname><link linkend="function-gio--icon-new-from-string">gio.icon_new_from_string</link></methodname>()
+		to get icon back from the returned string.
+            </para>
+	    <para>
+		The encoding of the returned string is proprietary to GIcon except in the following two cases
+	    </para>
+	    <para>
+		If icon is a <link linkend="class-giofileicon"><classname>gio.FileIcon</classname></link>,
+		the returned string is a native path (such as /path/to/my icon.png) without escaping
+		if the <link linkend="class-giofile"><classname>gio.File</classname></link>
+		for icon is a native file. If the file is not native, the returned string is the result of
+		<methodname><link linkend="method-giofile--get-uri">gio.File.get_uri</link></methodname>()
+		(such as sftp://path/to/my%20icon.png).
+	    </para>
+	    <para>
+		If icon is a <link linkend="class-giothemedicon"><classname>gio.ThemedIcon</classname></link>
+		with exactly one name, the encoding is simply the name (such as network-server).
+	    </para>
+        </refsect2>
+    </refsect1>
+    
+    <refsect1>
+        <title>Functions</title>
+
+        <refsect2 id="function-gio--icon-new-from-string">
+            <title>gio.icon_new_from_string</title>
+
+            <programlisting><methodsynopsis language="python">
+                <methodname>icon_new_from_string</methodname>
+                <methodparam><parameter role="keyword">str</parameter></methodparam>
+            </methodsynopsis></programlisting>
+            
+            <variablelist>
+                <varlistentry>
+                    <term><parameter>str</parameter>&nbsp;:</term>
+                    <listitem><simpara>A string obtained via
+		    <methodname><link linkend="method-gioicon--to-string">gio.Icon.to_string</link></methodname>().
+                    </simpara></listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
+                    <listitem><simpara>An object implementing the
+		    <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
+		    interface or <literal>None</literal> if error is set.
+                    </simpara></listitem>
+                </varlistentry>
+            </variablelist>
+
+            <para>
+                The <methodname>icon_new_from_string</methodname>() function generate a
+		<link linkend="class-gioicon"><classname>gio.Icon</classname></link>
+		instance from str. This function can fail if str is not valid - see
+		<methodname><link linkend="method-gioicon--to-string">gio.Icon.to_string</link></methodname>()
+		for discussion.
+            </para>
+            <para>
+                If your application or library provides one or more GIcon implementations you need
+		to ensure that each GType is registered with the type system prior to calling
+		<methodname><link linkend="function-gio--icon-new-from-string">gio.icon_new_from_string</link></methodname>().
+            </para>
+        </refsect2>
     </refsect1>
 </refentry>
-- 
cgit