[pygtk] reference: pygtk-gtktoolpalette.xml: add purpose, interfaces, properties and signals + update method

From: John Stowers <jstowers src gnome org>
To: commits-list gnome org
Cc:
Subject: [pygtk] reference: pygtk-gtktoolpalette.xml: add purpose, interfaces, properties and signals + update method
Date: Mon, 21 Mar 2011 02:10:15 +0000 (UTC)
commit 104b7c66947eea718ecde4c562c44eb995a3a054
Author: Dieter Verfaillie <dieterv optionexplicit be>
Date:   Wed Mar 16 13:43:58 2011 +0100

    reference: pygtk-gtktoolpalette.xml: add purpose, interfaces, properties and signals + update methods

 docs/reference/pygtk-gtktoolpalette.xml |  279 +++++++++++++++++++++++++++----
 1 files changed, 247 insertions(+), 32 deletions(-)
---
diff --git a/docs/reference/pygtk-gtktoolpalette.xml b/docs/reference/pygtk-gtktoolpalette.xml
index 96da38e..1b718c7 100644
--- a/docs/reference/pygtk-gtktoolpalette.xml
+++ b/docs/reference/pygtk-gtktoolpalette.xml
@@ -5,7 +5,7 @@
 <refentry id="class-gtktoolpalette">
   <refnamediv>
     <refname>gtk.ToolPalette</refname>
-    <refpurpose></refpurpose>
+    <refpurpose>a tool palette with categories (new in PyGTK 2.22)</refpurpose>
   </refnamediv>
 
   <refsect1>
@@ -119,6 +119,135 @@
   </refsect1>
 
   <refsect1>
+    <title>Implemented Interfaces</title>
+    <para>
+      <link linkend="class-gtktoolpalette"><classname>gtk.ToolPalette</classname></link>
+      implements
+      <link linkend="class-atkimplementor"><classname>atk.ImplementorIFace</classname></link>,
+      <link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>,
+    </para>
+  </refsect1>
+
+  <refsect1 id="properties-gtktoolpalette">
+    <title>gtk.ToolPalette 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>
+
+    <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>"icon-size"</entry>
+              <entry>Read-Write</entry>
+              <entry>Whether the group has been collapsed and items are hidden.
+              Default value: <literal>False</literal>.
+              This property is available in GTK+ 2.20 and above.</entry>
+            </row>
+            <row valign="top">
+              <entry>"icon-size-set"</entry>
+              <entry>Read-Write</entry>
+              <entry>Ellipsize for item group headers.
+              Default value: <literal>pango.ELLIPSIZE_NONE</literal>.
+              This property is available in GTK+ 2.20 and above.</entry>
+            </row>
+            <row valign="top">
+              <entry>"toolbar-style"</entry>
+              <entry>Read-Write</entry>
+              <entry>Relief of the group header button.
+              Default value: <literal>gtk.RELIEF_NORMAL</literal>.
+              This property is available in GTK+ 2.20 and above.</entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
+    </blockquote>
+
+  </refsect1>
+
+  <refsect1 id="child-properties-gtktoolpalette">
+    <title>gtk.ToolPalette Child Properties</title>
+
+    <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>"exclusive"</entry>
+              <entry>Read-Write</entry>
+              <entry>Whether the item should receive extra space when the group grows.
+              Default value: <literal>False</literal>.
+              This property is available in GTK+ 2.20 and above.</entry>
+            </row>
+            <row valign="top">
+              <entry>"expand"</entry>
+              <entry>Read-Write</entry>
+              <entry>Whether the item should fill the available space.
+              Default value: <literal>True</literal>.
+              This property is available in GTK+ 2.20 and above.</entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
+    </blockquote>
+
+  </refsect1>
+
+  <refsect1 id="style-properties-gtktoolpalette">
+    <title>gtk.ToolPalette Style Properties</title>
+
+    <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
+
+  </refsect1>
+
+  <refsect1 id="signal-prototypes-gtktoolpalette">
+    <title>gtk.ToolPalette 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>
+
+    <variablelist>
+      <varlistentry>
+        <term>"<link linkend="signal-gtktoolpalette--set-scroll-adjustments">set-scroll-adjustments</link>"</term>
+        <listitem>
+          <methodsynopsis language="python"><methodname>callback</methodname>
+            <methodparam><parameter>toolpalette</parameter></methodparam>
+            <methodparam><parameter>hadjustment</parameter></methodparam>
+            <methodparam><parameter>vadjustment</parameter></methodparam>
+            <methodparam><parameter>user_param1</parameter></methodparam>
+            <methodparam><parameter>...</parameter></methodparam>
+          </methodsynopsis>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Description</title>
+
+    <note>
+      <para>This widget is available in PyGTK 2.22 and above.</para>
+    </note>
+
+    <para>A <link linkend="class-gtktoolpalette"><classname>gtk.ToolPalette</classname></link>
+    is used together with <link linkend="class-gtktoolpalette"><classname>gtk.ToolPalette</classname></link>
+    to add <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> objects to
+    a palette like container with different categories and drag and drop support.</para>
+
+  </refsect1>
+
+  <refsect1>
     <title>Constructor</title>
 
     <programlisting>
@@ -133,13 +262,13 @@
         <listitem><simpara>a new <link linkend="class-gtktoolpalette"><classname>gtk.ToolPalette</classname></link></simpara></listitem>
       </varlistentry>
     </variablelist>
+
     <note>
       <para>This constructor is available in PyGTK 2.22 and above.</para>
     </note>
 
     <para>Creates a new tool palette.</para>
 
-
   </refsect1>
 
   <refsect1>
@@ -158,20 +287,22 @@
       <variablelist>
         <varlistentry>
           <term><parameter role="keyword">group</parameter>&nbsp;:</term>
-          <listitem><simpara>a <link linkend="class-gtktoolitemgroup"><classname>gtk.ToolItemGroup</classname></link> which is a child of palette</simpara></listitem>
+          <listitem><simpara>a <link linkend="class-gtktoolpalette"><classname>gtk.ToolPalette</classname></link> which is a child of palette</simpara></listitem>
         </varlistentry>
         <varlistentry>
           <term><parameter role="keyword">position</parameter>&nbsp;:</term>
           <listitem><simpara>a new index for group</simpara></listitem>
         </varlistentry>
       </variablelist>
+
       <note>
         <para>This method is available in PyGTK 2.22 and above.</para>
       </note>
 
       <para>The <methodname>set_group_position</methodname>() method sets the position of the group as an index of the tool palette.
-If position is 0 the group will become the first child, if position is
--1 it will become the last child.</para>
+      If position is 0 the group will become the first child, if position is
+      -1 it will become the last child.</para>
+
     </refsect2>
 
     <refsect2 id="method-gtktoolpalette--set-exclusive">
@@ -187,19 +318,21 @@ If position is 0 the group will become the first child, if position is
       <variablelist>
         <varlistentry>
           <term><parameter role="keyword">group</parameter>&nbsp;:</term>
-          <listitem><simpara>a <link linkend="class-gtktoolitemgroup"><classname>gtk.ToolItemGroup</classname></link> which is a child of palette</simpara></listitem>
+          <listitem><simpara>a <link linkend="class-gtktoolpalette"><classname>gtk.ToolPalette</classname></link> which is a child of palette</simpara></listitem>
         </varlistentry>
         <varlistentry>
           <term><parameter role="keyword">exclusive</parameter>&nbsp;:</term>
           <listitem><simpara>whether the group should be exclusive or not</simpara></listitem>
         </varlistentry>
       </variablelist>
+
       <note>
         <para>This method is available in PyGTK 2.22 and above.</para>
       </note>
 
       <para>Sets whether the group should be exclusive or not.
-If an exclusive group is expanded all other groups are collapsed.</para>
+      If an exclusive group is expanded all other groups are collapsed.</para>
+
     </refsect2>
 
     <refsect2 id="method-gtktoolpalette--set-expand">
@@ -215,18 +348,20 @@ If an exclusive group is expanded all other groups are collapsed.</para>
       <variablelist>
         <varlistentry>
           <term><parameter role="keyword">group</parameter>&nbsp;:</term>
-          <listitem><simpara>a <link linkend="class-gtktoolitemgroup"><classname>gtk.ToolItemGroup</classname></link> which is a child of palette</simpara></listitem>
+          <listitem><simpara>a <link linkend="class-gtktoolpalette"><classname>gtk.ToolPalette</classname></link> which is a child of palette</simpara></listitem>
         </varlistentry>
         <varlistentry>
           <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
           <listitem><simpara>whether the group should be given extra space</simpara></listitem>
         </varlistentry>
       </variablelist>
+
       <note>
         <para>This method is available in PyGTK 2.22 and above.</para>
       </note>
 
       <para>Sets whether the group should be given extra space.</para>
+
     </refsect2>
 
     <refsect2 id="method-gtktoolpalette--get-group-position">
@@ -241,19 +376,21 @@ If an exclusive group is expanded all other groups are collapsed.</para>
       <variablelist>
         <varlistentry>
           <term><parameter role="keyword">group</parameter>&nbsp;:</term>
-          <listitem><simpara>a <link linkend="class-gtktoolitemgroup"><classname>gtk.ToolItemGroup</classname></link></simpara></listitem>
+          <listitem><simpara>a <link linkend="class-gtktoolpalette"><classname>gtk.ToolPalette</classname></link></simpara></listitem>
         </varlistentry>
         <varlistentry>
           <term><emphasis>Returns</emphasis>&nbsp;:</term>
           <listitem><simpara>the index of group or -1 if <parameter>group</parameter> is not a child of <parameter>palette</parameter></simpara></listitem>
         </varlistentry>
       </variablelist>
+
       <note>
         <para>This method is available in PyGTK 2.22 and above.</para>
       </note>
 
       <para>Gets the position of <parameter>group</parameter> in <parameter>palette</parameter> as index.
-See <link linkend="method-gtktoolpalette--set-group-position"><methodname>gtk.ToolPalette.set_group_position</methodname></link>.</para>
+      See <link linkend="method-gtktoolpalette--set-group-position"><methodname>gtk.ToolPalette.set_group_position</methodname></link>.</para>
+
     </refsect2>
 
     <refsect2 id="method-gtktoolpalette--get-exclusive">
@@ -268,19 +405,21 @@ See <link linkend="method-gtktoolpalette--set-group-position"><methodname>gtk.To
       <variablelist>
         <varlistentry>
           <term><parameter role="keyword">group</parameter>&nbsp;:</term>
-          <listitem><simpara>a <link linkend="class-gtktoolitemgroup"><classname>gtk.ToolItemGroup</classname></link> which is a child of palette</simpara></listitem>
+          <listitem><simpara>a <link linkend="class-gtktoolpalette"><classname>gtk.ToolPalette</classname></link> which is a child of palette</simpara></listitem>
         </varlistentry>
         <varlistentry>
           <term><emphasis>Returns</emphasis>&nbsp;:</term>
-          <listitem><simpara><literal>TRUE</literal> if <parameter>group</parameter> is exclusive</simpara></listitem>
+          <listitem><simpara><literal>True</literal> if <parameter>group</parameter> is exclusive</simpara></listitem>
         </varlistentry>
       </variablelist>
+
       <note>
         <para>This method is available in PyGTK 2.22 and above.</para>
       </note>
 
       <para>Gets whether <parameter>group</parameter> is exclusive or not.
-See <link linkend="method-gtktoolpalette--set-exclusive"><methodname>gtk.ToolPalette.set_exclusive</methodname></link>.</para>
+      See <link linkend="method-gtktoolpalette--set-exclusive"><methodname>gtk.ToolPalette.set_exclusive</methodname></link>.</para>
+
     </refsect2>
 
     <refsect2 id="method-gtktoolpalette--get-expand">
@@ -295,19 +434,21 @@ See <link linkend="method-gtktoolpalette--set-exclusive"><methodname>gtk.ToolPal
       <variablelist>
         <varlistentry>
           <term><parameter role="keyword">group</parameter>&nbsp;:</term>
-          <listitem><simpara>a <link linkend="class-gtktoolitemgroup"><classname>gtk.ToolItemGroup</classname></link> which is a child of palette</simpara></listitem>
+          <listitem><simpara>a <link linkend="class-gtktoolpalette"><classname>gtk.ToolPalette</classname></link> which is a child of palette</simpara></listitem>
         </varlistentry>
         <varlistentry>
           <term><emphasis>Returns</emphasis>&nbsp;:</term>
-          <listitem><simpara><literal>TRUE</literal> if group should be given extra space, <literal>FALSE</literal> otherwise</simpara></listitem>
+          <listitem><simpara><literal>True</literal> if group should be given extra space, <literal>False</literal> otherwise</simpara></listitem>
         </varlistentry>
       </variablelist>
+
       <note>
         <para>This method is available in PyGTK 2.22 and above.</para>
       </note>
 
       <para>Gets whether group should be given extra space.
-See <link linkend="method-gtktoolpalette--set-expand"><methodname>gtk.ToolPalette.set_expand</methodname></link>.</para>
+      See <link linkend="method-gtktoolpalette--set-expand"><methodname>gtk.ToolPalette.set_expand</methodname></link>.</para>
+
     </refsect2>
 
     <refsect2 id="method-gtktoolpalette--set-icon-size">
@@ -322,14 +463,16 @@ See <link linkend="method-gtktoolpalette--set-expand"><methodname>gtk.ToolPalett
       <variablelist>
         <varlistentry>
           <term><parameter role="keyword">icon_size</parameter>&nbsp;:</term>
-          <listitem><simpara>the <literal>GtkIconSize</literal> that icons in the tool palette shall have</simpara></listitem>
+          <listitem><simpara>one of the <xref linkend="gtk-icon-size-constants" endterm="gtk-icon-size-constants-title"></xref> that icons in the tool palette shall have</simpara></listitem>
         </varlistentry>
       </variablelist>
+
       <note>
         <para>This method is available in PyGTK 2.22 and above.</para>
       </note>
 
       <para>The <methodname>set_icon_size</methodname>() method sets the size of icons in the tool palette.</para>
+
     </refsect2>
 
     <refsect2 id="method-gtktoolpalette--unset-icon-size">
@@ -341,12 +484,14 @@ See <link linkend="method-gtktoolpalette--set-expand"><methodname>gtk.ToolPalett
           <methodparam></methodparam>
         </methodsynopsis>
       </programlisting>
+
       <note>
         <para>This method is available in PyGTK 2.22 and above.</para>
       </note>
 
       <para>Unsets the tool palette icon size set with <link linkend="method-gtktoolpalette--set-icon-size"><methodname>gtk.ToolPalette.set_icon_size</methodname></link>,
-so that user preferences will be used to determine the icon size.</para>
+      so that user preferences will be used to determine the icon size.</para>
+
     </refsect2>
 
     <refsect2 id="method-gtktoolpalette--set-style">
@@ -361,14 +506,16 @@ so that user preferences will be used to determine the icon size.</para>
       <variablelist>
         <varlistentry>
           <term><parameter role="keyword">style</parameter>&nbsp;:</term>
-          <listitem><simpara>the <literal>GtkToolbarStyle</literal> that items in the tool palette shall have</simpara></listitem>
+          <listitem><simpara>one of the <xref linkend="gtk-toolbar-style-constants" endterm="gtk-toolbar-style-constants-title"></xref> that items in the tool palette shall have</simpara></listitem>
         </varlistentry>
       </variablelist>
+
       <note>
         <para>This method is available in PyGTK 2.22 and above.</para>
       </note>
 
       <para>The <methodname>set_style</methodname>() method sets the style (text, icons or both) of items in the tool palette.</para>
+
     </refsect2>
 
     <refsect2 id="method-gtktoolpalette--unset-style">
@@ -380,12 +527,14 @@ so that user preferences will be used to determine the icon size.</para>
           <methodparam></methodparam>
         </methodsynopsis>
       </programlisting>
+
       <note>
         <para>This method is available in PyGTK 2.22 and above.</para>
       </note>
 
       <para>Unsets a toolbar style set with <link linkend="method-gtktoolpalette--set-style"><methodname>gtk.ToolPalette.set_style</methodname></link>,
-so that user preferences will be used to determine the toolbar style.</para>
+      so that user preferences will be used to determine the toolbar style.</para>
+
     </refsect2>
 
     <refsect2 id="method-gtktoolpalette--get-icon-size">
@@ -400,15 +549,17 @@ so that user preferences will be used to determine the toolbar style.</para>
       <variablelist>
         <varlistentry>
           <term><emphasis>Returns</emphasis>&nbsp;:</term>
-          <listitem><simpara>the <literal>GtkIconSize</literal> of icons in the tool palette</simpara></listitem>
+          <listitem><simpara>one of the <xref linkend="gtk-icon-size-constants" endterm="gtk-icon-size-constants-title"></xref></simpara></listitem>
         </varlistentry>
       </variablelist>
+
       <note>
         <para>This method is available in PyGTK 2.22 and above.</para>
       </note>
 
       <para>Gets the size of icons in the tool palette.
-See <link linkend="method-gtktoolpalette--set-icon-size"><methodname>gtk.ToolPalette.set_icon_size</methodname></link>.</para>
+      See <link linkend="method-gtktoolpalette--set-icon-size"><methodname>gtk.ToolPalette.set_icon_size</methodname></link>.</para>
+
     </refsect2>
 
     <refsect2 id="method-gtktoolpalette--get-style">
@@ -423,14 +574,16 @@ See <link linkend="method-gtktoolpalette--set-icon-size"><methodname>gtk.ToolPal
       <variablelist>
         <varlistentry>
           <term><emphasis>Returns</emphasis>&nbsp;:</term>
-          <listitem><simpara>the <literal>GtkToolbarStyle</literal> of items in the tool palette.</simpara></listitem>
+          <listitem><simpara>one of the <xref linkend="gtk-toolbar-style-constants" endterm="gtk-toolbar-style-constants-title"></xref></simpara></listitem>
         </varlistentry>
       </variablelist>
+
       <note>
         <para>This method is available in PyGTK 2.22 and above.</para>
       </note>
 
       <para>Gets the style (icons, text or both) of items in the tool palette.</para>
+
     </refsect2>
 
     <refsect2 id="method-gtktoolpalette--get-drop-item">
@@ -454,15 +607,17 @@ See <link linkend="method-gtktoolpalette--set-icon-size"><methodname>gtk.ToolPal
         </varlistentry>
         <varlistentry>
           <term><emphasis>Returns</emphasis>&nbsp;:</term>
-          <listitem><simpara>the <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> at position or <literal>NULL</literal> if there is no such item</simpara></listitem>
+          <listitem><simpara>the <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> at position or <literal>None</literal> if there is no such item</simpara></listitem>
         </varlistentry>
       </variablelist>
+
       <note>
         <para>This method is available in PyGTK 2.22 and above.</para>
       </note>
 
       <para>Gets the item at position (x, y).
-See <link linkend="method-gtktoolpalette--get-drop-group"><methodname>gtk.ToolPalette.get_drop_group</methodname></link>.</para>
+      See <link linkend="method-gtktoolpalette--get-drop-group"><methodname>gtk.ToolPalette.get_drop_group</methodname></link>.</para>
+
     </refsect2>
 
     <refsect2 id="method-gtktoolpalette--get-drop-group">
@@ -486,14 +641,16 @@ See <link linkend="method-gtktoolpalette--get-drop-group"><methodname>gtk.ToolPa
         </varlistentry>
         <varlistentry>
           <term><emphasis>Returns</emphasis>&nbsp;:</term>
-          <listitem><simpara>the <link linkend="class-gtktoolitemgroup"><classname>gtk.ToolItemGroup</classname></link> at position or <literal>NULL</literal> if there is no such group</simpara></listitem>
+          <listitem><simpara>the <link linkend="class-gtktoolpalette"><classname>gtk.ToolPalette</classname></link> at position or <literal>None</literal> if there is no such group</simpara></listitem>
         </varlistentry>
       </variablelist>
+
       <note>
         <para>This method is available in PyGTK 2.22 and above.</para>
       </note>
 
       <para>Gets the group at position (x, y).</para>
+
     </refsect2>
 
     <refsect2 id="method-gtktoolpalette--get-drag-item">
@@ -515,12 +672,14 @@ See <link linkend="method-gtktoolpalette--get-drop-group"><methodname>gtk.ToolPa
           <listitem><simpara>the dragged item in selection</simpara></listitem>
         </varlistentry>
       </variablelist>
+
       <note>
         <para>This method is available in PyGTK 2.22 and above.</para>
       </note>
 
       <para>Get the dragged item from the selection.
-This could be a <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> or a <link linkend="class-gtktoolitemgroup"><classname>gtk.ToolItemGroup</classname></link>.</para>
+      This could be a <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> or a <link linkend="class-gtktoolpalette"><classname>gtk.ToolPalette</classname></link>.</para>
+
     </refsect2>
 
     <refsect2 id="method-gtktoolpalette--set-drag-source">
@@ -538,14 +697,16 @@ This could be a <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</class
           <listitem><simpara>the <literal>GtkToolPaletteDragTarget</literal><!-- -->s which the widget should support</simpara></listitem>
         </varlistentry>
       </variablelist>
+
       <note>
         <para>This method is available in PyGTK 2.22 and above.</para>
       </note>
 
       <para>The <methodname>set_drag_source</methodname>() method sets the tool palette as a drag source.
-Enables all groups and items in the tool palette as drag sources
-on button 1 and button 3 press with copy and move actions.
-See <link linkend="method-gtkwidget--drag-source-set"><methodname>gtk.Widget.drag_source_set</methodname></link>.</para>
+      Enables all groups and items in the tool palette as drag sources
+      on button 1 and button 3 press with copy and move actions.
+      See <link linkend="method-gtkwidget--drag-source-set"><methodname>gtk.Widget.drag_source_set</methodname></link>.</para>
+
     </refsect2>
 
     <refsect2 id="method-gtktoolpalette--add-drag-dest">
@@ -578,13 +739,15 @@ See <link linkend="method-gtkwidget--drag-source-set"><methodname>gtk.Widget.dra
           <listitem><simpara>the <literal>GdkDragAction</literal><!-- -->s which the widget should suppport</simpara></listitem>
         </varlistentry>
       </variablelist>
+
       <note>
         <para>This method is available in PyGTK 2.22 and above.</para>
       </note>
 
       <para>Sets <parameter>palette</parameter> as drag source (see <link linkend="method-gtktoolpalette--set-drag-source"><methodname>gtk.ToolPalette.set_drag_source</methodname></link>)
-and sets <parameter>widget</parameter> as a drag destination for drags from <parameter>palette</parameter>.
-See <link linkend="method-gtkwidget--drag-dest-set"><methodname>gtk.Widget.drag_dest_set</methodname></link>.</para>
+      and sets <parameter>widget</parameter> as a drag destination for drags from <parameter>palette</parameter>.
+      See <link linkend="method-gtkwidget--drag-dest-set"><methodname>gtk.Widget.drag_dest_set</methodname></link>.</para>
+
     </refsect2>
 
     <refsect2 id="method-gtktoolpalette--get-hadjustment">
@@ -602,11 +765,13 @@ See <link linkend="method-gtkwidget--drag-dest-set"><methodname>gtk.Widget.drag_
           <listitem><simpara>the horizontal adjustment of <parameter>palette</parameter></simpara></listitem>
         </varlistentry>
       </variablelist>
+
       <note>
         <para>This method is available in PyGTK 2.22 and above.</para>
       </note>
 
       <para>Gets the horizontal adjustment of the tool palette.</para>
+
     </refsect2>
 
     <refsect2 id="method-gtktoolpalette--get-vadjustment">
@@ -624,13 +789,63 @@ See <link linkend="method-gtkwidget--drag-dest-set"><methodname>gtk.Widget.drag_
           <listitem><simpara>the vertical adjustment of <parameter>palette</parameter></simpara></listitem>
         </varlistentry>
       </variablelist>
+
       <note>
         <para>This method is available in PyGTK 2.22 and above.</para>
       </note>
 
       <para>Gets the vertical adjustment of the tool palette.</para>
+
     </refsect2>
 
   </refsect1>
 
+  <refsect1>
+    <title>Signals</title>
+
+    <refsect2 id="signal-gtktoolpalette--set-scroll-adjustments">
+      <title>The "set-scroll-adjustments" gtk.ToolPalette Signal</title>
+
+      <programlisting><methodsynopsis language="python">
+        <methodname>callback</methodname>
+        <methodparam><parameter>toolpalette</parameter></methodparam>
+        <methodparam><parameter>hadjustment </parameter></methodparam>
+        <methodparam><parameter>vadjustment </parameter></methodparam>
+        <methodparam><parameter>user_param1</parameter></methodparam>
+        <methodparam><parameter>...</parameter></methodparam>
+      </methodsynopsis></programlisting>
+
+      <variablelist>
+        <varlistentry>
+          <term><parameter>toolpalette</parameter>&nbsp;:</term>
+          <listitem><simpara>the toolpalette that received the signal</simpara></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><parameter>hadjustment</parameter>&nbsp;:</term>
+          <listitem><simpara>the horizontal adjustment</simpara></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><parameter>vadjustment</parameter>&nbsp;:</term>
+          <listitem><simpara>the vertical adjustment</simpara></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><parameter>user_param1</parameter>&nbsp;:</term>
+          <listitem><simpara>the first user parameter (if any) specified with the <link linkend="method-gobject--connect"><methodname>connect</methodname>()</link> method</simpara></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><parameter>...</parameter>&nbsp;:</term>
+          <listitem><simpara>additional user parameters (if any)</simpara></listitem>
+        </varlistentry>
+      </variablelist>
+
+      <note>
+        <para>This signal is available in GTK+ 2.20 and above.</para>
+      </note>
+
+      <para>The "set-scroll-adjustments" signal is emitted when one or both
+      adjustments (specified by <parameter>hadjustment</parameter> and
+      <parameter>vadjustment</parameter>) are set on textview.</para>
+
+    </refsect2>
+  </refsect1>
 </refentry>
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]