reference: pygtk-gtkspinner.xml: add purpose, interfaces, properties and signals

1 files changed, 97 insertions, 1 deletions

diff --git a/docs/reference/pygtk-gtkspinner.xml b/docs/reference/pygtk-gtkspinner.xml
index a893dffe..cfb08b67 100644
--- a/docs/reference/pygtk-gtkspinner.xml
+++ b/docs/reference/pygtk-gtkspinner.xml
@@ -5,7 +5,7 @@
 <refentry id="class-gtkspinner">
   <refnamediv>
     <refname>gtk.Spinner</refname>
-    <refpurpose></refpurpose>
+    <refpurpose>show a spinner animation (new in PyGTK 2.22)</refpurpose>
   </refnamediv>
 
   <refsect1>
@@ -43,6 +43,102 @@
   </refsect1>
 
   <refsect1>
+    <title>Implemented Interfaces</title>
+    <para>
+      <link linkend="class-gtkspinner"><classname>gtk.Spinner</classname></link>
+      implements
+      <link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
+      <link linkend="class-atkimplementor"><classname>atk.ImplementorIFace</classname></link>
+    </para>
+  </refsect1>
+
+  <refsect1 id="properties-gtkspinner">
+    <title>gtk.Spinner Properties</title>
+
+    <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
+    <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
+
+    <blockquote role="properties">
+      <informaltable pgwide="1" frame="none">
+        <tgroup cols="3">
+          <colspec column="1" colwidth="1in"/>
+          <colspec column="2" colwidth="1in"/>
+          <colspec column="3" colwidth="4in"/>
+          <tbody>
+            <row valign="top">
+              <entry>"active"</entry>
+              <entry>Read-Write</entry>
+              <entry>Whether the spinner is active.
+              Default value: <literal>False</literal>
+              This property is available in GTK+ 2.20 and above.</entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
+    </blockquote>
+
+  </refsect1>
+
+  <refsect1 id="style-properties-gtkspinner">
+    <title>gtk.Spinner Style Properties</title>
+
+    <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
+
+    <blockquote role="properties">
+      <informaltable pgwide="1" frame="none">
+        <tgroup cols="3">
+          <colspec column="1" colwidth="1in"/>
+          <colspec column="2" colwidth="1in"/>
+          <colspec column="3" colwidth="4in"/>
+          <tbody>
+            <row valign="top">
+              <entry>"cycle-duration"</entry>
+              <entry>Read</entry>
+              <entry>The duration in milliseconds for the spinner to complete a full cycle.
+              Allowed values: &gt;= 500
+              Default value: 1000
+              This property is available in GTK+ 2.20 and above.</entry>
+            </row>
+            <row valign="top">
+              <entry>"num-steps"</entry>
+              <entry>Read</entry>
+              <entry>The number of steps for the spinner to complete a full loop. The animation will complete a full cycle in one second by default (see the "cycle-duration" style property).
+              Allowed values: &gt;= 1
+              Default value: 12
+              This property is available in GTK+ 2.20 and above.</entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
+    </blockquote>
+
+  </refsect1>
+
+  <refsect1 id="signal-prototypes-gtkspinner">
+    <title>gtk.Spinner Signal Prototypes</title>
+
+    <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
+    <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
+    <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Description</title>
+
+    <note>
+      <para>This widget is available in PyGTK 2.22 and above.</para>
+    </note>
+
+    <para>A GtkSpinner widget displays an icon-size spinning animation. It is often used as an
+    alternative to a GtkProgressBar for displaying indefinite activity, instead of actual progress.</para>
+
+    <para>To start the animation, use <link linkend="method-gtkspinner--start"><methodname>start</methodname></link>(),
+    to stop it use <link linkend="method-gtkspinner--stop"><methodname>stop</methodname></link>().</para>
+
+  </refsect1>
+
+  <refsect1>
     <title>Constructor</title>
 
     <programlisting>