|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /usr/share/gtk-doc/html/gtk/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GtkAssistant</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GTK+ Reference Manual">
<link rel="up" href="WindowWidgets.html" title="Windows">
<link rel="prev" href="GtkAboutDialog.html" title="GtkAboutDialog">
<link rel="next" href="DisplayWidgets.html" title="Display Widgets">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="WindowWidgets.html" title="Windows">
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
<link rel="chapter" href="Ornaments.html" title="Ornaments">
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
<link rel="chapter" href="Printing.html" title="Printing">
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and
GtkComboBoxEntry">
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkAboutDialog.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="WindowWidgets.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ Reference Manual</th>
<td><a accesskey="n" href="DisplayWidgets.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2839649" class="shortcut">Top</a>
 | 
<a href="#id2840817" class="shortcut">Description</a>
 | 
<a href="#id2840418" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2840488" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id2840510" class="shortcut">Child Properties</a>
 | 
<a href="#id2840612" class="shortcut">Style Properties</a>
 | 
<a href="#id2840664" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkAssistant"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2839649"></a><span class="refentrytitle">GtkAssistant</span>
</h2>
<p>GtkAssistant — A widget used to guide users through multi-step operations</p>
</td>
<td valign="top" align="right"><img src="assistant.png"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <gtk/gtk.h>
<a href="GtkAssistant.html#GtkAssistant-struct">GtkAssistant</a>;
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkAssistant.html#gtk-assistant-new">gtk_assistant_new</a> (void);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="GtkAssistant.html#gtk-assistant-get-current-page">gtk_assistant_get_current_page</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant);
void <a href="GtkAssistant.html#gtk-assistant-set-current-page">gtk_assistant_set_current_page</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> page_num);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="GtkAssistant.html#gtk-assistant-get-n-pages">gtk_assistant_get_n_pages</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant);
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkAssistant.html#gtk-assistant-get-nth-page">gtk_assistant_get_nth_page</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> page_num);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="GtkAssistant.html#gtk-assistant-prepend-page">gtk_assistant_prepend_page</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="GtkAssistant.html#gtk-assistant-append-page">gtk_assistant_append_page</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="GtkAssistant.html#gtk-assistant-insert-page">gtk_assistant_insert_page</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> position);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> (<a href="GtkAssistant.html#GtkAssistantPageFunc">*GtkAssistantPageFunc</a>) (<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> current_page,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);
void <a href="GtkAssistant.html#gtk-assistant-set-forward-page-func">gtk_assistant_set_forward_page_func</a>
(<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkAssistant.html#GtkAssistantPageFunc">GtkAssistantPageFunc</a> page_func,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data,
<a
href="../glib/glib-Datasets.html#GDestroyNotify"
>GDestroyNotify</a> destroy);
enum <a href="GtkAssistant.html#GtkAssistantPageType">GtkAssistantPageType</a>;
void <a href="GtkAssistant.html#gtk-assistant-set-page-type">gtk_assistant_set_page_type</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a href="GtkAssistant.html#GtkAssistantPageType">GtkAssistantPageType</a> type);
<a href="GtkAssistant.html#GtkAssistantPageType">GtkAssistantPageType</a> <a href="GtkAssistant.html#gtk-assistant-get-page-type">gtk_assistant_get_page_type</a>
(<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
void <a href="GtkAssistant.html#gtk-assistant-set-page-title">gtk_assistant_set_page_title</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *title);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="GtkAssistant.html#gtk-assistant-get-page-title">gtk_assistant_get_page_title</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
void <a href="GtkAssistant.html#gtk-assistant-set-page-header-image">gtk_assistant_set_page_header_image</a>
(<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *pixbuf);
<a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a>* <a href="GtkAssistant.html#gtk-assistant-get-page-header-image">gtk_assistant_get_page_header_image</a>
(<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
void <a href="GtkAssistant.html#gtk-assistant-set-page-side-image">gtk_assistant_set_page_side_image</a>
(<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *pixbuf);
<a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a>* <a href="GtkAssistant.html#gtk-assistant-get-page-side-image">gtk_assistant_get_page_side_image</a>
(<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
void <a href="GtkAssistant.html#gtk-assistant-set-page-complete">gtk_assistant_set_page_complete</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> complete);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkAssistant.html#gtk-assistant-get-page-complete">gtk_assistant_get_page_complete</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
void <a href="GtkAssistant.html#gtk-assistant-add-action-widget">gtk_assistant_add_action_widget</a> (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *child);
void <a href="GtkAssistant.html#gtk-assistant-remove-action-widget">gtk_assistant_remove_action_widget</a>
(<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *child);
void <a href="GtkAssistant.html#gtk-assistant-update-buttons-state">gtk_assistant_update_buttons_state</a>
(<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2840418"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a href="GtkObject.html" title="GtkObject">GtkObject</a>
+----<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
+----<a href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
+----<a href="GtkBin.html" title="GtkBin">GtkBin</a>
+----<a href="GtkWindow.html" title="GtkWindow">GtkWindow</a>
+----GtkAssistant
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2840488"></a><h2>Implemented Interfaces</h2>
<p>
GtkAssistant implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2840510"></a><h2>Child Properties</h2>
<pre class="synopsis">
"<a href="GtkAssistant.html#GtkAssistant--complete">complete</a>" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write
"<a href="GtkAssistant.html#GtkAssistant--header-image">header-image</a>" <a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> : Read / Write
"<a href="GtkAssistant.html#GtkAssistant--page-type">page-type</a>" <a href="GtkAssistant.html#GtkAssistantPageType">GtkAssistantPageType</a> : Read / Write
"<a href="GtkAssistant.html#GtkAssistant--sidebar-image">sidebar-image</a>" <a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> : Read / Write
"<a href="GtkAssistant.html#GtkAssistant--title">title</a>" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2840612"></a><h2>Style Properties</h2>
<pre class="synopsis">
"<a href="GtkAssistant.html#GtkAssistant--content-padding">content-padding</a>" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read
"<a href="GtkAssistant.html#GtkAssistant--header-padding">header-padding</a>" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2840664"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GtkAssistant.html#GtkAssistant-apply">apply</a>" void user_function (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
"<a href="GtkAssistant.html#GtkAssistant-cancel">cancel</a>" void user_function (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
"<a href="GtkAssistant.html#GtkAssistant-close">close</a>" void user_function (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
"<a href="GtkAssistant.html#GtkAssistant-prepare">prepare</a>" void user_function (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2840817"></a><h2>Description</h2>
<p>
A <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> is a widget used to represent a generally complex
operation splitted in several steps, guiding the user through its pages
and controlling the page flow to collect the necessary data.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2840843"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2840852"></a><h3>
<a name="GtkAssistant-struct"></a>GtkAssistant</h3>
<a class="indexterm" name="id2840865"></a><pre class="programlisting">typedef struct _GtkAssistant GtkAssistant;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2840881"></a><h3>
<a name="gtk-assistant-new"></a>gtk_assistant_new ()</h3>
<a class="indexterm" name="id2840896"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_assistant_new (void);</pre>
<p>
Creates a new <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a newly created <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr></tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2840956"></a><h3>
<a name="gtk-assistant-get-current-page"></a>gtk_assistant_get_current_page ()</h3>
<a class="indexterm" name="id2840972"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gtk_assistant_get_current_page (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant);</pre>
<p>
Returns the page number of the current page</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The index (starting from 0) of the current page in
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>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2841059"></a><h3>
<a name="gtk-assistant-set-current-page"></a>gtk_assistant_set_current_page ()</h3>
<a class="indexterm" name="id2841075"></a><pre class="programlisting">void gtk_assistant_set_current_page (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> page_num);</pre>
<p>
Switches the page to <em class="parameter"><code>page_num</code></em>. Note that this will only be necessary
in custom buttons, as the <em class="parameter"><code>assistant</code></em> flow can be set with
<a href="GtkAssistant.html#gtk-assistant-set-forward-page-func"><code class="function">gtk_assistant_set_forward_page_func()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>page_num</code></em> :</span></td>
<td> index of the page to switch to, starting from 0.
If negative, the last page will be used. If greater
than the number of pages in the <em class="parameter"><code>assistant</code></em>, nothing
will be done.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2841193"></a><h3>
<a name="gtk-assistant-get-n-pages"></a>gtk_assistant_get_n_pages ()</h3>
<a class="indexterm" name="id2841209"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gtk_assistant_get_n_pages (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant);</pre>
<p>
Returns the number of pages in the <em class="parameter"><code>assistant</code></em></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The number of pages in the <em class="parameter"><code>assistant</code></em>.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2841293"></a><h3>
<a name="gtk-assistant-get-nth-page"></a>gtk_assistant_get_nth_page ()</h3>
<a class="indexterm" name="id2841309"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_assistant_get_nth_page (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> page_num);</pre>
<p>
Returns the child widget contained in page number <em class="parameter"><code>page_num</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>page_num</code></em> :</span></td>
<td> The index of a page in the <em class="parameter"><code>assistant</code></em>, or -1 to get the last page;
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The child widget, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> if <em class="parameter"><code>page_num</code></em> is out of bounds.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2841433"></a><h3>
<a name="gtk-assistant-prepend-page"></a>gtk_assistant_prepend_page ()</h3>
<a class="indexterm" name="id2841449"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gtk_assistant_prepend_page (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);</pre>
<p>
Prepends a page to the <em class="parameter"><code>assistant</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a <a href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the index (starting at 0) of the inserted page
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2841557"></a><h3>
<a name="gtk-assistant-append-page"></a>gtk_assistant_append_page ()</h3>
<a class="indexterm" name="id2841573"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gtk_assistant_append_page (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);</pre>
<p>
Appends a page to the <em class="parameter"><code>assistant</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a <a href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the index (starting at 0) of the inserted page
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2841681"></a><h3>
<a name="gtk-assistant-insert-page"></a>gtk_assistant_insert_page ()</h3>
<a class="indexterm" name="id2841697"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gtk_assistant_insert_page (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> position);</pre>
<p>
Inserts a page in the <em class="parameter"><code>assistant</code></em> at a given position.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a <a href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>position</code></em> :</span></td>
<td> the index (starting at 0) at which to insert the page,
or -1 to append the page to the <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the index (starting from 0) of the inserted page
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2841834"></a><h3>
<a name="GtkAssistantPageFunc"></a>GtkAssistantPageFunc ()</h3>
<a class="indexterm" name="id2841848"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> (*GtkAssistantPageFunc) (<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> current_page,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);</pre>
<p>
A function used by <a href="GtkAssistant.html#gtk-assistant-set-forward-page-func"><code class="function">gtk_assistant_set_forward_page_func()</code></a> to know which
is the next page given a current one. It's called both for computing the
next page when the user presses the "forward" button and for handling
the behavior of the "last" button.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>current_page</code></em> :</span></td>
<td>The page number used to calculate the next page.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td>user data.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>The next page number.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2841943"></a><h3>
<a name="gtk-assistant-set-forward-page-func"></a>gtk_assistant_set_forward_page_func ()</h3>
<a class="indexterm" name="id2841958"></a><pre class="programlisting">void gtk_assistant_set_forward_page_func
(<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkAssistant.html#GtkAssistantPageFunc">GtkAssistantPageFunc</a> page_func,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data,
<a
href="../glib/glib-Datasets.html#GDestroyNotify"
>GDestroyNotify</a> destroy);</pre>
<p>
Sets the page forwarding function to be <em class="parameter"><code>page_func</code></em>, this function will
be used to determine what will be the next page when the user presses
the forward button. Setting <em class="parameter"><code>page_func</code></em> to <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> will make the assistant
to use the default forward function, which just goes to the next visible
page.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>page_func</code></em> :</span></td>
<td> the <a href="GtkAssistant.html#GtkAssistantPageFunc"><span class="type">GtkAssistantPageFunc</span></a>, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to use the default one
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td> user data for <em class="parameter"><code>page_func</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>destroy</code></em> :</span></td>
<td> destroy notifier for <em class="parameter"><code>data</code></em>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2842145"></a><h3>
<a name="GtkAssistantPageType"></a>enum GtkAssistantPageType</h3>
<a class="indexterm" name="id2842158"></a><pre class="programlisting">typedef enum
{
GTK_ASSISTANT_PAGE_CONTENT,
GTK_ASSISTANT_PAGE_INTRO,
GTK_ASSISTANT_PAGE_CONFIRM,
GTK_ASSISTANT_PAGE_SUMMARY,
GTK_ASSISTANT_PAGE_PROGRESS
} GtkAssistantPageType;
</pre>
<p>
An enum for determining the page role inside the <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>. It's used to
handle buttons sensitivity and visibility.
</p>
<p>
Note that an assistant needs to end its page flow with a page of type GTK_ASSISTANT_PAGE_CONFIRM
or GTK_ASSISTANT_PAGE_SUMMARY to be correct.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><a name="GTK-ASSISTANT-PAGE-CONTENT:CAPS"></a><code class="literal">GTK_ASSISTANT_PAGE_CONTENT</code></span></td>
<td>The page has regular contents.
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GTK-ASSISTANT-PAGE-INTRO:CAPS"></a><code class="literal">GTK_ASSISTANT_PAGE_INTRO</code></span></td>
<td>The page contains an introduction to the assistant task.
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GTK-ASSISTANT-PAGE-CONFIRM:CAPS"></a><code class="literal">GTK_ASSISTANT_PAGE_CONFIRM</code></span></td>
<td>The page lets the user confirm or deny the changes.
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GTK-ASSISTANT-PAGE-SUMMARY:CAPS"></a><code class="literal">GTK_ASSISTANT_PAGE_SUMMARY</code></span></td>
<td>The page informs the user of the changes done.
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GTK-ASSISTANT-PAGE-PROGRESS:CAPS"></a><code class="literal">GTK_ASSISTANT_PAGE_PROGRESS</code></span></td>
<td>Used for tasks that take a long time to complete, blocks the assistant until the page is marked as complete.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2842315"></a><h3>
<a name="gtk-assistant-set-page-type"></a>gtk_assistant_set_page_type ()</h3>
<a class="indexterm" name="id2842330"></a><pre class="programlisting">void gtk_assistant_set_page_type (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a href="GtkAssistant.html#GtkAssistantPageType">GtkAssistantPageType</a> type);</pre>
<p>
Sets the page type for <em class="parameter"><code>page</code></em>. The page type determines the page
behavior in the <em class="parameter"><code>assistant</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>type</code></em> :</span></td>
<td> the new type for <em class="parameter"><code>page</code></em>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2842461"></a><h3>
<a name="gtk-assistant-get-page-type"></a>gtk_assistant_get_page_type ()</h3>
<a class="indexterm" name="id2842477"></a><pre class="programlisting"><a href="GtkAssistant.html#GtkAssistantPageType">GtkAssistantPageType</a> gtk_assistant_get_page_type
(<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);</pre>
<p>
Gets the page type of <em class="parameter"><code>page</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the page type of <em class="parameter"><code>page</code></em>.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2842590"></a><h3>
<a name="gtk-assistant-set-page-title"></a>gtk_assistant_set_page_title ()</h3>
<a class="indexterm" name="id2842606"></a><pre class="programlisting">void gtk_assistant_set_page_title (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *title);</pre>
<p>
Sets a title for <em class="parameter"><code>page</code></em>. The title is displayed in the header
area of the assistant when <em class="parameter"><code>page</code></em> is the current page.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>title</code></em> :</span></td>
<td> the new title for <em class="parameter"><code>page</code></em>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2842737"></a><h3>
<a name="gtk-assistant-get-page-title"></a>gtk_assistant_get_page_title ()</h3>
<a class="indexterm" name="id2842752"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gtk_assistant_get_page_title (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);</pre>
<p>
Gets the title for <em class="parameter"><code>page</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the title for <em class="parameter"><code>page</code></em>.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2842866"></a><h3>
<a name="gtk-assistant-set-page-header-image"></a>gtk_assistant_set_page_header_image ()</h3>
<a class="indexterm" name="id2842882"></a><pre class="programlisting">void gtk_assistant_set_page_header_image
(<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *pixbuf);</pre>
<p>
Sets a header image for <em class="parameter"><code>page</code></em>. This image is displayed in the header
area of the assistant when <em class="parameter"><code>page</code></em> is the current page.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></td>
<td> the new header image <em class="parameter"><code>page</code></em>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2843014"></a><h3>
<a name="gtk-assistant-get-page-header-image"></a>gtk_assistant_get_page_header_image ()</h3>
<a class="indexterm" name="id2843030"></a><pre class="programlisting"><a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a>* gtk_assistant_get_page_header_image
(<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);</pre>
<p>
Gets the header image for <em class="parameter"><code>page</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the header image for <em class="parameter"><code>page</code></em>, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
if there's no header image for the page.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2843154"></a><h3>
<a name="gtk-assistant-set-page-side-image"></a>gtk_assistant_set_page_side_image ()</h3>
<a class="indexterm" name="id2843170"></a><pre class="programlisting">void gtk_assistant_set_page_side_image
(<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *pixbuf);</pre>
<p>
Sets a header image for <em class="parameter"><code>page</code></em>. This image is displayed in the side
area of the assistant when <em class="parameter"><code>page</code></em> is the current page.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></td>
<td> the new header image <em class="parameter"><code>page</code></em>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2843301"></a><h3>
<a name="gtk-assistant-get-page-side-image"></a>gtk_assistant_get_page_side_image ()</h3>
<a class="indexterm" name="id2843318"></a><pre class="programlisting"><a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a>* gtk_assistant_get_page_side_image
(<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);</pre>
<p>
Gets the header image for <em class="parameter"><code>page</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the side image for <em class="parameter"><code>page</code></em>, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
if there's no side image for the page.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2843441"></a><h3>
<a name="gtk-assistant-set-page-complete"></a>gtk_assistant_set_page_complete ()</h3>
<a class="indexterm" name="id2843457"></a><pre class="programlisting">void gtk_assistant_set_page_complete (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> complete);</pre>
<p>
Sets whether <em class="parameter"><code>page</code></em> contents are complete. This will make
<em class="parameter"><code>assistant</code></em> update the buttons state to be able to continue the task.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>complete</code></em> :</span></td>
<td> the completeness status of the page
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2843582"></a><h3>
<a name="gtk-assistant-get-page-complete"></a>gtk_assistant_get_page_complete ()</h3>
<a class="indexterm" name="id2843598"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_assistant_get_page_complete (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);</pre>
<p>
Gets whether <em class="parameter"><code>page</code></em> is complete..</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if <em class="parameter"><code>page</code></em> is complete.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2843721"></a><h3>
<a name="gtk-assistant-add-action-widget"></a>gtk_assistant_add_action_widget ()</h3>
<a class="indexterm" name="id2843737"></a><pre class="programlisting">void gtk_assistant_add_action_widget (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *child);</pre>
<p>
Adds a widget to the action area of a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>child</code></em> :</span></td>
<td> a <a href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2843837"></a><h3>
<a name="gtk-assistant-remove-action-widget"></a>gtk_assistant_remove_action_widget ()</h3>
<a class="indexterm" name="id2843854"></a><pre class="programlisting">void gtk_assistant_remove_action_widget
(<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *child);</pre>
<p>
Removes a widget from the action area of a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>child</code></em> :</span></td>
<td> a <a href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2843955"></a><h3>
<a name="gtk-assistant-update-buttons-state"></a>gtk_assistant_update_buttons_state ()</h3>
<a class="indexterm" name="id2843971"></a><pre class="programlisting">void gtk_assistant_update_buttons_state
(<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant);</pre>
<p>
Forces <em class="parameter"><code>assistant</code></em> to recompute the buttons state.
</p>
<p>
GTK+ automatically takes care of this in most situations,
e.g. when the user goes to a different page, or when the
visibility or completeness of a page changes.
</p>
<p>
One situation where it can be necessary to call this
function is when changing a value on the current page
affects the future page flow of the assistant.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> a <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr></tbody>
</table></div>
<p>Since 2.10
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2844054"></a><h2>Child Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2844065"></a><h3>
<a name="GtkAssistant--complete"></a>The "<code class="literal">complete</code>" child property</h3>
<a class="indexterm" name="id2844082"></a><pre class="programlisting"> "complete" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write</pre>
<p>
Setting the "complete" child property to <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> marks a page as complete
(i.e.: all the required fields are filled out). GTK+ uses this information
to control the sensitivity of the navigation buttons.</p>
<p>
</p>
<p>Default value: FALSE</p>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2844130"></a><h3>
<a name="GtkAssistant--header-image"></a>The "<code class="literal">header-image</code>" child property</h3>
<a class="indexterm" name="id2844146"></a><pre class="programlisting"> "header-image" <a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> : Read / Write</pre>
<p>
The image that is displayed next to the page.
</p>
<p>
Set this to <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to make the sidebar disappear.</p>
<p>
</p>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2844193"></a><h3>
<a name="GtkAssistant--page-type"></a>The "<code class="literal">page-type</code>" child property</h3>
<a class="indexterm" name="id2844209"></a><pre class="programlisting"> "page-type" <a href="GtkAssistant.html#GtkAssistantPageType">GtkAssistantPageType</a> : Read / Write</pre>
<p>
The type of the assistant page.</p>
<p>
</p>
<p>Default value: GTK_ASSISTANT_PAGE_CONTENT</p>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2844246"></a><h3>
<a name="GtkAssistant--sidebar-image"></a>The "<code class="literal">sidebar-image</code>" child property</h3>
<a class="indexterm" name="id2844262"></a><pre class="programlisting"> "sidebar-image" <a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> : Read / Write</pre>
<p>Sidebar image for the assistant page.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2844285"></a><h3>
<a name="GtkAssistant--title"></a>The "<code class="literal">title</code>" child property</h3>
<a class="indexterm" name="id2844301"></a><pre class="programlisting"> "title" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write</pre>
<p>
The title that is displayed in the page header.
</p>
<p>
If title and header-image are both <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>, no header is displayed.</p>
<p>
</p>
<p>Default value: NULL</p>
<p>Since 2.10
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2844352"></a><h2>Style Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2844363"></a><h3>
<a name="GtkAssistant--content-padding"></a>The "<code class="literal">content-padding</code>" style property</h3>
<a class="indexterm" name="id2844381"></a><pre class="programlisting"> "content-padding" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read</pre>
<p>Number of pixels around the content pages.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 1</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2844411"></a><h3>
<a name="GtkAssistant--header-padding"></a>The "<code class="literal">header-padding</code>" style property</h3>
<a class="indexterm" name="id2844428"></a><pre class="programlisting"> "header-padding" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read</pre>
<p>Number of pixels around the header.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 6</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2844459"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2844470"></a><h3>
<a name="GtkAssistant-apply"></a>The "apply" signal</h3>
<a class="indexterm" name="id2844480"></a><pre class="programlisting">void user_function (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
The ::apply signal is emitted when the apply button is clicked. The default
behavior of the <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> is to switch to the page after the current page,
unless the current page is the last one.
</p>
<p>
A handler for the ::apply signal should carry out the actions for which the
wizard has collected data. If the action takes a long time to complete, you
might consider to put a page of type GTK_ASSISTANT_PAGE_PROGRESS after the
confirmation page and handle this operation within the ::prepare signal of
the progress page.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> the <em class="parameter"><code>GtkAssistant</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2844582"></a><h3>
<a name="GtkAssistant-cancel"></a>The "cancel" signal</h3>
<a class="indexterm" name="id2844591"></a><pre class="programlisting">void user_function (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
The ::cancel signal is emitted when then the cancel button is clicked.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> the <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2844677"></a><h3>
<a name="GtkAssistant-close"></a>The "close" signal</h3>
<a class="indexterm" name="id2844687"></a><pre class="programlisting">void user_function (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
The ::close signal is emitted either when the close button of
a summary page is clicked, or when the apply button in the last
page in the flow (of type GTK_ASSISTANT_PAGE_CONFIRM) is clicked.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> the <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2844774"></a><h3>
<a name="GtkAssistant-prepare"></a>The "prepare" signal</h3>
<a class="indexterm" name="id2844785"></a><pre class="programlisting">void user_function (<a href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
The ::prepared signal is emitted when a new page is set as the assistant's
current page, before making the new page visible. A handler for this signal
can do any preparation which are necessary before showing <em class="parameter"><code>page</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>assistant</code></em> :</span></td>
<td> the <a href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>page</code></em> :</span></td>
<td> the current page
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
</div>
</div>
</body>
</html>