This patch adds documentation of the Python Clutter bindings. - Almost completely documented clutter.Actor - Added proper parts and chapters to reference - Added overview
Cheers, Daniel Schierbeck
Index: docs/Makefile.am
===================================================================
--- docs/Makefile.am (revision 2038)
+++ docs/Makefile.am (working copy)
@@ -10,6 +10,7 @@
XMLFILES = \
reference/clutter-ref.xml \
+ reference/clutter-overview.xml \
reference/clutter-cluttercolor.xml \
reference/clutter-clutteractor.xml \
$(NULL)
@@ -18,6 +19,12 @@
HTML_DATA = \
html/index.html \
html/index.sgml \
+ html/pt01.html \
+ html/pt02.html \
+ html/pt03.html \
+ html/pt04.html \
+ html/ch01.html \
+ html/ch02.html \
html/class-cluttercolor.html \
html/class-clutteractor.html \
html/pyclutter-$(REF_VERSION).devhelp
Index: docs/reference/clutter-cluttercolor.xml
===================================================================
--- docs/reference/clutter-cluttercolor.xml (revision 2038)
+++ docs/reference/clutter-cluttercolor.xml (working copy)
@@ -4,7 +4,7 @@
<refentry id="class-cluttercolor">
<refnamediv>
- <refname>clutter.Color</refname>
+ <refname>Colors</refname>
<refpurpose>Color management and manipulation.</refpurpose>
</refnamediv>
@@ -26,8 +26,8 @@
</constructorsynopsis>
<methodsynopsis language="python">
- <methodname><link linkend="method-clutter--parse">parse</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
+ <methodname><link linkend="method-cluttercolor--foo">foo</link></methodname>
+ <methodparam><parameter role="keyword">bar</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
@@ -48,9 +48,9 @@
<!-- BEGIN OF CLUTTER DESCRIPTION -->
<!-- ********************************** -->
-<refsect1 id="description-clutter-color">
+<refsect1 id="description-cluttercolor">
<title>Description</title>
- <para><link linkend="class-cluttercolor"><classname>ClutterColor</classname></link> is a simple
+ <para><link linkend="class-cluttercolor"><classname>clutter.Color</classname></link> is a simple
type for representing colors.</para>
</refsect1>
@@ -71,19 +71,19 @@
<variablelist>
<varlistentry>
<term><parameter role="keyword">red</parameter> :</term>
- <listitem><simpara>An integer between 0 and 255</simpara></listitem>
+ <listitem><simpara>red component, between 0 and 255</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">green</parameter> :</term>
- <listitem><simpara>An integer between 0 and 255</simpara></listitem>
+ <listitem><simpara>green component, between 0 and 255</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">blue</parameter> :</term>
- <listitem><simpara>An integer between 0 and 255</simpara></listitem>
+ <listitem><simpara>blue component, between 0 and 255</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">alpha</parameter> :</term>
- <listitem><simpara>An integer between 0 and 255</simpara></listitem>
+ <listitem><simpara>alpha component, between 0 and 255</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
@@ -104,22 +104,25 @@
<refsect1>
<title>Methods</title>
- <refsect2 id="method-clutter--parse">
- <title>clutter.Color.parse</title>
+ <refsect2 id="method-cluttercolor--foo">
+ <title>clutter.Color.foo</title>
- <programlisting><methodsynopsis language="python">
- <methodname>parse</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>foo</methodname>
+ <methodparam><parameter>bar</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
<variablelist>
- <varlistentry>
- </varlistentry>
+ <varlistentry>
+ <term><parameter>vanizzle</parameter> :</term>
+ <listitem><simpara>test</simpara></listitem>
+ </varlistentry>
</variablelist>
<para>
- The <methodname>get_auto_indent</methodname>() method returns whether
- auto indentation of text is enabled.
+ Some text.
</para>
</refsect2>
</refsect1>
Index: docs/reference/clutter-overview.xml
===================================================================
--- docs/reference/clutter-overview.xml (revision 0)
+++ docs/reference/clutter-overview.xml (revision 0)
@@ -0,0 +1,17 @@
+<?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";>
+
+<partintro>
+ <para>Clutter is a GObject based library for creating fast, visually rich
+ graphical user interfaces.</para>
+ <para>Clutter semantics work by having a stage (a window) and then adding
+ actors (widgets) to the stage and manipulating via the actor api. Actors
+ can contain child actors (ClutterGroup for example) and be manipulated
+ as a whole.</para>
+ <para>Animations and visual effects can be created via the use of timelines
+ and behaviours. Timelines provide accurate frame based animations.
+ Behaviours further extend this by taking a timeline, a control function
+ (<link linkend="class-clutteralpha"><classname>clutter.Alpha</classname></link>)
+ and then applying to actors as to modify a property as a function of time.</para>
+</partintro>
Index: docs/reference/clutter-clutteractor.xml
===================================================================
--- docs/reference/clutter-clutteractor.xml (revision 2038)
+++ docs/reference/clutter-clutteractor.xml (working copy)
@@ -37,9 +37,10 @@
<refsect1>
<title>Ancestry</title>
- <synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gobject">gobject.GInitiallyUnowned</link>
- +-- <link linkend="class-clutteractor">clutter.Actor</link>
+ <synopsis>
+<link linkend="class-gobject">gobject.GObject</link>
+ +--<link linkend="class-gobject">gobject.GInitiallyUnowned</link>
+ +--<link linkend="class-clutteractor">clutter.Actor</link>
</synopsis>
</refsect1>
@@ -63,6 +64,122 @@
<entry>Read-Write</entry>
<entry>The clip region for the actor.</entry>
</row>
+
+ <row valign="top">
+ <entry>"depth"</entry>
+ <entry>Read-Write</entry>
+ <entry>Depth of the actor. Default value: 0. Since 0.6.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"has-clip"</entry>
+ <entry>Read</entry>
+ <entry>Whether the actor has the clip property set or not.
+ Allowed values: >= -2147483647. Default value: False.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"height"</entry>
+ <entry>Read-Write</entry>
+ <entry>Height of the actor (in pixels). Allowed values: >= 0.
+ Default value: 0.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"name"</entry>
+ <entry>Read-Write</entry>
+ <entry>The name of the actor. Default value: None. Since 0.2.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"opacity"</entry>
+ <entry>Read-Write</entry>
+ <entry>Opacity of the actor. Default value: 255.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"reactive"</entry>
+ <entry>Read-Write</entry>
+ <entry>Whether the actor is reactive or not. Default value: False. Since 0.6.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"rotation-angle-x"</entry>
+ <entry>Read-Write</entry>
+ <entry>The rotation angle on the X axis. Allowed values: >= 0. Default value: 0.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"rotation-angle-y"</entry>
+ <entry>Read-Write</entry>
+ <entry>The rotation angle on the Y axis. Allowed values: >= 0. Default value: 0.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"rotation-angle-z"</entry>
+ <entry>Read-Write</entry>
+ <entry>The rotation angle on the Z axis. Allowed values: >= 0. Default value: 0.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"rotation-center-x"</entry>
+ <entry>Read-Write</entry>
+ <entry>The rotation center on the X axis.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"rotation-center-y"</entry>
+ <entry>Read-Write</entry>
+ <entry>The rotation center on the Y axis.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"rotation-center-z"</entry>
+ <entry>Read-Write</entry>
+ <entry>The rotation center on the Z axis.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"scale-x"</entry>
+ <entry>Read-Write</entry>
+ <entry>Scale X. Allowed values: >= 0. Default value: 1.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"scale-y"</entry>
+ <entry>Read-Write</entry>
+ <entry>Scale Y. Allowed values: >= 0. Default value: 1.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"scale-z"</entry>
+ <entry>Read-Write</entry>
+ <entry>Scale Z. Allowed values: >= 0. Default value: 1.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"visible"</entry>
+ <entry>Read-Write</entry>
+ <entry>Whether the actor is visible or not. Default value: False.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"width"</entry>
+ <entry>Read-Write</entry>
+ <entry>Width of the actor (in pixels). Allowed values: >= 0. Default value: 0.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"x"</entry>
+ <entry>Read-Write</entry>
+ <entry>X coordinate of the actor. Allowed values: >= -2147483647. Default value: 0.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"y"</entry>
+ <entry>Read-Write</entry>
+ <entry>Y coordinate of the actor. Allowed values: >= -2147483647. Default value: 0.</entry>
+ </row>
</tbody>
</tgroup>
</informaltable>
Index: docs/reference/clutter-ref.xml
===================================================================
--- docs/reference/clutter-ref.xml (revision 2038)
+++ docs/reference/clutter-ref.xml (working copy)
@@ -26,7 +26,26 @@
<!-- the reference page chapters for the PyGtksourceview2 classes -->
- <xi:include href="clutter-cluttercolor.xml"/>
- <xi:include href="clutter-clutteractor.xml"/>
+ <part>
+ <title>Clutter Overview</title>
+ <xi:include href="clutter-overview.xml"/>
+ </part>
+ <part>
+ <title>Clutter Core Reference</title>
+ <chapter>
+ <title>Abstract Classes and Interfaces</title>
+ <xi:include href="clutter-clutteractor.xml"/>
+ </chapter>
+ </part>
+ <part>
+ <title>Clutter Animation Support</title>
+ </part>
+ <part>
+ <title>Clutter Tools</title>
+ <chapter>
+ <title>General purpose API</title>
+ <xi:include href="clutter-cluttercolor.xml"/>
+ </chapter>
+ </part>
</book>
signature.asc
Description: This is a digitally signed message part
