summaryrefslogtreecommitdiffstats
path: root/docs/reference/pygio-constants.xml
diff options
context:
space:
mode:
authorGian Mario Tagliaretti <gianmt@gnome.org>2009-03-09 21:17:12 +0000
committerGian Mario Tagliaretti <gianmt@src.gnome.org>2009-03-09 21:17:12 +0000
commitcc9864de0a55723577d3fbe8b04d36f69fc35a22 (patch)
tree5d7fa2230bb68626ef1fd0a78c301f1873ff7138 /docs/reference/pygio-constants.xml
parent0c8e99a2fdc89f3ec72ad13439ed4b6228d6d788 (diff)
downloadpygobject-cc9864de0a55723577d3fbe8b04d36f69fc35a22.tar.gz
pygobject-cc9864de0a55723577d3fbe8b04d36f69fc35a22.tar.xz
pygobject-cc9864de0a55723577d3fbe8b04d36f69fc35a22.zip
Add gio.Emblem and constants in docs.
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. svn path=/trunk/; revision=1025
Diffstat (limited to 'docs/reference/pygio-constants.xml')
-rw-r--r--docs/reference/pygio-constants.xml59
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/reference/pygio-constants.xml b/docs/reference/pygio-constants.xml
new file mode 100644
index 0000000..37e4143
--- /dev/null
+++ b/docs/reference/pygio-constants.xml
@@ -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>