diff options
Diffstat (limited to 'docs/reference/pygtk-gtkspinner.xml')
| -rw-r--r-- | docs/reference/pygtk-gtkspinner.xml | 106 |
1 files changed, 106 insertions, 0 deletions
diff --git a/docs/reference/pygtk-gtkspinner.xml b/docs/reference/pygtk-gtkspinner.xml new file mode 100644 index 00000000..1243358f --- /dev/null +++ b/docs/reference/pygtk-gtkspinner.xml @@ -0,0 +1,106 @@ +<?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-gtkspinner"> + <refnamediv> + <refname>gtk.Spinner</refname> + <refpurpose></refpurpose> + </refnamediv> + + <refsect1> + <title>Synopsis</title> + + <classsynopsis language="python"> + <ooclass><classname>gtk.Spinner</classname></ooclass> + <ooclass><classname><link linkend="class-gtkdrawingarea">gtk.DrawingArea</link></classname></ooclass> + <constructorsynopsis language="python"> + <methodname><link linkend="constructor-gtkspinner">gtk.Spinner</link></methodname> + <methodparam></methodparam> + </constructorsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkspinner--start">start</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkspinner--stop">stop</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + </classsynopsis> + + </refsect1> + + <refsect1> + <title>Ancestry</title> + +<synopsis>+-- <link linkend="class-gobject">GObject</link> + +-- <link linkend="class-gtkobject">gtk.Object</link> + +-- <link linkend="class-gtkwidget">gtk.Widget</link> + +-- <link linkend="class-gtkdrawingarea">gtk.DrawingArea</link> + +-- <link linkend="class-gtkspinner">gtk.Spinner</link> +</synopsis> + + </refsect1> + + <refsect1> + <title>Constructor</title> + + <programlisting> + <constructorsynopsis language="python"> + <methodname><link linkend="constructor-gtkspinner">gtk.Spinner</link></methodname> + <methodparam></methodparam> + </constructorsynopsis> + </programlisting> + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>a new <link linkend="class-gtkspinner"><classname>gtk.Spinner</classname></link></simpara></listitem> + </varlistentry> + </variablelist> + <note> + <para>This constructor is available in PyGTK 2.20 and above.</para> + </note> + + <para>Returns a new spinner widget. Not yet started.</para> + + + </refsect1> + + <refsect1> + <title>Methods</title> + + <refsect2 id="method-gtkspinner--start"> + <title>gtk.Spinner.start</title> + + <programlisting> + <methodsynopsis language="python"> + <methodname>start</methodname> + <methodparam></methodparam> + </methodsynopsis> + </programlisting> + <note> + <para>This method is available in PyGTK 2.20 and above.</para> + </note> + + <para>Starts the animation of the spinner.</para> + </refsect2> + + <refsect2 id="method-gtkspinner--stop"> + <title>gtk.Spinner.stop</title> + + <programlisting> + <methodsynopsis language="python"> + <methodname>stop</methodname> + <methodparam></methodparam> + </methodsynopsis> + </programlisting> + <note> + <para>This method is available in PyGTK 2.20 and above.</para> + </note> + + <para>Stops the animation of the spinner.</para> + </refsect2> + + </refsect1> + +</refentry> |