[pygtk] reference: add gtk.InfoBar, gtk.OffscreenWindow, gtk.Spinner, gtk.ToolItemGroup and gtk.ToolPalette
- From: Dieter Verfaillie <dieterv src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [pygtk] reference: add gtk.InfoBar, gtk.OffscreenWindow, gtk.Spinner, gtk.ToolItemGroup and gtk.ToolPalette
- Date: Thu, 10 Mar 2011 21:19:42 +0000 (UTC)
commit 7603bd8fe43f180cb5c90897814ff647f0cf22b5
Author: Dieter Verfaillie <dieterv optionexplicit be>
Date: Thu Mar 10 21:48:14 2011 +0100
reference: add gtk.InfoBar, gtk.OffscreenWindow, gtk.Spinner, gtk.ToolItemGroup and gtk.ToolPalette skeleton xml files
docs/Makefile.am | 10 +
docs/reference/pygtk-gtk-classes.xml | 5 +
docs/reference/pygtk-gtkinfobar.xml | 370 ++++++++++++++++
docs/reference/pygtk-gtkoffscreenwindow.xml | 128 ++++++
docs/reference/pygtk-gtkspinner.xml | 106 +++++
docs/reference/pygtk-gtktoolitemgroup.xml | 521 ++++++++++++++++++++++
docs/reference/pygtk-gtktoolpalette.xml | 636 +++++++++++++++++++++++++++
7 files changed, 1776 insertions(+), 0 deletions(-)
---
diff --git a/docs/Makefile.am b/docs/Makefile.am
index cfa90ad..fbff999 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -152,6 +152,7 @@ XMLFILES = \
reference/pygtk-gtkimcontextsimple.xml \
reference/pygtk-gtkimcontext.xml \
reference/pygtk-gtkimmulticontext.xml \
+ reference/pygtk-gtkinfobar.xml \
reference/pygtk-gtkinputdialog.xml \
reference/pygtk-gtkinvisible.xml \
reference/pygtk-gtkitemfactory.xml \
@@ -170,6 +171,7 @@ XMLFILES = \
reference/pygtk-gtkmountoperation.xml \
reference/pygtk-gtknotebook.xml \
reference/pygtk-gtkobject.xml \
+ reference/pygtk-gtkoffscreenwindow.xml \
reference/pygtk-gtkoptionmenu.xml \
reference/pygtk-gtkpagesetupunixdialog.xml \
reference/pygtk-gtkpagesetup.xml \
@@ -212,6 +214,7 @@ XMLFILES = \
reference/pygtk-gtksizegroup.xml \
reference/pygtk-gtksocket.xml \
reference/pygtk-gtkspinbutton.xml \
+ reference/pygtk-gtkspinner.xml \
reference/pygtk-gtkstatusbar.xml \
reference/pygtk-gtkstatusicon.xml \
reference/pygtk-gtk-stock-items.xml \
@@ -232,6 +235,8 @@ XMLFILES = \
reference/pygtk-gtktoolbar.xml \
reference/pygtk-gtktoolbutton.xml \
reference/pygtk-gtktoolitem.xml \
+ reference/pygtk-gtktoolitemgroup.xml \
+ reference/pygtk-gtktoolpalette.xml \
reference/pygtk-gtktoolshell.xml \
reference/pygtk-gtktooltip.xml \
reference/pygtk-gtktooltips.xml \
@@ -436,6 +441,7 @@ HTML_FILES = \
html/class-gtkimcontext.html \
html/class-gtkimcontextsimple.html \
html/class-gtkimmulticontext.html \
+ html/class-gtkinfobar.html \
html/class-gtkinputdialog.html \
html/class-gtkinvisible.html \
html/class-gtkitemfactory.html \
@@ -454,6 +460,7 @@ HTML_FILES = \
html/class-gtkmountoperation.html \
html/class-gtknotebook.html \
html/class-gtkobject.html \
+ html/class-gtkoffscreenwindow.html \
html/class-gtkoptionmenu.html \
html/class-gtkpagesetup.html \
html/class-gtkpagesetupunixdialog.html \
@@ -496,6 +503,7 @@ HTML_FILES = \
html/class-gtksizegroup.html \
html/class-gtksocket.html \
html/class-gtkspinbutton.html \
+ html/class-gtkspinner.html \
html/class-gtkstatusbar.html \
html/class-gtkstatusicon.html \
html/class-gtkstyle.html \
@@ -515,6 +523,8 @@ HTML_FILES = \
html/class-gtktoolbar.html \
html/class-gtktoolbutton.html \
html/class-gtktoolitem.html \
+ html/class-gtktoolitemgroup.html \
+ html/class-gtktoolpalette.html \
html/class-gtktoolshell.html \
html/class-gtktooltip.html \
html/class-gtktooltips.html \
diff --git a/docs/reference/pygtk-gtk-classes.xml b/docs/reference/pygtk-gtk-classes.xml
index 4b11f2b..5901280 100644
--- a/docs/reference/pygtk-gtk-classes.xml
+++ b/docs/reference/pygtk-gtk-classes.xml
@@ -92,6 +92,7 @@
<xi:include href="pygtk-gtkimcontext.xml"/>
<xi:include href="pygtk-gtkimcontextsimple.xml"/>
<xi:include href="pygtk-gtkimmulticontext.xml"/>
+ <xi:include href="pygtk-gtkinfobar.xml"/>
<xi:include href="pygtk-gtkinputdialog.xml"/>
<xi:include href="pygtk-gtkinvisible.xml"/>
<xi:include href="pygtk-gtkitem.xml"/>
@@ -110,6 +111,7 @@
<xi:include href="pygtk-gtkmountoperation.xml"/>
<xi:include href="pygtk-gtknotebook.xml"/>
<xi:include href="pygtk-gtkobject.xml"/>
+ <xi:include href="pygtk-gtkoffscreenwindow.xml"/>
<xi:include href="pygtk-gtkoptionmenu.xml"/>
<xi:include href="pygtk-gtkpagesetup.xml"/>
<xi:include href="pygtk-gtkpaned.xml"/>
@@ -148,6 +150,7 @@
<xi:include href="pygtk-gtksizegroup.xml"/>
<xi:include href="pygtk-gtksocket.xml"/>
<xi:include href="pygtk-gtkspinbutton.xml"/>
+ <xi:include href="pygtk-gtkspinner.xml"/>
<xi:include href="pygtk-gtkstatusbar.xml"/>
<xi:include href="pygtk-gtkstatusicon.xml"/>
<xi:include href="pygtk-gtkstyle.xml"/>
@@ -167,6 +170,8 @@
<xi:include href="pygtk-gtktoolbar.xml"/>
<xi:include href="pygtk-gtktoolbutton.xml"/>
<xi:include href="pygtk-gtktoolitem.xml"/>
+ <xi:include href="pygtk-gtktoolitemgroup.xml"/>
+ <xi:include href="pygtk-gtktoolpalette.xml"/>
<xi:include href="pygtk-gtktoolshell.xml"/>
<xi:include href="pygtk-gtktooltip.xml"/>
<xi:include href="pygtk-gtktooltips.xml"/>
diff --git a/docs/reference/pygtk-gtkinfobar.xml b/docs/reference/pygtk-gtkinfobar.xml
new file mode 100644
index 0000000..7109a77
--- /dev/null
+++ b/docs/reference/pygtk-gtkinfobar.xml
@@ -0,0 +1,370 @@
+<?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-gtkinfobar">
+ <refnamediv>
+ <refname>gtk.InfoBar</refname>
+ <refpurpose></refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Synopsis</title>
+
+ <classsynopsis language="python">
+ <ooclass><classname>gtk.InfoBar</classname></ooclass>
+ <ooclass><classname><link linkend="class-gtkhbox">gtk.HBox</link></classname></ooclass>
+ <constructorsynopsis language="python">
+ <methodname><link linkend="constructor-gtkinfobar">gtk.InfoBar</link></methodname>
+ <methodparam></methodparam>
+ </constructorsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkinfobar--get-action-area">get_action_area</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkinfobar--get-content-area">get_content_area</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkinfobar--add-action-widget">add_action_widget</link></methodname>
+ <methodparam><parameter role="keyword">child</parameter></methodparam>
+ <methodparam><parameter role="keyword">response_id</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkinfobar--add-button">add_button</link></methodname>
+ <methodparam><parameter role="keyword">button_text</parameter></methodparam>
+ <methodparam><parameter role="keyword">response_id</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkinfobar--add-buttons">add_buttons</link></methodname>
+ <methodparam><parameter role="keyword">first_button_text</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkinfobar--set-response-sensitive">set_response_sensitive</link></methodname>
+ <methodparam><parameter role="keyword">response_id</parameter></methodparam>
+ <methodparam><parameter role="keyword">setting</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkinfobar--set-default-response">set_default_response</link></methodname>
+ <methodparam><parameter role="keyword">response_id</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkinfobar--response">response</link></methodname>
+ <methodparam><parameter role="keyword">response_id</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkinfobar--set-message-type">set_message_type</link></methodname>
+ <methodparam><parameter role="keyword">message_type</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkinfobar--get-message-type">get_message_type</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-gtkcontainer">gtk.Container</link>
+ +-- <link linkend="class-gtkbox">gtk.Box</link>
+ +-- <link linkend="class-gtkhbox">gtk.HBox</link>
+ +-- <link linkend="class-gtkinfobar">gtk.InfoBar</link>
+</synopsis>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Constructor</title>
+
+ <programlisting>
+ <constructorsynopsis language="python">
+ <methodname><link linkend="constructor-gtkinfobar">gtk.InfoBar</link></methodname>
+ <methodparam></methodparam>
+ </constructorsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a new <link linkend="class-gtkinfobar"><classname>gtk.InfoBar</classname></link> object</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This constructor is available in PyGTK 2.18 and above.</para>
+ </note>
+
+ <para>Creates a new <link linkend="class-gtkinfobar"><classname>gtk.InfoBar</classname></link> object.</para>
+
+
+ </refsect1>
+
+ <refsect1>
+ <title>Methods</title>
+
+ <refsect2 id="method-gtkinfobar--get-action-area">
+ <title>gtk.InfoBar.get_action_area</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_action_area</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the action area</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.18 and above.</para>
+ </note>
+
+ <para>The <methodname>get_action_area</methodname>() method returns the action area of <parameter>info_bar</parameter>.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtkinfobar--get-content-area">
+ <title>gtk.InfoBar.get_content_area</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_content_area</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the content area</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.18 and above.</para>
+ </note>
+
+ <para>The <methodname>get_content_area</methodname>() method returns the content area of <parameter>info_bar</parameter>.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtkinfobar--add-action-widget">
+ <title>gtk.InfoBar.add_action_widget</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>add_action_widget</methodname>
+ <methodparam><parameter role="keyword">child</parameter></methodparam>
+ <methodparam><parameter role="keyword">response_id</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">child</parameter> :</term>
+ <listitem><simpara>an activatable widget</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">response_id</parameter> :</term>
+ <listitem><simpara>response ID for <parameter>child</parameter></simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.18 and above.</para>
+ </note>
+
+ <para>Add an activatable widget to the action area of a <link linkend="class-gtkinfobar"><classname>gtk.InfoBar</classname></link>,
+connecting a signal handler that will emit the <link linkend="class-gtkinfobar"><classname>gtk.InfoBar</classname></link>::response
+signal on the message area when the widget is activated. The widget
+is appended to the end of the message areas action area.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtkinfobar--add-button">
+ <title>gtk.InfoBar.add_button</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>add_button</methodname>
+ <methodparam><parameter role="keyword">button_text</parameter></methodparam>
+ <methodparam><parameter role="keyword">response_id</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">button_text</parameter> :</term>
+ <listitem><simpara>text of button, or stock ID</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">response_id</parameter> :</term>
+ <listitem><simpara>response ID for the button</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the button widget that was added</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.18 and above.</para>
+ </note>
+
+ <para>Adds a button with the given text (or a stock button, if button_text
+is a stock ID) and sets things up so that clicking the button will emit
+the "response" signal with the given response_id. The button is appended
+to the end of the info bars's action area. The button widget is
+returned, but usually you don't need it.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtkinfobar--add-buttons">
+ <title>gtk.InfoBar.add_buttons</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>add_buttons</methodname>
+ <methodparam><parameter role="keyword">first_button_text</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">first_button_text</parameter> :</term>
+ <listitem><simpara>button text or stock ID</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.18 and above.</para>
+ </note>
+
+ <para>Adds more buttons, same as calling <link linkend="method-gtkinfobar--add-button"><methodname>gtk.InfoBar.add_button</methodname></link>
+repeatedly. The variable argument list should be <literal>NULL</literal>-terminated
+as with <function>gtk_info_bar_new_with_buttons()</function>. Each button must have both
+text and response ID.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtkinfobar--set-response-sensitive">
+ <title>gtk.InfoBar.set_response_sensitive</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>set_response_sensitive</methodname>
+ <methodparam><parameter role="keyword">response_id</parameter></methodparam>
+ <methodparam><parameter role="keyword">setting</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">response_id</parameter> :</term>
+ <listitem><simpara>a response ID</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">setting</parameter> :</term>
+ <listitem><simpara>TRUE for sensitive</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.18 and above.</para>
+ </note>
+
+ <para>Calls gtk_widget_set_sensitive (widget, setting) for each
+widget in the info bars's action area with the given response_id.
+A convenient way to sensitize/desensitize dialog buttons.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtkinfobar--set-default-response">
+ <title>gtk.InfoBar.set_default_response</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>set_default_response</methodname>
+ <methodparam><parameter role="keyword">response_id</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">response_id</parameter> :</term>
+ <listitem><simpara>a response ID</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.18 and above.</para>
+ </note>
+
+ <para>The <methodname>set_default_response</methodname>() method sets the last widget in the info bar's action area with
+the given response_id as the default widget for the dialog.
+Pressing "Enter" normally activates the default widget.
+ </para>
+ <para>
+Note that this function currently requires <parameter>info_bar</parameter> to
+be added to a widget hierarchy.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtkinfobar--response">
+ <title>gtk.InfoBar.response</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>response</methodname>
+ <methodparam><parameter role="keyword">response_id</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">response_id</parameter> :</term>
+ <listitem><simpara>a response ID</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.18 and above.</para>
+ </note>
+
+ <para>Emits the 'response' signal with the given <parameter>response_id</parameter>.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtkinfobar--set-message-type">
+ <title>gtk.InfoBar.set_message_type</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>set_message_type</methodname>
+ <methodparam><parameter role="keyword">message_type</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">message_type</parameter> :</term>
+ <listitem><simpara>a <literal>GtkMessageType</literal></simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.18 and above.</para>
+ </note>
+
+ <para>The <methodname>set_message_type</methodname>() method sets the message type of the message area.
+GTK+ uses this type to determine what color to use
+when drawing the message area.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtkinfobar--get-message-type">
+ <title>gtk.InfoBar.get_message_type</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_message_type</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the message type of the message area.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.18 and above.</para>
+ </note>
+
+ <para>The <methodname>get_message_type</methodname>() method returns the message type of the message area.</para>
+ </refsect2>
+
+ </refsect1>
+
+</refentry>
diff --git a/docs/reference/pygtk-gtkoffscreenwindow.xml b/docs/reference/pygtk-gtkoffscreenwindow.xml
new file mode 100644
index 0000000..4206004
--- /dev/null
+++ b/docs/reference/pygtk-gtkoffscreenwindow.xml
@@ -0,0 +1,128 @@
+<?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-gtkoffscreenwindow">
+ <refnamediv>
+ <refname>gtk.OffscreenWindow</refname>
+ <refpurpose></refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Synopsis</title>
+
+ <classsynopsis language="python">
+ <ooclass><classname>gtk.OffscreenWindow</classname></ooclass>
+ <ooclass><classname><link linkend="class-gtkwindow">gtk.Window</link></classname></ooclass>
+ <constructorsynopsis language="python">
+ <methodname><link linkend="constructor-gtkoffscreenwindow">gtk.OffscreenWindow</link></methodname>
+ <methodparam></methodparam>
+ </constructorsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkoffscreenwindow--get-pixmap">get_pixmap</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkoffscreenwindow--get-pixbuf">get_pixbuf</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-gtkcontainer">gtk.Container</link>
+ +-- <link linkend="class-gtkbin">gtk.Bin</link>
+ +-- <link linkend="class-gtkwindow">gtk.Window</link>
+ +-- <link linkend="class-gtkoffscreenwindow">gtk.OffscreenWindow</link>
+</synopsis>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Constructor</title>
+
+ <programlisting>
+ <constructorsynopsis language="python">
+ <methodname><link linkend="constructor-gtkoffscreenwindow">gtk.OffscreenWindow</link></methodname>
+ <methodparam></methodparam>
+ </constructorsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A pointer to a <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This constructor is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Creates a toplevel container widget that is used to retrieve
+snapshots of widgets without showing them on the screen. For
+widgets that are on the screen and part of a normal widget
+hierarchy, <link linkend="method-gtkwidget--get-snapshot"><methodname>gtk.Widget.get_snapshot</methodname></link> can be used instead.</para>
+
+
+ </refsect1>
+
+ <refsect1>
+ <title>Methods</title>
+
+ <refsect2 id="method-gtkoffscreenwindow--get-pixmap">
+ <title>gtk.OffscreenWindow.get_pixmap</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_pixmap</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A <literal>GdkPixmap</literal> pointer to the offscreen pixmap, or <literal>NULL</literal>.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Retrieves a snapshot of the contained widget in the form of
+a <literal>GdkPixmap</literal>. If you need to keep this around over window
+resizes then you should add a reference to it.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtkoffscreenwindow--get-pixbuf">
+ <title>gtk.OffscreenWindow.get_pixbuf</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_pixbuf</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A <literal>GdkPixbuf</literal> pointer, or <literal>NULL</literal>.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Retrieves a snapshot of the contained widget in the form of
+a <literal>GdkPixbuf</literal>. This is a new pixbuf with a reference count of 1,
+and the application should unreference it once it is no longer
+needed.</para>
+ </refsect2>
+
+ </refsect1>
+
+</refentry>
diff --git a/docs/reference/pygtk-gtkspinner.xml b/docs/reference/pygtk-gtkspinner.xml
new file mode 100644
index 0000000..1243358
--- /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>
diff --git a/docs/reference/pygtk-gtktoolitemgroup.xml b/docs/reference/pygtk-gtktoolitemgroup.xml
new file mode 100644
index 0000000..84e2a84
--- /dev/null
+++ b/docs/reference/pygtk-gtktoolitemgroup.xml
@@ -0,0 +1,521 @@
+<?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-gtktoolitemgroup">
+ <refnamediv>
+ <refname>gtk.ToolItemGroup</refname>
+ <refpurpose></refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Synopsis</title>
+
+ <classsynopsis language="python">
+ <ooclass><classname>gtk.ToolItemGroup</classname></ooclass>
+ <ooclass><classname><link linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass>
+ <constructorsynopsis language="python">
+ <methodname><link linkend="constructor-gtktoolitemgroup">gtk.ToolItemGroup</link></methodname>
+ <methodparam><parameter role="keyword">label</parameter></methodparam>
+ </constructorsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitemgroup--set-label">set_label</link></methodname>
+ <methodparam><parameter role="keyword">label</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitemgroup--set-label-widget">set_label_widget</link></methodname>
+ <methodparam><parameter role="keyword">label_widget</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitemgroup--set-collapsed">set_collapsed</link></methodname>
+ <methodparam><parameter role="keyword">collapsed</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitemgroup--set-ellipsize">set_ellipsize</link></methodname>
+ <methodparam><parameter role="keyword">ellipsize</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitemgroup--set-header-relief">set_header_relief</link></methodname>
+ <methodparam><parameter role="keyword">style</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitemgroup--get-label">get_label</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitemgroup--get-label-widget">get_label_widget</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitemgroup--get-collapsed">get_collapsed</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitemgroup--get-ellipsize">get_ellipsize</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitemgroup--get-header-relief">get_header_relief</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitemgroup--insert">insert</link></methodname>
+ <methodparam><parameter role="keyword">item</parameter></methodparam>
+ <methodparam><parameter role="keyword">position</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitemgroup--set-item-position">set_item_position</link></methodname>
+ <methodparam><parameter role="keyword">item</parameter></methodparam>
+ <methodparam><parameter role="keyword">position</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitemgroup--get-item-position">get_item_position</link></methodname>
+ <methodparam><parameter role="keyword">item</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitemgroup--get-n-items">get_n_items</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitemgroup--get-nth-item">get_nth_item</link></methodname>
+ <methodparam><parameter role="keyword">index</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitemgroup--get-drop-item">get_drop_item</link></methodname>
+ <methodparam><parameter role="keyword">x</parameter></methodparam>
+ <methodparam><parameter role="keyword">y</parameter></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-gtkcontainer">gtk.Container</link>
+ +-- <link linkend="class-gtktoolitemgroup">gtk.ToolItemGroup</link>
+</synopsis>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Constructor</title>
+
+ <programlisting>
+ <constructorsynopsis language="python">
+ <methodname><link linkend="constructor-gtktoolitemgroup">gtk.ToolItemGroup</link></methodname>
+ <methodparam><parameter role="keyword">label</parameter></methodparam>
+ </constructorsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">label</parameter> :</term>
+ <listitem><simpara>the label of the new group</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a new <link linkend="class-gtktoolitemgroup"><classname>gtk.ToolItemGroup</classname></link>.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This constructor is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Creates a new tool item group with label <parameter>label</parameter>.</para>
+
+
+ </refsect1>
+
+ <refsect1>
+ <title>Methods</title>
+
+ <refsect2 id="method-gtktoolitemgroup--set-label">
+ <title>gtk.ToolItemGroup.set_label</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>set_label</methodname>
+ <methodparam><parameter role="keyword">label</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">label</parameter> :</term>
+ <listitem><simpara>the new human-readable label of of the group</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>The <methodname>set_label</methodname>() method sets the label of the tool item group. The label is displayed in the header
+of the group.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolitemgroup--set-label-widget">
+ <title>gtk.ToolItemGroup.set_label_widget</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>set_label_widget</methodname>
+ <methodparam><parameter role="keyword">label_widget</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">label_widget</parameter> :</term>
+ <listitem><simpara>the widget to be displayed in place of the usual label</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>The <methodname>set_label_widget</methodname>() method sets the label of the tool item group.
+The label widget is displayed in the header of the group, in place
+of the usual label.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolitemgroup--set-collapsed">
+ <title>gtk.ToolItemGroup.set_collapsed</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>set_collapsed</methodname>
+ <methodparam><parameter role="keyword">collapsed</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">collapsed</parameter> :</term>
+ <listitem><simpara>whether the <parameter>group</parameter> should be collapsed or expanded</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Sets whether the <parameter>group</parameter> should be collapsed or expanded.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolitemgroup--set-ellipsize">
+ <title>gtk.ToolItemGroup.set_ellipsize</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>set_ellipsize</methodname>
+ <methodparam><parameter role="keyword">ellipsize</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">ellipsize</parameter> :</term>
+ <listitem><simpara>the <literal>PangoEllipsizeMode</literal> labels in <parameter>group</parameter> should use</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>The <methodname>set_ellipsize</methodname>() method sets the ellipsization mode which should be used by labels in <parameter>group</parameter>.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolitemgroup--set-header-relief">
+ <title>gtk.ToolItemGroup.set_header_relief</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>set_header_relief</methodname>
+ <methodparam><parameter role="keyword">style</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">style</parameter> :</term>
+ <listitem><simpara>the <literal>GtkReliefStyle</literal></simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Set the button relief of the group header.
+See <link linkend="method-gtkbutton--set-relief"><methodname>gtk.Button.set_relief</methodname></link> for details.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolitemgroup--get-label">
+ <title>gtk.ToolItemGroup.get_label</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_label</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the label of <parameter>group</parameter>. The label is an internal string of <parameter>group</parameter> and must not be modified. Note that <literal>NULL</literal> is returned if a custom label has been set with <link linkend="method-gtktoolitemgroup--set-label-widget"><methodname>gtk.ToolItemGroup.set_label_widget</methodname></link></simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Gets the label of <parameter>group</parameter>.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolitemgroup--get-label-widget">
+ <title>gtk.ToolItemGroup.get_label_widget</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_label_widget</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the label widget of <parameter>group</parameter></simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Gets the label widget of <parameter>group</parameter>.
+See <link linkend="method-gtktoolitemgroup--set-label-widget"><methodname>gtk.ToolItemGroup.set_label_widget</methodname></link>.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolitemgroup--get-collapsed">
+ <title>gtk.ToolItemGroup.get_collapsed</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_collapsed</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>TRUE</literal> if <parameter>group</parameter> is collapsed, <literal>FALSE</literal> if it is expanded</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Gets whether <parameter>group</parameter> is collapsed or expanded.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolitemgroup--get-ellipsize">
+ <title>gtk.ToolItemGroup.get_ellipsize</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_ellipsize</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the <literal>PangoEllipsizeMode</literal> of <parameter>group</parameter></simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Gets the ellipsization mode of <parameter>group</parameter>.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolitemgroup--get-header-relief">
+ <title>gtk.ToolItemGroup.get_header_relief</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_header_relief</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the <literal>GtkReliefStyle</literal></simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Gets the relief mode of the header button of <parameter>group</parameter>.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolitemgroup--insert">
+ <title>gtk.ToolItemGroup.insert</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>insert</methodname>
+ <methodparam><parameter role="keyword">item</parameter></methodparam>
+ <methodparam><parameter role="keyword">position</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">item</parameter> :</term>
+ <listitem><simpara>the <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> to insert into <parameter>group</parameter></simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">position</parameter> :</term>
+ <listitem><simpara>the position of <parameter>item</parameter> in <parameter>group</parameter>, starting with 0. The position -1 means end of list.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Inserts <parameter>item</parameter> at <parameter>position</parameter> in the list of children of <parameter>group</parameter>.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolitemgroup--set-item-position">
+ <title>gtk.ToolItemGroup.set_item_position</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>set_item_position</methodname>
+ <methodparam><parameter role="keyword">item</parameter></methodparam>
+ <methodparam><parameter role="keyword">position</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">item</parameter> :</term>
+ <listitem><simpara>the <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> to move to a new position, should be a child of <parameter>group</parameter>.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">position</parameter> :</term>
+ <listitem><simpara>the new position of <parameter>item</parameter> in <parameter>group</parameter>, starting with 0. The position -1 means end of list.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>The <methodname>set_item_position</methodname>() method sets the position of <parameter>item</parameter> in the list of children of <parameter>group</parameter>.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolitemgroup--get-item-position">
+ <title>gtk.ToolItemGroup.get_item_position</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_item_position</methodname>
+ <methodparam><parameter role="keyword">item</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">item</parameter> :</term>
+ <listitem><simpara>a <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link></simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the index of <parameter>item</parameter> in <parameter>group</parameter> or -1 if <parameter>item</parameter> is no child of <parameter>group</parameter></simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Gets the position of <parameter>item</parameter> in <parameter>group</parameter> as index.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolitemgroup--get-n-items">
+ <title>gtk.ToolItemGroup.get_n_items</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_n_items</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the number of tool items in <parameter>group</parameter></simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Gets the number of tool items in <parameter>group</parameter>.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolitemgroup--get-nth-item">
+ <title>gtk.ToolItemGroup.get_nth_item</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_nth_item</methodname>
+ <methodparam><parameter role="keyword">index</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">index</parameter> :</term>
+ <listitem><simpara>the index</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> at index</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Gets the tool item at <parameter>index</parameter> in group.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolitemgroup--get-drop-item">
+ <title>gtk.ToolItemGroup.get_drop_item</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_drop_item</methodname>
+ <methodparam><parameter role="keyword">x</parameter></methodparam>
+ <methodparam><parameter role="keyword">y</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">x</parameter> :</term>
+ <listitem><simpara>the x position</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">y</parameter> :</term>
+ <listitem><simpara>the y position</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> at position (x, y)</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Gets the tool item at position (x, y).</para>
+ </refsect2>
+
+ </refsect1>
+
+</refentry>
diff --git a/docs/reference/pygtk-gtktoolpalette.xml b/docs/reference/pygtk-gtktoolpalette.xml
new file mode 100644
index 0000000..34d86d3
--- /dev/null
+++ b/docs/reference/pygtk-gtktoolpalette.xml
@@ -0,0 +1,636 @@
+<?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-gtktoolpalette">
+ <refnamediv>
+ <refname>gtk.ToolPalette</refname>
+ <refpurpose></refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Synopsis</title>
+
+ <classsynopsis language="python">
+ <ooclass><classname>gtk.ToolPalette</classname></ooclass>
+ <ooclass><classname><link linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass>
+ <constructorsynopsis language="python">
+ <methodname><link linkend="constructor-gtktoolpalette">gtk.ToolPalette</link></methodname>
+ <methodparam></methodparam>
+ </constructorsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolpalette--set-group-position">set_group_position</link></methodname>
+ <methodparam><parameter role="keyword">group</parameter></methodparam>
+ <methodparam><parameter role="keyword">position</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolpalette--set-exclusive">set_exclusive</link></methodname>
+ <methodparam><parameter role="keyword">group</parameter></methodparam>
+ <methodparam><parameter role="keyword">exclusive</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolpalette--set-expand">set_expand</link></methodname>
+ <methodparam><parameter role="keyword">group</parameter></methodparam>
+ <methodparam><parameter role="keyword">expand</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolpalette--get-group-position">get_group_position</link></methodname>
+ <methodparam><parameter role="keyword">group</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolpalette--get-exclusive">get_exclusive</link></methodname>
+ <methodparam><parameter role="keyword">group</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolpalette--get-expand">get_expand</link></methodname>
+ <methodparam><parameter role="keyword">group</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolpalette--set-icon-size">set_icon_size</link></methodname>
+ <methodparam><parameter role="keyword">icon_size</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolpalette--unset-icon-size">unset_icon_size</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolpalette--set-style">set_style</link></methodname>
+ <methodparam><parameter role="keyword">style</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolpalette--unset-style">unset_style</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolpalette--get-icon-size">get_icon_size</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolpalette--get-style">get_style</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolpalette--get-drop-item">get_drop_item</link></methodname>
+ <methodparam><parameter role="keyword">x</parameter></methodparam>
+ <methodparam><parameter role="keyword">y</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolpalette--get-drop-group">get_drop_group</link></methodname>
+ <methodparam><parameter role="keyword">x</parameter></methodparam>
+ <methodparam><parameter role="keyword">y</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolpalette--get-drag-item">get_drag_item</link></methodname>
+ <methodparam><parameter role="keyword">selection</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolpalette--set-drag-source">set_drag_source</link></methodname>
+ <methodparam><parameter role="keyword">targets</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolpalette--add-drag-dest">add_drag_dest</link></methodname>
+ <methodparam><parameter role="keyword">widget</parameter></methodparam>
+ <methodparam><parameter role="keyword">flags</parameter></methodparam>
+ <methodparam><parameter role="keyword">targets</parameter></methodparam>
+ <methodparam><parameter role="keyword">actions</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolpalette--get-hadjustment">get_hadjustment</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolpalette--get-vadjustment">get_vadjustment</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-gtkcontainer">gtk.Container</link>
+ +-- <link linkend="class-gtktoolpalette">gtk.ToolPalette</link>
+</synopsis>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Constructor</title>
+
+ <programlisting>
+ <constructorsynopsis language="python">
+ <methodname><link linkend="constructor-gtktoolpalette">gtk.ToolPalette</link></methodname>
+ <methodparam></methodparam>
+ </constructorsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <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.20 and above.</para>
+ </note>
+
+ <para>Creates a new tool palette.</para>
+
+
+ </refsect1>
+
+ <refsect1>
+ <title>Methods</title>
+
+ <refsect2 id="method-gtktoolpalette--set-group-position">
+ <title>gtk.ToolPalette.set_group_position</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>set_group_position</methodname>
+ <methodparam><parameter role="keyword">group</parameter></methodparam>
+ <methodparam><parameter role="keyword">position</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">group</parameter> :</term>
+ <listitem><simpara>a <link linkend="class-gtktoolitemgroup"><classname>gtk.ToolItemGroup</classname></link> which is a child of palette</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">position</parameter> :</term>
+ <listitem><simpara>a new index for group</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 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>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolpalette--set-exclusive">
+ <title>gtk.ToolPalette.set_exclusive</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>set_exclusive</methodname>
+ <methodparam><parameter role="keyword">group</parameter></methodparam>
+ <methodparam><parameter role="keyword">exclusive</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">group</parameter> :</term>
+ <listitem><simpara>a <link linkend="class-gtktoolitemgroup"><classname>gtk.ToolItemGroup</classname></link> which is a child of palette</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">exclusive</parameter> :</term>
+ <listitem><simpara>whether the group should be exclusive or not</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 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>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolpalette--set-expand">
+ <title>gtk.ToolPalette.set_expand</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>set_expand</methodname>
+ <methodparam><parameter role="keyword">group</parameter></methodparam>
+ <methodparam><parameter role="keyword">expand</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">group</parameter> :</term>
+ <listitem><simpara>a <link linkend="class-gtktoolitemgroup"><classname>gtk.ToolItemGroup</classname></link> which is a child of palette</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">expand</parameter> :</term>
+ <listitem><simpara>whether the group should be given extra space</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Sets whether the group should be given extra space.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolpalette--get-group-position">
+ <title>gtk.ToolPalette.get_group_position</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_group_position</methodname>
+ <methodparam><parameter role="keyword">group</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">group</parameter> :</term>
+ <listitem><simpara>a <link linkend="class-gtktoolitemgroup"><classname>gtk.ToolItemGroup</classname></link></simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</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.20 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>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolpalette--get-exclusive">
+ <title>gtk.ToolPalette.get_exclusive</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_exclusive</methodname>
+ <methodparam><parameter role="keyword">group</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">group</parameter> :</term>
+ <listitem><simpara>a <link linkend="class-gtktoolitemgroup"><classname>gtk.ToolItemGroup</classname></link> which is a child of palette</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>TRUE</literal> if <parameter>group</parameter> is exclusive</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 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>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolpalette--get-expand">
+ <title>gtk.ToolPalette.get_expand</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_expand</methodname>
+ <methodparam><parameter role="keyword">group</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">group</parameter> :</term>
+ <listitem><simpara>a <link linkend="class-gtktoolitemgroup"><classname>gtk.ToolItemGroup</classname></link> which is a child of palette</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <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.20 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>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolpalette--set-icon-size">
+ <title>gtk.ToolPalette.set_icon_size</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>set_icon_size</methodname>
+ <methodparam><parameter role="keyword">icon_size</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">icon_size</parameter> :</term>
+ <listitem><simpara>the <literal>GtkIconSize</literal> that icons in the tool palette shall have</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 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">
+ <title>gtk.ToolPalette.unset_icon_size</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>unset_icon_size</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <note>
+ <para>This method is available in PyGTK 2.20 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>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolpalette--set-style">
+ <title>gtk.ToolPalette.set_style</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>set_style</methodname>
+ <methodparam><parameter role="keyword">style</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">style</parameter> :</term>
+ <listitem><simpara>the <literal>GtkToolbarStyle</literal> that items in the tool palette shall have</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 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">
+ <title>gtk.ToolPalette.unset_style</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>unset_style</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <note>
+ <para>This method is available in PyGTK 2.20 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>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolpalette--get-icon-size">
+ <title>gtk.ToolPalette.get_icon_size</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_icon_size</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the <literal>GtkIconSize</literal> of icons in the tool palette</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 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>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolpalette--get-style">
+ <title>gtk.ToolPalette.get_style</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_style</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the <literal>GtkToolbarStyle</literal> of items in the tool palette.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 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">
+ <title>gtk.ToolPalette.get_drop_item</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_drop_item</methodname>
+ <methodparam><parameter role="keyword">x</parameter></methodparam>
+ <methodparam><parameter role="keyword">y</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">x</parameter> :</term>
+ <listitem><simpara>the x position</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">y</parameter> :</term>
+ <listitem><simpara>the y position</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</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>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 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>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolpalette--get-drop-group">
+ <title>gtk.ToolPalette.get_drop_group</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_drop_group</methodname>
+ <methodparam><parameter role="keyword">x</parameter></methodparam>
+ <methodparam><parameter role="keyword">y</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">x</parameter> :</term>
+ <listitem><simpara>the x position</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">y</parameter> :</term>
+ <listitem><simpara>the y position</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</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>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Gets the group at position (x, y).</para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolpalette--get-drag-item">
+ <title>gtk.ToolPalette.get_drag_item</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_drag_item</methodname>
+ <methodparam><parameter role="keyword">selection</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">selection</parameter> :</term>
+ <listitem><simpara>a <link linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link></simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the dragged item in selection</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 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>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolpalette--set-drag-source">
+ <title>gtk.ToolPalette.set_drag_source</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>set_drag_source</methodname>
+ <methodparam><parameter role="keyword">targets</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">targets</parameter> :</term>
+ <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.20 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>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolpalette--add-drag-dest">
+ <title>gtk.ToolPalette.add_drag_dest</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>add_drag_dest</methodname>
+ <methodparam><parameter role="keyword">widget</parameter></methodparam>
+ <methodparam><parameter role="keyword">flags</parameter></methodparam>
+ <methodparam><parameter role="keyword">targets</parameter></methodparam>
+ <methodparam><parameter role="keyword">actions</parameter></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">widget</parameter> :</term>
+ <listitem><simpara>a <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> which should be a drag destination for <parameter>palette</parameter></simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">flags</parameter> :</term>
+ <listitem><simpara>the flags that specify what actions GTK+ should take for drops on that widget</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">targets</parameter> :</term>
+ <listitem><simpara>the <literal>GtkToolPaletteDragTarget</literal><!-- -->s which the widget should support</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">actions</parameter> :</term>
+ <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.20 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>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolpalette--get-hadjustment">
+ <title>gtk.ToolPalette.get_hadjustment</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_hadjustment</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the horizontal adjustment of <parameter>palette</parameter></simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Gets the horizontal adjustment of the tool palette.</para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolpalette--get-vadjustment">
+ <title>gtk.ToolPalette.get_vadjustment</title>
+
+ <programlisting>
+ <methodsynopsis language="python">
+ <methodname>get_vadjustment</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the vertical adjustment of <parameter>palette</parameter></simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>Gets the vertical adjustment of the tool palette.</para>
+ </refsect2>
+
+ </refsect1>
+
+</refentry>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
