Add new gtk.VolumeButton() docs.

svn path=/trunk/; revision=2871

4 files changed, 117 insertions, 7 deletions

diff --git a/docs/Makefile.am b/docs/Makefile.am
index 4cf6f719..e8c68d1a 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -241,15 +241,16 @@ XMLFILES = 						\
 	reference/pygtk-gtkuimanager.xml		\
 	reference/pygtk-gtkvbox.xml			\
 	reference/pygtk-gtkvbuttonbox.xml		\
-	reference/pygtk-gtkwidget.xml			\
 	reference/pygtk-gtkviewport.xml			\
-	reference/pygtk-gtkwindowgroup.xml		\
-	reference/pygtk-gtkwindow.xml			\
+	reference/pygtk-gtkvolumebutton.xml		\
 	reference/pygtk-gtkvpaned.xml			\
 	reference/pygtk-gtkvruler.xml			\
 	reference/pygtk-gtkvscale.xml			\
 	reference/pygtk-gtkvscrollbar.xml		\
 	reference/pygtk-gtkvseparator.xml		\
+	reference/pygtk-gtkwidget.xml			\
+	reference/pygtk-gtkwindowgroup.xml		\
+	reference/pygtk-gtkwindow.xml			\
 	reference/pygtk-hierarchy.xml			\
 	reference/pygtk-introduction.xml		\
 	reference/pygtk-pangoattribute.xml		\
@@ -514,15 +515,16 @@ HTML_FILES =						\
 	html/class-gtkuimanager.html			\
 	html/class-gtkvbox.html				\
 	html/class-gtkvbuttonbox.html			\
-	html/class-gtkwidget.html			\
 	html/class-gtkviewport.html			\
-	html/class-gtkwindowgroup.html			\
-	html/class-gtkwindow.html			\
+	html/class-gtkvolumebutton.html			\
 	html/class-gtkvpaned.html			\
 	html/class-gtkvruler.html			\
 	html/class-gtkvscale.html			\
 	html/class-gtkvscrollbar.html			\
 	html/class-gtkvseparator.html			\
+	html/class-gtkwidget.html			\
+	html/class-gtkwindowgroup.html			\
+	html/class-gtkwindow.html			\
 	html/class-hierarchy.html			\
 	html/class-pangoattribute.html			\
 	html/class-pangoattriterator.html		\
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 34ce731c..b222c175 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,4 +1,9 @@
-2007-07-29  Gian Mario Tagliaretti  <gianmt@gnome.org>
+2007-08-05  Gian Mario Tagliaretti  <gianmt@gnome.org>
+
+	* pygtk-gtkvolumebutton.xml:
+	* pygtk-gtk-classes.xml: Add new gtk.VolumeButton() docs.
+
+2007-08-04  Gian Mario Tagliaretti  <gianmt@gnome.org>
 
 	* pygtk-gtkiconview.xml: Update with 2.12 API.
 
diff --git a/docs/reference/pygtk-gtk-classes.xml b/docs/reference/pygtk-gtk-classes.xml
index b5e25972..5fbf3fe4 100644
--- a/docs/reference/pygtk-gtk-classes.xml
+++ b/docs/reference/pygtk-gtk-classes.xml
@@ -179,6 +179,7 @@
   <xi:include href="pygtk-gtkuimanager.xml"/>
   <xi:include href="pygtk-gtkvbox.xml"/>
   <xi:include href="pygtk-gtkvbuttonbox.xml"/>
+  <xi:include href="pygtk-gtkvolumebutton.xml"/>
   <xi:include href="pygtk-gtkvpaned.xml"/>
   <xi:include href="pygtk-gtkvruler.xml"/>
   <xi:include href="pygtk-gtkvscale.xml"/>
diff --git a/docs/reference/pygtk-gtkvolumebutton.xml b/docs/reference/pygtk-gtkvolumebutton.xml
new file mode 100644
index 00000000..2288744d
--- /dev/null
+++ b/docs/reference/pygtk-gtkvolumebutton.xml
@@ -0,0 +1,102 @@
+<?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-gtkvolumebutton">
+    <refnamediv>
+        <refname>gtk.VolumeButton</refname>
+        <refpurpose>A button which pops up a volume control (new in PyGTK 2.12)</refpurpose>
+    </refnamediv>
+
+    <refsect1>
+        <title>Synopsis</title>
+
+    <classsynopsis language="python">
+        <ooclass><classname>gtk.VolumeButton</classname></ooclass>
+        <ooclass><classname><link linkend="class-gtkscalebutton">gtk.ScaleButton</link></classname></ooclass>
+    <constructorsynopsis language="python">
+        <methodname><link linkend="constructor-gtkvolumebutton">gtk.VolumeButton</link></methodname>
+        <methodparam></methodparam>
+    </constructorsynopsis>
+
+    </classsynopsis>
+    </refsect1>
+
+    <refsect1>
+        <title>Ancestry</title>
+
+<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+  +-- <link linkend="class-gtkobject">gtk.Object</link>
+    +-- <link linkend="class-gtkwidget">gtk.Widget</link>
+      +-- <link linkend="class-gtkcontainer">gtk.Container</link>
+        +-- <link linkend="class-gtkbin">gtk.Bin</link>
+          +-- <link linkend="class-gtkbutton">gtk.Button</link>
+            +-- <link linkend="class-gtkscalebutton">gtk.ScaleButton</link>
+              +-- <link linkend="class-gtkvolumebutton">gtk.VolumeButton</link>
+</synopsis>
+
+    </refsect1>
+
+    <refsect1 id="properties-gtkvolumebutton">
+        <title>gtk.VolumeButton Properties</title>
+    
+        <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
+        <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
+        <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
+        <para><link linkend="properties-gtkbutton">gtk.Button Properties</link></para>
+        <para><link linkend="properties-gtkscalebutton">gtk.ScaleButton Properties</link></para>
+    </refsect1>
+
+    <refsect1 id="style-properties-gtkscalebutton">
+        <title>gtk.VolumeButton Style Properties</title>
+
+        <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
+        <para><link linkend="style-properties-gtkbutton">gtk.Button Style Properties</link></para>
+
+    </refsect1>
+    
+    <refsect1 id="signal-prototypes-gtkscalebutton">
+        <title>gtk.VolumeButton 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>
+        <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
+        <para><link linkend="signal-prototypes-gtkbutton">gtk.Button Signal Prototypes</link></para>
+        <para><link linkend="signal-prototypes-gtkscalebutton">gtk.ScaleButton Signal Prototypes</link></para>
+    </refsect1>
+
+    <refsect1>
+        <title>Description</title>
+            <para>
+                <link linkend="class-gtkvolumebutton"><classname>gtk.VolumeButton</classname></link>
+                is a subclass of
+                <link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>
+                that has been tailored for use as a volume control widget with suitable icons,
+                tooltips and accessible labels.
+            </para>
+    </refsect1>
+
+    <refsect1 id="constructor-gtkvolumebutton">
+        <title>Constructor</title>
+
+        <programlisting><constructorsynopsis language="python">
+            <methodname>gtk.VolumeButton</methodname>
+            <methodparam></methodparam>
+        </constructorsynopsis></programlisting>
+
+        <variablelist>
+        </variablelist>
+
+        <note>
+            <para>This constructor is available in PyGTK 2.12 and above.</para>
+        </note>
+
+        <para>
+            Creates a <link linkend="class-gtkvolumebutton"><classname>gtk.VolumeButton</classname></link>,
+            with a range between 0 and 100, with a stepping of 2. Volume values can be obtained and
+            modified using the functions from
+            <link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>
+        </para>
+    </refsect1>
+</refentry>