[pygtk] reference: pygtk-gtkbutton.xml: add missing (g|s)et_image_position methods



commit ddc90a0d2eb39435ba18f4d564893548f977907e
Author: Dieter Verfaillie <dieterv optionexplicit be>
Date:   Thu Feb 17 07:24:54 2011 +0100

    reference: pygtk-gtkbutton.xml: add missing (g|s)et_image_position methods

 docs/reference/ChangeLog           |    1 +
 docs/reference/pygtk-gtkbutton.xml |  191 +++++++++++++++++++++---------------
 2 files changed, 115 insertions(+), 77 deletions(-)
---
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 6fb9268..1c01297 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -4,6 +4,7 @@
 		* pygtk-gtkaccessible.xml: add new methods
 		* pygtk-gtkaction.xml: add new methods
 		* pygtk-gtkassistant.xml: add new commit method
+		* pygtk-gtkbutton.xml: add missing (g|s)et_image_position methods
 
 2011-01-12  Dieter Verfaillie  <dieterv optionexplicit be>
 
diff --git a/docs/reference/pygtk-gtkbutton.xml b/docs/reference/pygtk-gtkbutton.xml
index 9ade945..d255aa5 100644
--- a/docs/reference/pygtk-gtkbutton.xml
+++ b/docs/reference/pygtk-gtkbutton.xml
@@ -14,110 +14,97 @@ clicked.</refpurpose>
 
     <classsynopsis language="python">
       <ooclass><classname>gtk.Button</classname></ooclass>
-      <ooclass><classname><link
-linkend="class-gtkbin">gtk.Bin</link></classname></ooclass>
+      <ooclass><classname><link linkend="class-gtkbin">gtk.Bin</link></classname></ooclass>
       <constructorsynopsis language="python">
-	<methodname><link linkend="constructor-gtkbutton">gtk.Button</link></methodname>
-	<methodparam><parameter
-		       role="keyword">label</parameter><initializer>None</initializer></methodparam>
-	<methodparam><parameter
-		       role="keyword">stock</parameter><initializer>None</initializer></methodparam>
-	<methodparam><parameter
-		       role="keyword">use_underline</parameter><initializer>True</initializer></methodparam>
+        <methodname><link linkend="constructor-gtkbutton">gtk.Button</link></methodname>
+        <methodparam><parameter role="keyword">label</parameter><initializer>None</initializer></methodparam>
+        <methodparam><parameter role="keyword">stock</parameter><initializer>None</initializer></methodparam>
+        <methodparam><parameter role="keyword">use_underline</parameter><initializer>True</initializer></methodparam>
       </constructorsynopsis>
       <methodsynopsis language="python">
-	<methodname><link
-linkend="method-gtkbutton--pressed">pressed</link></methodname>
-	<methodparam></methodparam>  </methodsynopsis>
+        <methodname><link linkend="method-gtkbutton--pressed">pressed</link></methodname>
+        <methodparam></methodparam>
+      </methodsynopsis>
       <methodsynopsis language="python">
-	<methodname><link
-linkend="method-gtkbutton--released">released</link></methodname>
-	<methodparam></methodparam>  </methodsynopsis>
+        <methodname><link linkend="method-gtkbutton--released">released</link></methodname>
+        <methodparam></methodparam>
+      </methodsynopsis>
       <methodsynopsis language="python">
-	<methodname><link
-linkend="method-gtkbutton--clicked">clicked</link></methodname>
-	<methodparam></methodparam>  </methodsynopsis>
+        <methodname><link linkend="method-gtkbutton--clicked">clicked</link></methodname>
+        <methodparam></methodparam>
+      </methodsynopsis>
       <methodsynopsis language="python">
-	<methodname><link
-linkend="method-gtkbutton--enter">enter</link></methodname>
-	<methodparam></methodparam>  </methodsynopsis>
+      <methodname><link linkend="method-gtkbutton--enter">enter</link></methodname>
+        <methodparam></methodparam>
+      </methodsynopsis>
       <methodsynopsis language="python">
-	<methodname><link
-linkend="method-gtkbutton--leave">leave</link></methodname>
-	<methodparam></methodparam>  </methodsynopsis>
+        <methodname><link linkend="method-gtkbutton--leave">leave</link></methodname>
+        <methodparam></methodparam>
+      </methodsynopsis>
       <methodsynopsis language="python">
-	<methodname><link
-linkend="method-gtkbutton--set-relief">set_relief</link></methodname>
-	<methodparam><parameter
-		       role="keyword">newstyle</parameter></methodparam>
+        <methodname><link linkend="method-gtkbutton--set-relief">set_relief</link></methodname>
+        <methodparam><parameter role="keyword">newstyle</parameter></methodparam>
       </methodsynopsis>
       <methodsynopsis language="python">
-	<methodname><link
-linkend="method-gtkbutton--get-relief">get_relief</link></methodname>
-	<methodparam></methodparam>  </methodsynopsis>
+        <methodname><link linkend="method-gtkbutton--get-relief">get_relief</link></methodname>
+        <methodparam></methodparam>
+      </methodsynopsis>
       <methodsynopsis language="python">
-	<methodname><link
-linkend="method-gtkbutton--set-label">set_label</link></methodname>
-	<methodparam><parameter
-		       role="keyword">label</parameter></methodparam>
+        <methodname><link linkend="method-gtkbutton--set-label">set_label</link></methodname>
+        <methodparam><parameter role="keyword">label</parameter></methodparam>
       </methodsynopsis>
       <methodsynopsis language="python">
-	<methodname><link
-linkend="method-gtkbutton--get-label">get_label</link></methodname>
-	<methodparam></methodparam>  </methodsynopsis>
+        <methodname><link linkend="method-gtkbutton--get-label">get_label</link></methodname>
+        <methodparam></methodparam>
+      </methodsynopsis>
       <methodsynopsis language="python">
-	<methodname><link
-linkend="method-gtkbutton--set-use-underline">set_use_underline</link></methodname>
-	<methodparam><parameter
-		       role="keyword">use_underline</parameter></methodparam>
+        <methodname><link linkend="method-gtkbutton--set-use-underline">set_use_underline</link></methodname>
+        <methodparam><parameter role="keyword">use_underline</parameter></methodparam>
       </methodsynopsis>
       <methodsynopsis language="python">
-	<methodname><link
-linkend="method-gtkbutton--get-use-underline">get_use_underline</link></methodname>
-	<methodparam></methodparam>  </methodsynopsis>
+        <methodname><link linkend="method-gtkbutton--get-use-underline">get_use_underline</link></methodname>
+        <methodparam></methodparam>
+      </methodsynopsis>
       <methodsynopsis language="python">
-	<methodname><link
-linkend="method-gtkbutton--set-use-stock">set_use_stock</link></methodname>
-	<methodparam><parameter
-		       role="keyword">use_stock</parameter></methodparam>
+        <methodname><link linkend="method-gtkbutton--set-use-stock">set_use_stock</link></methodname>
+        <methodparam><parameter role="keyword">use_stock</parameter></methodparam>
       </methodsynopsis>
       <methodsynopsis language="python">
-	<methodname><link
-linkend="method-gtkbutton--get-use-stock">get_use_stock</link></methodname>
-	<methodparam></methodparam>  </methodsynopsis>
+        <methodname><link linkend="method-gtkbutton--get-use-stock">get_use_stock</link></methodname>
+        <methodparam></methodparam>
+      </methodsynopsis>
       <methodsynopsis language="python">
-	<methodname><link
-linkend="method-gtkbutton--set-focus-on-click">set_focus_on_click</link></methodname>
-	<methodparam><parameter
-		       role="keyword">focus_on_click</parameter></methodparam>
+        <methodname><link linkend="method-gtkbutton--set-focus-on-click">set_focus_on_click</link></methodname>
+        <methodparam><parameter role="keyword">focus_on_click</parameter></methodparam>
       </methodsynopsis>
       <methodsynopsis language="python">
-	<methodname><link
-linkend="method-gtkbutton--get-focus-on-click">get_focus_on_click</link></methodname>
-	<methodparam></methodparam>  </methodsynopsis>
+        <methodname><link linkend="method-gtkbutton--get-focus-on-click">get_focus_on_click</link></methodname>
+        <methodparam></methodparam>
+      </methodsynopsis>
       <methodsynopsis language="python">
-	<methodname><link
-linkend="method-gtkbutton--set-alignment">set_alignment</link></methodname>
-	<methodparam><parameter
-		       role="keyword">xalign</parameter></methodparam>
-	<methodparam><parameter
-		       role="keyword">yalign</parameter></methodparam>
+        <methodname><link linkend="method-gtkbutton--set-alignment">set_alignment</link></methodname>
+        <methodparam><parameter role="keyword">xalign</parameter></methodparam>
+        <methodparam><parameter role="keyword">yalign</parameter></methodparam>
       </methodsynopsis>
       <methodsynopsis language="python">
-	<methodname><link
-linkend="method-gtkbutton--get-alignment">get_alignment</link></methodname>
-	<methodparam></methodparam>
+        <methodname><link linkend="method-gtkbutton--get-alignment">get_alignment</link></methodname>
+        <methodparam></methodparam>
       </methodsynopsis>
       <methodsynopsis language="python">
-	<methodname><link
-linkend="method-gtkbutton--set-image">set_image</link></methodname>
-	<methodparam><parameter
-		       role="keyword">image</parameter></methodparam>
+        <methodname><link linkend="method-gtkbutton--set-image">set_image</link></methodname>
+        <methodparam><parameter role="keyword">image</parameter></methodparam>
+      </methodsynopsis>
+      <methodsynopsis language="python">
+        <methodname><link linkend="method-gtkbutton--get-image">get_image</link></methodname>
+        <methodparam></methodparam>
+      </methodsynopsis>
+      <methodsynopsis language="python">
+        <methodname><link linkend="method-gtkbutton--set-image-position">set_image_position</link></methodname>
+        <methodparam><parameter role="keyword">position</parameter></methodparam>
       </methodsynopsis>
       <methodsynopsis language="python">
-	<methodname><link
-linkend="method-gtkbutton--get-image">get_image</link></methodname>
-	<methodparam></methodparam>
+        <methodname><link linkend="method-gtkbutton--get-image-position">get_image_position</link></methodname>
+        <methodparam></methodparam>
       </methodsynopsis>
     </classsynopsis>
 
@@ -135,7 +122,7 @@ linkend="method-gtkbutton--get-image">get_image</link></methodname>
 </synopsis>
 
   </refsect1>
-  
+
   <refsect1>
 		<title>Implemented Interfaces</title>
 		<para>
@@ -994,6 +981,56 @@ method for more information.</para>
 
     </refsect2>
 
+   <refsect2 id="method-gtkbutton--set-image-position">
+      <title>gtk.Button.set_image_position</title>
+
+      <programlisting><methodsynopsis language="python">
+        <methodname>set_image_position</methodname>
+        <methodparam><parameter role="keyword">position</parameter></methodparam>
+      </methodsynopsis></programlisting>
+
+      <variablelist>
+        <varlistentry>
+          <term><parameter role="keyword">position</parameter>&nbsp;:</term>
+          <listitem><simpara>the position of the image relative to the text inside the button.</simpara></listitem>
+        </varlistentry>
+      </variablelist>
+
+      <note>
+        <para>This method is available in PyGTK 2.10 and above.</para>
+      </note>
+
+      <para>The <methodname>set_image_position</methodname>() method sets the
+      position of the image relative to the text inside the button. The value of
+      <parameter>position</parameter> can be one of the <xref linkend="gtk-position-type-constants"
+      endterm="gtk-position-type-constants-title"></xref>.</para>
+
+    </refsect2>
+
+    <refsect2 id="method-gtkbutton--get-image-position">
+      <title>gtk.Button.get_image_position</title>
+
+      <programlisting><methodsynopsis language="python">
+        <methodname>get_image_position</methodname>
+        <methodparam></methodparam>
+      </methodsynopsis></programlisting>
+
+      <variablelist>
+        <varlistentry>
+          <term><emphasis>Returns</emphasis>&nbsp;:</term>
+          <listitem><simpara>the position of the image relative to the text inside the button.</simpara></listitem>
+        </varlistentry>
+      </variablelist>
+
+      <note>
+        <para>This method is available in PyGTK 2.10 and above.</para>
+      </note>
+
+      <para>The <methodname>get_image_position</methodname>() method returns the
+      position of the image relative to the text inside the button.</para>
+
+    </refsect2>
+
   </refsect1>
 
   <refsect1>
@@ -1213,5 +1250,5 @@ matter where the pointer is.</para>
     </refsect2>
 
   </refsect1>
-      
+
 </refentry>



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]