pygobject r1026 - in trunk: . docs docs/reference
- From: gianmt svn gnome org
- To: svn-commits-list gnome org
- Subject: pygobject r1026 - in trunk: . docs docs/reference
- Date: Mon, 9 Mar 2009 23:35:05 +0000 (UTC)
Author: gianmt
Date: Mon Mar 9 23:35:05 2009
New Revision: 1026
URL: http://svn.gnome.org/viewvc/pygobject?rev=1026&view=rev
Log:
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.
Added:
trunk/docs/reference/ChangeLog
trunk/docs/reference/pygio-emblemedicon.xml
trunk/docs/reference/pygio-icon.xml
Modified:
trunk/ChangeLog
trunk/docs/Makefile.am
trunk/docs/reference/pygio-classes.xml
trunk/docs/reference/pygio-emblem.xml
Modified: trunk/docs/Makefile.am
==============================================================================
--- trunk/docs/Makefile.am (original)
+++ trunk/docs/Makefile.am Mon Mar 9 23:35:05 2009
@@ -17,6 +17,9 @@
html/gobject-class-reference.html \
html/glib-class-reference.html \
html/gio-applaunchcontext.html \
+ html/gio-emblem.html \
+ html/gio-emblemedicon.html \
+ html/gio-icon.html \
html/gio-constants.html \
html/gio-class-reference.html \
html/gobject-constants.html \
@@ -44,6 +47,9 @@
reference/pyglib-mainloop.xml \
reference/pygio-classes.xml \
reference/pygio-applaunchcontext.xml \
+ reference/pygio-emblem.xml \
+ reference/pygio-emblemedicon.xml \
+ reference/pygio-icon.xml \
reference/pygio-constants.xml
XSL_FILES = \
Modified: trunk/docs/reference/pygio-classes.xml
==============================================================================
--- trunk/docs/reference/pygio-classes.xml (original)
+++ trunk/docs/reference/pygio-classes.xml Mon Mar 9 23:35:05 2009
@@ -10,6 +10,8 @@
<xi:include href="pygio-applaunchcontext.xml"/>
<xi:include href="pygio-cancellable.xml"/>
<xi:include href="pygio-emblem.xml"/>
+<xi:include href="pygio-icon.xml"/>
+<xi:include href="pygio-emblemedicon.xml"/>
<xi:include href="pygio-constants.xml"/>
</chapter>
Modified: trunk/docs/reference/pygio-emblem.xml
==============================================================================
--- trunk/docs/reference/pygio-emblem.xml (original)
+++ trunk/docs/reference/pygio-emblem.xml Mon Mar 9 23:35:05 2009
@@ -17,16 +17,16 @@
<ooclass><classname><link linkend="class-gioicon">gio.Icon</link></classname></ooclass>
<constructorsynopsis language="python">
- <methodname><link linkend="constructor-giocancellable">gio.Emblem</link></methodname>
+ <methodname><link linkend="constructor-gioemblem">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>
+ <methodname><link linkend="method-gioemblem--get-icon">get_icon</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
- <methodname><link linkend="method-giocancellable--get-origin">get_origin</link></methodname>
+ <methodname><link linkend="method-gioemblem--get-origin">get_origin</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
@@ -50,6 +50,15 @@
</synopsis>
</refsect1>
+
+ <refsect1>
+ <title>Implemented Interfaces</title>
+ <para>
+ <link linkend="class-gioemblem"><classname>gio.Emblem</classname></link>
+ implements
+ <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
+ </para>
+ </refsect1>
<refsect1>
<title>Description</title>
@@ -98,7 +107,7 @@
<refsect1>
<title>Methods</title>
- <refsect2 id="method-giocancellable--get-icon">
+ <refsect2 id="method-gioemblem--get-icon">
<title>gio.Emblem.get_icon</title>
<programlisting><methodsynopsis language="python">
@@ -120,7 +129,7 @@
</para>
</refsect2>
- <refsect2 id="method-giocancellable--get-origin">
+ <refsect2 id="method-gioemblem--get-origin">
<title>gio.Emblem.get_origin</title>
<programlisting><methodsynopsis language="python">
Added: trunk/docs/reference/pygio-emblemedicon.xml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/pygio-emblemedicon.xml Mon Mar 9 23:35:05 2009
@@ -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> :</term>
+ <listitem><simpara>a
+ <link linkend="class-gioicon"><classname>gio.Icon</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>emblem</parameter> :</term>
+ <listitem><simpara>a
+ <link linkend="class-gioemblem"><classname>gio.Emblem</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</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> :</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> :</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>
Added: trunk/docs/reference/pygio-icon.xml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/pygio-icon.xml Mon Mar 9 23:35:05 2009
@@ -0,0 +1,124 @@
+<?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-gioicon">
+ <refnamediv>
+ <refname>gio.Icon</refname>
+ <refpurpose>Interface for icons.</refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Synopsis</title>
+
+ <classsynopsis language="python">
+ <ooclass><classname>gio.Icon</classname></ooclass>
+ <ooclass><classname><link linkend="class-gobjectginterface">gobject.GInterface</link></classname></ooclass>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gioicon--equal">equal</link></methodname>
+ <methodparam><parameter role="keyword">icon2</parameter></methodparam>
+ </methodsynopsis>
+
+ </classsynopsis>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Ancestry</title>
+
+<synopsis>+-- <link linkend="class-gobjectginterface">gobject.GInterface</link>
+ +-- <link linkend="class-gioicon">gio.Icon</link>
+</synopsis>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Known Derived Interfaces</title>
+ <para>
+ <link linkend="class-gioicon"><classname>gio.Icon</classname></link> is required by
+ <link linkend="class-gioloadableicon"><classname>gio.LoadableIcon</classname></link>.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Known Implementation</title>
+ <para>
+ <link linkend="class-gioicon"><classname>gio.Icon</classname></link> is implemented by
+ <link linkend="class-giothemedicon"><classname>gio.ThemedIcon</classname></link>,
+ <link linkend="class-giofileicon"><classname>gio.FileIcon</classname></link>,
+ <link linkend="class-gioemblem"><classname>gio.Emblem</classname></link>,
+ <link linkend="class-gioemblemedicon"><classname>gio.EmblemedIcon</classname></link>.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
+ is a very minimal interface for icons. It provides functions for checking
+ the equality of two icons, hashing of icons and serializing an icon to and from strings.
+ </para>
+ <para>
+ <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
+ does not provide the actual pixmap for the icon as this is out of GIO's
+ scope, however implementations of
+ <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
+ may contain the name of an icon (see
+ <link linkend="class-giothemedicon"><classname>gio.ThemedIcon</classname></link>),
+ or the path to an icon (see
+ <link linkend="class-gioloadableicon"><classname>gio.LoadableIcon</classname></link>).
+ </para>
+ <!--
+ <para>
+ To obtain a hash of a <link linkend="class-gioicon"><classname>gio.Icon</classname></link>, see
+ <methodname><link linkend="method-gioicon- -hash">gio.Icon.hash</link></methodname>().
+ </para>
+ -->
+ <para>
+ 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
+ <methodname><link linkend="method-gioicon- -new-from-string">gio.Icon.new_from_string</link></methodname>().
+ </para>
+ <para>
+ If your application or library provides one or more
+ <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>().
+ </para>
+ -->
+ </refsect1>
+
+ <refsect1>
+ <title>Methods</title>
+
+ <refsect2 id="method-gioicon--equal">
+ <title>gio.Emblem.equal</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>equal</methodname>
+ <methodparam><parameter role="keyword">icon2</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>icon2</parameter> :</term>
+ <listitem><simpara>the second
+ <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>equal</methodname>() method checks if two icons are equal.
+ </para>
+ </refsect2>
+ </refsect1>
+</refentry>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
