pygtk r3086 - trunk/docs/reference
- From: gianmt svn gnome org
- To: svn-commits-list gnome org
- Subject: pygtk r3086 - trunk/docs/reference
- Date: Sun, 22 Feb 2009 18:08:43 +0000 (UTC)
Author: gianmt
Date: Sun Feb 22 18:08:43 2009
New Revision: 3086
URL: http://svn.gnome.org/viewvc/pygtk?rev=3086&view=rev
Log:
2009-02-22 Gian Mario Tagliaretti <gianmt gnome org>
* pygtk-gtkcontainer.xml:
* pygtk-gtkcolorselectiondialog.xml:
* pygtk-gtkclipboard.xml:
* pygtk-gtkadjustment.xml:
* pygtk-gtkaccelgroup.xml:
* pygtk-gtkwidget.xml: Update docs to 2.14
Modified:
trunk/docs/reference/ChangeLog
trunk/docs/reference/pygtk-gtkaccelgroup.xml
trunk/docs/reference/pygtk-gtkadjustment.xml
trunk/docs/reference/pygtk-gtkclipboard.xml
trunk/docs/reference/pygtk-gtkcolorselectiondialog.xml
trunk/docs/reference/pygtk-gtkcontainer.xml
trunk/docs/reference/pygtk-gtkwidget.xml
Modified: trunk/docs/reference/pygtk-gtkaccelgroup.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkaccelgroup.xml (original)
+++ trunk/docs/reference/pygtk-gtkaccelgroup.xml Sun Feb 22 18:08:43 2009
@@ -82,7 +82,16 @@
<methodparam><parameter>(*find_func</parameter></methodparam>
</methodsynopsis>
END NOT IMPLEMENTED -->
- </classsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkaccelgroup--get-is-locked">get_is_locked</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkaccelgroup--get-modifier-mask">get_modifier_mask</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
+ </classsynopsis>
<programlisting>
<emphasis role="bold">Functions</emphasis>
@@ -491,6 +500,62 @@
END NOT IMPLEMENTED -->
+ <refsect2 id="method-gtkaccelgroup--get-is-locked">
+ <title>gtk.AccelGroup.get_is_locked</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_is_locked</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> if there are 1 or more locks
+ on the accel_group, <literal>False</literal> otherwise. </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_is_locked</methodname>() method returns the locked status.
+ Locks are added and removed using
+ <link linkend="method-gtkaccelgroup--lock">lock</link>() and
+ <link linkend="method-gtkaccelgroup--lock">lock</link>().
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkaccelgroup--get-modifier-mask">
+ <title>gtk.AccelGroup.get_modifier_mask</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_modifier_mask</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the modifier mask for this accel group.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_modifier_mask</methodname>() method gets a
+ GdkModifierType representing the mask for this accel_group.
+ For example, gtk.gdk.CONTROL_MASK, gtk.gdk.SHIFT_MASK, etc.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
Modified: trunk/docs/reference/pygtk-gtkadjustment.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkadjustment.xml (original)
+++ trunk/docs/reference/pygtk-gtkadjustment.xml Sun Feb 22 18:08:43 2009
@@ -74,6 +74,72 @@
<methodparam><parameter
role="keyword">value</parameter></methodparam>
</methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkadjustment--configure">configure</link></methodname>
+ <methodparam><parameter
+ role="keyword">value</parameter></methodparam>
+ <methodparam><parameter
+ role="keyword">lower</parameter></methodparam>
+ <methodparam><parameter
+ role="keyword">upper</parameter></methodparam>
+ <methodparam><parameter
+ role="keyword">step_increment</parameter></methodparam>
+ <methodparam><parameter
+ role="keyword">page_increment</parameter></methodparam>
+ <methodparam><parameter
+ role="keyword">page_size</parameter></methodparam>
+ </methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkadjustment--get-lower">get_lower</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkadjustment--set-lower">set_lower</link></methodname>
+ <methodparam><parameter role="keyword">lower</parameter></methodparam>
+ </methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkadjustment--get-page-increment">get_page_increment</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkadjustment--set-page-increment">set_page_increment</link></methodname>
+ <methodparam><parameter role="keyword">page_increment</parameter></methodparam>
+ </methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkadjustment--get-page-size">get_page_size</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkadjustment--set-page-size">set_page_size</link></methodname>
+ <methodparam><parameter role="keyword">page_size</parameter></methodparam>
+ </methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkadjustment--get-step-increment">get_step_increment</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkadjustment--set-step-increment">set_step_increment</link></methodname>
+ <methodparam><parameter role="keyword">step_increment</parameter></methodparam>
+ </methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkadjustment--get-upper">get_upper</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkadjustment--set-upper">set_upper</link></methodname>
+ <methodparam><parameter role="keyword">upper</parameter></methodparam>
+ </methodsynopsis>
</classsynopsis>
</refsect1>
@@ -506,7 +572,6 @@
</refsect2>
-
<refsect2 id="method-gtkadjustment--get-value">
<title>gtk.Adjustment.get_value</title>
@@ -548,6 +613,294 @@
</refsect2>
+ <refsect2 id="method-gtkadjustment--get-lower">
+ <title>gtk.Adjustment.get_lower</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_lower</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>The current minimum value of the adjustment.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>The <methodname>get_lower</methodname>() method gets the current minimum
+ value of the adjustment.</para>
+
+ </refsect2>
+
+
+ <refsect2 id="method-gtkadjustment--set-lower">
+ <title>gtk.Adjustment.set_lower</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_lower</methodname>
+ <methodparam><parameter role="keyword">lower</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">lower</parameter> :</term>
+ <listitem><simpara>the new minimum value</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_lower</methodname>() method sets the minimum value of the adjustment.
+ </para>
+
+ <para>
+ When setting multiple adjustment properties via their individual setters,
+ multiple "changed" signals will be emitted. However, since the emission of the
+ "changed" signal is tied to the emission of the "GObject::notify"
+ signals of the changed properties, it's possible to compress the "changed"
+ signals into one by calling gobject.Gobject.freeze_notify() and gobject.Gobject.thaw_notify()
+ around the calls to the individual setters.
+ </para>
+
+ <para>
+ Alternatively, using
+ <link linkend="method-gtkadjustment--configure">gtk.Adjustment.configure</link>()
+ has the same effect of compressing "changed" emissions.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkadjustment--get-page-increment">
+ <title>gtk.Adjustment.get_page_increment</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_page_increment</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>The current page increment of the adjustment.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>The <methodname>get_page_increment</methodname>() method gets the current page
+ increment of the adjustment.</para>
+
+ </refsect2>
+
+
+ <refsect2 id="method-gtkadjustment--set-page-increment">
+ <title>gtk.Adjustment.set_page_increment</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_page_increment</methodname>
+ <methodparam><parameter role="keyword">page_increment</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">page_increment</parameter> :</term>
+ <listitem><simpara>the new page increment value</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_page_increment</methodname>() method sets the page increment of the adjustment.
+ </para>
+
+ <para>
+ See
+ <link linkend="method-gtkadjustment--get-lower">gtk.Adjustment.get_lower</link>()
+ about how to compress multiple emissions of the "changed" signal when setting multiple adjustment properties.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkadjustment--get-page-size">
+ <title>gtk.Adjustment.get_page_size</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_page_size</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>The current page size of the adjustment.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>The <methodname>get_page_size</methodname>() method gets the current page
+ size of the adjustment.</para>
+
+ </refsect2>
+
+
+ <refsect2 id="method-gtkadjustment--set-page-size">
+ <title>gtk.Adjustment.set_page_size</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_page_size</methodname>
+ <methodparam><parameter role="keyword">page_size</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">page_size</parameter> :</term>
+ <listitem><simpara>the new page size value</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_page_size</methodname>() method sets the page size of the adjustment.
+ </para>
+
+ <para>
+ See
+ <link linkend="method-gtkadjustment--get-lower">gtk.Adjustment.get_lower</link>()
+ about how to compress multiple emissions of the "changed" signal when setting multiple adjustment properties.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkadjustment--get-step-increment">
+ <title>gtk.Adjustment.get_step_increment</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_step_increment</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>The current step increment of the adjustment.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>The <methodname>get_step_increment</methodname>() method gets the current step
+ increment of the adjustment.</para>
+
+ </refsect2>
+
+
+ <refsect2 id="method-gtkadjustment--set-step-increment">
+ <title>gtk.Adjustment.set_step_increment</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_step_increment</methodname>
+ <methodparam><parameter role="keyword">step_increment</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">step_increment</parameter> :</term>
+ <listitem><simpara>the new step increment value</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_step_increment</methodname>() method sets the step increment of the adjustment.
+ </para>
+
+ <para>
+ See
+ <link linkend="method-gtkadjustment--get-lower">gtk.Adjustment.get_lower</link>()
+ about how to compress multiple emissions of the "changed" signal when setting multiple adjustment properties.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkadjustment--get-upper">
+ <title>gtk.Adjustment.get_upper</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_upper</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>The current minimum value of the adjustment.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>The <methodname>get_upper</methodname>() method gets the current minimum
+ value of the adjustment.</para>
+
+ </refsect2>
+
+
+ <refsect2 id="method-gtkadjustment--set-upper">
+ <title>gtk.Adjustment.set_upper</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_upper</methodname>
+ <methodparam><parameter role="keyword">upper</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">upper</parameter> :</term>
+ <listitem><simpara>the new maximum value</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_upper</methodname>() method sets the maximum value of the adjustment.
+ </para>
+
+ <para>
+ Note that values will be restricted by upper - page-size if the page-size property is nonzero.
+ </para>
+
+ <para>
+ See
+ <link linkend="method-gtkadjustment--get-lower">gtk.Adjustment.get_lower</link>()
+ about how to compress multiple emissions of the "changed" signal when setting multiple adjustment properties.
+ </para>
+
+ </refsect2>
+
</refsect1>
Modified: trunk/docs/reference/pygtk-gtkclipboard.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkclipboard.xml (original)
+++ trunk/docs/reference/pygtk-gtkclipboard.xml Sun Feb 22 18:08:43 2009
@@ -113,6 +113,10 @@
<methodname><link linkend="method-gtkclipboard--wait-is-rich-text-available">wait_is_rich_text_available</link></methodname>
<methodparam><parameter role="keyword">buffer</parameter></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkclipboard--wait-is-uris-available">wait_is_uris_available</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
</classsynopsis>
<programlisting>
@@ -1185,6 +1189,43 @@
</refsect2>
+ <refsect2 id="method-gtkclipboard--wait-is-uris-available">
+ <title>gtk.Clipboard.wait_is_uris_available</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>wait_is_uris_available</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> if is there is an URI list
+ available, <literal>False</literal>
+ otherwise.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>wait_is_uris_available</methodname>()
+ method Test to see if there is a list of URIs available to be pasted This
+ is done by requesting the TARGETS atom and checking if it contains the URI targets.
+ This function waits for the data to be received using the main loop, so events,
+ timeouts, etc, may be dispatched during the wait.
+ </para>
+
+ <!-- NOT IMPLEMENTED
+ <para>This method is a little faster than calling <link
+ linkend="method-gtkclipboard- -wait-for-uris"><methodname>gtk.Clipboard.wait_for_uris</methodname></link>()
+ since it doesn't need to retrieve the actual text.</para>
+ -->
+
+ </refsect2>
+
</refsect1>
<refsect1>
Modified: trunk/docs/reference/pygtk-gtkcolorselectiondialog.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkcolorselectiondialog.xml (original)
+++ trunk/docs/reference/pygtk-gtkcolorselectiondialog.xml Sun Feb 22 18:08:43 2009
@@ -21,6 +21,10 @@
<methodparam><parameter
role="keyword">title</parameter></methodparam>
</constructorsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkcolorselectiondialog--get-color-selection">get_color_selection</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
</classsynopsis>
</refsect1>
@@ -170,5 +174,36 @@
the dialog title.</para>
</refsect1>
+
+ <refsect1>
+ <title>Methods</title>
+
+ <refsect2 id="method-gtkcolorselectiondialog--get-color-selection">
+ <title>gtk.Frame.get_color_selection</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_color_selection</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the embedded <link linkend="class-gtkcolorselection">
+ <classname>gtk.ColorSelection</classname></link>.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_color_selection</methodname>() method retrieves the
+ <link linkend="class-gtkcolorselection"><classname>gtk.ColorSelection</classname></link>
+ widget embedded in the dialog.
+ </para>
+
+ </refsect2>
+ </refsect1>
</refentry>
Modified: trunk/docs/reference/pygtk-gtkcontainer.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkcontainer.xml (original)
+++ trunk/docs/reference/pygtk-gtkcontainer.xml Sun Feb 22 18:08:43 2009
@@ -106,6 +106,10 @@
linkend="method-gtkcontainer--set-focus-child">set_focus_child</link></methodname>
<methodparam><parameter
role="keyword">child</parameter></methodparam>
+ </methodsynopsis><methodsynopsis language="python">
+ <methodname><link
+linkend="method-gtkcontainer--get-focus-child">get_focus_child</link></methodname>
+ <methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
@@ -947,6 +951,30 @@
</refsect2>
+ <refsect2 id="method-gtkcontainer--get-focus-child">
+ <title>gtk.Container.get_focus_child</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_focus_child</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>The child widget which has the focus inside container,
+ or <literal>None</literal> if none is set.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>The <methodname>get_focus_child</methodname>() method returns the
+ current focus child widget inside container.</para>
+
+ </refsect2>
+
<refsect2 id="method-gtkcontainer--set-focus-vadjustment">
<title>gtk.Container.set_focus_vadjustment</title>
Modified: trunk/docs/reference/pygtk-gtkwidget.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkwidget.xml (original)
+++ trunk/docs/reference/pygtk-gtkwidget.xml Sun Feb 22 18:08:43 2009
@@ -933,6 +933,14 @@
<methodname><link linkend="method-gtkwidget--trigger-tooltip-query">trigger_tooltip_query</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkwidget--get-snapshot">get_snapshot</link></methodname>
+ <methodparam><parameter role="keyword">clip_rect</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkwidget--get-window">get_window</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
</classsynopsis>
<programlisting>
@@ -1323,6 +1331,14 @@
2.10 and above.</entry>
</row>
+ <row valign="top">
+ <entry>"window"</entry>
+ <entry>Read</entry>
+ <entry>The "window" property is the widget's window if it is
+ realized, <literal>None</literal> otherwise.
+ This property is available in GTK+ 2.14 and above.</entry>
+ </row>
+
</tbody>
</tgroup>
</informaltable>
@@ -1494,6 +1510,17 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term>"<link linkend="signal-gtkwidget--damage-event">delete-event</link>"</term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>widget</parameter></methodparam>
+ <methodparam><parameter>event</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term>"<link linkend="signal-gtkwidget--delete-event">delete-event</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
@@ -6688,7 +6715,7 @@
</note>
<para>
- The <methodname>get_tooltip_text</methodname>() method
+ The <methodname>get_tooltip_window</methodname>() method
returns the <link linkend="class-gtkwindow"><classname>gtk.Window</classname></link>
of the current tooltip. This can be the
<link linkend="class-gtkwindow"><classname>gtk.Window</classname></link>
@@ -6940,6 +6967,92 @@
</para>
</refsect2>
+
+ <refsect2 id="method-gtkwidget--get-snapshot">
+ <title>gtk.Widget.get_snapshot</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_snapshot</methodname>
+ <methodparam><parameter role="keyword">clip_rect</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">clip_rect</parameter> :</term>
+ <listitem><simpara>a <link linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
+ or <literal>None</literal>.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>The <link linkend="class-gdkpixmap">
+ <classname>gtk.gdk.PixmapWindow</classname></link>
+ snapshot of the widget.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_snapshot</methodname>() method
+ creates a <link linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
+ of the contents of the widget and its children.
+ </para>
+ <para>
+ Works even if the widget is obscured. The depth and visual of the resulting pixmap
+ is dependent on the widget being snapshot and likely differs from those of a
+ target widget displaying the pixmap. The function
+ <link linkend="method-gdkpixbuf--get-from-drawable"><methodname>gtk.gdk.Pixbuf.get_from_drawable</methodname></link>()
+ can be used to convert the pixmap to a visual independant representation.
+ </para>
+ <para>
+ The snapshot area used by this function is the widget's allocation
+ plus any extra space occupied by additional windows belonging to
+ this widget (such as the arrows of a spin button). Thus, the resulting
+ snapshot pixmap is possibly larger than the allocation.
+ </para>
+ <para>
+ If clip_rect is non-<literal>None</literal>, the resulting pixmap is shrunken
+ to match the specified clip_rect. The (x,y) coordinates of clip_rect are
+ interpreted widget relative. If width or height of clip_rect are 0 or negative,
+ the width or height of the resulting pixmap will be shrunken by the respective amount.
+ For instance a clip_rect { +5, +5, -10, -10 } will chop off 5 pixels at each side
+ of the snapshot pixmap. If non-NULL, clip_rect will contain the exact widget-relative
+ snapshot coordinates upon return. A clip_rect of { -1, -1, 0, 0 } can be used to preserve
+ the auto-grown snapshot area and use clip_rect as a pure output parameter.
+ </para>
+ <para>
+ The returned pixmap can be <literal>None</literal>, if the resulting clip_area was empty.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkwidget--get-window">
+ <title>gtk.Widget.get_window</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_window</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the widget's <link linkend="class-gtkwindow"><classname>gtk.Window</classname>
+ </link>.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_window</methodname>() method
+ returns the widget's <link linkend="class-gtkwindow"><classname>gtk.Window</classname></link>
+ if it is realized, <literal>None</literal> otherwise.
+ </para>
+
+ </refsect2>
</refsect1>
@@ -7646,6 +7759,56 @@
</refsect2>
+ <refsect2 id="signal-gtkwidget--damage-event">
+ <title>The "damage-event" gtk.Widget Signal</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>callback</methodname>
+ <methodparam><parameter>widget</parameter></methodparam>
+ <methodparam><parameter>event</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>widget</parameter> :</term>
+ <listitem><simpara>the widget that received the
+signal</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>event</parameter> :</term>
+ <listitem><simpara>the event that triggered the
+signal</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param1</parameter> :</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> :</term>
+ <listitem><simpara>additional user parameters (if
+any)</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> to stop other handlers
+ from being invoked for the event. <literal>False</literal> to
+ propagate the event further.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The "damage-event" signal is emitted when a redirected window belonging
+ to widget gets drawn into. The region/area members of the event shows
+ what area of the redirected drawable was drawn into.
+ </para>
+
+ </refsect2>
+
<refsect2 id="signal-gtkwidget--delete-event">
<title>The "delete-event" gtk.Widget Signal</title>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
