pygtk r3108 - in branches/pygtk-2-14/docs: . icons images reference
- From: gianmt svn gnome org
- To: svn-commits-list gnome org
- Subject: pygtk r3108 - in branches/pygtk-2-14/docs: . icons images reference
- Date: Thu, 5 Mar 2009 22:54:50 +0000 (UTC)
Author: gianmt
Date: Thu Mar 5 22:54:50 2009
New Revision: 3108
URL: http://svn.gnome.org/viewvc/pygtk?rev=3108&view=rev
Log:
2009-03-05 Gian Mario Tagliaretti <gianmt gnome org>
* images/*: Add new images.
* icons/stock_page_setup_24.png:
* icons/stock_print_error_24.png:
* icons/stock_print_warning_24.png:
* icons/stock_print_report_24.png:
* icons/stock_print_paused_24.png: Add new stock items.
* pygtk-gdkapplaunchcontext.xml:
* pygtk-gtkmountoperation.xml:
* pygtk-gtktoolshell.xml: Add new classes.
* Makefile.am:
* pygtk-gtkwidget.xml:
* pygtk-gtktooltip.xml:
* pygtk-gtklayout.xml:
* pygtk-gdkwindow.xml:
* pygtk-gtk-constants.xml:
* pygtk-gtktoolitem.xml:
* pygtk-gtkwindow.xml:
* pygtk-gtkimage.xml:
* pygtk-gtkpagesetup.xml:
* pygtk-gtkclipboard.xml:
* pygtk-gtkcolorselectiondialog.xml:
* pygtk-gtkfontselectiondialog.xml:
* pygtk-gtkicontheme.xml:
* pygtk-gtkfontselection.xml:
* pygtk-gtkadjustment.xml:
* pygtk-gtkmessagedialog.xml:
* pygtk-gdk-functions.xml:
* pygtk-gtkaccelgroup.xml:
* pygtk-gdkscreen.xml:
* pygtk-gtkiconinfo.xml:
* pygtk-gtkdialog.xml:
* pygtk-gtkprintsettings.xml:
* pygtk-gtkplug.xml:
* pygtk-gtktooltips.xml:
* pygtk-gtksocket.xml:
* pygtk-gtkselectiondata.xml:
* pygtk-gtkfilechooser.xml:
* pygtk-gtkhandlebox.xml:
* pygtk-gtk-stock-items.xml:
* pygtk-gtkcontainer.xml:
* pygtk-gdk-classes.xml:
* pygtk-gtk-classes.xml: Update docs to 2.14 API.
Added:
branches/pygtk-2-14/docs/icons/stock_page_setup_24.png (contents, props changed)
branches/pygtk-2-14/docs/icons/stock_print_error_24.png (contents, props changed)
branches/pygtk-2-14/docs/icons/stock_print_paused_24.png (contents, props changed)
branches/pygtk-2-14/docs/icons/stock_print_report_24.png (contents, props changed)
branches/pygtk-2-14/docs/icons/stock_print_warning_24.png (contents, props changed)
branches/pygtk-2-14/docs/images/
branches/pygtk-2-14/docs/images/layout-btlr.png (contents, props changed)
branches/pygtk-2-14/docs/images/layout-btrl.png (contents, props changed)
branches/pygtk-2-14/docs/images/layout-lrbt.png (contents, props changed)
branches/pygtk-2-14/docs/images/layout-lrtb.png (contents, props changed)
branches/pygtk-2-14/docs/images/layout-rlbt.png (contents, props changed)
branches/pygtk-2-14/docs/images/layout-rltb.png (contents, props changed)
branches/pygtk-2-14/docs/images/layout-tblr.png (contents, props changed)
branches/pygtk-2-14/docs/images/layout-tbrl.png (contents, props changed)
branches/pygtk-2-14/docs/reference/pygtk-gdkapplaunchcontext.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkmountoperation.xml
branches/pygtk-2-14/docs/reference/pygtk-gtktoolshell.xml
Modified:
branches/pygtk-2-14/docs/Makefile.am
branches/pygtk-2-14/docs/reference/ChangeLog
branches/pygtk-2-14/docs/reference/pygtk-gdk-classes.xml
branches/pygtk-2-14/docs/reference/pygtk-gdk-functions.xml
branches/pygtk-2-14/docs/reference/pygtk-gdkscreen.xml
branches/pygtk-2-14/docs/reference/pygtk-gdkwindow.xml
branches/pygtk-2-14/docs/reference/pygtk-gtk-classes.xml
branches/pygtk-2-14/docs/reference/pygtk-gtk-constants.xml
branches/pygtk-2-14/docs/reference/pygtk-gtk-stock-items.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkaccelgroup.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkadjustment.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkclipboard.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkcolorselectiondialog.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkcontainer.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkdialog.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkfilechooser.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkfontselection.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkfontselectiondialog.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkhandlebox.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkiconinfo.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkicontheme.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkimage.xml
branches/pygtk-2-14/docs/reference/pygtk-gtklayout.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkmessagedialog.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkpagesetup.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkplug.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkprintsettings.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkselectiondata.xml
branches/pygtk-2-14/docs/reference/pygtk-gtksocket.xml
branches/pygtk-2-14/docs/reference/pygtk-gtktoolitem.xml
branches/pygtk-2-14/docs/reference/pygtk-gtktooltip.xml
branches/pygtk-2-14/docs/reference/pygtk-gtktooltips.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkwidget.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkwindow.xml
Modified: branches/pygtk-2-14/docs/Makefile.am
==============================================================================
--- branches/pygtk-2-14/docs/Makefile.am (original)
+++ branches/pygtk-2-14/docs/Makefile.am Thu Mar 5 22:54:50 2009
@@ -33,7 +33,8 @@
reference/pygtk-atktable.xml \
reference/pygtk-atktext.xml \
reference/pygtk-atkvalue.xml \
- reference/pygtk-gdkatom.xml \
+ reference/pygtk-gdkapplaunchcontext.xml \
+ reference/pygtk-gdkatom.xml \
reference/pygtk-gdkcairocontext.xml \
reference/pygtk-gdk-classes.xml \
reference/pygtk-gdkcolormap.xml \
@@ -162,6 +163,7 @@
reference/pygtk-gtkmenu.xml \
reference/pygtk-gtkmessagedialog.xml \
reference/pygtk-gtkmisc.xml \
+ reference/pygtk-gtkmountoperation.xml \
reference/pygtk-gtknotebook.xml \
reference/pygtk-gtkobject.xml \
reference/pygtk-gtkoptionmenu.xml \
@@ -226,6 +228,7 @@
reference/pygtk-gtktoolbar.xml \
reference/pygtk-gtktoolbutton.xml \
reference/pygtk-gtktoolitem.xml \
+ reference/pygtk-gtktoolshell.xml \
reference/pygtk-gtktooltip.xml \
reference/pygtk-gtktooltips.xml \
reference/pygtk-gtktreedragdest.xml \
@@ -319,6 +322,7 @@
html/class-atktext.html \
html/class-atkvalue.html \
html/class-gdkatom.html \
+ html/class-gdkapplaunchcontext.html \
html/class-gdkcairocontext.html \
html/class-gdkcolor.html \
html/class-gdkcolormap.html \
@@ -439,6 +443,7 @@
html/class-gtkmenutoolbutton.html \
html/class-gtkmessagedialog.html \
html/class-gtkmisc.html \
+ html/class-gtkmountoperation.html \
html/class-gtknotebook.html \
html/class-gtkobject.html \
html/class-gtkoptionmenu.html \
@@ -502,6 +507,7 @@
html/class-gtktoolbar.html \
html/class-gtktoolbutton.html \
html/class-gtktoolitem.html \
+ html/class-gtktoolshell.html \
html/class-gtktooltip.html \
html/class-gtktooltips.html \
html/class-gtktreedragdest.html \
@@ -587,7 +593,7 @@
CSSdir = $(TARGET_DIR)
EXTRA_DIST = \
- cursors icons \
+ cursors icons images \
$(HTML_FILES) \
$(XMLFILES) \
$(XSLFILES) \
@@ -596,6 +602,7 @@
dist-hook:
rm -rf `find $(distdir)/cursors -name .svn`
rm -rf `find $(distdir)/icons -name .svn`
+ rm -rf `find $(distdir)/images -name .svn`
install-data-local:
installfiles=`echo $(srcdir)/html/*`; \
@@ -604,6 +611,7 @@
else \
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) \
$(DESTDIR)$(TARGET_DIR)/icons \
+ $(DESTDIR)$(TARGET_DIR)/images \
$(DESTDIR)$(TARGET_DIR)/cursors; \
for i in $$installfiles; do \
echo '-- Installing '$$i ; \
@@ -615,6 +623,10 @@
echo '-- Installing '$$i ; \
$(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR)/icons; \
done; \
+ for i in $(srcdir)/images/*; do \
+ echo '-- Installing '$$i ; \
+ $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR)/images; \
+ done; \
for i in $(srcdir)/cursors/*; do \
echo '-- Installing '$$i ; \
$(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR)/cursors; \
Added: branches/pygtk-2-14/docs/icons/stock_page_setup_24.png
==============================================================================
Binary file. No diff available.
Added: branches/pygtk-2-14/docs/icons/stock_print_error_24.png
==============================================================================
Binary file. No diff available.
Added: branches/pygtk-2-14/docs/icons/stock_print_paused_24.png
==============================================================================
Binary file. No diff available.
Added: branches/pygtk-2-14/docs/icons/stock_print_report_24.png
==============================================================================
Binary file. No diff available.
Added: branches/pygtk-2-14/docs/icons/stock_print_warning_24.png
==============================================================================
Binary file. No diff available.
Added: branches/pygtk-2-14/docs/images/layout-btlr.png
==============================================================================
Binary file. No diff available.
Added: branches/pygtk-2-14/docs/images/layout-btrl.png
==============================================================================
Binary file. No diff available.
Added: branches/pygtk-2-14/docs/images/layout-lrbt.png
==============================================================================
Binary file. No diff available.
Added: branches/pygtk-2-14/docs/images/layout-lrtb.png
==============================================================================
Binary file. No diff available.
Added: branches/pygtk-2-14/docs/images/layout-rlbt.png
==============================================================================
Binary file. No diff available.
Added: branches/pygtk-2-14/docs/images/layout-rltb.png
==============================================================================
Binary file. No diff available.
Added: branches/pygtk-2-14/docs/images/layout-tblr.png
==============================================================================
Binary file. No diff available.
Added: branches/pygtk-2-14/docs/images/layout-tbrl.png
==============================================================================
Binary file. No diff available.
Modified: branches/pygtk-2-14/docs/reference/pygtk-gdk-classes.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gdk-classes.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gdk-classes.xml Thu Mar 5 22:54:50 2009
@@ -6,6 +6,7 @@
<!-- GDK CLASSES -->
+ <xi:include href="pygtk-gdkapplaunchcontext.xml"/>
<xi:include href="pygtk-gdkatom.xml"/>
<xi:include href="pygtk-gdkcairocontext.xml"/>
<xi:include href="pygtk-gdkcolor.xml"/>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gdk-functions.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gdk-functions.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gdk-functions.xml Thu Mar 5 22:54:50 2009
@@ -511,7 +511,10 @@
<methodname><link
linkend="function-gdk--threads-leave">gtk.gdk.threads_leave</link></methodname>
<methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
+ </methodsynopsis><synopsis language="python">
+ <varname><link
+linkend="function-gdk--lock">gtk.gdk.lock</link></varname>
+ </synopsis><methodsynopsis language="python">
<methodname><link
linkend="function-gdk--threads-init">gtk.gdk.threads_init</link></methodname>
<methodparam></methodparam>
@@ -966,6 +969,24 @@
</refsect2>
+ <refsect2 id="function-gdk--lock">
+ <title>gtk.gdk.lock</title>
+
+ <programlisting><synopsis language="python">
+ <varname>gtk.gdk.lock</varname>
+ </synopsis></programlisting>
+
+ <para>
+ The <varname>gtk.gdk.lock</varname> constant is a context manager that calls
+ <link linkend="function-gdk--threads-enter"><function>gtk.gdk.threads_enter</function></link>
+ and <link linkend="function-gdk--threads-leave"><function>gtk.gdk.threads_leave</function></link>
+ in its <function>__enter__</function> and <function>__exit__</function> methods
+ correspondingly. It is intended to be used in <literal>with</literal> statement,
+ new in Python 2.5. Read statement description for details.
+ </para>
+
+ </refsect2>
+
<refsect2 id="function-gdk--threads-init">
<title>gtk.gdk.threads_init</title>
Added: branches/pygtk-2-14/docs/reference/pygtk-gdkapplaunchcontext.xml
==============================================================================
--- (empty file)
+++ branches/pygtk-2-14/docs/reference/pygtk-gdkapplaunchcontext.xml Thu Mar 5 22:54:50 2009
@@ -0,0 +1,224 @@
+<?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-gdkapplaunchcontext">
+ <refnamediv>
+ <refname>gtk.gdk.AppLaunchContext</refname>
+ <refpurpose>Startup notification for applications.</refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Synopsis</title>
+
+ <classsynopsis language="python">
+ <ooclass><classname>gtk.gdk.AppLaunchContext</classname></ooclass>
+ <ooclass><classname><link linkend="class-gioapplaunchcontext">gio.AppLaunchContext</link></classname></ooclass>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gdkapplaunchcontext--set-desktop">set_desktop</link></methodname>
+ <methodparam><parameter role="keyword">desktop</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gdkapplaunchcontext--set-display">set_display</link></methodname>
+ <methodparam><parameter role="keyword">display</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gdkapplaunchcontext--set-icon">set_icon</link></methodname>
+ <methodparam><parameter role="keyword">icon</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gdkapplaunchcontext--set-icon-name">set_icon_name</link></methodname>
+ <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gdkapplaunchcontext--set-screen">set_screen</link></methodname>
+ <methodparam><parameter role="keyword">screen</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gdkapplaunchcontext--set-timestamp">set_timestamp</link></methodname>
+ <methodparam><parameter role="keyword">timestamp</parameter></methodparam>
+ </methodsynopsis>
+
+ </classsynopsis>
+ </refsect1>
+
+ <refsect1>
+ <title>Ancestry</title>
+
+<synopsis>+-- <link linkend="class-gioapplaunchcontext">gio.AppLaunchContext</link>
+ +-- <link linkend="class-gdkapplaunchcontext">gtk.gdk.AppLaunchContext</link>
+</synopsis>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ The <link linkend="class-gdkapplaunchcontext"><classname>gtk.gdk.AppLaunchContext</classname></link>
+ is an implementation of <link linkend="class-gioapplaunchcontext">gio.AppLaunchContext</link>
+ that handles launching an application in a graphical context. It provides startup notification
+ and allows to launch applications on a specific screen or workspace.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Methods</title>
+
+ <refsect2 id="method-gdkapplaunchcontext--set-display">
+ <title>gtk.gdk.AppLaunchContext.set_display</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_display</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>display</parameter> :</term>
+ <listitem><simpara>a
+ <link linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_display</methodname>() method sets the display
+ on which applications will be launched when using this context. See also
+ <methodname><link linkend="method-gdkapplaunchcontext--set-screen">set_screen</link></methodname>.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gdkapplaunchcontext--set-desktop">
+ <title>gtk.gdk.AppLaunchContext.set_desktop</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_desktop</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>desktop</parameter> :</term>
+ <listitem><simpara>the number of a workspace, or -1
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_desktop</methodname>() method sets the workspace
+ on which applications will be launched when using this context when
+ running under a window manager that supports multiple workspaces, as
+ described in the Extended Window Manager Hints.
+ </para>
+ <para>
+ When the workspace is not specified or desktop is set to -1, it is
+ up to the window manager to pick one, typically it will be the current workspace.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gdkapplaunchcontext--set-icon">
+ <title>gtk.gdk.AppLaunchContext.set_icon</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_icon</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>icon</parameter> :</term>
+ <listitem><simpara>a
+ <link linkend="class-gioicon"><classname>gio.Icon</classname></link>,
+ or <literal>None</literal>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_icon</methodname>() method sets the icon for
+ applications that are launched with this context. See also
+ <methodname><link linkend="method-gdkapplaunchcontext--set-icon-name">set_icon_name</link></methodname>.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gdkapplaunchcontext--set-icon-name">
+ <title>gtk.gdk.AppLaunchContext.set_icon_name</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_icon_name</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>icon_name</parameter> :</term>
+ <listitem><simpara>an icon name, or <literal>None</literal>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_icon_name</methodname>() method sets the icon
+ for applications that are launched with this context. The icon_name
+ will be interpreted in the same way as the Icon field in desktop files. See also
+ <methodname><link linkend="method-gdkapplaunchcontext--set-icon">set_icon</link></methodname>.
+ </para>
+ <para>
+ If both icon and icon_name are set, the icon_name takes priority.
+ If neither icon or icon_name is set, the icon is taken from either the
+ file that is passed to launched application or from the
+ <link linkend="class-gioappinfo"><classname>gio.AppInfo</classname></link>
+ for the launched application itself.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gdkapplaunchcontext--set-timestamp">
+ <title>gtk.gdk.AppLaunchContext.set_timestamp</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_timestamp</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>timestamp</parameter> :</term>
+ <listitem><simpara>a timestamp
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_timestamp</methodname>() method sets the timestamp of
+ context. The timestamp should ideally be taken from the event that triggered the launch.
+ </para>
+ <para>
+ Window managers can use this information to avoid moving the focus
+ to the newly launched application when the user is busy typing in
+ another window. This is also known as 'focus stealing prevention'.
+ </para>
+ </refsect2>
+ </refsect1>
+</refentry>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gdkscreen.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gdkscreen.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gdkscreen.xml Thu Mar 5 22:54:50 2009
@@ -110,6 +110,18 @@
<methodname><link linkend="method-gdkscreen--get-rgba-visual">get_rgba_visual</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gdkscreen--get-monitor-height-mm">get_monitor_height_mm</link></methodname>
+ <methodparam><parameter role="keyword">monitor_num</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gdkscreen--get-monitor-width-mm">get_monitor_width_mm</link></methodname>
+ <methodparam><parameter role="keyword">monitor_num</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gdkscreen--get-monitor-plug-name">get_monitor_plug_name</link></methodname>
+ <methodparam><parameter role="keyword">monitor_num</parameter></methodparam>
+ </methodsynopsis>
</classsynopsis>
<programlisting>
@@ -158,6 +170,18 @@
</listitem>
</varlistentry>
</variablelist>
+ <variablelist>
+ <varlistentry>
+ <term>"<link linkend="signal-gdkscreen--monitors-changed">monitors-changed</link>"</term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>screen</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
@@ -870,6 +894,95 @@
</refsect2>
+ <refsect2 id="method-gdkscreen--get-monitor-height-mm">
+ <title>gtk.gdk.Screen.get_monitor_height_mm</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_monitor_height_mm</methodname>
+ <methodparam><parameter role="keyword">monitor_num</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">monitor_num</parameter> :</term>
+ <listitem><simpara>Number of the monitor.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>The height of the monitor, or -1 if not available.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_monitor_height_mm</methodname>() method gets the height
+ in millimeters of the specified monitor.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gdkscreen--get-monitor-width-mm">
+ <title>gtk.gdk.Screen.get_monitor_width_mm</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_monitor_width_mm</methodname>
+ <methodparam><parameter role="keyword">monitor_num</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">monitor_num</parameter> :</term>
+ <listitem><simpara>Number of the monitor.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>The width of the monitor, or -1 if not available.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_monitor_width_mm</methodname>() method gets the width
+ in millimeters of the specified monitor.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gdkscreen--get-monitor-plug-name">
+ <title>gtk.gdk.Screen.get_monitor_plug_name</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_monitor_plug_name</methodname>
+ <methodparam><parameter role="keyword">monitor_num</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">monitor_num</parameter> :</term>
+ <listitem><simpara>Number of the monitor.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A newly-allocated string containing the name of the monitor,
+ or <literal>None</literal> if the name cannot be determined.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_monitor_plug_name</methodname>() method returns the output
+ name of the specified monitor. Usually something like VGA, DVI, or TV, not the
+ actual product name of the display device.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
@@ -1023,6 +1136,46 @@
</refsect2>
+ <refsect2 id="signal-gdkscreen--monitor-changed">
+ <title>The "monitor-changed" gtk.gdk.Screen Signal</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>callback</methodname>
+ <methodparam><parameter>screen</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>screen</parameter> :</term>
+ <listitem><simpara>the screen that received 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>
+ </variablelist>
+
+ <para>
+ The "monitor-changed" signal is emitted when the number, size or position
+ of the monitors attached to the screen change.
+ </para>
+ <para>
+ Only for X for now. Future implementations for Win32 and OS X may be a possibility.
+ </para>
+
+
+ </refsect2>
</refsect1>
</refentry>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gdkwindow.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gdkwindow.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gdkwindow.xml Thu Mar 5 22:54:50 2009
@@ -686,6 +686,24 @@
<methodname><link linkend="method-gdkwindow--set-startup-id">set_startup_id</link></methodname>
<methodparam><parameter role="keyword">startup_id</parameter></methodparam>
</methodsynopsis>
+
+ <!-- NOT IMPLEMENTED
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gdkwindow- -redirect-to-drawable">redirect_to_drawable</link></methodname>
+ <methodparam><parameter role="keyword">drawable</parameter></methodparam>
+ <methodparam><parameter role="keyword">src_x</parameter></methodparam>
+ <methodparam><parameter role="keyword">src_y</parameter></methodparam>
+ <methodparam><parameter role="keyword">dest_x</parameter></methodparam>
+ <methodparam><parameter role="keyword">dest_y</parameter></methodparam>
+ <methodparam><parameter role="keyword">width</parameter></methodparam>
+ <methodparam><parameter role="keyword">height</parameter></methodparam>
+ </methodsynopsis>
+ END NOT IMPLEMENTED -->
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gdkwindow--remove-redirection">remove_redirection</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
</classsynopsis>
<programlisting>
@@ -4407,6 +4425,104 @@
</para>
</refsect2>
+
+ <!-- NOT IMPLEMENTED
+ <refsect2 id="method-gdkwindow- -redirect-to-drawable">
+ <title>gtk.gdk.Window.redirect_to_drawable</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>redirect_to_drawable</methodname>
+ <methodparam><parameter role="keyword">drawable</parameter></methodparam>
+ <methodparam><parameter role="keyword">src_x</parameter></methodparam>
+ <methodparam><parameter role="keyword">src_y</parameter></methodparam>
+ <methodparam><parameter role="keyword">dest_x</parameter></methodparam>
+ <methodparam><parameter role="keyword">dest_y</parameter></methodparam>
+ <methodparam><parameter role="keyword">width</parameter></methodparam>
+ <methodparam><parameter role="keyword">height</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter
+ role="keyword">drawable</parameter> :</term>
+ <listitem><simpara><link linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter
+ role="keyword">src_x</parameter> :</term>
+ <listitem><simpara>x position in window</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter
+ role="keyword">src_y</parameter> :</term>
+ <listitem><simpara>y position in window</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter
+ role="keyword">dest_x</parameter> :</term>
+ <listitem><simpara>x position in drawable</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter
+ role="keyword">dest_y</parameter> :</term>
+ <listitem><simpara>y position in drawable </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter
+ role="keyword">width</parameter> :</term>
+ <listitem><simpara>width of redirection </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter
+ role="keyword">height</parameter> :</term>
+ <listitem><simpara>height of redirection </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>input_shape_combine_region</methodname>() method redirects drawing
+ into window so that drawing to the window in the rectangle specified by src_x, src_y, width
+ and height is also drawn into drawable at dest_x, dest_y.
+ </para>
+ <para>
+ Only drawing between
+ <methodname><link linkend="method-gdkwindow- -begin-paint-region">gtk.gdk.Window.begin_paint_region</link></methodname>()
+ or
+ <methodname><link linkend="method-gdkwindow- -begin-paint-region">gtk.gdk.Window.begin_paint_rect</link></methodname>()
+ and
+ <methodname><link linkend="method-gdkwindow- -end-paint">gtk.gdk.Window.end_paint</link></methodname>()
+ is redirected.
+ </para>
+
+ </refsect2>
+ END NOT IMPLEMENTED -->
+
+ <refsect2 id="method-gdkwindow--remove-redirection">
+ <title>gtk.gdk.Window.remove_redirection</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>remove_redirection</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ When using GTK+, typically you should use
+ <methodname><link linkend="method-gtkwindow--set-startup-id">gtk.Window.set_startup_id</link></methodname>()
+ instead of this low-level function.
+ </para>
+
+ </refsect2>
</refsect1>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtk-classes.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtk-classes.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtk-classes.xml Thu Mar 5 22:54:50 2009
@@ -103,6 +103,7 @@
<xi:include href="pygtk-gtkmenutoolbutton.xml"/>
<xi:include href="pygtk-gtkmessagedialog.xml"/>
<xi:include href="pygtk-gtkmisc.xml"/>
+ <xi:include href="pygtk-gtkmountoperation.xml"/>
<xi:include href="pygtk-gtknotebook.xml"/>
<xi:include href="pygtk-gtkobject.xml"/>
<xi:include href="pygtk-gtkoptionmenu.xml"/>
@@ -162,6 +163,7 @@
<xi:include href="pygtk-gtktoolbar.xml"/>
<xi:include href="pygtk-gtktoolbutton.xml"/>
<xi:include href="pygtk-gtktoolitem.xml"/>
+ <xi:include href="pygtk-gtktoolshell.xml"/>
<xi:include href="pygtk-gtktooltip.xml"/>
<xi:include href="pygtk-gtktooltips.xml"/>
<xi:include href="pygtk-gtktreedragdest.xml"/>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtk-constants.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtk-constants.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtk-constants.xml Thu Mar 5 22:54:50 2009
@@ -48,6 +48,7 @@
<xref linkend="gtk-metric-type-constants" endterm="gtk-metric-type-constants-title"></xref>
<xref linkend="gtk-movement-step-constants" endterm="gtk-movement-step-constants-title"></xref>
<xref linkend="gtk-notebook-tab-constants" endterm="gtk-notebook-tab-constants-title"></xref>
+<xref linkend="gtk-number-up-layout-constants" endterm="gtk-number-up-layout-constants-title"></xref>
<xref linkend="gtk-object-flags-constants" endterm="gtk-object-flags-constants-title"></xref>
<xref linkend="gtk-orientation-constants" endterm="gtk-orientation-constants-title"></xref>
<xref linkend="gtk-pack-direction-constants" endterm="gtk-pack-direction-constants-title"></xref>
@@ -1635,6 +1636,113 @@
</refsect2>
+ <refsect2 id="gtk-number-up-layout-constants">
+ <title id="gtk-number-up-layout-constants-title">GTK Number Up Layout Constants</title>
+
+ <para>Used to determine the layout of pages on a sheet when printing
+ multiple pages per sheet.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><literal>gtk.NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM</literal></term>
+ <listitem>
+ <simpara>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/layout-lrtb.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gtk.NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_BOTTOM_TO_TOP</literal></term>
+ <listitem>
+ <simpara>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/layout-lrbt.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gtk.NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_TOP_TO_BOTTOM</literal></term>
+ <listitem>
+ <simpara>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/layout-rltb.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gtk.NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_BOTTOM_TO_TOP</literal></term>
+ <listitem>
+ <simpara>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/layout-lrbt.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gtk.NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_LEFT_TO_RIGHT</literal></term>
+ <listitem>
+ <simpara>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/layout-tblr.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gtk.NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_RIGHT_TO_LEFT</literal></term>
+ <listitem>
+ <simpara>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/layout-tbrl.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gtk.NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_LEFT_TO_RIGHT</literal></term>
+ <listitem>
+ <simpara>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/layout-btlr.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gtk.NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_RIGHT_TO_LEFT</literal></term>
+ <listitem>
+ <simpara>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/layout-btrl.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </simpara>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ </refsect2>
+
<refsect2 id="gtk-object-flags-constants">
<title id="gtk-object-flags-constants-title">GTK Object Flags Constants</title>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtk-stock-items.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtk-stock-items.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtk-stock-items.xml Thu Mar 5 22:54:50 2009
@@ -768,6 +768,17 @@
</varlistentry>
<varlistentry>
+ <term><literal>gtk.STOCK_PAGE_SETUP</literal></term>
+ <listitem>
+ <simpara><inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/stock_page_setup_24.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>Available in GTK+ 2.14 and above.</simpara>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><literal>gtk.STOCK_PASTE</literal></term>
<listitem>
<simpara><inlinemediaobject>
@@ -801,6 +812,28 @@
</varlistentry>
<varlistentry>
+ <term><literal>gtk.STOCK_PRINT_ERROR</literal></term>
+ <listitem>
+ <simpara><inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/stock_print_error_24.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>Available in GTK+ 2.14 and above.</simpara>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>gtk.STOCK_PRINT_PAUSED</literal></term>
+ <listitem>
+ <simpara><inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/stock_print_paused_24.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>Available in GTK+ 2.14 and above.</simpara>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><literal>gtk.STOCK_PRINT_PREVIEW</literal></term>
<listitem>
<simpara><inlinemediaobject>
@@ -812,6 +845,28 @@
</varlistentry>
<varlistentry>
+ <term><literal>gtk.STOCK_PRINT_REPORT</literal></term>
+ <listitem>
+ <simpara><inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/stock_print_report_24.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>Available in GTK+ 2.14 and above.</simpara>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>gtk.STOCK_PRINT_WARNING</literal></term>
+ <listitem>
+ <simpara><inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/stock_print_warning_24.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>Available in GTK+ 2.14 and above.</simpara>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><literal>gtk.STOCK_PROPERTIES</literal></term>
<listitem>
<simpara><inlinemediaobject>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkaccelgroup.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkaccelgroup.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkaccelgroup.xml Thu Mar 5 22:54:50 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: branches/pygtk-2-14/docs/reference/pygtk-gtkadjustment.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkadjustment.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkadjustment.xml Thu Mar 5 22:54:50 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: branches/pygtk-2-14/docs/reference/pygtk-gtkclipboard.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkclipboard.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkclipboard.xml Thu Mar 5 22:54:50 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: branches/pygtk-2-14/docs/reference/pygtk-gtkcolorselectiondialog.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkcolorselectiondialog.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkcolorselectiondialog.xml Thu Mar 5 22:54:50 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: branches/pygtk-2-14/docs/reference/pygtk-gtkcontainer.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkcontainer.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkcontainer.xml Thu Mar 5 22:54:50 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: branches/pygtk-2-14/docs/reference/pygtk-gtkdialog.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkdialog.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkdialog.xml Thu Mar 5 22:54:50 2009
@@ -95,6 +95,16 @@
<methodparam><parameter
role="keyword">widget</parameter></methodparam>
</methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkdialog--get-action-area">get_action_area</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkdialog--get-content-area">get_content_area</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
</classsynopsis>
<programlisting>
@@ -792,12 +802,63 @@
</refsect2>
+ <refsect2 id="method-gtkdialog--get-action-area">
+ <title>gtk.Dialog.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.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_action_area</methodname>() method
+ returns the action area of dialog.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkdialog--get-content-area">
+ <title>gtk.Dialog.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
+ <link linkend="class-gdkscreen"><classname>gtk.VBox</classname></link>.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_content_area</methodname>() method
+ returns the content area of dialog.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
<title>Functions</title>
- <refsect2 id="function-gtk- -alternative-dialog-button-order">
+ <refsect2 id="function-gtk--alternative-dialog-button-order">
<title>gtk.alternative_dialog_button_order</title>
<programlisting><methodsynopsis language="python">
@@ -809,8 +870,8 @@
<varlistentry>
<term><parameter role="keyword">screen</parameter> :</term>
<listitem><simpara>the <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname> or
-<literal>None</literal> to use the default screen</link></simpara></listitem>
+linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link> or
+<literal>None</literal> to use the default screen</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkfilechooser.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkfilechooser.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkfilechooser.xml Thu Mar 5 22:54:50 2009
@@ -206,6 +206,42 @@
<methodname><link linkend="method-gtkfilechooser--get-do-overwrite-confirmation">get_do_overwrite_confirmation</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfilechooser--get-current-folder-file">get_current_folder_file</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfilechooser--get-file">get_file</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
+ <!-- NOT IMPLEMENTED
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfilechooser- -get-files">get_files</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ -->
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfilechooser--get-preview-file">get_preview_file</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfilechooser--select-file">select_file</link></methodname>
+ <methodparam><parameter role="keyword">file</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfilechooser--set-current-folder-file">set_current_folder_file</link></methodname>
+ <methodparam><parameter role="keyword">file</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfilechooser--set-file">set_file</link></methodname>
+ <methodparam><parameter role="keyword">file</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfilechooser--unselect-file">unselect_file</link></methodname>
+ <methodparam><parameter role="keyword">file</parameter></methodparam>
+ </methodsynopsis>
</classsynopsis>
</refsect1>
@@ -2115,6 +2151,273 @@
</refsect2>
+ <refsect2 id="method-gtkfilechooser--get-current-folder-file">
+ <title>gtk.FileChooser.get_current_folder_file</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_current_folder_file</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>The <link linkend="class-giofile">
+ <classname>gio.File</classname></link>.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_current_folder_file</methodname>() method returns
+ the current folder of chooser as <link linkend="class-giofile"><classname>gio.File</classname></link>.
+ See <link linkend="method-gtkfilechooser--get-current-folder-uri">gtk.FileChooser.get_current_folder_uri</link>().
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfilechooser--get-file">
+ <title>gtk.FileChooser.get_file</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_file</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A selected <link linkend="class-giofile">
+ <classname>gio.File</classname></link>.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_file</methodname>() method returns
+ the <link linkend="class-giofile"><classname>gio.File</classname></link>
+ for the currently selected file in the file selector.
+ If multiple files are selected, one of the files will be returned at random.
+ </para>
+ <para>
+ If the file chooser is in folder mode, this function returns the selected folder.
+ </para>
+
+ </refsect2>
+
+ <!-- NOT IMPLEMENTED
+ <refsect2 id="method-gtkfilechooser- -get-files">
+ <title>gtk.FileChooser.get_files</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_files</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A list containing a <link linkend="class-giofile">
+ <classname>gio.File</classname></link> for each selected file and subfolder
+ in the current folder.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_files</methodname>() method returns
+ Lists all the selected files and subfolders in the current folder of chooser as
+ <link linkend="class-giofile"><classname>gio.File</classname></link>. An internal function, see
+ <link linkend="method-gtkfilechooser- -get-uris">gtk.FileChooser.get_uris</link>().
+ </para>
+
+ </refsect2> -->
+
+ <refsect2 id="method-gtkfilechooser--get-preview-file">
+ <title>gtk.FileChooser.get_preview_file</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_preview_file</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>The <link linkend="class-giofile">
+ <classname>gio.File</classname></link> for the file to preview,
+ or <literal>None</literal> if no file is selected.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_preview_file</methodname>() method returns
+ the <link linkend="class-giofile"><classname>gio.File</classname></link>
+ that should be previewed in a custom preview Internal function, see
+ <link linkend="method-gtkfilechooser--get-preview-uri">gtk.FileChooser.get_preview_uri</link>().
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfilechooser--select-file">
+ <title>gtk.FileChooser.select_file</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>select_file</methodname>
+ <methodparam><parameter role="keyword">file</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">file</parameter> :</term>
+ <listitem><simpara>the file to select.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> if both the folder could be changed
+ and the path was selected successfully,
+ <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>select_file</methodname>() method
+ selects the file referred to by file. An internal function. See
+ <link linkend="method-gtkfilechooser--select-uri">gtk.FileChooser.select_uri</link>().
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfilechooser--set-current-folder-file">
+ <title>gtk.FileChooser.set_current_folder_file</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_current_folder_file</methodname>
+ <methodparam><parameter role="keyword">file</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">file</parameter> :</term>
+ <listitem><simpara>the <link linkend="class-giofile"><classname>gio.File</classname></link>
+ for the new folder.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> if the folder could be changed
+ successfully, <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>set_current_folder_file</methodname>() method
+ sets the current folder for chooser from a
+ <link linkend="class-giofile"><classname>gio.File</classname></link>.
+ Internal function, see
+ <link linkend="method-gtkfilechooser--set-current-folder-uri">gtk.FileChooser.set_current_folder_uri</link>().
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfilechooser--set-file">
+ <title>gtk.FileChooser.set_file</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_file</methodname>
+ <methodparam><parameter role="keyword">file</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">file</parameter> :</term>
+ <listitem><simpara>the <link linkend="class-giofile"><classname>gio.File</classname></link>
+ to set as current.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> if both the folder could be changed
+ and the file selected successfully, <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>set_file</methodname>() method
+ Sets file as the current filename for the file chooser, by changing to the
+ file's parent folder and actually selecting the file in list.
+ If the chooser is in gtk.FILE_CHOOSER_ACTION_SAVE mode, the file's base
+ name will also appear in the dialog's file name entry.
+ </para>
+ <para>
+ If the file name isn't in the current folder of chooser, then the current
+ folder of chooser will be changed to the folder containing filename.
+ This is equivalent to a sequence of
+ <link linkend="method-gtkfilechooser--unselect-all">gtk.FileChooser.unselect_all</link>()
+ followed by <link linkend="method-gtkfilechooser--select-filename">gtk.FileChooser.select_filename</link>().
+ </para>
+ <para>
+ Note that the file must exist, or nothing will be done except for the directory change.
+ </para>
+ <para>
+ If you are implementing a File/Save As... dialog, you should use this function
+ if you already have a file name to which the user may save; for example,
+ when the user opens an existing file and then does File/Save As... on it.
+ If you don't have a file name already â for example, if the user just created a
+ new file and is saving it for the first time, do not call this function. Instead,
+ use something similar to this:
+ </para>
+<programlisting>
+if (document_is_new):
+ # the user just created a new document
+ chooser.set_current_folder_file(default_file_for_saving)
+ chooser.set_current_name("Untitled document")
+else:
+ # the user edited an existing document
+ chooser.set_file(existing_file)
+</programlisting>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfilechooser--unselect-file">
+ <title>gtk.FileChooser.unselect_file</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>unselect_file</methodname>
+ <methodparam><parameter role="keyword">file</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">file</parameter> :</term>
+ <listitem><simpara>a <link linkend="class-giofile"><classname>gio.File</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>unselect_file</methodname>() method
+ unselects the file referred to by file. If the file is not in the current
+ directory, does not exist, or is otherwise not currently selected, does nothing.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkfontselection.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkfontselection.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkfontselection.xml Thu Mar 5 22:54:50 2009
@@ -39,6 +39,40 @@
<methodparam><parameter
role="keyword">text</parameter></methodparam>
</methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselection--get-face">get_face</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselection--get-face-list">get_face_list</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselection--get-family">get_family</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselection--get-family-list">get_family_list</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselection--get-preview-entry">get_preview_entry</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselection--get-size">get_size</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselection--get-size-entry">get_size_entry</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselection--get-size-list">get_size_list</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
</classsynopsis>
</refsect1>
@@ -282,6 +316,225 @@
</refsect2>
+ <refsect2 id="method-gtkfontselection--get-face">
+ <title>gtk.FontSelection.get_face</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_face</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A <link linkend="class-pangofontface"><classname>pango.FontFace</classname></link>
+ representing the selected font group details.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_face</methodname>() method gets the
+ <link linkend="class-pangofontface"><classname>pango.FontFace</classname></link>
+ representing the selected font group details (i.e. family, slant, weight, width, etc).
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfontselection--get-face-list">
+ <title>gtk.FontSelection.get_face_list</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_face_list</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A
+ <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
+ that is part of fontsel.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_face_list</methodname>() method returns the
+ <link linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
+ which lists all styles available for the selected font. For example, 'Regular', 'Bold', etc.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfontselection--get-family">
+ <title>gtk.FontSelection.get_family</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_family</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A <link linkend="class-pangofontselection"><classname>pango.FontSelection</classname></link>
+ representing the selected font family. Font families are a collection of font faces.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_family</methodname>() method gets the
+ <link linkend="class-pangofontselection"><classname>pango.FontSelection</classname></link>
+ representing the selected font family.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfontselection--get-family-list">
+ <title>gtk.FontSelection.get_family_list</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_family_list</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A
+ <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
+ that is part of fontsel.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_family_list</methodname>() method returns the
+ <link linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
+ that lists font families, for example, 'Sans', 'Serif', etc.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfontselection--get-preview-entry">
+ <title>gtk.FontSelection.get_preview_entry</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_preview_entry</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A
+ <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
+ that is part of fontsel.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_preview_entry</methodname>() method returns the
+ <link linkend="class-gtkentry"><classname>gtk.Entry</classname></link>
+ used to display the font as a preview.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfontselection--get-size">
+ <title>gtk.FontSelection.get_size</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_size</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A n integer representing the selected font size,
+ or -1 if no font size is selected. </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_size</methodname>() method returns the selected font size.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfontselection--get-size-entry">
+ <title>gtk.FontSelection.get_size_entry</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_size_entry</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A
+ <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
+ that is part of fontsel.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_preview_entry</methodname>() method returns the
+ <link linkend="class-gtkentry"><classname>gtk.Entry</classname></link>
+ used to allow the user to edit the font number manually instead of
+ selecting it from the list of font sizes.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfontselection--get-size-list">
+ <title>gtk.FontSelection.get_size_list</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_size_list</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A
+ <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
+ that is part of fontsel.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_size_list</methodname>() method returns the
+ <link linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
+ used to list font sizes.
+ </para>
+
+ </refsect2>
+
</refsect1>
</refentry>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkfontselectiondialog.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkfontselectiondialog.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkfontselectiondialog.xml Thu Mar 5 22:54:50 2009
@@ -41,6 +41,20 @@
<methodparam><parameter
role="keyword">text</parameter></methodparam>
</methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselectiondialog--get-apply-button">get_apply_button</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselectiondialog--get-cancel-button">get_cancel_button</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselectiondialog--get-ok-button">get_ok_button</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
</classsynopsis>
</refsect1>
@@ -323,6 +337,80 @@
</refsect2>
+ <refsect2 id="method-gtkfontselectiondialog--get-apply-button">
+ <title>gtk.FontSelectionDialog.get_apply_button</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_apply_button</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above but it will be deprecated in 2.16
+ don't use this method.</para>
+ </note>
+
+ <para>
+ The <methodname>get_apply_button</methodname>() method obtains a button.
+ The button doesn't have any function.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfontselectiondialog--get-cancel-button">
+ <title>gtk.FontSelectionDialog.get_cancel_button</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_cancel_button</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>.
+ used in the dialog for the 'Cancel' button.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_cancel_button</methodname>() method gets the 'Cancel' button.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfontselectiondialog--get-ok-button">
+ <title>gtk.FontSelectionDialog.get_ok_button</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_ok_button</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>.
+ used in the dialog for the 'OK' button.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_ok_button</methodname>() method gets the 'OK' button.
+ </para>
+
+ </refsect2>
+
</refsect1>
</refentry>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkhandlebox.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkhandlebox.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkhandlebox.xml Thu Mar 5 22:54:50 2009
@@ -49,6 +49,12 @@
<methodname><link
linkend="method-gtkhandlebox--get-snap-edge">get_snap_edge</link></methodname>
<methodparam></methodparam> </methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkhandlebox--get-child-detached">get_child_detached</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
</classsynopsis>
</refsect1>
@@ -394,6 +400,31 @@
</refsect2>
+ <refsect2 id="method-gtkhandlebox--get-child-detached">
+ <title>gtk.HandleBox.get_child_detached</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_child_detached</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> if the child is currently detached,
+ otherwise <literal>False</literal></simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_child_detached</methodname>() method gets
+ whether the handlebox's child is currently detached.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkiconinfo.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkiconinfo.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkiconinfo.xml Thu Mar 5 22:54:50 2009
@@ -52,6 +52,13 @@
</methodsynopsis>
</classsynopsis>
+<programlisting>
+<emphasis role="bold">Functions</emphasis>
+<methodsynopsis language="python">
+ <methodname><link linkend="function-gtk--iconinfo-new-from-pixbuf">gtk.icon_info_new_from_pixbuf</link></methodname>
+ <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
</refsect1>
<refsect1>
@@ -388,4 +395,35 @@
</refsect1>
+
+ <refsect1>
+ <title>Functions</title>
+
+ <refsect2 id="function-gtk--iconinfo-new-from-pixbuf">
+ <title>gtk.icon_info_new_from_pixbuf</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>gtk.icon_info_new_from_pixbuf</methodname>
+ <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">pixbuf</parameter> :</term>
+ <listitem><simpara>the <link linkend="class-gtkpixbuf"><classname>gtk.Pixbuf</classname></link>
+ to wrap in a <link linkend="class-gtkiconinfo"><classname>gtk.IconInfo</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This function is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ Creates a <link linkend="class-gtkiconinfo"><classname>gtk.IconInfo</classname></link>
+ for a <link linkend="class-gtkpixbuf"><classname>gtk.Pixbuf</classname></link>.
+ </para>
+
+ </refsect2>
+ </refsect1>
</refentry>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkicontheme.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkicontheme.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkicontheme.xml Thu Mar 5 22:54:50 2009
@@ -81,6 +81,12 @@
<methodname><link linkend="method-gtkicontheme--get-icon-sizes">get_icon_sizes</link></methodname>
<methodparam><parameter role="keyword">icon_name</parameter></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkicontheme--lookup-by-gicon">lookup_by_gicon</link></methodname>
+ <methodparam><parameter role="keyword">icon</parameter></methodparam>
+ <methodparam><parameter role="keyword">size</parameter></methodparam>
+ <methodparam><parameter role="keyword">flags</parameter></methodparam>
+ </methodsynopsis>
</classsynopsis>
<programlisting>
@@ -783,6 +789,51 @@
</refsect2>
+ <refsect2 id="method-gtkicontheme--lookup-by-gicon">
+ <title>gtk.IconTheme.lookup_by_gicon</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>lookup_by_gicon</methodname>
+ <methodparam><parameter role="keyword">icon</parameter></methodparam>
+ <methodparam><parameter role="keyword">size</parameter></methodparam>
+ <methodparam><parameter role="keyword">flags</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">icon</parameter> :</term>
+ <listitem><simpara>the <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
+ to lookup</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">size</parameter> :</term>
+ <listitem><simpara>The desired icon size.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">flags</parameter> :</term>
+ <listitem><simpara>the flags modifying the behavior of the icon
+ lookup</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A <link linkend="class-gtkiconinfo"><classname>gtk.IconInfo</classname></link>.
+ structure containing information about the icon, or <literal>None</literal>
+ if the icon wasn't found.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>lookup_by_gicon</methodname>() method Looks up an icon
+ and returns a structure containing information such as the filename of
+ the icon. The icon can then be rendered into a pixbuf using
+ <methodname><link linkend="method-gtkiconinfo--load-icon">gtk.IconInfo.load_icon</link></methodname>().
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkimage.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkimage.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkimage.xml Thu Mar 5 22:54:50 2009
@@ -128,6 +128,12 @@
linkend="method-gtkimage--clear">clear</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkimage--set-from-gicon">set_from_gicon</link></methodname>
+ <methodparam><parameter role="keyword">gicon</parameter></methodparam>
+ <methodparam><parameter role="keyword">size</parameter></methodparam>
+ </methodsynopsis>
</classsynopsis>
<programlisting>
@@ -162,6 +168,10 @@
</methodsynopsis><methodsynopsis language="python">
<methodname><link linkend="function-gtk--image-new-from-pixbuf">gtk.image_new_from_pixbuf</link></methodname>
<methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
+ </methodsynopsis><methodsynopsis language="python">
+ <methodname><link linkend="function-gtk--image-new-from-gicon">gtk.image_new_from_gicon</link></methodname>
+ <methodparam><parameter role="keyword">gicon</parameter></methodparam>
+ <methodparam><parameter role="keyword">size</parameter></methodparam>
</methodsynopsis></programlisting>
</refsect1>
@@ -1008,6 +1018,37 @@
</refsect2>
+ <refsect2 id="method-gtkimage--set-from-gicon">
+ <title>gtk.Image.set_from_gicon</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_from_gicon</methodname>
+ <methodparam><parameter role="keyword">icon</parameter></methodparam>
+ <methodparam><parameter role="keyword">size</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">icon</parameter> :</term>
+ <listitem><simpara>an icon</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">size</parameter> :</term>
+ <listitem><simpara>an icon size</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ For the <methodname>set_from_gicon</methodname>() method see
+ <methodname><link linkend="function-gtk--image-new-from-gicon">gtk.image_new_from_gicon</link></methodname>()
+ for details.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
@@ -1354,6 +1395,44 @@
<link linkend="function-gtk--image-new-from-icon-set">gtk.image_new_from_icon_set</link>
</para>
</refsect2>
+
+ <refsect2 id="function-gtk--image-new-from-gicon">
+ <title>gtk.image_new_from_gicon</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>gtk.image_new_from_gicon</methodname>
+ <methodparam><parameter role="keyword">gicon</parameter></methodparam>
+ <methodparam><parameter role="keyword">size</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">gicon</parameter> :</term>
+ <listitem><simpara>a <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">size</parameter> :</term>
+ <listitem><simpara>a stock icon size.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a new <link linkend="class-gtkimage"><classname>gtk.Image</classname></link>
+ displaying the themed icon.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This function is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>The <function>gtk.image_new_from_pixbuf</function>() function returns
+ a new <link linkend="class-gtkimage"><classname>gtk.Image</classname></link>
+ displaying an icon from the current icon theme. If the icon name isn't known,
+ a "broken image" icon will be displayed instead. If the current icon theme is
+ changed, the icon will be updated appropriately.
+ </para>
+ </refsect2>
</refsect1>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtklayout.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtklayout.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtklayout.xml Thu Mar 5 22:54:50 2009
@@ -73,6 +73,11 @@
<methodparam><parameter
role="keyword">adjustment</parameter></methodparam>
</methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtklayout--get-bin-window">get_bin_window</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
</classsynopsis>
</refsect1>
@@ -556,6 +561,32 @@
</refsect2>
+ <refsect2 id="method-gtklayout--get-bin-window">
+ <title>gtk.Layout.get_bin_window</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_bin_window</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a
+ <link linkend="class-gdkwindow"><classname>gtk.gdk.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_bin_window</methodname>() method retrieve the bin window
+ of the layout used for drawing operations.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkmessagedialog.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkmessagedialog.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkmessagedialog.xml Thu Mar 5 22:54:50 2009
@@ -48,6 +48,10 @@
<methodname><link linkend="method-gtkmessagedialog--set-image">set_image</link></methodname>
<methodparam><parameter role="keyword">image</parameter></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkmessagedialog--get-image">get_image</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
</classsynopsis>
</refsect1>
@@ -474,6 +478,31 @@
</refsect2>
+ <refsect2 id="method-gtkmessagedialog--get-image">
+ <title>gtk.MessageDialog.get_image</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_image</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the dialog's image.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_image</methodname>() method gets the dialog's image.
+ </para>
+
+ </refsect2>
+
</refsect1>
</refentry>
Added: branches/pygtk-2-14/docs/reference/pygtk-gtkmountoperation.xml
==============================================================================
--- (empty file)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkmountoperation.xml Thu Mar 5 22:54:50 2009
@@ -0,0 +1,344 @@
+<?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-gtkmountoperation">
+ <refnamediv>
+ <refname>gtk.MountOperation</refname>
+ <refpurpose>Functions for working with GIO (new in PyGTK 2.14)</refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Synopsis</title>
+
+ <classsynopsis language="python">
+ <ooclass><classname>gtk.MountOperation</classname></ooclass>
+ <ooclass><classname><link linkend="class-giomountoperation">gio.MountOperation</link></classname></ooclass>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkmountoperation--get-parent">get_parent</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkmountoperation--get-screen">get_screen</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkmountoperation--is-showing">is_showing</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkmountoperation--set-parent">set_parent</link></methodname>
+ <methodparam><parameter role="keyword">parent</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkmountoperation--set-screen">set_screen</link></methodname>
+ <methodparam><parameter role="keyword">screen</parameter></methodparam>
+ </methodsynopsis>
+
+ </classsynopsis>
+
+<programlisting>
+<emphasis role="bold">Functions</emphasis>
+
+<methodsynopsis language="python">
+ <methodname><link linkend="function-gtk--show-uri">gtk.show_uri</link></methodname>
+ <methodparam><parameter role="keyword">screen</parameter></methodparam>
+ <methodparam><parameter role="keyword">uri</parameter></methodparam>
+ <methodparam><parameter role="keyword">timestamp</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Ancestry</title>
+
+<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+ +-- <link linkend="class-giomountoperation">gio.MountOperation</link>
+ +-- <link linkend="class-gtkmountoperation">gtk.MountOperation</link>
+</synopsis>
+
+ </refsect1>
+
+ <refsect1 id="properties-gtkmountoperation">
+ <title>gtk.MountOperation Properties</title>
+
+ <blockquote role="properties">
+ <informaltable pgwide="1" frame="none">
+ <tgroup cols="3">
+ <colspec column="1" colwidth="1in"/>
+ <colspec column="2" colwidth="1in"/>
+ <colspec column="3" colwidth="3.5in"/>
+ <tbody>
+
+ <row valign="top">
+ <entry>"is-showing"</entry>
+ <entry>Read</entry>
+ <entry>Are we showing a dialog. Default value: <literal>False</literal>.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"parent"</entry>
+ <entry>Read/Write</entry>
+ <entry>The parent window.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"screen"</entry>
+ <entry>Read/Write</entry>
+ <entry>The screen where this window will be displayed.</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </blockquote>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+ The functions and objects described here make working with GTK+ and GIO more convenient.
+ <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>
+ is needed when mounting volumes and
+ <methodname><link linkend="function-gtk--show-uri">gtk.show_uri</link></methodname>()
+ is a convenient way to launch applications for URIs. Another object that is worth
+ mentioning in this context is
+ <link linkend="class-gdkapplaunchcontext"><classname>gtk.gdk.AppLaunchContext</classname></link>,
+ which provides visual feedback when lauching applications.
+ </para>
+ </refsect1>
+
+ <refsect1 id="constructor-gtkmountoperation">
+ <title>Constructor</title>
+
+ <programlisting><constructorsynopsis language="python">
+ <methodname>gtk.MountOperation</methodname>
+ <methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
+ </constructorsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">parent</parameter> :</term>
+ <listitem><simpara>transient parent of the window, or
+ <literal>None</literal>.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a new
+ <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ Creates a new <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>.
+ </para>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Methods</title>
+
+ <refsect2 id="method-gtkmountoperation--get-parent">
+ <title>gtk.MountOperation.get_parent</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_parent</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a new
+ <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_parent</methodname>() method gets the transient
+ parent used by the
+ <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtkmountoperation--get-screen">
+ <title>gtk.MountOperation.get_screen</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_screen</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the screen on which windows of op are shown.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_screen</methodname>() method gets the screen
+ on which windows of the
+ <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>
+ will be shown.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtkmountoperation--is-showing">
+ <title>gtk.MountOperation.is_showing</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>is_showing</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> if op is currently displaying a window.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>is_showing</methodname>() method returns whetherthe
+ <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>
+ is currently displaying a window.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtkmountoperation--set-parent">
+ <title>gtk.MountOperation.set_parent</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_parent</methodname>
+ <methodparam><parameter>parent</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">parent</parameter> :</term>
+ <listitem><simpara>transient parent of the window,
+ or <literal>None</literal>.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_parent</methodname>() method sets the
+ transient parent for windows shown by the
+ <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtkmountoperation--set-screen">
+ <title>gtk.MountOperation.set_screen</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_screen</methodname>
+ <methodparam><parameter>screen</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">screen</parameter> :</term>
+ <listitem><simpara>a
+ <link linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_screen</methodname>() method gets the screen
+ on which windows of the
+ <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>
+ will be shown.
+ </para>
+ </refsect2>
+ </refsect1>
+ <refsect1>
+ <title>Functions</title>
+
+ <refsect2 id="function-gtk--show-uri">
+ <title>gtk.show_uri</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>show_uri</methodname>
+ <methodparam><parameter>screen</parameter></methodparam>
+ <methodparam><parameter>uri</parameter></methodparam>
+ <methodparam><parameter>timestamp</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">screen</parameter> :</term>
+ <listitem><simpara>A
+ <link linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
+ to show the uri on or <literal>None</literal> for the default screen.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">uri</parameter> :</term>
+ <listitem><simpara>the uri to show.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">timestamp</parameter> :</term>
+ <listitem><simpara>a timestamp to prevent focus stealing.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This function is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>show_uri</methodname>() function is a convenience
+ function for launching the default application to show the uri.
+ The uri must be of a form understood by GIO. Typical examples are:
+ </para>
+<programlisting>
+file:///home/gnome/pict.jpg
+http://www.gnome.org
+mailto:me gnome org
+</programlisting>
+
+ <para>
+ Ideally the timestamp is taken from the event triggering the
+ <methodname><link linkend="function-gtk--show-uri">gtk.show_uri</link></methodname>()
+ call. If timestamp is not known you can take gtk.gdk.CURRENT_TIME.
+ </para>
+ <para>
+ This function can be used as a replacement for gnome_vfs_url_show() and gnome_url_show().
+ </para>
+ </refsect2>
+ </refsect1>
+</refentry>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkpagesetup.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkpagesetup.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkpagesetup.xml Thu Mar 5 22:54:50 2009
@@ -100,6 +100,10 @@
<methodname><link linkend="method-gtkpagesetup--to-file">to_file</link></methodname>
<methodparam><parameter role="keyword">file_name</parameter></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkpagesetup--load-file">load_file</link></methodname>
+ <methodparam><parameter role="keyword">file_name</parameter></methodparam>
+ </methodsynopsis>
</classsynopsis>
<programlisting>
@@ -795,6 +799,37 @@
</refsect2>
+ <refsect2 id="method-gtkpagesetup--laod-file">
+ <title>gtk.PageSetup.load_file</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>load_file</methodname>
+ <methodparam><parameter role="keyword">file_name</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">file_name</parameter> :</term>
+ <listitem><simpara>the filename to read the page setup from.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>True on success.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>load_file</methodname>() method
+ Reads the page setup from the file file_name. See
+ <methodname><link linkend="method-gtkpagesetup--to-file">to_file</link></methodname>.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkplug.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkplug.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkplug.xml Thu Mar 5 22:54:50 2009
@@ -34,7 +34,11 @@
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
- <methodname><link linkend="method-gtksocket--get-plug-window">get_plug_window</link></methodname>
+ <methodname><link linkend="method-gtksocket--get-embedded">get_embedded</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtksocket--get-socket-window">get_socket_window</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
@@ -240,25 +244,54 @@
linkend="method-gtksocket--add-id"><methodname>gtk.Socket.add_id</methodname>()</link>.</para>
</refsect2>
+
+ <refsect2 id="method-gtksocket--get-embedded">
+ <title>gtk.Socket.get_embedded</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_embedded</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> if the plug is embedded in
+ a socket.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_embedded</methodname>() method determines whether
+ the plug is embedded in a socket.
+ </para>
+
+ </refsect2>
+
- <refsect2 id="method-gtksocket--get-plug-window">
- <title>gtk.Socket.get_plug_window</title>
+ <refsect2 id="method-gtksocket--get-socket-window">
+ <title>gtk.Socket.get_socket_window</title>
<programlisting><methodsynopsis language="python">
- <methodname>get_plug_window</methodname>
+ <methodname>get_socket_window</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara>the window of the plug if available, or
+ <listitem><simpara>the window of the socket if available, or
<literal>None</literal>.</simpara></listitem>
</varlistentry>
</variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
<para>
- The <methodname>get_plug_window</methodname>() method retrieves the
- window of the plug. Use this to check if the plug has been created
- inside of the socket.
+ The <methodname>get_socket_window</methodname>() method retrieves the
+ socket the plug is embedded in.
</para>
</refsect2>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkprintsettings.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkprintsettings.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkprintsettings.xml Thu Mar 5 22:54:50 2009
@@ -276,6 +276,18 @@
<methodname><link linkend="method-gtkprintsettings--to-file">to_file</link></methodname>
<methodparam><parameter role="keyword">file_name</parameter></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkprintsettings--get-number-up-layout">get_number_up_layout</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkprintsettings--set-number-up-layout">set_number_up_layout</link></methodname>
+ <methodparam><parameter role="keyword">number_up_layout</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkprintsettings--load-file">load_file</link></methodname>
+ <methodparam><parameter role="keyword">file_name</parameter></methodparam>
+ </methodsynopsis>
</classsynopsis>
<programlisting>
@@ -1988,6 +2000,84 @@
</refsect2>
+ <refsect2 id="method-gtkprintsettings--get-number-up-layout">
+ <title>gtk.PrintSettings.get_number_up_layout</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_number_up_layout</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>layout of page in number-up mode.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.16 and above.</para>
+ </note>
+
+ <para></para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkprintsettings--set-number-up-layout">
+ <title>gtk.PrintSettings.set_number_up_layout</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_number_up_layout</methodname>
+ <methodparam><parameter role="keyword">number_up_layout</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">number_up_layout</parameter> :</term>
+ <listitem><simpara>a
+ <methodname><link linkend="gtk-number-up-layout-constants">GtkNumberUpLayout</link></methodname>
+ constant value.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.16 and above.</para>
+ </note>
+
+ <para>Sets the value of <link linkend="gtk-number-up-layout-constants">GtkNumberUpLayout</link>.</para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkprintsettings--load-file">
+ <title>gtk.PrintSettings.load_file</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>load_file</methodname>
+ <methodparam><parameter role="keyword">file_name</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">file_name</parameter> :</term>
+ <listitem><simpara>the filename to read the settings from.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> on success.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.16 and above.</para>
+ </note>
+
+ <para>
+ Reads the print settings from file_name. See
+ <methodname><link linkend="method-gtkprintsettings--to-file">gtk.PrintSettings.to_file</link></methodname>.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkselectiondata.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkselectiondata.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkselectiondata.xml Thu Mar 5 22:54:50 2009
@@ -91,6 +91,33 @@
<methodname><link linkend="method-gtkselectiondata--targets-include-uri">targets_include_uri</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
+
+ <!-- NOT IMPLEMENTED
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkselectiondata- -get-data">get_data</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ -->
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkselectiondata--get-data-type">get_data_type</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkselectiondata--get-display">get_display</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkselectiondata--get-format">get_format</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkselectiondata--get-length">get_length</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkselectiondata--get-target">get_target</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
</classsynopsis>
<programlisting>
@@ -638,6 +665,121 @@
</refsect2>
+ <refsect2 id="method-gtkselectiondata--get-data-type">
+ <title>gtk.SelectionData.get_data_type</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_data_type</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the data type of the selection.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>Retrieves the data type of the selection.</para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkselectiondata--get-display">
+ <title>gtk.SelectionData.get_display</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_display</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the display of the selection.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>Retrieves the display of the selection.</para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkselectiondata--get-format">
+ <title>gtk.SelectionData.get_format</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_format</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the format of the selection.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>Retrieves the format of the selection.</para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkselectiondata--get-length">
+ <title>gtk.SelectionData.get_length</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_length</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the length of the data of the selection.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>Retrieves the length of the data of the selection.</para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkselectiondata--get-target">
+ <title>gtk.SelectionData.get_targets</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_target</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the target of the selection.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>Retrieves the target of the selection.</para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtksocket.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtksocket.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtksocket.xml Thu Mar 5 22:54:50 2009
@@ -29,6 +29,12 @@
<methodname><link
linkend="method-gtksocket--get-id">get_id</link></methodname>
<methodparam></methodparam> </methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtksocket--get-plug-window">get_plug_window</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
</classsynopsis>
</refsect1>
@@ -236,6 +242,28 @@
</refsect2>
+ <refsect2 id="method-gtksocket--get-plug-window">
+ <title>gtk.Socket.get_plug_window</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_plug_window</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the window of the plug if available, or
+ <literal>None</literal>.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>get_plug_window</methodname>() method retrieves the
+ window of the plug. Use this to check if the plug has been created
+ inside of the socket.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtktoolitem.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtktoolitem.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtktoolitem.xml Thu Mar 5 22:54:50 2009
@@ -113,6 +113,10 @@
<methodname><link linkend="method-gtktoolitem--set-tooltip-text">set_tooltip_text</link></methodname>
<methodparam><parameter role="keyword">text</parameter></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitem--toolbar-reconfigured">toolbar_reconfigured</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
</classsynopsis>
</refsect1>
@@ -1024,6 +1028,32 @@
<methodname><link linkend="method-gtkwidget--set-tooltip-text">gtk.Widget.set_tooltip_text</link></methodname>().</para>
</refsect2>
+
+ <refsect2 id="method-gtktoolitem--toolbar-reconfigured">
+ <title>gtk.ToolItem.toolbar_reconfigured</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>toolbar_reconfigured</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>toolbar_reconfigured</methodname>() method emits the signal
+ "<link linkend="signal-gtktoolitem--toolbar-reconfigured">toolbar-reconfigured</link>"
+ on tool_item.
+ <link linkend="class-gtktoolbar"><classname>gtk.ToolBar</classname></link>
+ and other
+ <link linkend="class-gtktoolshell"><classname>gtk.ToolShell</classname></link>
+ implementations use this function to notify children, when some aspect of their configuration changes.
+ </para>
+
+ </refsect2>
</refsect1>
Added: branches/pygtk-2-14/docs/reference/pygtk-gtktoolshell.xml
==============================================================================
--- (empty file)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtktoolshell.xml Thu Mar 5 22:54:50 2009
@@ -0,0 +1,214 @@
+<?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-gtktoolshell">
+ <refnamediv>
+ <refname>gtk.ToolShell</refname>
+ <refpurpose>Interface for containers containing GtkToolItem widgets.</refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Synopsis</title>
+
+ <classsynopsis language="python">
+ <ooclass><classname>gtk.ToolShell</classname></ooclass>
+ <ooclass><classname><link linkend="class-ginterface">gobject.GInterface</link></classname></ooclass>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolshell--get-icon-size">get_icon_size</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolshell--get-orientation">get_orientation</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolshell--get-relief-style">get_relief_style</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolshell--get-style">get_style</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolshell--rebuild-menu">rebuild_menu</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
+ </classsynopsis>
+ </refsect1>
+
+ <refsect1>
+ <title>Ancestry</title>
+
+<synopsis>+-- <link linkend="class-ginterface">gobject.GInterface</link>
+ +-- <link linkend="class-gtktoolshell">gtk.ToolShell</link>
+</synopsis>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Known Implementation</title>
+ <para>
+ <link linkend="class-gtktoolshell"><classname>gtk.ToolShell</classname></link>
+ is implementated by
+ <link linkend="class-gtktoolbar"><classname>gtk.ToolBar</classname></link>,
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ The <link linkend="class-gtktoolshell"><classname>gtk.ToolShell</classname></link>
+ interface allows container widgets to provide additional information when embedding GtkToolItem widgets.
+ see_also: <link linkend="class-gtktoolbar"><classname>gtk.ToolBar</classname></link>,
+ <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Methods</title>
+
+ <refsect2 id="method-gtktoolshell--get-icon-size">
+ <title>gtk.ToolShell.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 current size for icons of shell.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_icon_size</methodname>() method retrieves the
+ icon size for the tool shell. Tool items must not call this
+ function directly, but rely on
+ <methodname><link linkend="method-gtktoolitem--get-icon-size">gtk.ToolItem.get_icon_size</link></methodname>()
+ instead.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolshell--get-orientation">
+ <title>gtk.ToolShell.get_orientation</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_orientation</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>The current orientation of shell.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_orientation</methodname>() method retrieves the
+ current orientation for the tool shell. Tool items must not call
+ this function directly, but rely on
+ <methodname><link linkend="method-gtktoolitem--get-orientation">gtk.ToolItem.get_orientation</link></methodname>()
+ instead.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolshell--get-relief-style">
+ <title>gtk.ToolShell.get_relief_style</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_relief_style</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>The relief style of buttons on shell.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_relief_style</methodname>() method returns the relief
+ style of buttons on shell. Tool items must not call this function directly, but rely on
+ <methodname><link linkend="method-gtktoolitem--get-relief-style">gtk.ToolItem.get_relief_style</link></methodname>()
+ instead.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolshell--get-style">
+ <title>gtk.ToolShell.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 current style of shell.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_style</methodname>() method retrieves whether the tool
+ shell has text, icons, or both. Tool items must not call this function directly, but rely on
+ <methodname><link linkend="method-gtktoolitem--get-style">gtk.ToolItem.get_style</link></methodname>()
+ instead.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtktoolshell--rebuild-menu">
+ <title>gtk.ToolShell.rebuild_menu</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>rebuild_menu</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>rebuild_menu</methodname>() method calling this function signals the
+ tool shell that the overflow menu item for tool items have changed.
+ If there is an overflow menu and if it is visible when this function it called, the menu will be rebuilt.
+ Tool items must not call this function directly, but rely on
+ <methodname><link linkend="method-gtktoolitem--get-relief-style">gtk.ToolItem.get_relief_style</link></methodname>()
+ instead.
+ </para>
+ </refsect2>
+ </refsect1>
+</refentry>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtktooltip.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtktooltip.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtktooltip.xml Thu Mar 5 22:54:50 2009
@@ -24,6 +24,11 @@
<methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
+ <methodname><link linkend="method-gtktooltip--set-icon-from-stock">set_icon_from_icon_name</link></methodname>
+ <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
+ <methodparam><parameter role="keyword">size</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
<methodname><link linkend="method-gtktooltip--set-icon-from-stock">set_icon_from_stock</link></methodname>
<methodparam><parameter role="keyword">stock_id</parameter></methodparam>
<methodparam><parameter role="keyword">size</parameter></methodparam>
@@ -200,6 +205,38 @@
</para>
</refsect2>
+ <refsect2 id="method-gtktooltip--set-icon-from-icon-name">
+ <title>gtk.Tooltip.set_icon_from_icon_name</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_icon_from_icon_name</methodname>
+ <methodparam><parameter>icon_name</parameter></methodparam>
+ <methodparam><parameter>size</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">icon_name</parameter> :</term>
+ <listitem><simpara>an icon name, or <literal>None</literal>.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">size</parameter> :</term>
+ <listitem><simpara>A stock icon size.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_icon_from_icon_name</methodname>() method sets
+ the icon of the tooltip (which is in front of the text) to be the
+ icon indicated by icon_name with the size indicated by size. If icon_name
+ is <literal>None</literal>, the image will be hidden.
+ </para>
+ </refsect2>
+
<refsect2 id="method-gtktooltip--set-icon-from-stock">
<title>gtk.Tooltip.set_icon_from_stock</title>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtktooltips.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtktooltips.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtktooltips.xml Thu Mar 5 22:54:50 2009
@@ -154,6 +154,10 @@
<refsect1>
<title>Description</title>
+
+ <warning>
+ <para>This method is deprecated in PyGTK 2.12 and above</para>
+ </warning>
<para>Tooltips are the messages that appear next to a widget when the
mouse pointer is held over it for a short amount of time. They are
@@ -203,6 +207,10 @@
object</simpara></listitem>
</varlistentry>
</variablelist>
+
+ <warning>
+ <para>This method is deprecated in PyGTK 2.12 and above</para>
+ </warning>
<para>Creates an empty <link
linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link>
@@ -219,6 +227,10 @@
<programlisting><methodsynopsis language="python">
<methodname>enable</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
+
+ <warning>
+ <para>This method is deprecated in PyGTK 2.12 and above</para>
+ </warning>
<para>The <methodname>enable</methodname>() method enables a group of
tooltips. A tooltip will be displayed over its associated widget when
@@ -232,6 +244,10 @@
<programlisting><methodsynopsis language="python">
<methodname>disable</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
+
+ <warning>
+ <para>This method is deprecated in PyGTK 2.12 and above</para>
+ </warning>
<para>The <methodname>disable</methodname>() method disables a group
of tooltips. A tooltip will not be displayed over its associated widget when
@@ -262,6 +278,10 @@
<listitem><simpara>the tooltip private text for context sensitive display</simpara></listitem>
</varlistentry>
</variablelist>
+
+ <warning>
+ <para>This method is deprecated in PyGTK 2.12 and above</para>
+ </warning>
<para>The <methodname>set_tips</methodname>() method creates a tooltip
for the specified <parameter>widget</parameter>. The text specified by
@@ -277,6 +297,10 @@
<programlisting><methodsynopsis language="python">
<methodname>force_window</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
+
+ <warning>
+ <para>This method is deprecated in PyGTK 2.12 and above</para>
+ </warning>
<para>The <methodname>force_window</methodname>() method ensures that
the window used for displaying the given tooltips is created. Applications
@@ -310,6 +334,10 @@
<literal>None</literal></simpara></listitem>
</varlistentry>
</variablelist>
+
+ <warning>
+ <para>This method is deprecated in PyGTK 2.12 and above</para>
+ </warning>
<para>The <function>gtk.tooltips_data_get</function>() function
returns a tuple containing the tooltip data associated with
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkwidget.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkwidget.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkwidget.xml Thu Mar 5 22:54:50 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>
@@ -3651,7 +3678,8 @@
a screen, because font information may be needed.</para>
<para>Also remember that the size request is not necessarily the size
-a widget will actually be allocated. See the <link
+a widget will actually be allocated.</para>
+ <para>See the <link
linkend="method-gtkwidget--get-child-requisition"><methodname>get_child_requisition</methodname>()</link>
method.</para>
@@ -6688,7 +6716,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 +6968,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 +7760,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>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkwindow.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkwindow.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkwindow.xml Thu Mar 5 22:54:50 2009
@@ -484,6 +484,10 @@
<methodname><link linkend="method-gtkwindow--set-startup-id">set_startup_id</link></methodname>
<methodparam><parameter role="keyword">startup_id</parameter></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkwindow--get-default-widget">get_default_widget</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
</classsynopsis>
<programlisting>
@@ -3891,6 +3895,34 @@
</para>
</refsect2>
+ <refsect2 id="method-gtkwindow--get-default-widget">
+ <title>gtk.Window.get_default_widget</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_default_widget</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>The default widget, or <literal>None</literal>
+ if there is none.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ Returns the default widget for window. See
+ <methodname><link linkend="method-gtkwindow--set-default">gtk.Window.set_default</link></methodname>()()
+ for more details.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
