Create a dedicated Changelog for the docs and move the latest entries in

2009-03-09  Gian Mario Tagliaretti  <gianmt@gnome.org>

	* docs/reference/Changelog: Create a dedicated Changelog for the docs
	and move the latest entries in there.

2009-03-09  Gian Mario Tagliaretti  <gianmt@gnome.org>

	* docs/Makefile.am:
	* docs/reference/pygio-classes.xml:
	* docs/reference/pygio-emblemedicon.xml:
	* docs/reference/pygio-icon.xml:
	* docs/reference/pygio-emblem.xml: Add gio.EmblemedIcon and
	gio.Icon in docs, fix a couple of typos.


svn path=/trunk/; revision=1026

1 files changed, 160 insertions, 0 deletions

diff --git a/docs/reference/pygio-emblemedicon.xml b/docs/reference/pygio-emblemedicon.xml
new file mode 100644
index 0000000..f4582b8
--- /dev/null
+++ b/docs/reference/pygio-emblemedicon.xml
@@ -0,0 +1,160 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+
+<refentry id="class-gioemblemedicon">
+    <refnamediv>
+        <refname>gio.EmblemedIcon</refname>
+        <refpurpose>Icon with emblems.</refpurpose>
+    </refnamediv>
+
+    <refsect1>
+        <title>Synopsis</title>
+
+    <classsynopsis language="python">
+        <ooclass><classname>gio.EmblemedIcon</classname></ooclass>
+        <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
+        <ooclass><classname><link linkend="class-gioicon">gio.Icon</link></classname></ooclass>
+    
+    <constructorsynopsis language="python">
+	<methodname><link linkend="constructor-gioemblemedicon">gio.EmblemedIcon</link></methodname>
+	<methodparam><parameter role="keyword">icon</parameter></methodparam>
+        <methodparam><parameter role="keyword">emblem</parameter></methodparam>
+    </constructorsynopsis>
+    
+    
+    <methodsynopsis language="python">
+        <methodname><link linkend="method-gioemblemedicon--add-emblem">add_emblem</link></methodname>
+        <methodparam><parameter role="keyword">emblem</parameter></methodparam>
+    </methodsynopsis>
+    <methodsynopsis language="python">
+        <methodname><link linkend="method-gioemblemedicon--get-icon">get_icon</link></methodname>
+        <methodparam></methodparam>
+    </methodsynopsis>
+    
+    </classsynopsis>
+
+    </refsect1>
+
+    <refsect1>
+        <title>Ancestry</title>
+
+<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+  +-- <link linkend="class-gioemblemedicon">gio.EmblemedIcon</link>
+</synopsis>
+
+    </refsect1>
+    
+    <refsect1>
+	<title>Implemented Interfaces</title>
+        <para>
+            <link linkend="class-gioemblemedicon"><classname>gio.EmblemedIcon</classname></link>
+            implements
+            <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
+        </para>
+    </refsect1>
+
+    <refsect1>
+        <title>Description</title>
+
+        <para>
+            The <link linkend="class-gioemblemedicon"><classname>gio.EmblemedIcon</classname></link>
+            class is an implementation of <classname><link linkend="class-gioicon">gio.Icon</link></classname>
+            that supports adding an emblem to an icon. Adding multiple emblems to an icon is ensured via
+            <methodname><link linkend="method-gioemblemedicon--add-emblem">gio.EmblemedIcon.add_emblem</link></methodname>().
+        </para>
+        <para>
+            Note that
+            <link linkend="class-gioemblemedicon"><classname>gio.EmblemedIcon</classname></link>
+            allows no control over the position of the emblems. See also
+            <link linkend="class-gioemblem"><classname>gio.Emblem</classname></link>
+            for more information.
+        </para>
+    </refsect1>
+
+    <refsect1 id="constructor-gioemblem">
+        <title>Constructor</title>
+  
+        <programlisting><constructorsynopsis language="python">
+            <methodname>gio.EmblemedIcon</methodname>
+            <methodparam><parameter role="keyword">icon</parameter></methodparam>
+            <methodparam><parameter role="keyword">emblem</parameter></methodparam>
+        </constructorsynopsis></programlisting>
+        <variablelist>
+            <varlistentry>
+                <term><parameter>icon</parameter>&nbsp;:</term>
+                <listitem><simpara>a
+                <link linkend="class-gioicon"><classname>gio.Icon</classname></link>.
+                </simpara></listitem>
+            </varlistentry>
+            <varlistentry>
+                <term><parameter>emblem</parameter>&nbsp;:</term>
+                <listitem><simpara>a
+                <link linkend="class-gioemblem"><classname>gio.Emblem</classname></link>.
+                </simpara></listitem>
+            </varlistentry>
+            <varlistentry>
+                <term><emphasis>Returns</emphasis>&nbsp;:</term>
+                <listitem><simpara>a new
+                <link linkend="class-gioicon"><classname>gio.Icon</classname></link>.
+                </simpara></listitem>
+            </varlistentry>
+        </variablelist>
+    
+        <para>
+            Creates a new <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
+            for icon with the emblem emblem.
+        </para>
+  
+    </refsect1>
+
+    <refsect1>
+        <title>Methods</title>
+
+        <refsect2 id="method-gioemblemedicon--add-emblem">
+            <title>gio.EmblemedIcon.add_emblem</title>
+
+            <programlisting><methodsynopsis language="python">
+                <methodname>add_emblem</methodname>
+                <methodparam><parameter role="keyword">emblem</parameter></methodparam>
+            </methodsynopsis></programlisting>
+            
+            <variablelist>
+                <varlistentry>
+                    <term><parameter>emblem</parameter>&nbsp;:</term>
+                    <listitem><simpara>a
+                    <link linkend="class-gioemblem"><classname>gio.Emblem</classname></link>
+                    </simpara></listitem>
+                </varlistentry>
+            </variablelist>
+    
+            <para>
+                The <methodname>add_emblem</methodname>() method adds emblem to the
+                list of <link linkend="class-gioemblem"><classname>gio.Emblem</classname></link>s.
+            </para>
+        </refsect2>
+
+        <refsect2 id="method-gioemblemedicon--get-icon">
+            <title>gio.EmblemedIcon.get_icon</title>
+
+            <programlisting><methodsynopsis language="python">
+                <methodname>get_icon</methodname>
+                <methodparam></methodparam>
+            </methodsynopsis></programlisting>
+            
+            <variablelist>
+                <varlistentry>
+                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
+                    <listitem><simpara>a
+                    <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
+                    that is owned by emblemed.
+                    </simpara></listitem>
+                </varlistentry>
+            </variablelist>
+    
+            <para>
+                The <methodname>get_icon</methodname>() method gets the main icon for emblemed.
+            </para>
+        </refsect2>
+    </refsect1>
+</refentry>