1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>GtkAssistant</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
7
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
8
<link rel="up" href="WindowWidgets.html" title="Windows">
9
<link rel="prev" href="GtkAboutDialog.html" title="GtkAboutDialog">
10
<link rel="next" href="GtkOffscreenWindow.html" title="GtkOffscreenWindow">
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
<td><a accesskey="p" href="GtkAboutDialog.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="WindowWidgets.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
<th width="100%" align="center">GTK+ 2 Reference Manual</th>
21
<td><a accesskey="n" href="GtkOffscreenWindow.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#GtkAssistant.synopsis" class="shortcut">Top</a>
26
<a href="#GtkAssistant.description" class="shortcut">Description</a>
28
<a href="#GtkAssistant.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
<a href="#GtkAssistant.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32
<a href="#GtkAssistant.child-properties" class="shortcut">Child Properties</a>
34
<a href="#GtkAssistant.style-properties" class="shortcut">Style Properties</a>
36
<a href="#GtkAssistant.signals" class="shortcut">Signals</a>
39
<div class="refentry">
40
<a name="GtkAssistant"></a><div class="titlepage"></div>
41
<div class="refnamediv"><table width="100%"><tr>
43
<h2><span class="refentrytitle"><a name="GtkAssistant.top_of_page"></a>GtkAssistant</span></h2>
44
<p>GtkAssistant — A widget used to guide users through multi-step operations</p>
46
<td valign="top" align="right"><img src="assistant.png"></td>
48
<div class="refsynopsisdiv">
49
<a name="GtkAssistant.synopsis"></a><h2>Synopsis</h2>
50
<pre class="synopsis">
51
#include <gtk/gtk.h>
53
struct <a class="link" href="GtkAssistant.html#GtkAssistant-struct" title="struct GtkAssistant">GtkAssistant</a>;
54
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GtkAssistant.html#gtk-assistant-new" title="gtk_assistant_new ()">gtk_assistant_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
55
<span class="returnvalue">gint</span> <a class="link" href="GtkAssistant.html#gtk-assistant-get-current-page" title="gtk_assistant_get_current_page ()">gtk_assistant_get_current_page</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>);
56
<span class="returnvalue">void</span> <a class="link" href="GtkAssistant.html#gtk-assistant-set-current-page" title="gtk_assistant_set_current_page ()">gtk_assistant_set_current_page</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
57
<em class="parameter"><code><span class="type">gint</span> page_num</code></em>);
58
<span class="returnvalue">gint</span> <a class="link" href="GtkAssistant.html#gtk-assistant-get-n-pages" title="gtk_assistant_get_n_pages ()">gtk_assistant_get_n_pages</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>);
59
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GtkAssistant.html#gtk-assistant-get-nth-page" title="gtk_assistant_get_nth_page ()">gtk_assistant_get_nth_page</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
60
<em class="parameter"><code><span class="type">gint</span> page_num</code></em>);
61
<span class="returnvalue">gint</span> <a class="link" href="GtkAssistant.html#gtk-assistant-prepend-page" title="gtk_assistant_prepend_page ()">gtk_assistant_prepend_page</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
62
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>);
63
<span class="returnvalue">gint</span> <a class="link" href="GtkAssistant.html#gtk-assistant-append-page" title="gtk_assistant_append_page ()">gtk_assistant_append_page</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
64
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>);
65
<span class="returnvalue">gint</span> <a class="link" href="GtkAssistant.html#gtk-assistant-insert-page" title="gtk_assistant_insert_page ()">gtk_assistant_insert_page</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
66
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>,
67
<em class="parameter"><code><span class="type">gint</span> position</code></em>);
68
<span class="returnvalue">gint</span> (<a class="link" href="GtkAssistant.html#GtkAssistantPageFunc" title="GtkAssistantPageFunc ()">*GtkAssistantPageFunc</a>) (<em class="parameter"><code><span class="type">gint</span> current_page</code></em>,
69
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
70
<span class="returnvalue">void</span> <a class="link" href="GtkAssistant.html#gtk-assistant-set-forward-page-func" title="gtk_assistant_set_forward_page_func ()">gtk_assistant_set_forward_page_func</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
71
<em class="parameter"><code><a class="link" href="GtkAssistant.html#GtkAssistantPageFunc" title="GtkAssistantPageFunc ()"><span class="type">GtkAssistantPageFunc</span></a> page_func</code></em>,
72
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
73
<em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);
74
enum <a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum GtkAssistantPageType">GtkAssistantPageType</a>;
75
<span class="returnvalue">void</span> <a class="link" href="GtkAssistant.html#gtk-assistant-set-page-type" title="gtk_assistant_set_page_type ()">gtk_assistant_set_page_type</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
76
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>,
77
<em class="parameter"><code><a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum GtkAssistantPageType"><span class="type">GtkAssistantPageType</span></a> type</code></em>);
78
<a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum GtkAssistantPageType"><span class="returnvalue">GtkAssistantPageType</span></a> <a class="link" href="GtkAssistant.html#gtk-assistant-get-page-type" title="gtk_assistant_get_page_type ()">gtk_assistant_get_page_type</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
79
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>);
80
<span class="returnvalue">void</span> <a class="link" href="GtkAssistant.html#gtk-assistant-set-page-title" title="gtk_assistant_set_page_title ()">gtk_assistant_set_page_title</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
81
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>,
82
<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>);
83
const <span class="returnvalue">gchar</span> * <a class="link" href="GtkAssistant.html#gtk-assistant-get-page-title" title="gtk_assistant_get_page_title ()">gtk_assistant_get_page_title</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
84
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>);
85
<span class="returnvalue">void</span> <a class="link" href="GtkAssistant.html#gtk-assistant-set-page-header-image" title="gtk_assistant_set_page_header_image ()">gtk_assistant_set_page_header_image</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
86
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>,
87
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);
88
<a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * <a class="link" href="GtkAssistant.html#gtk-assistant-get-page-header-image" title="gtk_assistant_get_page_header_image ()">gtk_assistant_get_page_header_image</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
89
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>);
90
<span class="returnvalue">void</span> <a class="link" href="GtkAssistant.html#gtk-assistant-set-page-side-image" title="gtk_assistant_set_page_side_image ()">gtk_assistant_set_page_side_image</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
91
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>,
92
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);
93
<a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * <a class="link" href="GtkAssistant.html#gtk-assistant-get-page-side-image" title="gtk_assistant_get_page_side_image ()">gtk_assistant_get_page_side_image</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
94
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>);
95
<span class="returnvalue">void</span> <a class="link" href="GtkAssistant.html#gtk-assistant-set-page-complete" title="gtk_assistant_set_page_complete ()">gtk_assistant_set_page_complete</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
96
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>,
97
<em class="parameter"><code><span class="type">gboolean</span> complete</code></em>);
98
<span class="returnvalue">gboolean</span> <a class="link" href="GtkAssistant.html#gtk-assistant-get-page-complete" title="gtk_assistant_get_page_complete ()">gtk_assistant_get_page_complete</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
99
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>);
100
<span class="returnvalue">void</span> <a class="link" href="GtkAssistant.html#gtk-assistant-add-action-widget" title="gtk_assistant_add_action_widget ()">gtk_assistant_add_action_widget</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
101
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *child</code></em>);
102
<span class="returnvalue">void</span> <a class="link" href="GtkAssistant.html#gtk-assistant-remove-action-widget" title="gtk_assistant_remove_action_widget ()">gtk_assistant_remove_action_widget</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
103
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *child</code></em>);
104
<span class="returnvalue">void</span> <a class="link" href="GtkAssistant.html#gtk-assistant-update-buttons-state" title="gtk_assistant_update_buttons_state ()">gtk_assistant_update_buttons_state</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>);
105
<span class="returnvalue">void</span> <a class="link" href="GtkAssistant.html#gtk-assistant-commit" title="gtk_assistant_commit ()">gtk_assistant_commit</a> (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>);
108
<div class="refsect1">
109
<a name="GtkAssistant.object-hierarchy"></a><h2>Object Hierarchy</h2>
110
<pre class="synopsis">
112
+----GInitiallyUnowned
113
+----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
114
+----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
115
+----<a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
116
+----<a class="link" href="GtkBin.html" title="GtkBin">GtkBin</a>
117
+----<a class="link" href="GtkWindow.html" title="GtkWindow">GtkWindow</a>
121
<div class="refsect1">
122
<a name="GtkAssistant.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
124
GtkAssistant implements
125
AtkImplementorIface and <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
127
<div class="refsect1">
128
<a name="GtkAssistant.child-properties"></a><h2>Child Properties</h2>
129
<pre class="synopsis">
130
"<a class="link" href="GtkAssistant.html#GtkAssistant--c-complete" title='The "complete" child property'>complete</a>" <span class="type">gboolean</span> : Read / Write
131
"<a class="link" href="GtkAssistant.html#GtkAssistant--c-header-image" title='The "header-image" child property'>header-image</a>" <a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>* : Read / Write
132
"<a class="link" href="GtkAssistant.html#GtkAssistant--c-page-type" title='The "page-type" child property'>page-type</a>" <a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum GtkAssistantPageType"><span class="type">GtkAssistantPageType</span></a> : Read / Write
133
"<a class="link" href="GtkAssistant.html#GtkAssistant--c-sidebar-image" title='The "sidebar-image" child property'>sidebar-image</a>" <a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>* : Read / Write
134
"<a class="link" href="GtkAssistant.html#GtkAssistant--c-title" title='The "title" child property'>title</a>" <span class="type">gchar</span>* : Read / Write
137
<div class="refsect1">
138
<a name="GtkAssistant.style-properties"></a><h2>Style Properties</h2>
139
<pre class="synopsis">
140
"<a class="link" href="GtkAssistant.html#GtkAssistant--s-content-padding" title='The "content-padding" style property'>content-padding</a>" <span class="type">gint</span> : Read
141
"<a class="link" href="GtkAssistant.html#GtkAssistant--s-header-padding" title='The "header-padding" style property'>header-padding</a>" <span class="type">gint</span> : Read
144
<div class="refsect1">
145
<a name="GtkAssistant.signals"></a><h2>Signals</h2>
146
<pre class="synopsis">
147
"<a class="link" href="GtkAssistant.html#GtkAssistant-apply" title='The "apply" signal'>apply</a>" : <code class="literal">Run Last</code>
148
"<a class="link" href="GtkAssistant.html#GtkAssistant-cancel" title='The "cancel" signal'>cancel</a>" : <code class="literal">Run Last</code>
149
"<a class="link" href="GtkAssistant.html#GtkAssistant-close" title='The "close" signal'>close</a>" : <code class="literal">Run Last</code>
150
"<a class="link" href="GtkAssistant.html#GtkAssistant-prepare" title='The "prepare" signal'>prepare</a>" : <code class="literal">Run Last</code>
153
<div class="refsect1">
154
<a name="GtkAssistant.description"></a><h2>Description</h2>
156
A <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> is a widget used to represent a generally complex
157
operation splitted in several steps, guiding the user through its pages
158
and controlling the page flow to collect the necessary data.
162
<div class="refsect2">
163
<a name="GtkAssistant-BUILDER-UI"></a><h3>GtkAssistant as GtkBuildable</h3>
165
The GtkAssistant implementation of the GtkBuildable interface exposes the
166
<em class="parameter"><code>action_area</code></em> as internal children with the name "action_area".
169
To add pages to an assistant in GtkBuilder, simply add it as a
170
<child> to the GtkAssistant object, and set its child properties
177
<div class="refsect1">
178
<a name="GtkAssistant.details"></a><h2>Details</h2>
179
<div class="refsect2">
180
<a name="GtkAssistant-struct"></a><h3>struct GtkAssistant</h3>
181
<pre class="programlisting">struct GtkAssistant;</pre>
186
<div class="refsect2">
187
<a name="gtk-assistant-new"></a><h3>gtk_assistant_new ()</h3>
188
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * gtk_assistant_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
190
Creates a new <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>.
192
<div class="variablelist"><table border="0" class="variablelist">
194
<col align="left" valign="top">
198
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
199
<td>a newly created <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
203
<p class="since">Since 2.10</p>
206
<div class="refsect2">
207
<a name="gtk-assistant-get-current-page"></a><h3>gtk_assistant_get_current_page ()</h3>
208
<pre class="programlisting"><span class="returnvalue">gint</span> gtk_assistant_get_current_page (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>);</pre>
210
Returns the page number of the current page
212
<div class="variablelist"><table border="0" class="variablelist">
214
<col align="left" valign="top">
219
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
220
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
224
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
225
<td>The index (starting from 0) of the current page in
226
the <em class="parameter"><code>assistant</code></em>, if the <em class="parameter"><code>assistant</code></em> has no pages, -1 will be returned</td>
230
<p class="since">Since 2.10</p>
233
<div class="refsect2">
234
<a name="gtk-assistant-set-current-page"></a><h3>gtk_assistant_set_current_page ()</h3>
235
<pre class="programlisting"><span class="returnvalue">void</span> gtk_assistant_set_current_page (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
236
<em class="parameter"><code><span class="type">gint</span> page_num</code></em>);</pre>
238
Switches the page to <em class="parameter"><code>page_num</code></em>. Note that this will only be necessary
239
in custom buttons, as the <em class="parameter"><code>assistant</code></em> flow can be set with
240
<a class="link" href="GtkAssistant.html#gtk-assistant-set-forward-page-func" title="gtk_assistant_set_forward_page_func ()"><code class="function">gtk_assistant_set_forward_page_func()</code></a>.
242
<div class="variablelist"><table border="0" class="variablelist">
244
<col align="left" valign="top">
249
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
250
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
254
<td><p><span class="term"><em class="parameter"><code>page_num</code></em> :</span></p></td>
255
<td>index of the page to switch to, starting from 0.
256
If negative, the last page will be used. If greater
257
than the number of pages in the <em class="parameter"><code>assistant</code></em>, nothing
262
<p class="since">Since 2.10</p>
265
<div class="refsect2">
266
<a name="gtk-assistant-get-n-pages"></a><h3>gtk_assistant_get_n_pages ()</h3>
267
<pre class="programlisting"><span class="returnvalue">gint</span> gtk_assistant_get_n_pages (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>);</pre>
269
Returns the number of pages in the <em class="parameter"><code>assistant</code></em>
271
<div class="variablelist"><table border="0" class="variablelist">
273
<col align="left" valign="top">
278
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
279
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
283
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
284
<td>The number of pages in the <em class="parameter"><code>assistant</code></em>.</td>
288
<p class="since">Since 2.10</p>
291
<div class="refsect2">
292
<a name="gtk-assistant-get-nth-page"></a><h3>gtk_assistant_get_nth_page ()</h3>
293
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * gtk_assistant_get_nth_page (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
294
<em class="parameter"><code><span class="type">gint</span> page_num</code></em>);</pre>
296
Returns the child widget contained in page number <em class="parameter"><code>page_num</code></em>.
298
<div class="variablelist"><table border="0" class="variablelist">
300
<col align="left" valign="top">
305
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
306
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
310
<td><p><span class="term"><em class="parameter"><code>page_num</code></em> :</span></p></td>
311
<td>The index of a page in the <em class="parameter"><code>assistant</code></em>, or -1 to get the last page;</td>
314
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
315
<td>The child widget, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
316
if <em class="parameter"><code>page_num</code></em> is out of bounds. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
321
<p class="since">Since 2.10</p>
324
<div class="refsect2">
325
<a name="gtk-assistant-prepend-page"></a><h3>gtk_assistant_prepend_page ()</h3>
326
<pre class="programlisting"><span class="returnvalue">gint</span> gtk_assistant_prepend_page (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
327
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>);</pre>
329
Prepends a page to the <em class="parameter"><code>assistant</code></em>.
331
<div class="variablelist"><table border="0" class="variablelist">
333
<col align="left" valign="top">
338
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
339
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
343
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
344
<td>a <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
348
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
349
<td>the index (starting at 0) of the inserted page</td>
353
<p class="since">Since 2.10</p>
356
<div class="refsect2">
357
<a name="gtk-assistant-append-page"></a><h3>gtk_assistant_append_page ()</h3>
358
<pre class="programlisting"><span class="returnvalue">gint</span> gtk_assistant_append_page (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
359
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>);</pre>
361
Appends a page to the <em class="parameter"><code>assistant</code></em>.
363
<div class="variablelist"><table border="0" class="variablelist">
365
<col align="left" valign="top">
370
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
371
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
375
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
376
<td>a <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
380
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
381
<td>the index (starting at 0) of the inserted page</td>
385
<p class="since">Since 2.10</p>
388
<div class="refsect2">
389
<a name="gtk-assistant-insert-page"></a><h3>gtk_assistant_insert_page ()</h3>
390
<pre class="programlisting"><span class="returnvalue">gint</span> gtk_assistant_insert_page (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
391
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>,
392
<em class="parameter"><code><span class="type">gint</span> position</code></em>);</pre>
394
Inserts a page in the <em class="parameter"><code>assistant</code></em> at a given position.
396
<div class="variablelist"><table border="0" class="variablelist">
398
<col align="left" valign="top">
403
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
404
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
408
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
409
<td>a <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
413
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
414
<td>the index (starting at 0) at which to insert the page,
415
or -1 to append the page to the <em class="parameter"><code>assistant</code></em>
419
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
420
<td>the index (starting from 0) of the inserted page</td>
424
<p class="since">Since 2.10</p>
427
<div class="refsect2">
428
<a name="GtkAssistantPageFunc"></a><h3>GtkAssistantPageFunc ()</h3>
429
<pre class="programlisting"><span class="returnvalue">gint</span> (*GtkAssistantPageFunc) (<em class="parameter"><code><span class="type">gint</span> current_page</code></em>,
430
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
432
A function used by <a class="link" href="GtkAssistant.html#gtk-assistant-set-forward-page-func" title="gtk_assistant_set_forward_page_func ()"><code class="function">gtk_assistant_set_forward_page_func()</code></a> to know which
433
is the next page given a current one. It's called both for computing the
434
next page when the user presses the "forward" button and for handling
435
the behavior of the "last" button.
437
<div class="variablelist"><table border="0" class="variablelist">
439
<col align="left" valign="top">
444
<td><p><span class="term"><em class="parameter"><code>current_page</code></em> :</span></p></td>
445
<td>The page number used to calculate the next page.</td>
448
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
452
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
453
<td>The next page number.</td>
459
<div class="refsect2">
460
<a name="gtk-assistant-set-forward-page-func"></a><h3>gtk_assistant_set_forward_page_func ()</h3>
461
<pre class="programlisting"><span class="returnvalue">void</span> gtk_assistant_set_forward_page_func (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
462
<em class="parameter"><code><a class="link" href="GtkAssistant.html#GtkAssistantPageFunc" title="GtkAssistantPageFunc ()"><span class="type">GtkAssistantPageFunc</span></a> page_func</code></em>,
463
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
464
<em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);</pre>
466
Sets the page forwarding function to be <em class="parameter"><code>page_func</code></em>, this function will
467
be used to determine what will be the next page when the user presses
468
the forward button. Setting <em class="parameter"><code>page_func</code></em> to <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> will make the assistant
469
to use the default forward function, which just goes to the next visible
472
<div class="variablelist"><table border="0" class="variablelist">
474
<col align="left" valign="top">
479
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
480
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
484
<td><p><span class="term"><em class="parameter"><code>page_func</code></em> :</span></p></td>
485
<td>the <a class="link" href="GtkAssistant.html#GtkAssistantPageFunc" title="GtkAssistantPageFunc ()"><span class="type">GtkAssistantPageFunc</span></a>, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default one. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
489
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
490
<td>user data for <em class="parameter"><code>page_func</code></em>
494
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
495
<td>destroy notifier for <em class="parameter"><code>data</code></em>
500
<p class="since">Since 2.10</p>
503
<div class="refsect2">
504
<a name="GtkAssistantPageType"></a><h3>enum GtkAssistantPageType</h3>
505
<pre class="programlisting">typedef enum {
506
GTK_ASSISTANT_PAGE_CONTENT,
507
GTK_ASSISTANT_PAGE_INTRO,
508
GTK_ASSISTANT_PAGE_CONFIRM,
509
GTK_ASSISTANT_PAGE_SUMMARY,
510
GTK_ASSISTANT_PAGE_PROGRESS
511
} GtkAssistantPageType;
514
An enum for determining the page role inside the <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>. It's
515
used to handle buttons sensitivity and visibility.
518
Note that an assistant needs to end its page flow with a page of type
519
<a class="link" href="GtkAssistant.html#GTK-ASSISTANT-PAGE-CONFIRM:CAPS"><code class="literal">GTK_ASSISTANT_PAGE_CONFIRM</code></a>, <a class="link" href="GtkAssistant.html#GTK-ASSISTANT-PAGE-SUMMARY:CAPS"><code class="literal">GTK_ASSISTANT_PAGE_SUMMARY</code></a> or
520
<a class="link" href="GtkAssistant.html#GTK-ASSISTANT-PAGE-PROGRESS:CAPS"><code class="literal">GTK_ASSISTANT_PAGE_PROGRESS</code></a> to be correct.
522
<div class="variablelist"><table border="0" class="variablelist">
524
<col align="left" valign="top">
529
<td><p><a name="GTK-ASSISTANT-PAGE-CONTENT:CAPS"></a><span class="term"><code class="literal">GTK_ASSISTANT_PAGE_CONTENT</code></span></p></td>
530
<td>The page has regular contents.
534
<td><p><a name="GTK-ASSISTANT-PAGE-INTRO:CAPS"></a><span class="term"><code class="literal">GTK_ASSISTANT_PAGE_INTRO</code></span></p></td>
535
<td>The page contains an introduction to the
540
<td><p><a name="GTK-ASSISTANT-PAGE-CONFIRM:CAPS"></a><span class="term"><code class="literal">GTK_ASSISTANT_PAGE_CONFIRM</code></span></p></td>
541
<td>The page lets the user confirm or deny the
546
<td><p><a name="GTK-ASSISTANT-PAGE-SUMMARY:CAPS"></a><span class="term"><code class="literal">GTK_ASSISTANT_PAGE_SUMMARY</code></span></p></td>
547
<td>The page informs the user of the changes
552
<td><p><a name="GTK-ASSISTANT-PAGE-PROGRESS:CAPS"></a><span class="term"><code class="literal">GTK_ASSISTANT_PAGE_PROGRESS</code></span></p></td>
553
<td>Used for tasks that take a long time to
554
complete, blocks the assistant until the page is marked as complete.
561
<div class="refsect2">
562
<a name="gtk-assistant-set-page-type"></a><h3>gtk_assistant_set_page_type ()</h3>
563
<pre class="programlisting"><span class="returnvalue">void</span> gtk_assistant_set_page_type (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
564
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>,
565
<em class="parameter"><code><a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum GtkAssistantPageType"><span class="type">GtkAssistantPageType</span></a> type</code></em>);</pre>
567
Sets the page type for <em class="parameter"><code>page</code></em>. The page type determines the page
568
behavior in the <em class="parameter"><code>assistant</code></em>.
570
<div class="variablelist"><table border="0" class="variablelist">
572
<col align="left" valign="top">
577
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
578
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
582
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
583
<td>a page of <em class="parameter"><code>assistant</code></em>
587
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
588
<td>the new type for <em class="parameter"><code>page</code></em>
593
<p class="since">Since 2.10</p>
596
<div class="refsect2">
597
<a name="gtk-assistant-get-page-type"></a><h3>gtk_assistant_get_page_type ()</h3>
598
<pre class="programlisting"><a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum GtkAssistantPageType"><span class="returnvalue">GtkAssistantPageType</span></a> gtk_assistant_get_page_type (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
599
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>);</pre>
601
Gets the page type of <em class="parameter"><code>page</code></em>.
603
<div class="variablelist"><table border="0" class="variablelist">
605
<col align="left" valign="top">
610
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
611
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
615
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
616
<td>a page of <em class="parameter"><code>assistant</code></em>
620
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
621
<td>the page type of <em class="parameter"><code>page</code></em>.</td>
625
<p class="since">Since 2.10</p>
628
<div class="refsect2">
629
<a name="gtk-assistant-set-page-title"></a><h3>gtk_assistant_set_page_title ()</h3>
630
<pre class="programlisting"><span class="returnvalue">void</span> gtk_assistant_set_page_title (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
631
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>,
632
<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>);</pre>
634
Sets a title for <em class="parameter"><code>page</code></em>. The title is displayed in the header
635
area of the assistant when <em class="parameter"><code>page</code></em> is the current page.
637
<div class="variablelist"><table border="0" class="variablelist">
639
<col align="left" valign="top">
644
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
645
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
649
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
650
<td>a page of <em class="parameter"><code>assistant</code></em>
654
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
655
<td>the new title for <em class="parameter"><code>page</code></em>
660
<p class="since">Since 2.10</p>
663
<div class="refsect2">
664
<a name="gtk-assistant-get-page-title"></a><h3>gtk_assistant_get_page_title ()</h3>
665
<pre class="programlisting">const <span class="returnvalue">gchar</span> * gtk_assistant_get_page_title (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
666
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>);</pre>
668
Gets the title for <em class="parameter"><code>page</code></em>.
670
<div class="variablelist"><table border="0" class="variablelist">
672
<col align="left" valign="top">
677
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
678
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
682
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
683
<td>a page of <em class="parameter"><code>assistant</code></em>
687
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
688
<td>the title for <em class="parameter"><code>page</code></em>.</td>
692
<p class="since">Since 2.10</p>
695
<div class="refsect2">
696
<a name="gtk-assistant-set-page-header-image"></a><h3>gtk_assistant_set_page_header_image ()</h3>
697
<pre class="programlisting"><span class="returnvalue">void</span> gtk_assistant_set_page_header_image (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
698
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>,
699
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);</pre>
701
Sets a header image for <em class="parameter"><code>page</code></em>. This image is displayed in the header
702
area of the assistant when <em class="parameter"><code>page</code></em> is the current page.
704
<div class="variablelist"><table border="0" class="variablelist">
706
<col align="left" valign="top">
711
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
712
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
716
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
717
<td>a page of <em class="parameter"><code>assistant</code></em>
721
<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td>
722
<td>the new header image <em class="parameter"><code>page</code></em>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
727
<p class="since">Since 2.10</p>
730
<div class="refsect2">
731
<a name="gtk-assistant-get-page-header-image"></a><h3>gtk_assistant_get_page_header_image ()</h3>
732
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * gtk_assistant_get_page_header_image (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
733
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>);</pre>
735
Gets the header image for <em class="parameter"><code>page</code></em>.
737
<div class="variablelist"><table border="0" class="variablelist">
739
<col align="left" valign="top">
744
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
745
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
749
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
750
<td>a page of <em class="parameter"><code>assistant</code></em>
754
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
755
<td>the header image for <em class="parameter"><code>page</code></em>, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
756
if there's no header image for the page. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
761
<p class="since">Since 2.10</p>
764
<div class="refsect2">
765
<a name="gtk-assistant-set-page-side-image"></a><h3>gtk_assistant_set_page_side_image ()</h3>
766
<pre class="programlisting"><span class="returnvalue">void</span> gtk_assistant_set_page_side_image (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
767
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>,
768
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);</pre>
770
Sets a header image for <em class="parameter"><code>page</code></em>. This image is displayed in the side
771
area of the assistant when <em class="parameter"><code>page</code></em> is the current page.
773
<div class="variablelist"><table border="0" class="variablelist">
775
<col align="left" valign="top">
780
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
781
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
785
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
786
<td>a page of <em class="parameter"><code>assistant</code></em>
790
<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td>
791
<td>the new header image <em class="parameter"><code>page</code></em>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
796
<p class="since">Since 2.10</p>
799
<div class="refsect2">
800
<a name="gtk-assistant-get-page-side-image"></a><h3>gtk_assistant_get_page_side_image ()</h3>
801
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * gtk_assistant_get_page_side_image (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
802
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>);</pre>
804
Gets the header image for <em class="parameter"><code>page</code></em>.
806
<div class="variablelist"><table border="0" class="variablelist">
808
<col align="left" valign="top">
813
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
814
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
818
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
819
<td>a page of <em class="parameter"><code>assistant</code></em>
823
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
824
<td>the side image for <em class="parameter"><code>page</code></em>, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
825
if there's no side image for the page. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
830
<p class="since">Since 2.10</p>
833
<div class="refsect2">
834
<a name="gtk-assistant-set-page-complete"></a><h3>gtk_assistant_set_page_complete ()</h3>
835
<pre class="programlisting"><span class="returnvalue">void</span> gtk_assistant_set_page_complete (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
836
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>,
837
<em class="parameter"><code><span class="type">gboolean</span> complete</code></em>);</pre>
839
Sets whether <em class="parameter"><code>page</code></em> contents are complete. This will make
840
<em class="parameter"><code>assistant</code></em> update the buttons state to be able to continue the task.
842
<div class="variablelist"><table border="0" class="variablelist">
844
<col align="left" valign="top">
849
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
850
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
854
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
855
<td>a page of <em class="parameter"><code>assistant</code></em>
859
<td><p><span class="term"><em class="parameter"><code>complete</code></em> :</span></p></td>
860
<td>the completeness status of the page</td>
864
<p class="since">Since 2.10</p>
867
<div class="refsect2">
868
<a name="gtk-assistant-get-page-complete"></a><h3>gtk_assistant_get_page_complete ()</h3>
869
<pre class="programlisting"><span class="returnvalue">gboolean</span> gtk_assistant_get_page_complete (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
870
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>);</pre>
872
Gets whether <em class="parameter"><code>page</code></em> is complete.
874
<div class="variablelist"><table border="0" class="variablelist">
876
<col align="left" valign="top">
881
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
882
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
886
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
887
<td>a page of <em class="parameter"><code>assistant</code></em>
891
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
893
<code class="literal">TRUE</code> if <em class="parameter"><code>page</code></em> is complete.</td>
897
<p class="since">Since 2.10</p>
900
<div class="refsect2">
901
<a name="gtk-assistant-add-action-widget"></a><h3>gtk_assistant_add_action_widget ()</h3>
902
<pre class="programlisting"><span class="returnvalue">void</span> gtk_assistant_add_action_widget (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
903
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *child</code></em>);</pre>
905
Adds a widget to the action area of a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>.
907
<div class="variablelist"><table border="0" class="variablelist">
909
<col align="left" valign="top">
914
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
915
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
919
<td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
920
<td>a <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
925
<p class="since">Since 2.10</p>
928
<div class="refsect2">
929
<a name="gtk-assistant-remove-action-widget"></a><h3>gtk_assistant_remove_action_widget ()</h3>
930
<pre class="programlisting"><span class="returnvalue">void</span> gtk_assistant_remove_action_widget (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
931
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *child</code></em>);</pre>
933
Removes a widget from the action area of a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>.
935
<div class="variablelist"><table border="0" class="variablelist">
937
<col align="left" valign="top">
942
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
943
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
947
<td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
948
<td>a <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
953
<p class="since">Since 2.10</p>
956
<div class="refsect2">
957
<a name="gtk-assistant-update-buttons-state"></a><h3>gtk_assistant_update_buttons_state ()</h3>
958
<pre class="programlisting"><span class="returnvalue">void</span> gtk_assistant_update_buttons_state (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>);</pre>
960
Forces <em class="parameter"><code>assistant</code></em> to recompute the buttons state.
963
GTK+ automatically takes care of this in most situations,
964
e.g. when the user goes to a different page, or when the
965
visibility or completeness of a page changes.
968
One situation where it can be necessary to call this
969
function is when changing a value on the current page
970
affects the future page flow of the assistant.
972
<div class="variablelist"><table border="0" class="variablelist">
974
<col align="left" valign="top">
978
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
979
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
983
<p class="since">Since 2.10</p>
986
<div class="refsect2">
987
<a name="gtk-assistant-commit"></a><h3>gtk_assistant_commit ()</h3>
988
<pre class="programlisting"><span class="returnvalue">void</span> gtk_assistant_commit (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>);</pre>
990
Erases the visited page history so the back button is not
991
shown on the current page, and removes the cancel button
992
from subsequent pages.
995
Use this when the information provided up to the current
996
page is hereafter deemed permanent and cannot be modified
997
or undone. For example, showing a progress page to track
998
a long-running, unreversible operation after the user has
999
clicked apply on a confirmation page.
1001
<div class="variablelist"><table border="0" class="variablelist">
1003
<col align="left" valign="top">
1007
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
1008
<td>a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
1012
<p class="since">Since 2.22</p>
1015
<div class="refsect1">
1016
<a name="GtkAssistant.child-property-details"></a><h2>Child Property Details</h2>
1017
<div class="refsect2">
1018
<a name="GtkAssistant--c-complete"></a><h3>The <code class="literal">"complete"</code> child property</h3>
1019
<pre class="programlisting"> "complete" <span class="type">gboolean</span> : Read / Write</pre>
1021
Setting the "complete" child property to <code class="literal">TRUE</code> marks a page as complete
1022
(i.e.: all the required fields are filled out). GTK+ uses this information
1023
to control the sensitivity of the navigation buttons.
1025
<p>Default value: FALSE</p>
1026
<p class="since">Since 2.10</p>
1029
<div class="refsect2">
1030
<a name="GtkAssistant--c-header-image"></a><h3>The <code class="literal">"header-image"</code> child property</h3>
1031
<pre class="programlisting"> "header-image" <a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>* : Read / Write</pre>
1033
The image that is displayed next to the page.
1036
Set this to <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> to make the sidebar disappear.
1038
<p class="since">Since 2.10</p>
1041
<div class="refsect2">
1042
<a name="GtkAssistant--c-page-type"></a><h3>The <code class="literal">"page-type"</code> child property</h3>
1043
<pre class="programlisting"> "page-type" <a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum GtkAssistantPageType"><span class="type">GtkAssistantPageType</span></a> : Read / Write</pre>
1045
The type of the assistant page.
1047
<p>Default value: GTK_ASSISTANT_PAGE_CONTENT</p>
1048
<p class="since">Since 2.10</p>
1051
<div class="refsect2">
1052
<a name="GtkAssistant--c-sidebar-image"></a><h3>The <code class="literal">"sidebar-image"</code> child property</h3>
1053
<pre class="programlisting"> "sidebar-image" <a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>* : Read / Write</pre>
1054
<p>Sidebar image for the assistant page.</p>
1057
<div class="refsect2">
1058
<a name="GtkAssistant--c-title"></a><h3>The <code class="literal">"title"</code> child property</h3>
1059
<pre class="programlisting"> "title" <span class="type">gchar</span>* : Read / Write</pre>
1061
The title that is displayed in the page header.
1064
If title and header-image are both <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, no header is displayed.
1066
<p>Default value: NULL</p>
1067
<p class="since">Since 2.10</p>
1070
<div class="refsect1">
1071
<a name="GtkAssistant.style-property-details"></a><h2>Style Property Details</h2>
1072
<div class="refsect2">
1073
<a name="GtkAssistant--s-content-padding"></a><h3>The <code class="literal">"content-padding"</code> style property</h3>
1074
<pre class="programlisting"> "content-padding" <span class="type">gint</span> : Read</pre>
1075
<p>Number of pixels around the content pages.</p>
1076
<p>Allowed values: >= 0</p>
1077
<p>Default value: 1</p>
1080
<div class="refsect2">
1081
<a name="GtkAssistant--s-header-padding"></a><h3>The <code class="literal">"header-padding"</code> style property</h3>
1082
<pre class="programlisting"> "header-padding" <span class="type">gint</span> : Read</pre>
1083
<p>Number of pixels around the header.</p>
1084
<p>Allowed values: >= 0</p>
1085
<p>Default value: 6</p>
1088
<div class="refsect1">
1089
<a name="GtkAssistant.signal-details"></a><h2>Signal Details</h2>
1090
<div class="refsect2">
1091
<a name="GtkAssistant-apply"></a><h3>The <code class="literal">"apply"</code> signal</h3>
1092
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant,
1093
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
1095
The ::apply signal is emitted when the apply button is clicked. The default
1096
behavior of the <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> is to switch to the page after the current
1097
page, unless the current page is the last one.
1100
A handler for the ::apply signal should carry out the actions for which
1101
the wizard has collected data. If the action takes a long time to complete,
1102
you might consider putting a page of type <a class="link" href="GtkAssistant.html#GTK-ASSISTANT-PAGE-PROGRESS:CAPS"><code class="literal">GTK_ASSISTANT_PAGE_PROGRESS</code></a>
1103
after the confirmation page and handle this operation within the
1104
<a class="link" href="GtkAssistant.html#GtkAssistant-prepare" title='The "prepare" signal'><span class="type">"prepare"</span></a> signal of the progress page.
1106
<div class="variablelist"><table border="0" class="variablelist">
1108
<col align="left" valign="top">
1113
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
1114
<td>the <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
1118
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1119
<td>user data set when the signal handler was connected.</td>
1123
<p class="since">Since 2.10</p>
1126
<div class="refsect2">
1127
<a name="GtkAssistant-cancel"></a><h3>The <code class="literal">"cancel"</code> signal</h3>
1128
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant,
1129
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
1131
The ::cancel signal is emitted when then the cancel button is clicked.
1133
<div class="variablelist"><table border="0" class="variablelist">
1135
<col align="left" valign="top">
1140
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
1141
<td>the <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
1145
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1146
<td>user data set when the signal handler was connected.</td>
1150
<p class="since">Since 2.10</p>
1153
<div class="refsect2">
1154
<a name="GtkAssistant-close"></a><h3>The <code class="literal">"close"</code> signal</h3>
1155
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant,
1156
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
1158
The ::close signal is emitted either when the close button of
1159
a summary page is clicked, or when the apply button in the last
1160
page in the flow (of type <a class="link" href="GtkAssistant.html#GTK-ASSISTANT-PAGE-CONFIRM:CAPS"><code class="literal">GTK_ASSISTANT_PAGE_CONFIRM</code></a>) is clicked.
1162
<div class="variablelist"><table border="0" class="variablelist">
1164
<col align="left" valign="top">
1169
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
1170
<td>the <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
1174
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1175
<td>user data set when the signal handler was connected.</td>
1179
<p class="since">Since 2.10</p>
1182
<div class="refsect2">
1183
<a name="GtkAssistant-prepare"></a><h3>The <code class="literal">"prepare"</code> signal</h3>
1184
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant,
1185
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page,
1186
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
1188
The ::prepare signal is emitted when a new page is set as the assistant's
1189
current page, before making the new page visible. A handler for this signal
1190
can do any preparation which are necessary before showing <em class="parameter"><code>page</code></em>.
1192
<div class="variablelist"><table border="0" class="variablelist">
1194
<col align="left" valign="top">
1199
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
1200
<td>the <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
1204
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
1205
<td>the current page</td>
1208
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1209
<td>user data set when the signal handler was connected.</td>
1213
<p class="since">Since 2.10</p>
1217
<div class="footer">
1219
Generated by GTK-Doc V1.18</div>
b'\\ No newline at end of file'
added
removed
share/gtk-doc/html/gtk2/GtkAssistant.html
