pygtk r3102 - in trunk/docs: . reference
- From: gianmt svn gnome org
- To: svn-commits-list gnome org
- Subject: pygtk r3102 - in trunk/docs: . reference
- Date: Wed, 4 Mar 2009 22:44:52 +0000 (UTC)
Author: gianmt
Date: Wed Mar 4 22:44:52 2009
New Revision: 3102
URL: http://svn.gnome.org/viewvc/pygtk?rev=3102&view=rev
Log:
2009-03-04 Gian Mario Tagliaretti <gianmt gnome org>
* pygtk-gtkwindow.xml: Update docs to 2.14
* Makefile.am:
* pygtk-gtk-classes.xml:
* pygtk-gtktoolshell.xml: Add new class gtk.ToolShell.
Added:
trunk/docs/reference/pygtk-gtktoolshell.xml
Modified:
trunk/docs/Makefile.am
trunk/docs/reference/ChangeLog
trunk/docs/reference/pygtk-gtk-classes.xml
trunk/docs/reference/pygtk-gtkwindow.xml
Modified: trunk/docs/Makefile.am
==============================================================================
--- trunk/docs/Makefile.am (original)
+++ trunk/docs/Makefile.am Wed Mar 4 22:44:52 2009
@@ -227,6 +227,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 \
@@ -504,6 +505,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 \
Modified: trunk/docs/reference/pygtk-gtk-classes.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtk-classes.xml (original)
+++ trunk/docs/reference/pygtk-gtk-classes.xml Wed Mar 4 22:44:52 2009
@@ -163,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"/>
Added: trunk/docs/reference/pygtk-gtktoolshell.xml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/pygtk-gtktoolshell.xml Wed Mar 4 22:44:52 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: trunk/docs/reference/pygtk-gtkwindow.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkwindow.xml (original)
+++ trunk/docs/reference/pygtk-gtkwindow.xml Wed Mar 4 22:44:52 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]
