~ubuntu-branches/ubuntu/natty/pygtk/natty-proposed
» Revision
60
: docs/html/class-gtkassistant.html
« back to all changes in this revision
Viewing changes to docs/html/class-gtkassistant.html
- browse files at revision 60
- compare with another revision
- download diff
- download tarball
- view history from revision 60
- Committer: Bazaar Package Importer
- Author(s): Sebastien Bacher
- Date: 2010-01-07 11:08:47 UTC
- mfrom: (1.2.8 upstream)
- Revision ID: james.westby@ubuntu.com-20100107110847-f5av7e1ttudh7ra6
Tags: 2.17.0-0ubuntu1
New upstream version
- files added:
- gtk/gdk-2.18.defs
- files modified:
- ChangeLog
added
removed
docs/html/class-gtkassistant.html
1
<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.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-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" lang="en"><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
2
(new in PyGTK 2.10)</p></div><div class="refsect1" lang="en"><a name="id3263526"></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>):
3
<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></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3275228"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
1
<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.1"><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
2
(new in PyGTK 2.10)</p></div><div class="refsect1" title="Synopsis"><a name="id3502350"></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>):
3
<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></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3602311"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
4
4
+-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
5
5
+-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
6
6
+-- <a class="link" href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
7
7
+-- <a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
8
8
+-- <a class="link" href="class-gtkwindow.html" title="gtk.Window">gtk.Window</a>
9
9
+-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Assistant</a>
10
</pre></div><div class="refsect1" lang="en"><a name="id3290524"></a><h2>Implemented Interfaces</h2><p>
10
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3589546"></a><h2>Implemented Interfaces</h2><p>
11
11
<a class="link" href="class-gtkassistant.html" title="gtk.Assistant"><code class="classname">gtk.Assistant</code></a>
12
12
implements
13
13
<a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
14
</p></div><div class="refsect1" lang="en"><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" lang="en"><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><col><col></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
14
</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
15
15
values: >= 0. Default value: 1. This property is available in
16
16
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: >=
17
17
0 Default value: 6. This property is available in GTK+ 2.10
18
and above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><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><col><col></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
18
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
19
19
(i.e.: all the required fields are filled out). GTK+ uses this
20
20
information to control the sensitivity of the navigation
21
21
buttons. Default value: <code class="literal">False</code>. This property
32
32
"title" and "header-image" are both <code class="literal">None</code>,
33
33
no header is displayed. Default value:
34
34
<code class="literal">None</code>. This property is available in GTK+
35
2.10 and above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><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" lang="en"><a name="id3085093"></a><h2>Description</h2><p>A <a class="link" href="class-gtkassistant.html" title="gtk.Assistant"><code class="classname">gtk.Assistant</code></a>
35
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="id3675355"></a><h2>Description</h2><p>A <a class="link" href="class-gtkassistant.html" title="gtk.Assistant"><code class="classname">gtk.Assistant</code></a>
36
36
is a widget used to guide the user through a complex operation by
37
37
breaking it into several steps. Each step is generally handled by one
38
38
assistant page. The assistant controls the page flow to collect the
39
necessary data to complete the application task.</p></div><div class="refsect1" lang="en"><a name="id3069865"></a><h2>Constructor</h2><div class="refsect2" lang="en"><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>
40
object.</td></tr></tbody></table><div class="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" lang="en"><a name="id3370274"></a><h2>Methods</h2><div class="refsect2" lang="en"><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
39
necessary data to complete the application task.</p></div><div class="refsect1" title="Constructor"><a name="id3675013"></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>
40
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="id3618835"></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
41
41
in the assistant, if the assistant has no pages, -1 will be
42
returned.</td></tr></tbody></table><div class="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
43
the page number of the current page.</p></div><div class="refsect2" lang="en"><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
42
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
43
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
44
44
from 0. If negative, the last page will be used. If greater than
45
45
the number of pages in the assistant, there will be no
46
change.</td></tr></tbody></table><div class="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
46
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
47
47
the page to the page specified by
48
48
<em class="parameter"><code>page_num</code></em>. Note that this will only be necessary
49
49
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>
50
method.</p></div><div class="refsect2" lang="en"><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" 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
51
number of pages in the assistant</p></div><div class="refsect2" lang="en"><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
50
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
51
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
52
52
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
53
53
<em class="parameter"><code>page_num</code></em> is out of
54
bounds.</td></tr></tbody></table><div class="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
54
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
55
55
child widget contained in the page specified by
56
<em class="parameter"><code>page_num</code></em>.</p></div><div class="refsect2" lang="en"><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
57
page</td></tr></tbody></table><div class="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
58
page specified by <em class="parameter"><code>page</code></em> to the assistant.</p></div><div class="refsect2" lang="en"><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
59
page</td></tr></tbody></table><div class="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
60
page specified by <em class="parameter"><code>page</code></em> to the assistant.</p></div><div class="refsect2" lang="en"><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
56
<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
57
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
58
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
59
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
60
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
61
61
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
62
page</td></tr></tbody></table><div class="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
62
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
63
63
page specified by <em class="parameter"><code>page</code></em> in the assistant at the
64
position index specified by <em class="parameter"><code>position</code></em>.</p></div><div class="refsect2" lang="en"><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
64
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
65
65
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
66
<em class="parameter"><code>page_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 method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">set_forward_page_func</code>() method sets
66
<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
67
67
the page forwarding function to be
68
68
<em class="parameter"><code>page_func</code></em>. This function will be used to
69
69
determine what will be the next page when the user presses the forward
73
73
def page_func(current_page, user_data):
74
74
</pre><p>where <em class="parameter"><code>current_page</code></em> is the index of the
75
75
current page and <em class="parameter"><code>user_data</code></em> is
76
<em class="parameter"><code>data</code></em>.</p></div><div class="refsect2" lang="en"><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
77
<em class="parameter"><code>page</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 method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">set_page_type</code>() method sets the
76
<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
77
<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
78
78
page type, which specifies the page behavior, for the page specified
79
79
by <em class="parameter"><code>page</code></em> to the value specified by
80
<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" lang="en"><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
81
<em class="parameter"><code>page</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 method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">get_page_type</code>() method returns the
80
<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
81
<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
82
82
page type of the page specified by <em class="parameter"><code>page</code></em>. The
83
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" lang="en"><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
84
<em class="parameter"><code>page</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 method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">set_page_title</code>() method sets the
83
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
84
<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
85
85
title for the page specified by <em class="parameter"><code>page</code></em> to the
86
86
string specified by <em class="parameter"><code>title</code></em>. The title is
87
87
displayed in the header area of the assistant when
88
<em class="parameter"><code>page</code></em> is the current page.</p></div><div class="refsect2" lang="en"><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
89
<em class="parameter"><code>page</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 method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">get_page_title</code>() method returns the
90
title for the page specified by <em class="parameter"><code>page</code></em>.</p></div><div class="refsect2" lang="en"><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
88
<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
89
<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
90
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
91
91
<em class="parameter"><code>page</code></em> or
92
<code class="literal">None</code>.</td></tr></tbody></table><div class="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
92
<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
93
93
the <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a>
94
94
specified by <em class="parameter"><code>pixbuf</code></em> as the header image for the
95
95
page specified by <em class="parameter"><code>page</code></em>. This image is displayed
96
96
in the header area of the assistant when <em class="parameter"><code>page</code></em>
97
97
is the current page. If <em class="parameter"><code>pixbuf</code></em> is
98
<code class="literal">None</code> the header image will be removed.</p></div><div class="refsect2" lang="en"><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>,
98
<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>,
99
99
or <code class="literal">None</code> if there's no header image for the
100
page.</td></tr></tbody></table><div class="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
100
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
101
101
returns the header image for the page specified by
102
<em class="parameter"><code>page</code></em>.</p></div><div class="refsect2" lang="en"><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
102
<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
103
103
<em class="parameter"><code>page</code></em> or
104
<code class="literal">None</code>.</td></tr></tbody></table><div class="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
104
<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
105
105
the <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a>
106
106
specified by <em class="parameter"><code>pixbuf</code></em> as the header image for the
107
107
page specified by <em class="parameter"><code>page</code></em>. This image is displayed
108
108
in the side area of the assistant when <em class="parameter"><code>page</code></em> is
109
109
the current page. If <em class="parameter"><code>pixbuf</code></em> is
110
<code class="literal">None</code> the side image will be removed.</p></div><div class="refsect2" lang="en"><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>,
110
<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>,
111
111
or <code class="literal">None</code> if there's no side image for the
112
page.</td></tr></tbody></table><div class="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
112
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
113
113
returns the header image for the page specified by
114
<em class="parameter"><code>page</code></em>.</p></div><div class="refsect2" lang="en"><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
115
complete.</td></tr></tbody></table><div class="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
114
<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
115
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
116
116
"complete" property of the page specified by
117
117
<em class="parameter"><code>page</code></em> to the value specified by
118
118
<em class="parameter"><code>complete</code></em>. If <em class="parameter"><code>complete</code></em> is
119
119
<code class="literal">True</code> the <em class="parameter"><code>page</code></em> contents are
120
120
complete. This will make the assistant update the state of its
121
buttons.</p></div><div class="refsect2" lang="en"><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
122
<em class="parameter"><code>page</code></em> is complete.</td></tr></tbody></table><div class="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
121
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
122
<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
123
123
the value of the "complete" property of the page specified by
124
124
<em class="parameter"><code>page</code></em>. If the return value is
125
125
<code class="literal">True</code>, the <em class="parameter"><code>page</code></em> contents are
126
complete.</p></div><div class="refsect2" lang="en"><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" 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
126
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
127
127
widget specified by <em class="parameter"><code>child</code></em> to the action area of
128
the assistant.</p></div><div class="refsect2" lang="en"><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" 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
128
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
129
129
removes the widget specified by <em class="parameter"><code>child</code></em> from the
130
action area of the assistant.</p></div><div class="refsect2" lang="en"><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" 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
130
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
131
131
forces the assistant to recompute the state of its buttons.</p><p>PyGTK automatically takes care of this in most situations,
132
132
e.g. when the user goes to a different page, or when the visibility or
133
133
completeness of a page changes.</p><p>One situation where it can be necessary to call this function is
134
134
when changing a value on the current page affects the future page flow
135
of the assistant.</p></div></div><div class="refsect1" lang="en"><a name="id3292437"></a><h2>Signals</h2><div class="refsect2" lang="en"><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>
135
of the assistant.</p></div></div><div class="refsect1" title="Signals"><a name="id3574183"></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>
136
136
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
137
137
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
138
138
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
144
144
time to complete, you might consider to put a page of type
145
145
<code class="literal">gtk.ASSISTANT_PAGE_PROGRESS</code> after the confirmation
146
146
page and handle this operation within the "prepare" signal of the
147
progress page.</p></div><div class="refsect2" lang="en"><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>
147
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>
148
148
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
149
149
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
150
150
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
151
151
any)</td></tr></tbody></table><p>The "cancel" signal is emitted when the cancel button is
152
clicked.</p></div><div class="refsect2" lang="en"><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>
152
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>
153
153
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
154
154
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
155
155
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
156
156
any)</td></tr></tbody></table><p>The "close" signal is emitted either when the close button of a
157
157
summary page is clicked, or when the apply button in the last page in
158
158
the flow (of type <code class="literal">gtk.ASSISTANT_PAGE_CONFIRM</code>) is
159
clicked.</p></div><div class="refsect2" lang="en"><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>
159
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>
160
160
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
161
161
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
162
162
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
Loggerhead is a web-based interface for Breezy
Version: 2.0.1