/usr/share/gtk-doc/html/pygtk/class-gtkassistant.html is in python-gtk2-doc 2.24.0-5.1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Assistant</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" 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-gtkaspectframe.html" title="gtk.AspectFrame"><link rel="next" href="class-gtkbin.html" title="gtk.Bin"></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.Assistant</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkaspectframe.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkbin.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.Assistant"><a name="class-gtkassistant"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.Assistant</h2><p>gtk.Assistant — a widget used to guide users through multi-step operations
(new in PyGTK 2.10)</p></div><div class="refsect1" title="Synopsis"><a name="id3474310"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Assistant</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkwindow.html" title="gtk.Window">gtk.Window</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname">gtk.Assistant</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkassistant.html#method-gtkassistant--get-current-page" title="gtk.Assistant.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-gtkassistant.html#method-gtkassistant--set-current-page" title="gtk.Assistant.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-gtkassistant.html#method-gtkassistant--get-n-pages" title="gtk.Assistant.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-gtkassistant.html#method-gtkassistant--get-nth-page" title="gtk.Assistant.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-gtkassistant.html#method-gtkassistant--prepend-page" title="gtk.Assistant.prepend_page">prepend_page</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkassistant.html#method-gtkassistant--append-page" title="gtk.Assistant.append_page">append_page</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkassistant.html#method-gtkassistant--insert-page" title="gtk.Assistant.insert_page">insert_page</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</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-gtkassistant.html#method-gtkassistant--set-forward-page-func" title="gtk.Assistant.set_forward_page_func">set_forward_page_func</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_func</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>data</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkassistant.html#method-gtkassistant--set-page-type" title="gtk.Assistant.set_page_type">set_page_type</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkassistant.html#method-gtkassistant--get-page-type" title="gtk.Assistant.get_page_type">get_page_type</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkassistant.html#method-gtkassistant--set-page-title" title="gtk.Assistant.set_page_title">set_page_title</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>title</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkassistant.html#method-gtkassistant--get-page-title" title="gtk.Assistant.get_page_title">get_page_title</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkassistant.html#method-gtkassistant--set-page-header-image" title="gtk.Assistant.set_page_header_image">set_page_header_image</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>pixbuf</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkassistant.html#method-gtkassistant--get-page-header-image" title="gtk.Assistant.get_page_header_image">get_page_header_image</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkassistant.html#method-gtkassistant--set-page-side-image" title="gtk.Assistant.set_page_side_image">set_page_side_image</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>pixbuf</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkassistant.html#method-gtkassistant--get-page-side-image" title="gtk.Assistant.get_page_side_image">get_page_side_image</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkassistant.html#method-gtkassistant--set-page-complete" title="gtk.Assistant.set_page_complete">set_page_complete</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>complete</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkassistant.html#method-gtkassistant--get-page-complete" title="gtk.Assistant.get_page_complete">get_page_complete</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkassistant.html#method-gtkassistant--add-action-widget" title="gtk.Assistant.add_action_widget">add_action_widget</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-gtkassistant.html#method-gtkassistant--remove-action-widget" title="gtk.Assistant.remove_action_widget">remove_action_widget</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-gtkassistant.html#method-gtkassistant--update-buttons-state" title="gtk.Assistant.update_buttons_state">update_buttons_state</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkassistant.html#method-gtkassistant--commit" title="gtk.Assistant.commit">commit</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3451698"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
+-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
+-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
+-- <a class="link" href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
+-- <a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
+-- <a class="link" href="class-gtkwindow.html" title="gtk.Window">gtk.Window</a>
+-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Assistant</a>
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3370393"></a><h2>Implemented Interfaces</h2><p>
<a class="link" href="class-gtkassistant.html" title="gtk.Assistant"><code class="classname">gtk.Assistant</code></a>
implements
<a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
</p></div><div class="refsect1" title="gtk.Assistant Properties"><a name="properties-gtkassistant"></a><h2>gtk.Assistant Properties</h2><p><a class="link" href="class-gtkobject.html#properties-gtkobject" title="gtk.Object Properties">gtk.Object Properties</a></p><p><a class="link" href="class-gtkwidget.html#properties-gtkwidget" title="gtk.Widget Properties">gtk.Widget Properties</a></p><p><a class="link" href="class-gtkcontainer.html#properties-gtkcontainer" title="gtk.Container Properties">gtk.Container Properties</a></p><p><a class="link" href="class-gtkwindow.html#properties-gtkwindow" title="gtk.Window Properties">gtk.Window Properties</a></p></div><div class="refsect1" title="gtk.Assistant Style Properties"><a name="style-properties-gtkassistant"></a><h2>gtk.Assistant Style Properties</h2><p><a class="link" href="class-gtkwidget.html#style-properties-gtkwidget" title="gtk.Widget Style Properties">gtk.Widget Style Properties</a></p><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"content-padding"</td><td valign="top">Read</td><td valign="top">Number of pixels around the content pages. Allowed
values: >= 0. Default value: 1. This property is available in
GTK+ 2.10 and above.</td></tr><tr valign="top"><td valign="top">"header-padding"</td><td valign="top">Read</td><td valign="top">Number of pixels around the header. Allowed values: >=
0 Default value: 6. This property is available in GTK+ 2.10
and above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.Assistant Child Properties"><a name="child-properties-gtkassistant"></a><h2>gtk.Assistant Child Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"complete"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code>, marks a page as complete
(i.e.: all the required fields are filled out). GTK+ uses this
information to control the sensitivity of the navigation
buttons. Default value: <code class="literal">False</code>. This property
is available in GTK+ 2.10 and above.</td></tr><tr valign="top"><td valign="top">"header-image"</td><td valign="top">Read-Write</td><td valign="top">The <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a>
image that is displayed in the page header. This property is
available in GTK+ 2.10 and above.</td></tr><tr valign="top"><td valign="top">"page-type"</td><td valign="top">Read-Write</td><td valign="top">The type of the assistant page - one of the <a class="xref" href="gtk-constants.html#gtk-assistant-page-type-constants" title="GTK Assistant Page Type Constants">GTK Assistant Page Type Constants</a> .
Default value:
<code class="literal">gtk.ASSISTANT_PAGE_CONTENT</code>. This property
is available in GTK+ 2.10 and above.</td></tr><tr valign="top"><td valign="top">"sidebar-image"</td><td valign="top">Read-Write</td><td valign="top">The <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a>
image displayed in the sidebar for the assistant page. Set
this to <code class="literal">None</code> to make the sidebar
disappear. This property is available in GTK+ 2.10 and
above.</td></tr><tr valign="top"><td valign="top">"title"</td><td valign="top">Read-Write</td><td valign="top">The title that is displayed in the page header. If
"title" and "header-image" are both <code class="literal">None</code>,
no header is displayed. Default value:
<code class="literal">None</code>. This property is available in GTK+
2.10 and above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.Assistant Signal Prototypes"><a name="signal-prototypes-gtkassistant"></a><h2>gtk.Assistant 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><p><a class="link" href="class-gtkwindow.html#signal-prototypes-gtkwindow" title="gtk.Window Signal Prototypes">gtk.Window 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-gtkassistant.html#signal-gtkassistant--apply" title='The "apply" Signal'>apply</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>widget</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-gtkassistant.html#signal-gtkassistant--cancel" title='The "cancel" Signal'>cancel</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>widget</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-gtkassistant.html#signal-gtkassistant--close" title='The "close" Signal'>close</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>widget</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-gtkassistant.html#signal-gtkassistant--prepare" title='The "prepare" Signal'>prepare</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>widget</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>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" title="Description"><a name="id3497951"></a><h2>Description</h2><p>A <a class="link" href="class-gtkassistant.html" title="gtk.Assistant"><code class="classname">gtk.Assistant</code></a>
is a widget used to guide the user through a complex operation by
breaking it into several steps. Each step is generally handled by one
assistant page. The assistant controls the page flow to collect the
necessary data to complete the application task.</p></div><div class="refsect1" title="Constructor"><a name="id3457976"></a><h2>Constructor</h2><div class="refsect2" title="gtk.Assistant"><a name="constructor-gtkassistant"></a><h3>gtk.Assistant</h3><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.Assistant</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>a new <a class="link" href="class-gtkassistant.html" title="gtk.Assistant"><code class="classname">gtk.Assistant</code></a>
object.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.10 and above.</p></div><p>Creates a new <a class="link" href="class-gtkassistant.html" title="gtk.Assistant"><code class="classname">gtk.Assistant</code></a>.</p></div></div><div class="refsect1" title="Methods"><a name="id3547530"></a><h2>Methods</h2><div class="refsect2" title="gtk.Assistant.get_current_page"><a name="method-gtkassistant--get-current-page"></a><h3>gtk.Assistant.get_current_page</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_current_page</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><span class="term"><strong class="parameter"><code></code></strong> :</span></p></td><td>The index (starting from 0) of the current page
in the assistant, if the assistant has no pages, -1 will be
returned.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">get_current_page</code>() method returns
the page number of the current page.</p></div><div class="refsect2" title="gtk.Assistant.set_current_page"><a name="method-gtkassistant--set-current-page"></a><h3>gtk.Assistant.set_current_page</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_current_page</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_num</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>page_num</code></strong> :</span></p></td><td>the index of the page to switch to, starting
from 0. If negative, the last page will be used. If greater than
the number of pages in the assistant, there will be no
change.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">set_current_page</code>() method switches
the page to the page specified by
<em class="parameter"><code>page_num</code></em>. Note that this will only be necessary
in custom buttons, as the assistant flow can be set with the <a class="link" href="class-gtkassistant.html#method-gtkassistant--set-forward-page-func" title="gtk.Assistant.set_forward_page_func"><code class="methodname">set_forward_page_func</code>()</a>
method.</p></div><div class="refsect2" title="gtk.Assistant.get_n_pages"><a name="method-gtkassistant--get-n-pages"></a><h3>gtk.Assistant.get_n_pages</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_n_pages</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 number of pages in the assistant.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">get_n_pages</code>() method returns the
number of pages in the assistant</p></div><div class="refsect2" title="gtk.Assistant.get_nth_page"><a name="method-gtkassistant--get-nth-page"></a><h3>gtk.Assistant.get_nth_page</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_nth_page</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_num</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>page_num</code></strong> :</span></p></td><td>The index of a page in the assistant, or -1 to
get the last page;</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>The child widget, or <code class="literal">None</code> if
<em class="parameter"><code>page_num</code></em> is out of
bounds.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">get_nth_page</code>() method returns the
child widget contained in the page specified by
<em class="parameter"><code>page_num</code></em>.</p></div><div class="refsect2" title="gtk.Assistant.prepend_page"><a name="method-gtkassistant--prepend-page"></a><h3>gtk.Assistant.prepend_page</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">prepend_page</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</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>page</code></strong> :</span></p></td><td>a <a class="link" href="class-gtkwidget.html" title="gtk.Widget"><code class="classname">gtk.Widget</code></a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the index (starting at 0) of the inserted
page</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">prepend_page</code>() method prepends the
page specified by <em class="parameter"><code>page</code></em> to the assistant.</p></div><div class="refsect2" title="gtk.Assistant.append_page"><a name="method-gtkassistant--append-page"></a><h3>gtk.Assistant.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>page</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>page</code></strong> :</span></p></td><td>a <a class="link" href="class-gtkwidget.html" title="gtk.Widget"><code class="classname">gtk.Widget</code></a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the index (starting at 0) of the inserted
page</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">append_page</code>() method appends the
page specified by <em class="parameter"><code>page</code></em> to the assistant.</p></div><div class="refsect2" title="gtk.Assistant.insert_page"><a name="method-gtkassistant--insert-page"></a><h3>gtk.Assistant.insert_page</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">insert_page</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>position</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>page</code></strong> :</span></p></td><td>a <a class="link" href="class-gtkwidget.html" title="gtk.Widget"><code class="classname">gtk.Widget</code></a></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>position</code></strong> :</span></p></td><td>the index (starting at 0) at which to insert the
page, or -1 to append the page to the assistant</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the index (starting from 0) of the inserted
page</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">insert_page</code>() method inserts the
page specified by <em class="parameter"><code>page</code></em> in the assistant at the
position index specified by <em class="parameter"><code>position</code></em>.</p></div><div class="refsect2" title="gtk.Assistant.set_forward_page_func"><a name="method-gtkassistant--set-forward-page-func"></a><h3>gtk.Assistant.set_forward_page_func</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_forward_page_func</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_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>page_func</code></strong> :</span></p></td><td>the function, or <code class="literal">None</code> to use
the default function.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>data</code></strong> :</span></p></td><td>user data for
<em class="parameter"><code>page_func</code></em></td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">set_forward_page_func</code>() method sets
the page forwarding function to be
<em class="parameter"><code>page_func</code></em>. This function will be used to
determine what will be the next page when the user presses the forward
button. Setting <em class="parameter"><code>page_func</code></em> to
<code class="literal">None</code> will make the assistant use the default
forward function, which just goes to the next visible page.</p><p>The signature of <em class="parameter"><code>page_func</code></em> is:</p><pre class="programlisting">
def page_func(current_page, user_data):
</pre><p>where <em class="parameter"><code>current_page</code></em> is the index of the
current page and <em class="parameter"><code>user_data</code></em> is
<em class="parameter"><code>data</code></em>.</p></div><div class="refsect2" title="gtk.Assistant.set_page_type"><a name="method-gtkassistant--set-page-type"></a><h3>gtk.Assistant.set_page_type</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_page_type</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</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>page</code></strong> :</span></p></td><td>a page in the assistant</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>type</code></strong> :</span></p></td><td>the new type for
<em class="parameter"><code>page</code></em></td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">set_page_type</code>() method sets the
page type, which specifies the page behavior, for the page specified
by <em class="parameter"><code>page</code></em> to the value specified by
<em class="parameter"><code>type</code></em>. The page type must be one of the <a class="xref" href="gtk-constants.html#gtk-assistant-page-type-constants" title="GTK Assistant Page Type Constants">GTK Assistant Page Type Constants</a>.</p></div><div class="refsect2" title="gtk.Assistant.get_page_type"><a name="method-gtkassistant--get-page-type"></a><h3>gtk.Assistant.get_page_type</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_page_type</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</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>page</code></strong> :</span></p></td><td>a page in the assistant</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the page type of
<em class="parameter"><code>page</code></em>.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">get_page_type</code>() method returns the
page type of the page specified by <em class="parameter"><code>page</code></em>. The
page type will be one of the <a class="xref" href="gtk-constants.html#gtk-assistant-page-type-constants" title="GTK Assistant Page Type Constants">GTK Assistant Page Type Constants</a>.</p></div><div class="refsect2" title="gtk.Assistant.set_page_title"><a name="method-gtkassistant--set-page-title"></a><h3>gtk.Assistant.set_page_title</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_page_title</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>title</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>page</code></strong> :</span></p></td><td>a page of the assistant</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>title</code></strong> :</span></p></td><td>the new title for
<em class="parameter"><code>page</code></em></td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">set_page_title</code>() method sets the
title for the page specified by <em class="parameter"><code>page</code></em> to the
string specified by <em class="parameter"><code>title</code></em>. The title is
displayed in the header area of the assistant when
<em class="parameter"><code>page</code></em> is the current page.</p></div><div class="refsect2" title="gtk.Assistant.get_page_title"><a name="method-gtkassistant--get-page-title"></a><h3>gtk.Assistant.get_page_title</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_page_title</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</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>page</code></strong> :</span></p></td><td>a page of the assistant</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the title for
<em class="parameter"><code>page</code></em>.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">get_page_title</code>() method returns the
title for the page specified by <em class="parameter"><code>page</code></em>.</p></div><div class="refsect2" title="gtk.Assistant.set_page_header_image"><a name="method-gtkassistant--set-page-header-image"></a><h3>gtk.Assistant.set_page_header_image</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_page_header_image</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>pixbuf</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>page</code></strong> :</span></p></td><td>a page of the assistant</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>pixbuf</code></strong> :</span></p></td><td>the new header image for
<em class="parameter"><code>page</code></em> or
<code class="literal">None</code>.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">set_page_header_image</code>() method sets
the <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a>
specified by <em class="parameter"><code>pixbuf</code></em> as the header image for the
page specified by <em class="parameter"><code>page</code></em>. This image is displayed
in the header area of the assistant when <em class="parameter"><code>page</code></em>
is the current page. If <em class="parameter"><code>pixbuf</code></em> is
<code class="literal">None</code> the header image will be removed.</p></div><div class="refsect2" title="gtk.Assistant.get_page_header_image"><a name="method-gtkassistant--get-page-header-image"></a><h3>gtk.Assistant.get_page_header_image</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_page_header_image</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</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>page</code></strong> :</span></p></td><td>a page of the assistant</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the header image for <em class="parameter"><code>page</code></em>,
or <code class="literal">None</code> if there's no header image for the
page.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">get_page_header_image</code>() method
returns the header image for the page specified by
<em class="parameter"><code>page</code></em>.</p></div><div class="refsect2" title="gtk.Assistant.set_page_side_image"><a name="method-gtkassistant--set-page-side-image"></a><h3>gtk.Assistant.set_page_side_image</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_page_side_image</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>pixbuf</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>page</code></strong> :</span></p></td><td>a page of the assistant</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>pixbuf</code></strong> :</span></p></td><td>the new side image for
<em class="parameter"><code>page</code></em> or
<code class="literal">None</code>.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">set_page_side_image</code>() method sets
the <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a>
specified by <em class="parameter"><code>pixbuf</code></em> as the header image for the
page specified by <em class="parameter"><code>page</code></em>. This image is displayed
in the side area of the assistant when <em class="parameter"><code>page</code></em> is
the current page. If <em class="parameter"><code>pixbuf</code></em> is
<code class="literal">None</code> the side image will be removed.</p></div><div class="refsect2" title="gtk.Assistant.get_page_side_image"><a name="method-gtkassistant--get-page-side-image"></a><h3>gtk.Assistant.get_page_side_image</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_page_side_image</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</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>page</code></strong> :</span></p></td><td>a page of the assistant</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the side image for <em class="parameter"><code>page</code></em>,
or <code class="literal">None</code> if there's no side image for the
page.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">get_page_side_image</code>() method
returns the header image for the page specified by
<em class="parameter"><code>page</code></em>.</p></div><div class="refsect2" title="gtk.Assistant.set_page_complete"><a name="method-gtkassistant--set-page-complete"></a><h3>gtk.Assistant.set_page_complete</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_page_complete</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>complete</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>page</code></strong> :</span></p></td><td>a page of the assistant</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>complete</code></strong> :</span></p></td><td>if <code class="literal">True</code> the page status is
complete.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">set_page_complete</code>() method sets the
"complete" property of the page specified by
<em class="parameter"><code>page</code></em> to the value specified by
<em class="parameter"><code>complete</code></em>. If <em class="parameter"><code>complete</code></em> is
<code class="literal">True</code> the <em class="parameter"><code>page</code></em> contents are
complete. This will make the assistant update the state of its
buttons.</p></div><div class="refsect2" title="gtk.Assistant.get_page_complete"><a name="method-gtkassistant--get-page-complete"></a><h3>gtk.Assistant.get_page_complete</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_page_complete</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</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>page</code></strong> :</span></p></td><td>a page of the assistant</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if
<em class="parameter"><code>page</code></em> is complete.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">get_page_complete</code>() method returns
the value of the "complete" property of the page specified by
<em class="parameter"><code>page</code></em>. If the return value is
<code class="literal">True</code>, the <em class="parameter"><code>page</code></em> contents are
complete.</p></div><div class="refsect2" title="gtk.Assistant.add_action_widget"><a name="method-gtkassistant--add-action-widget"></a><h3>gtk.Assistant.add_action_widget</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">add_action_widget</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</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>child</code></strong> :</span></p></td><td>a <a class="link" href="class-gtkwidget.html" title="gtk.Widget"><code class="classname">gtk.Widget</code></a></td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">add_action_widget</code>() method adds the
widget specified by <em class="parameter"><code>child</code></em> to the action area of
the assistant.</p></div><div class="refsect2" title="gtk.Assistant.remove_action_widget"><a name="method-gtkassistant--remove-action-widget"></a><h3>gtk.Assistant.remove_action_widget</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">remove_action_widget</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</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>child</code></strong> :</span></p></td><td>a <a class="link" href="class-gtkwidget.html" title="gtk.Widget"><code class="classname">gtk.Widget</code></a></td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">remove_action_widget</code>() method
removes the widget specified by <em class="parameter"><code>child</code></em> from the
action area of the assistant.</p></div><div class="refsect2" title="gtk.Assistant.update_buttons_state"><a name="method-gtkassistant--update-buttons-state"></a><h3>gtk.Assistant.update_buttons_state</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">update_buttons_state</span>(<span class="methodparam"></span>)</code></pre><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">update_buttons_state</code>() method
forces the assistant to recompute the state of its buttons.</p><p>PyGTK automatically takes care of this in most situations,
e.g. when the user goes to a different page, or when the visibility or
completeness of a page changes.</p><p>One situation where it can be necessary to call this function is
when changing a value on the current page affects the future page flow
of the assistant.</p></div><div class="refsect2" title="gtk.Assistant.commit"><a name="method-gtkassistant--commit"></a><h3>gtk.Assistant.commit</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">commit</span>(<span class="methodparam"></span>)</code></pre><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.22 and above.</p></div><p>The <code class="methodname">commit</code>() method erases the visited
page history so the back button is not shown on the current page, and
removes the cancel button from subsequent pages.</p><p>Use this when the information provided up to the current page is
hereafter deemed permanent and cannot be modified or undone. For example,
showing a progress page to track a long-running, unreversible operation
after the user has clicked apply on a confirmation page.</p></div></div><div class="refsect1" title="Signals"><a name="id3328805"></a><h2>Signals</h2><div class="refsect2" title='The "apply" Signal'><a name="signal-gtkassistant--apply"></a><h3>The "apply" Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>assistant</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>assistant</code></em> :</span></p></td><td>the <a class="link" href="class-gtkassistant.html" title="gtk.Assistant"><code class="classname">gtk.Assistant</code></a>
that received the signal</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
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "apply" signal is emitted when the apply button is
clicked. The default behavior of the <a class="link" href="class-gtkassistant.html" title="gtk.Assistant"><code class="classname">gtk.Assistant</code></a>
is to switch to the page after the current page, unless the current
page is the last one.</p><p>A handler for the "apply" signal should carry out the actions
for which the wizard has collected data. If the action takes a long
time to complete, you might consider to put a page of type
<code class="literal">gtk.ASSISTANT_PAGE_PROGRESS</code> after the confirmation
page and handle this operation within the "prepare" signal of the
progress page.</p></div><div class="refsect2" title='The "cancel" Signal'><a name="signal-gtkassistant--cancel"></a><h3>The "cancel" Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>assistant</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>assistant</code></em> :</span></p></td><td>the <a class="link" href="class-gtkassistant.html" title="gtk.Assistant"><code class="classname">gtk.Assistant</code></a>
that received the signal</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
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "cancel" signal is emitted when the cancel button is
clicked.</p></div><div class="refsect2" title='The "close" Signal'><a name="signal-gtkassistant--close"></a><h3>The "close" Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>assistant</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>assistant</code></em> :</span></p></td><td>the <a class="link" href="class-gtkassistant.html" title="gtk.Assistant"><code class="classname">gtk.Assistant</code></a>
that received the signal</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
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "close" signal is emitted either when the close button of a
summary page is clicked, or when the apply button in the last page in
the flow (of type <code class="literal">gtk.ASSISTANT_PAGE_CONFIRM</code>) is
clicked.</p></div><div class="refsect2" title='The "prepare" Signal'><a name="signal-gtkassistant--prepare"></a><h3>The "prepare" Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>assistant</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>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>assistant</code></em> :</span></p></td><td>the <a class="link" href="class-gtkassistant.html" title="gtk.Assistant"><code class="classname">gtk.Assistant</code></a>
that received the signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td><td>the new page to prepare for
display</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
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "prepare" signal is emitted when a new page is set as the
assistant's current page, but before making the new page visible. A
handler for this signal can do any preparation that are necessary
before showing <em class="parameter"><code>page</code></em>.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gtkaspectframe.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gtkbin.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.AspectFrame </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.Bin</td></tr></table></div></body></html>
|