diff options
author | Gian Mario Tagliaretti <gianmt@src.gnome.org> | 2007-09-29 09:00:05 +0000 |
---|---|---|
committer | Gian Mario Tagliaretti <gianmt@src.gnome.org> | 2007-09-29 09:00:05 +0000 |
commit | 291434ace05548342b2ff8268b6cdff3dd8c12aa (patch) | |
tree | 388691cf97065da0f521516a98eeee6e05b60b0f /docs | |
parent | 4270872d72a6f6ada4509967887cb5daeb952c3c (diff) | |
download | pygtk-291434ace05548342b2ff8268b6cdff3dd8c12aa.tar.gz |
Update docs with 2.12 API
svn path=/trunk/; revision=2909
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/ChangeLog | 6 | ||||
-rw-r--r-- | docs/reference/pygtk-gtkmenushell.xml | 61 | ||||
-rw-r--r-- | docs/reference/pygtk-gtknotebook.xml | 102 | ||||
-rw-r--r-- | docs/reference/pygtk-gtkpagesetup.xml | 67 |
4 files changed, 230 insertions, 6 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 9f77709e..33ea7478 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,9 @@ +2007-09-29 Gian Mario Tagliaretti <gianmt@gnome.org> + + * pygtk-gtkpagesetup.xml: + * pygtk-gtknotebook.xml: + * pygtk-gtkmenushell.xml: Updated with 2.12 API. + 2007-08-05 Gian Mario Tagliaretti <gianmt@gnome.org> * pygtk-gtkmenutoolbutton.xml: Update with 2.12 API. diff --git a/docs/reference/pygtk-gtkmenushell.xml b/docs/reference/pygtk-gtkmenushell.xml index 63fbaf1d..519b9a98 100644 --- a/docs/reference/pygtk-gtkmenushell.xml +++ b/docs/reference/pygtk-gtkmenushell.xml @@ -222,6 +222,23 @@ linkend="signal-gtkmenushell--move-current">move-current</link>"</term> </varlistentry> <varlistentry> <term>"<link +linkend="signal-gtkmenushell--move-selected">move-selected</link>"</term> + <listitem> + <methodsynopsis + language="python"><methodname>callback</methodname> + <methodparam><parameter>menushell</parameter> + </methodparam> + <methodparam><parameter>distance</parameter> + </methodparam> + <methodparam><parameter>user_param1</parameter> + </methodparam> + <methodparam><parameter>...</parameter> + </methodparam> + </methodsynopsis> + </listitem> + </varlistentry> + <varlistentry> + <term>"<link linkend="signal-gtkmenushell--selection-done">selection-done</link>"</term> <listitem> <methodsynopsis @@ -788,6 +805,50 @@ item.</simpara> </variablelist> </refsect2> + + <refsect2 id="signal-gtkmenushell--move-selected"> + <title>The "move-selected" gtk.MenuShell Signal</title> + + <programlisting><methodsynopsis language="python"> + <methodname>callback</methodname> + <methodparam><parameter>menushell</parameter></methodparam> + <methodparam><parameter>distance</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter>menushell</parameter> :</term> + <listitem><simpara>the menushell that received the +signal</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter>distance</parameter> :</term> + <listitem><simpara>+1 to move to the next item, + -1 to move to the previous</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> + + <note> + <para>This signal is available in GTK+ 2.12 and above.</para> + </note> + + <para>The "move-selected" signal is emitted to move the selection to another item.</para> + + </refsect2> <refsect2 id="signal-gtkmenushell--selection-done"> <title>The "selection-done" gtk.MenuShell Signal</title> diff --git a/docs/reference/pygtk-gtknotebook.xml b/docs/reference/pygtk-gtknotebook.xml index 3bcc0c94..8e134493 100644 --- a/docs/reference/pygtk-gtknotebook.xml +++ b/docs/reference/pygtk-gtknotebook.xml @@ -310,12 +310,21 @@ linkend="method-gtknotebook--reorder-child">reorder_child</link></methodname> button on the notebook pops up a menu that you can use to go to a page. Default value: <literal>False</literal>.</entry> </row> - <row valign="top"> - <entry>"group-id"</entry> - <entry>Read-Write</entry> - <entry>Group ID for tabs drag and drop. Allowed values: >= - -1. Default value: -1.</entry> - </row> + + <!-- HOLD THE DISPLAY OF THIS PROPERTY + <row valign="top"> + <entry>"group"</entry> + <entry>Read-Write</entry> + <entry>Group for tabs drag and drop.</entry> + </row> + END HOLD --> + + <row valign="top"> + <entry>"group-id"</entry> + <entry>Read-Write</entry> + <entry>Group ID for tabs drag and drop. Allowed values: >= + -1. Default value: -1.</entry> + </row> <row valign="top"> <entry>"homogeneous"</entry> @@ -586,6 +595,29 @@ linkend="signal-gtknotebook--change-current-page">change-current-page</link>"</t </methodsynopsis> </listitem> </varlistentry> + + <varlistentry> + <term>"<link +linkend="signal-gtknotebook--create-window">create-window</link>"</term> + <listitem> + <methodsynopsis + language="python"><methodname>callback</methodname> + <methodparam><parameter>notebook</parameter> + </methodparam> + <methodparam><parameter>page</parameter> + </methodparam> + <methodparam><parameter>x</parameter> + </methodparam> + <methodparam><parameter>y</parameter> + </methodparam> + <methodparam><parameter>user_param1</parameter> + </methodparam> + <methodparam><parameter>...</parameter> + </methodparam> + </methodsynopsis> + </listitem> + </varlistentry> + <varlistentry> <term>"<link linkend="signal-gtknotebook--focus-tab">focus-tab</link>"</term> @@ -2106,6 +2138,64 @@ forward or page backward request is issued.</para> </refsect2> + <refsect2 id="signal-gtknotebook--create-window"> + <title>The "create-window" gtk.Notebook Signal</title> + + <programlisting><methodsynopsis language="python"> + <methodname>callback</methodname> + <methodparam><parameter>notebook</parameter></methodparam> + <methodparam><parameter>page</parameter></methodparam> + <methodparam><parameter>x</parameter></methodparam> + <methodparam><parameter>y</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter>notebook</parameter> :</term> + <listitem><simpara>the notebook that received the +signal</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter>page</parameter> :</term> + <listitem><simpara>the tab of notebook that is being detached + </simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter> :</term> + <listitem><simpara>the X coordinate where the drop happens + </simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter> :</term> + <listitem><simpara>the Y coordinate where the drop happens + </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 "create-window" signal is emitted when a + detachable tab is dropped on the root window.</para> + + <para>A handler for this signal can create a window containing + a notebook where the tab will be attached. It is also responsible + for moving/resizing the window and adding the necessary properties + to the notebook (e.g. the <link linkend="properties-gtknotebook">GtkNotebook:group-id</link> ).</para> + + </refsect2> + <refsect2 id="signal-gtknotebook--focus-tab"> <title>The "focus-tab" gtk.Notebook Signal</title> diff --git a/docs/reference/pygtk-gtkpagesetup.xml b/docs/reference/pygtk-gtkpagesetup.xml index 682e5947..a1b8b0f6 100644 --- a/docs/reference/pygtk-gtkpagesetup.xml +++ b/docs/reference/pygtk-gtkpagesetup.xml @@ -96,6 +96,10 @@ <methodname><link linkend="method-gtkpagesetup--get-page-height">get_page_height</link></methodname> <methodparam><parameter role="keyword">unit</parameter></methodparam> </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkpagesetup--to-file">to_file</link></methodname> + <methodparam><parameter role="keyword">file_name</parameter></methodparam> + </methodsynopsis> </classsynopsis> <programlisting> @@ -106,6 +110,9 @@ <methodparam><parameter role="keyword">parent</parameter></methodparam> <methodparam><parameter role="keyword">page_setup</parameter></methodparam> <methodparam><parameter role="keyword">settings</parameter></methodparam> + </methodsynopsis><methodsynopsis language="python"> + <methodname><link linkend="function-gtk--page-setup-new-from-file">gtk.page_setup_new_from_file</link></methodname> + <methodparam><parameter role="keyword">file_name</parameter></methodparam> </methodsynopsis></programlisting> </refsect1> @@ -760,6 +767,34 @@ </refsect2> + <refsect2 id="method-gtkpagesetup--to-file"> + <title>gtk.PageSetup.to_file</title> + + <programlisting><methodsynopsis language="python"> + <methodname>to_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 file to save to</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.12 and above.</para> + </note> + + <para>The <methodname>to_file</methodname>() method + saves the information from setup to <parameter>file_name</parameter>.</para> + + </refsect2> + </refsect1> <refsect1> @@ -812,6 +847,38 @@ </refsect2> + <refsect2 id="function-gtk--page-setup-new-from-file"> + <title>gtk.page_setup_new_from_file</title> + + <programlisting><methodsynopsis language="python"> + <methodname>gtk.page_setup_new_from_file</methodname> + <methodparam><parameter + role="keyword">file_name</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">parent</parameter> :</term> + <listitem><simpara>transient parent, or + <literal>None</literal></simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>The restored <link + linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link></simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This function is available in PyGTK 2.12 and above.</para> + </note> + + <para>Reads the page setup from the file file_name. Returns a new + <link linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link> + object with the restored page setup, or None if an error occurred. See + <link linkend="method-gtkpagesetup--to-file">gtk.PageSetup.to_file</link>.</para> + + </refsect2> + </refsect1> </refentry> |