pygobject r1025 - in trunk: . docs docs/reference
- From: gianmt svn gnome org
- To: svn-commits-list gnome org
- Subject: pygobject r1025 - in trunk: . docs docs/reference
- Date: Mon, 9 Mar 2009 21:17:12 +0000 (UTC)
Author: gianmt
Date: Mon Mar 9 21:17:12 2009
New Revision: 1025
URL: http://svn.gnome.org/viewvc/pygobject?rev=1025&view=rev
Log:
2009-03-09 Gian Mario Tagliaretti <gianmt gnome org>
* docs/Makefile.am:
* docs/reference/pygio-classes.xml:
* docs/reference/pygio-constants.xml:
* docs/reference/pygio-emblem.xml: Add gio.Emblem and constants in docs.
Added:
trunk/docs/reference/pygio-constants.xml
trunk/docs/reference/pygio-emblem.xml
Modified:
trunk/ChangeLog
trunk/docs/Makefile.am
trunk/docs/reference/pygio-classes.xml
Modified: trunk/docs/Makefile.am
==============================================================================
--- trunk/docs/Makefile.am (original)
+++ trunk/docs/Makefile.am Mon Mar 9 21:17:12 2009
@@ -14,9 +14,10 @@
html/class-glibmainloop.html \
html/glib-constants.html \
html/glib-functions.html \
- html/gio-applaunchcontext.html \
html/gobject-class-reference.html \
html/glib-class-reference.html \
+ html/gio-applaunchcontext.html \
+ html/gio-constants.html \
html/gio-class-reference.html \
html/gobject-constants.html \
html/gobject-functions.html \
@@ -42,7 +43,8 @@
reference/pyglib-maincontext.xml \
reference/pyglib-mainloop.xml \
reference/pygio-classes.xml \
- reference/pygio-applaunchcontext.xml
+ reference/pygio-applaunchcontext.xml \
+ reference/pygio-constants.xml
XSL_FILES = \
xsl/common.xsl \
Modified: trunk/docs/reference/pygio-classes.xml
==============================================================================
--- trunk/docs/reference/pygio-classes.xml (original)
+++ trunk/docs/reference/pygio-classes.xml Mon Mar 9 21:17:12 2009
@@ -9,5 +9,7 @@
<!-- GLIB CLASSES -->
<xi:include href="pygio-applaunchcontext.xml"/>
<xi:include href="pygio-cancellable.xml"/>
+<xi:include href="pygio-emblem.xml"/>
+<xi:include href="pygio-constants.xml"/>
</chapter>
Added: trunk/docs/reference/pygio-constants.xml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/pygio-constants.xml Mon Mar 9 21:17:12 2009
@@ -0,0 +1,59 @@
+<?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="gio-constants">
+ <refnamediv>
+ <refname>gio Constants</refname>
+ <refpurpose>the built-in constants of the gio module</refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Synopsis</title>
+
+<programlisting>
+<xref linkend="gio-emblem-origin-constants" endterm="gio-emblem-origin-constants-title"></xref>
+</programlisting>
+
+ </refsect1>
+
+ <refsect1 id="gio-constants-description">
+ <title>Description</title>
+
+ <refsect2 id="gio-emblem-origin-constants">
+ <title id="gio-emblem-origin-constants-title">Gio Emblem Origin Constants</title>
+
+ <para>
+ GEmblemOrigin is used to add information about the origin of the emblem to GEmblem.
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term><literal>gio.EMBLEM_ORIGIN_DEVICE</literal></term>
+ <listitem>
+ <simpara>Embleme adds device-specific information.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.EMBLEM_ORIGIN_LIVEMETADATA</literal></term>
+ <listitem>
+ <simpara>Emblem depicts live metadata, such as "readonly".</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.EMBLEM_ORIGIN_TAG</literal></term>
+ <listitem>
+ <simpara>Emblem comes from a user-defined tag, e.g. set by nautilus (in the future).</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.EMBLEM_ORIGIN_UNKNOWN</literal></term>
+ <listitem>
+ <simpara>Emblem of unknown origin.</simpara>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+ </refsect1>
+
+</refentry>
Added: trunk/docs/reference/pygio-emblem.xml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/pygio-emblem.xml Mon Mar 9 21:17:12 2009
@@ -0,0 +1,176 @@
+<?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-gioemblem">
+ <refnamediv>
+ <refname>gio.Emblem</refname>
+ <refpurpose>An object for emblems.</refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Synopsis</title>
+
+ <classsynopsis language="python">
+ <ooclass><classname>gio.Emblem</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-giocancellable">gio.Emblem</link></methodname>
+ <methodparam><parameter role="keyword">icon</parameter></methodparam>
+ </constructorsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giocancellable--get-icon">get_icon</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giocancellable--get-origin">get_origin</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
+ </classsynopsis>
+
+<programlisting>
+<emphasis role="bold">Functions</emphasis>
+
+<methodsynopsis language="python">
+ <methodname><link linkend="function-gio--emblem-new-with-origin">gio.emblem_new_with_origin</link></methodname>
+ <methodparam><parameter role="keyword">origin</parameter></methodparam>
+</methodsynopsis></programlisting>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Ancestry</title>
+
+<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+ +-- <link linkend="class-gioemblem">gio.Emblem</link>
+</synopsis>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ The <link linkend="class-gioemblem"><classname>gio.Emblem</classname></link>
+ class is an implementation of <classname><link linkend="class-gioicon">gio.Icon</link></classname>
+ that supports having an emblem, which is an icon with additional properties.
+ It can than be added to a
+ <link linkend="class-gioemblemedicon"><classname>gio.EmblemedIcon</classname></link>.
+ </para>
+ <para>
+ Currently, only metainformation about the emblem's origin is supported.
+ More may be added in the future.
+ </para>
+ </refsect1>
+
+ <refsect1 id="constructor-gioemblem">
+ <title>Constructor</title>
+
+ <programlisting><constructorsynopsis language="python">
+ <methodname>gio.Emblem</methodname>
+ <methodparam><parameter role="keyword">icon</parameter></methodparam>
+ </constructorsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>icon</parameter> :</term>
+ <listitem><simpara>a
+ <link linkend="class-gioicon"><classname>gio.Icon</classname></link> containing the icon.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a new
+ <link linkend="class-gioemblem"><classname>gio.Emblem</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Creates a new <link linkend="class-gioemblem"><classname>gio.Emblem</classname></link> for icon.
+ </para>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Methods</title>
+
+ <refsect2 id="method-giocancellable--get-icon">
+ <title>gio.Emblem.get_icon</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_icon</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a
+ <link linkend="class-gioicon"><classname>gio.Icon</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>get_icon</methodname>() method gives back the icon from emblem.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-giocancellable--get-origin">
+ <title>gio.Emblem.get_origin</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_origin</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the origin of the emblem.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>get_origin</methodname>() method gets the origin of the emblem.
+ </para>
+ </refsect2>
+ </refsect1>
+
+ <refsect1>
+ <title>Functions</title>
+
+ <refsect2 id="function-gio--emblem-new-with-origin">
+ <title>gio.emblem_new_with_origin</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>emblem_new_with_origin</methodname>
+ <methodparam><parameter role="keyword">origin</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>origin</parameter> :</term>
+ <listitem><simpara>a <xref linkend="gio-emblem-origin-constants" endterm="gio-emblem-origin-constants-title"></xref>
+ defining the emblem's origin .
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A <link linkend="class-gioemblem"><classname>gio.Emblem</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>emblem_new_with_origin</methodname>() function creates
+ a new emblem for icon.
+ </para>
+ </refsect2>
+ </refsect1>
+</refentry>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
