1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Notebook</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkmountoperation.html" title="gtk.MountOperation"><link rel="next" href="class-gtkobject.html" title="gtk.Object"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.Notebook</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkmountoperation.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkobject.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtknotebook"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.Notebook</h2><p>gtk.Notebook — a tabbed notebook container.</p></div><div class="refsect1" lang="en"><a name="id3566404"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Notebook</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a></span></span>):
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Notebook</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkmountoperation.html" title="gtk.MountOperation"><link rel="next" href="class-gtkobject.html" title="gtk.Object"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.Notebook</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkmountoperation.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkobject.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtknotebook"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.Notebook</h2><p>gtk.Notebook — a tabbed notebook container.</p></div><div class="refsect1" lang="en"><a name="id3767210"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Notebook</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a></span></span>):
2
2
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtknotebook.html#constructor-gtknotebook" title="Constructor">gtk.Notebook</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--append-page" title="gtk.Notebook.append_page">append_page</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>tab_label</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--append-page-menu" title="gtk.Notebook.append_page_menu">append_page_menu</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>tab_label</code></strong></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>menu_label</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--prepend-page" title="gtk.Notebook.prepend_page">prepend_page</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>tab_label</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--prepend-page-menu" title="gtk.Notebook.prepend_page_menu">prepend_page_menu</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>tab_label</code></strong></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>menu_label</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--insert-page" title="gtk.Notebook.insert_page">insert_page</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>tab_label</code></strong></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>position</code></strong></span><span class="initializer">=-1</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--insert-page-menu" title="gtk.Notebook.insert_page_menu">insert_page_menu</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>tab_label</code></strong></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>menu_label</code></strong></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>position</code></strong></span><span class="initializer">=-1</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--remove-page" title="gtk.Notebook.remove_page">remove_page</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_num</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--get-current-page" title="gtk.Notebook.get_current_page">get_current_page</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--get-nth-page" title="gtk.Notebook.get_nth_page">get_nth_page</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_num</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--get-n-pages" title="gtk.Notebook.get_n_pages">get_n_pages</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--page-num" title="gtk.Notebook.page_num">page_num</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--set-current-page" title="gtk.Notebook.set_current_page">set_current_page</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_num</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--next-page" title="gtk.Notebook.next_page">next_page</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--prev-page" title="gtk.Notebook.prev_page">prev_page</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--set-show-border" title="gtk.Notebook.set_show_border">set_show_border</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>show_border</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--get-show-border" title="gtk.Notebook.get_show_border">get_show_border</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--set-show-tabs" title="gtk.Notebook.set_show_tabs">set_show_tabs</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>show_tabs</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--get-show-tabs" title="gtk.Notebook.get_show_tabs">get_show_tabs</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--set-tab-pos" title="gtk.Notebook.set_tab_pos">set_tab_pos</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>pos</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--get-tab-pos" title="gtk.Notebook.get_tab_pos">get_tab_pos</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--set-scrollable" title="gtk.Notebook.set_scrollable">set_scrollable</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>scrollable</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--get-scrollable" title="gtk.Notebook.get_scrollable">get_scrollable</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--popup-enable" title="gtk.Notebook.popup_enable">popup_enable</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--popup-disable" title="gtk.Notebook.popup_disable">popup_disable</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--get-tab-label" title="gtk.Notebook.get_tab_label">get_tab_label</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--set-tab-label" title="gtk.Notebook.set_tab_label">set_tab_label</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>tab_label</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--set-tab-label-text" title="gtk.Notebook.set_tab_label_text">set_tab_label_text</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>tab_text</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--get-tab-label-text" title="gtk.Notebook.get_tab_label_text">get_tab_label_text</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--get-menu-label" title="gtk.Notebook.get_menu_label">get_menu_label</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--set-menu-label" title="gtk.Notebook.set_menu_label">set_menu_label</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>menu_label</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--set-menu-label-text" title="gtk.Notebook.set_menu_label_text">set_menu_label_text</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>menu_text</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--get-menu-label-text" title="gtk.Notebook.get_menu_label_text">get_menu_label_text</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--query-tab-label-packing" title="gtk.Notebook.query_tab_label_packing">query_tab_label_packing</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--set-tab-label-packing" title="gtk.Notebook.set_tab_label_packing">set_tab_label_packing</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>expand</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>fill</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>pack_type</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--reorder-child" title="gtk.Notebook.reorder_child">reorder_child</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>position</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--set-group-id" title="gtk.Notebook.set_group_id">set_group_id</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>group_id</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--get-group-id" title="gtk.Notebook.get_group_id">get_group_id</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--get-tab-reorderable" title="gtk.Notebook.get_tab_reorderable">get_tab_reorderable</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--set-tab-reorderable" title="gtk.Notebook.set_tab_reorderable">set_tab_reorderable</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>reorderable</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--get-tab-detachable" title="gtk.Notebook.get_tab_detachable">get_tab_detachable</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#method-gtknotebook--set-tab-detachable" title="gtk.Notebook.set_tab_detachable">set_tab_detachable</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>detachable</code></strong></span></span>)</code><br></pre></td></tr></table><pre class="programlisting">
3
3
<span class="bold"><strong>Functions</strong></span>
5
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#function-gtk--notebook-set-window-creation-hook" title="gtk.notebook_set_window_creation_hook">gtk.notebook_set_window_creation_hook</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>func</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>data</code></strong></span></span>)</code></pre></div><div class="refsect1" lang="en"><a name="id3567879"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
5
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtknotebook.html#function-gtk--notebook-set-window-creation-hook" title="gtk.notebook_set_window_creation_hook">gtk.notebook_set_window_creation_hook</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>func</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>data</code></strong></span></span>)</code></pre></div><div class="refsect1" lang="en"><a name="id3768685"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
6
6
+-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
7
7
+-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
8
8
+-- <a class="link" href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
9
9
+-- <a class="link" href="class-gtknotebook.html" title="gtk.Notebook">gtk.Notebook</a>
10
</pre></div><div class="refsect1" lang="en"><a name="id3567924"></a><h2>Implemented Interfaces</h2><p>
10
</pre></div><div class="refsect1" lang="en"><a name="id3768730"></a><h2>Implemented Interfaces</h2><p>
11
11
<a class="link" href="class-gtknotebook.html" title="gtk.Notebook"><code class="classname">gtk.Notebook</code></a>
13
13
<a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
57
57
reference to the start or end of the parent - one of the <a class="xref" href="gtk-constants.html#gtk-pack-type-constants" title="GTK Pack Type Constants">GTK Pack Type Constants</a>:
58
58
<code class="literal">gtk.PACK_START</code> or
59
59
<code class="literal">gtk.PACK_END</code>. Default value:
60
<code class="literal">gtk.PACK_START</code>.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="id3568845"></a><h2>Attributes</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"tab_pos"</td><td valign="top">Read</td><td valign="top">The side of the notebook that holds the tabs:
60
<code class="literal">gtk.PACK_START</code>.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="id3769651"></a><h2>Attributes</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"tab_pos"</td><td valign="top">Read</td><td valign="top">The side of the notebook that holds the tabs:
61
61
<code class="literal">gtk.POS_LEFT</code>, <code class="literal">gtk.POS_RIGHT</code>,
62
<code class="literal">gtk.POS_TOP</code> or <code class="literal">gtk.POS_BOTTOM</code></td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtknotebook"></a><h2>gtk.Notebook Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkobject.html#signal-prototypes-gtkobject" title="gtk.Object Signal Prototypes">gtk.Object Signal Prototypes</a></p><p><a class="link" href="class-gtkwidget.html#signal-prototypes-gtkwidget" title="gtk.Widget Signal Prototypes">gtk.Widget Signal Prototypes</a></p><p><a class="link" href="class-gtkcontainer.html#signal-prototypes-gtkcontainer" title="gtk.Container Signal Prototypes">gtk.Container Signal Prototypes</a></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtknotebook.html#signal-gtknotebook--change-current-page" title='The "change-current-page" gtk.Notebook Signal'>change-current-page</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>offset</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtknotebook.html#signal-gtknotebook--create-window" title='The "create-window" gtk.Notebook Signal'>create-window</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>page</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>x</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>y</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtknotebook.html#signal-gtknotebook--focus-tab" title='The "focus-tab" gtk.Notebook Signal'>focus-tab</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>type</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtknotebook.html#signal-gtknotebook--move-focus-out" title='The "move-focus-out" gtk.Notebook Signal'>move-focus-out</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>direction_type</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtknotebook.html#signal-gtknotebook--page-added" title='The "page-added" Signal'>page-added</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>child</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>page_num</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtknotebook.html#signal-gtknotebook--page-removed" title='The "page-removed" Signal'>page-removed</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>child</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>page_num</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtknotebook.html#signal-gtknotebook--page-reordered" title='The "page-reordered" Signal'>page-reordered</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>child</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>page_num</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtknotebook.html#signal-gtknotebook--select-page" title='The "select-page" gtk.Notebook Signal'>select-page</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>move_focus</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtknotebook.html#signal-gtknotebook--switch-page" title='The "switch-page" gtk.Notebook Signal'>switch-page</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>page</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>page_num</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3569760"></a><h2>Description</h2><p>The <a class="link" href="class-gtknotebook.html" title="gtk.Notebook"><code class="classname">gtk.Notebook</code></a>
62
<code class="literal">gtk.POS_TOP</code> or <code class="literal">gtk.POS_BOTTOM</code></td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtknotebook"></a><h2>gtk.Notebook Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkobject.html#signal-prototypes-gtkobject" title="gtk.Object Signal Prototypes">gtk.Object Signal Prototypes</a></p><p><a class="link" href="class-gtkwidget.html#signal-prototypes-gtkwidget" title="gtk.Widget Signal Prototypes">gtk.Widget Signal Prototypes</a></p><p><a class="link" href="class-gtkcontainer.html#signal-prototypes-gtkcontainer" title="gtk.Container Signal Prototypes">gtk.Container Signal Prototypes</a></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtknotebook.html#signal-gtknotebook--change-current-page" title='The "change-current-page" gtk.Notebook Signal'>change-current-page</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>offset</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtknotebook.html#signal-gtknotebook--create-window" title='The "create-window" gtk.Notebook Signal'>create-window</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>page</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>x</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>y</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtknotebook.html#signal-gtknotebook--focus-tab" title='The "focus-tab" gtk.Notebook Signal'>focus-tab</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>type</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtknotebook.html#signal-gtknotebook--move-focus-out" title='The "move-focus-out" gtk.Notebook Signal'>move-focus-out</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>direction_type</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtknotebook.html#signal-gtknotebook--page-added" title='The "page-added" Signal'>page-added</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>child</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>page_num</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtknotebook.html#signal-gtknotebook--page-removed" title='The "page-removed" Signal'>page-removed</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>child</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>page_num</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtknotebook.html#signal-gtknotebook--page-reordered" title='The "page-reordered" Signal'>page-reordered</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>child</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>page_num</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtknotebook.html#signal-gtknotebook--select-page" title='The "select-page" gtk.Notebook Signal'>select-page</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>move_focus</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtknotebook.html#signal-gtknotebook--switch-page" title='The "switch-page" gtk.Notebook Signal'>switch-page</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>page</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>page_num</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3770566"></a><h2>Description</h2><p>The <a class="link" href="class-gtknotebook.html" title="gtk.Notebook"><code class="classname">gtk.Notebook</code></a>
63
63
widget is a <a class="link" href="class-gtkcontainer.html" title="gtk.Container"><code class="classname">gtk.Container</code></a>
64
64
whose children are overlapping pages that can be switched between by using
65
65
tab labels along one edge. There are many configuration options for the
103
103
the parent object, while a custom element in an <object> element gets parsed
104
104
by the custom tag handler of the object.
105
105
</p></div></div><div class="refsect1" lang="en"><a name="constructor-gtknotebook"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.Notebook</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the newly created <a class="link" href="class-gtknotebook.html" title="gtk.Notebook"><code class="classname">gtk.Notebook</code></a></td></tr></tbody></table><p>Creates a new <a class="link" href="class-gtknotebook.html" title="gtk.Notebook"><code class="classname">gtk.Notebook</code></a>
106
widget with no pages.</p></div><div class="refsect1" lang="en"><a name="id3569981"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtknotebook--append-page"></a><h3>gtk.Notebook.append_page</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">append_page</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>tab_label</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>child</code></strong> :</span></p></td><td>the <a class="link" href="class-gtkwidget.html" title="gtk.Widget"><code class="classname">gtk.Widget</code></a> to use as
106
widget with no pages.</p></div><div class="refsect1" lang="en"><a name="id3770787"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtknotebook--append-page"></a><h3>gtk.Notebook.append_page</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">append_page</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>tab_label</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>child</code></strong> :</span></p></td><td>the <a class="link" href="class-gtkwidget.html" title="gtk.Widget"><code class="classname">gtk.Widget</code></a> to use as
107
107
the contents of the page.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>tab_label</code></strong> :</span></p></td><td>the <a class="link" href="class-gtkwidget.html" title="gtk.Widget"><code class="classname">gtk.Widget</code></a> to be
108
108
used as the label for the page.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>in PyGTK 2.0 and 2.2 returns
109
109
<code class="literal">None</code>. In PyGTK 2.4 and above returns the index
384
384
destination and accept the target 'GTK_NOTEBOOK_TAB'. The notebook
385
385
will fill the selection with a reference to the child
386
386
widget that corresponds to the dropped tab.</p><p>If you want a notebook to accept drags from other widgets, you
387
will have to set your own DnD code to do it.</p></div></div><div class="refsect1" lang="en"><a name="id3575226"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gtk--notebook-set-window-creation-hook"></a><h3>gtk.notebook_set_window_creation_hook</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.notebook_set_window_creation_hook</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>func</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>data</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>func</code></strong> :</span></p></td><td> a function to call when a tab is dropped
387
will have to set your own DnD code to do it.</p></div></div><div class="refsect1" lang="en"><a name="id3776032"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gtk--notebook-set-window-creation-hook"></a><h3>gtk.notebook_set_window_creation_hook</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.notebook_set_window_creation_hook</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>func</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>data</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>func</code></strong> :</span></p></td><td> a function to call when a tab is dropped
388
388
in an empty area.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>data</code></strong> :</span></p></td><td> data to pass to
389
389
<em class="parameter"><code>func</code></em></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.10 and above.</p></div><p>The <code class="function">gtk.notebook_set_window_creation_hook</code>
390
390
function installs a global function (specified by
408
408
This function will also be responsible of moving/resizing the window and adding the
409
409
necessary properties to the notebook (i.e.: group-id). If the
410
410
function returns <code class="literal">None</code>, the drag will be cancelled.
411
</p></div></div><div class="refsect1" lang="en"><a name="id3575465"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtknotebook--change-current-page"></a><h3>The "change-current-page" gtk.Notebook Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>offset</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>notebook</code></em> :</span></p></td><td>the notebook that received the
411
</p></div></div><div class="refsect1" lang="en"><a name="id3776271"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtknotebook--change-current-page"></a><h3>The "change-current-page" gtk.Notebook Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>notebook</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>offset</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>notebook</code></em> :</span></p></td><td>the notebook that received the
412
412
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td><td>the count of pages to move (negative count is
413
413
backward)</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
414
414
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>