| Server IP : 182.53.201.61 / Your IP : 216.73.217.175 Web Server : Apache/2.2.15 (Fedora) System : Linux km10.dyndns.org 2.6.31.5-127.fc12.i686.PAE #1 SMP Sat Nov 7 21:25:57 EST 2009 i686 User : apache ( 48) PHP Version : 5.3.3 Disable Function : NONE MySQL : ON | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON 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=UTF-8">
<title>GtkAssistant</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" 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.11 (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="Builder.html" title="Interface builder">
<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="chapter" href="gtk-migrating-GtkBuilder.html" title="Migrating from libglade to GtkBuilder">
<link rel="chapter" href="gtk-migrating-tooltips.html" title="Migrating from GtkTooltips to GtkTooltip">
<link rel="chapter" href="gtk-migrating-entry-icons.html" title="Migrating from SexyIconEntry to GtkEntry">
<link rel="chapter" href="gtk-migrating-label-links.html" title="Migrating from SexyUrlLabel to GtkLabel">
<link rel="chapter" href="gtk-migrating-ClientSideWindows.html" title="Migrating to client-side windows">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="api-index-full.html" title="Index of all symbols">
<link rel="index" href="api-index-deprecated.html" title="Index of deprecated symbols">
<link rel="index" href="api-index-2-2.html" title="Index of new symbols in 2.2">
<link rel="index" href="api-index-2-4.html" title="Index of new symbols in 2.4">
<link rel="index" href="api-index-2-6.html" title="Index of new symbols in 2.6">
<link rel="index" href="api-index-2-8.html" title="Index of new symbols in 2.8">
<link rel="index" href="api-index-2-10.html" title="Index of new symbols in 2.10">
<link rel="index" href="api-index-2-12.html" title="Index of new symbols in 2.12">
<link rel="index" href="api-index-2-14.html" title="Index of new symbols in 2.14">
<link rel="index" href="api-index-2-16.html" title="Index of new symbols in 2.16">
<link rel="index" href="api-index-2-18.html" title="Index of new symbols in 2.18">
</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">
<a href="#GtkAssistant.synopsis" class="shortcut">Top</a>
|
<a href="#GtkAssistant.description" class="shortcut">Description</a>
|
<a href="#GtkAssistant.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GtkAssistant.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#GtkAssistant.child-properties" class="shortcut">Child Properties</a>
|
<a href="#GtkAssistant.style-properties" class="shortcut">Style Properties</a>
|
<a href="#GtkAssistant.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="GtkAssistant">
<a name="GtkAssistant"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkAssistant.top_of_page"></a>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" title="Synopsis">
<a name="GtkAssistant.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gtk/gtk.h>
<a class="link" href="GtkAssistant.html#GtkAssistant-struct" title="GtkAssistant">GtkAssistant</a>;
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> * <a class="link" href="GtkAssistant.html#gtk-assistant-new" title="gtk_assistant_new ()">gtk_assistant_new</a> (void);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> <a class="link" href="GtkAssistant.html#gtk-assistant-get-current-page" title="gtk_assistant_get_current_page ()">gtk_assistant_get_current_page</a> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant);
void <a class="link" href="GtkAssistant.html#gtk-assistant-set-current-page" title="gtk_assistant_set_current_page ()">gtk_assistant_set_current_page</a> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> page_num);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> <a class="link" href="GtkAssistant.html#gtk-assistant-get-n-pages" title="gtk_assistant_get_n_pages ()">gtk_assistant_get_n_pages</a> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant);
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> * <a class="link" href="GtkAssistant.html#gtk-assistant-get-nth-page" title="gtk_assistant_get_nth_page ()">gtk_assistant_get_nth_page</a> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> page_num);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> <a class="link" href="GtkAssistant.html#gtk-assistant-prepend-page" title="gtk_assistant_prepend_page ()">gtk_assistant_prepend_page</a> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> <a class="link" href="GtkAssistant.html#gtk-assistant-append-page" title="gtk_assistant_append_page ()">gtk_assistant_append_page</a> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> <a class="link" href="GtkAssistant.html#gtk-assistant-insert-page" title="gtk_assistant_insert_page ()">gtk_assistant_insert_page</a> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> position);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> (<a class="link" href="GtkAssistant.html#GtkAssistantPageFunc" title="GtkAssistantPageFunc ()">*GtkAssistantPageFunc</a>) (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> current_page,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);
void <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> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkAssistant.html#GtkAssistantPageFunc" title="GtkAssistantPageFunc ()">GtkAssistantPageFunc</a> page_func,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data,
<a
href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"
>GDestroyNotify</a> destroy);
enum <a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum GtkAssistantPageType">GtkAssistantPageType</a>;
void <a class="link" href="GtkAssistant.html#gtk-assistant-set-page-type" title="gtk_assistant_set_page_type ()">gtk_assistant_set_page_type</a> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum GtkAssistantPageType">GtkAssistantPageType</a> type);
<a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum GtkAssistantPageType">GtkAssistantPageType</a> <a class="link" href="GtkAssistant.html#gtk-assistant-get-page-type" title="gtk_assistant_get_page_type ()">gtk_assistant_get_page_type</a> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
void <a class="link" href="GtkAssistant.html#gtk-assistant-set-page-title" title="gtk_assistant_set_page_title ()">gtk_assistant_set_page_title</a> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *title);
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> * <a class="link" href="GtkAssistant.html#gtk-assistant-get-page-title" title="gtk_assistant_get_page_title ()">gtk_assistant_get_page_title</a> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
void <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> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *pixbuf);
<a
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</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> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
void <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> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *pixbuf);
<a
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</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> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
void <a class="link" href="GtkAssistant.html#gtk-assistant-set-page-complete" title="gtk_assistant_set_page_complete ()">gtk_assistant_set_page_complete</a> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> complete);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="GtkAssistant.html#gtk-assistant-get-page-complete" title="gtk_assistant_get_page_complete ()">gtk_assistant_get_page_complete</a> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page);
void <a class="link" href="GtkAssistant.html#gtk-assistant-add-action-widget" title="gtk_assistant_add_action_widget ()">gtk_assistant_add_action_widget</a> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *child);
void <a class="link" href="GtkAssistant.html#gtk-assistant-remove-action-widget" title="gtk_assistant_remove_action_widget ()">gtk_assistant_remove_action_widget</a> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *child);
void <a class="link" href="GtkAssistant.html#gtk-assistant-update-buttons-state" title="gtk_assistant_update_buttons_state ()">gtk_assistant_update_buttons_state</a> (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="GtkAssistant.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
+----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
+----<a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
+----<a class="link" href="GtkBin.html" title="GtkBin">GtkBin</a>
+----<a class="link" href="GtkWindow.html" title="GtkWindow">GtkWindow</a>
+----GtkAssistant
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="GtkAssistant.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkAssistant implements
AtkImplementorIface and <a class="link" href="gtk-gtkbuildable.html#GtkBuildable">GtkBuildable</a>.</p>
</div>
<div class="refsect1" title="Child Properties">
<a name="GtkAssistant.child-properties"></a><h2>Child Properties</h2>
<pre class="synopsis">
"<a class="link" href="GtkAssistant.html#GtkAssistant--c-complete" title='The "complete" child property'>complete</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write
"<a class="link" href="GtkAssistant.html#GtkAssistant--c-header-image" title='The "header-image" child property'>header-image</a>" <a
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a>* : Read / Write
"<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">GtkAssistantPageType</a> : Read / Write
"<a class="link" href="GtkAssistant.html#GtkAssistant--c-sidebar-image" title='The "sidebar-image" child property'>sidebar-image</a>" <a
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a>* : Read / Write
"<a class="link" href="GtkAssistant.html#GtkAssistant--c-title" title='The "title" child property'>title</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write
</pre>
</div>
<div class="refsect1" title="Style Properties">
<a name="GtkAssistant.style-properties"></a><h2>Style Properties</h2>
<pre class="synopsis">
"<a class="link" href="GtkAssistant.html#GtkAssistant--s-content-padding" title='The "content-padding" style property'>content-padding</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> : Read
"<a class="link" href="GtkAssistant.html#GtkAssistant--s-header-padding" title='The "header-padding" style property'>header-padding</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> : Read
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="GtkAssistant.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GtkAssistant.html#GtkAssistant-apply" title='The "apply" signal'>apply</a>" : Run Last
"<a class="link" href="GtkAssistant.html#GtkAssistant-cancel" title='The "cancel" signal'>cancel</a>" : Run Last
"<a class="link" href="GtkAssistant.html#GtkAssistant-close" title='The "close" signal'>close</a>" : Run Last
"<a class="link" href="GtkAssistant.html#GtkAssistant-prepare" title='The "prepare" signal'>prepare</a>" : Run Last
</pre>
</div>
<div class="refsect1" title="Description">
<a name="GtkAssistant.description"></a><h2>Description</h2>
<p>
A <a class="link" 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 class="refsect2" title="GtkAssistant as GtkBuildable">
<a name="GtkAssistant-BUILDER-UI"></a><h3>GtkAssistant as GtkBuildable</h3>
<p>
The GtkAssistant implementation of the GtkBuildable interface exposes the
<em class="parameter"><code>action_area</code></em> as internal children with the name "action_area".
</p>
<p>
To add pages to an assistant in GtkBuilder, simply add it as a <child>
to the GtkAssistant object, and set its child properties as necessary.
</p>
</div>
</div>
<div class="refsect1" title="Details">
<a name="GtkAssistant.details"></a><h2>Details</h2>
<div class="refsect2" title="GtkAssistant">
<a name="GtkAssistant-struct"></a><h3>GtkAssistant</h3>
<pre class="programlisting">typedef struct _GtkAssistant GtkAssistant;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_new ()">
<a name="gtk-assistant-new"></a><h3>gtk_assistant_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> * gtk_assistant_new (void);</pre>
<p>
Creates a new <a class="link" 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><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly created <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_get_current_page ()">
<a name="gtk-assistant-get-current-page"></a><h3>gtk_assistant_get_current_page ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> gtk_assistant_get_current_page (<a class="link" 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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The index (starting from 0) of the 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 class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_set_current_page ()">
<a name="gtk-assistant-set-current-page"></a><h3>gtk_assistant_set_current_page ()</h3>
<pre class="programlisting">void gtk_assistant_set_current_page (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a
href="/usr/share/gtk-doc/html/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 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>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page_num</code></em> :</span></p></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 class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_get_n_pages ()">
<a name="gtk-assistant-get-n-pages"></a><h3>gtk_assistant_get_n_pages ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> gtk_assistant_get_n_pages (<a class="link" 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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The number of pages in the <em class="parameter"><code>assistant</code></em>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_get_nth_page ()">
<a name="gtk-assistant-get-nth-page"></a><h3>gtk_assistant_get_nth_page ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> * gtk_assistant_get_nth_page (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a
href="/usr/share/gtk-doc/html/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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page_num</code></em> :</span></p></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><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The child widget, or <a
href="/usr/share/gtk-doc/html/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 class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_prepend_page ()">
<a name="gtk-assistant-prepend-page"></a><h3>gtk_assistant_prepend_page ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> gtk_assistant_prepend_page (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" 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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td> a <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the index (starting at 0) of the inserted page
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_append_page ()">
<a name="gtk-assistant-append-page"></a><h3>gtk_assistant_append_page ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> gtk_assistant_append_page (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" 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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td> a <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the index (starting at 0) of the inserted page
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_insert_page ()">
<a name="gtk-assistant-insert-page"></a><h3>gtk_assistant_insert_page ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> gtk_assistant_insert_page (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="/usr/share/gtk-doc/html/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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td> a <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></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><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the index (starting from 0) of the inserted page
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="GtkAssistantPageFunc ()">
<a name="GtkAssistantPageFunc"></a><h3>GtkAssistantPageFunc ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> (*GtkAssistantPageFunc) (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> current_page,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);</pre>
<p>
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
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><p><span class="term"><em class="parameter"><code>current_page</code></em> :</span></p></td>
<td>The page number used to calculate the next page.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>user data.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The next page number.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_set_forward_page_func ()">
<a name="gtk-assistant-set-forward-page-func"></a><h3>gtk_assistant_set_forward_page_func ()</h3>
<pre class="programlisting">void gtk_assistant_set_forward_page_func (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkAssistant.html#GtkAssistantPageFunc" title="GtkAssistantPageFunc ()">GtkAssistantPageFunc</a> page_func,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data,
<a
href="/usr/share/gtk-doc/html/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="/usr/share/gtk-doc/html/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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page_func</code></em> :</span></p></td>
<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/glib/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a> to use the default one
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td> user data for <em class="parameter"><code>page_func</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
<td> destroy notifier for <em class="parameter"><code>data</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="enum GtkAssistantPageType">
<a name="GtkAssistantPageType"></a><h3>enum GtkAssistantPageType</h3>
<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 class="link" 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><p><a name="GTK-ASSISTANT-PAGE-CONTENT--CAPS"></a><span class="term"><code class="literal">GTK_ASSISTANT_PAGE_CONTENT</code></span></p></td>
<td>The page has regular contents.
</td>
</tr>
<tr>
<td><p><a name="GTK-ASSISTANT-PAGE-INTRO--CAPS"></a><span class="term"><code class="literal">GTK_ASSISTANT_PAGE_INTRO</code></span></p></td>
<td>The page contains an introduction to the assistant task.
</td>
</tr>
<tr>
<td><p><a name="GTK-ASSISTANT-PAGE-CONFIRM--CAPS"></a><span class="term"><code class="literal">GTK_ASSISTANT_PAGE_CONFIRM</code></span></p></td>
<td>The page lets the user confirm or deny the changes.
</td>
</tr>
<tr>
<td><p><a name="GTK-ASSISTANT-PAGE-SUMMARY--CAPS"></a><span class="term"><code class="literal">GTK_ASSISTANT_PAGE_SUMMARY</code></span></p></td>
<td>The page informs the user of the changes done.
</td>
</tr>
<tr>
<td><p><a name="GTK-ASSISTANT-PAGE-PROGRESS--CAPS"></a><span class="term"><code class="literal">GTK_ASSISTANT_PAGE_PROGRESS</code></span></p></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" title="gtk_assistant_set_page_type ()">
<a name="gtk-assistant-set-page-type"></a><h3>gtk_assistant_set_page_type ()</h3>
<pre class="programlisting">void gtk_assistant_set_page_type (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum 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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td> the new type for <em class="parameter"><code>page</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_get_page_type ()">
<a name="gtk-assistant-get-page-type"></a><h3>gtk_assistant_get_page_type ()</h3>
<pre class="programlisting"><a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum GtkAssistantPageType">GtkAssistantPageType</a> gtk_assistant_get_page_type (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" 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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the page type of <em class="parameter"><code>page</code></em>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_set_page_title ()">
<a name="gtk-assistant-set-page-title"></a><h3>gtk_assistant_set_page_title ()</h3>
<pre class="programlisting">void gtk_assistant_set_page_title (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
const <a
href="/usr/share/gtk-doc/html/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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
<td> the new title for <em class="parameter"><code>page</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_get_page_title ()">
<a name="gtk-assistant-get-page-title"></a><h3>gtk_assistant_get_page_title ()</h3>
<pre class="programlisting">const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> * gtk_assistant_get_page_title (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" 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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the title for <em class="parameter"><code>page</code></em>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_set_page_header_image ()">
<a name="gtk-assistant-set-page-header-image"></a><h3>gtk_assistant_set_page_header_image ()</h3>
<pre class="programlisting">void gtk_assistant_set_page_header_image (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td>
<td> the new header image <em class="parameter"><code>page</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_get_page_header_image ()">
<a name="gtk-assistant-get-page-header-image"></a><h3>gtk_assistant_get_page_header_image ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> * gtk_assistant_get_page_header_image (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" 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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the header image for <em class="parameter"><code>page</code></em>, or <a
href="/usr/share/gtk-doc/html/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 class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_set_page_side_image ()">
<a name="gtk-assistant-set-page-side-image"></a><h3>gtk_assistant_set_page_side_image ()</h3>
<pre class="programlisting">void gtk_assistant_set_page_side_image (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td>
<td> the new header image <em class="parameter"><code>page</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_get_page_side_image ()">
<a name="gtk-assistant-get-page-side-image"></a><h3>gtk_assistant_get_page_side_image ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> * gtk_assistant_get_page_side_image (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" 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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the side image for <em class="parameter"><code>page</code></em>, or <a
href="/usr/share/gtk-doc/html/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 class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_set_page_complete ()">
<a name="gtk-assistant-set-page-complete"></a><h3>gtk_assistant_set_page_complete ()</h3>
<pre class="programlisting">void gtk_assistant_set_page_complete (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="/usr/share/gtk-doc/html/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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>complete</code></em> :</span></p></td>
<td> the completeness status of the page
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_get_page_complete ()">
<a name="gtk-assistant-get-page-complete"></a><h3>gtk_assistant_get_page_complete ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_assistant_get_page_complete (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" 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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td> a page of <em class="parameter"><code>assistant</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/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 class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_add_action_widget ()">
<a name="gtk-assistant-add-action-widget"></a><h3>gtk_assistant_add_action_widget ()</h3>
<pre class="programlisting">void gtk_assistant_add_action_widget (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *child);</pre>
<p>
Adds a widget to the action area of a <a class="link" 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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
<td> a <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_remove_action_widget ()">
<a name="gtk-assistant-remove-action-widget"></a><h3>gtk_assistant_remove_action_widget ()</h3>
<pre class="programlisting">void gtk_assistant_remove_action_widget (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *child);</pre>
<p>
Removes a widget from the action area of a <a class="link" 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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
<td> a <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2" title="gtk_assistant_update_buttons_state ()">
<a name="gtk-assistant-update-buttons-state"></a><h3>gtk_assistant_update_buttons_state ()</h3>
<pre class="programlisting">void gtk_assistant_update_buttons_state (<a class="link" 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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> a <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.10</p>
</div>
</div>
<div class="refsect1" title="Child Property Details">
<a name="GtkAssistant.child-property-details"></a><h2>Child Property Details</h2>
<div class="refsect2" title='The "complete" child property'>
<a name="GtkAssistant--c-complete"></a><h3>The <code class="literal">"complete"</code> child property</h3>
<pre class="programlisting"> "complete" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write</pre>
<p>
Setting the "complete" child property to <a
href="/usr/share/gtk-doc/html/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" title='The "header-image" child property'>
<a name="GtkAssistant--c-header-image"></a><h3>The <code class="literal">"header-image"</code> child property</h3>
<pre class="programlisting"> "header-image" <a
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/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="/usr/share/gtk-doc/html/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" title='The "page-type" child property'>
<a name="GtkAssistant--c-page-type"></a><h3>The <code class="literal">"page-type"</code> child property</h3>
<pre class="programlisting"> "page-type" <a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum 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" title='The "sidebar-image" child property'>
<a name="GtkAssistant--c-sidebar-image"></a><h3>The <code class="literal">"sidebar-image"</code> child property</h3>
<pre class="programlisting"> "sidebar-image" <a
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a>* : Read / Write</pre>
<p>Sidebar image for the assistant page.</p>
</div>
<hr>
<div class="refsect2" title='The "title" child property'>
<a name="GtkAssistant--c-title"></a><h3>The <code class="literal">"title"</code> child property</h3>
<pre class="programlisting"> "title" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</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="/usr/share/gtk-doc/html/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" title="Style Property Details">
<a name="GtkAssistant.style-property-details"></a><h2>Style Property Details</h2>
<div class="refsect2" title='The "content-padding" style property'>
<a name="GtkAssistant--s-content-padding"></a><h3>The <code class="literal">"content-padding"</code> style property</h3>
<pre class="programlisting"> "content-padding" <a
href="/usr/share/gtk-doc/html/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" title='The "header-padding" style property'>
<a name="GtkAssistant--s-header-padding"></a><h3>The <code class="literal">"header-padding"</code> style property</h3>
<pre class="programlisting"> "header-padding" <a
href="/usr/share/gtk-doc/html/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" title="Signal Details">
<a name="GtkAssistant.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "apply" signal'>
<a name="GtkAssistant-apply"></a><h3>The <code class="literal">"apply"</code> signal</h3>
<pre class="programlisting">void user_function (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a
href="/usr/share/gtk-doc/html/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 class="link" 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 <a class="link" href="GtkAssistant.html#GTK-ASSISTANT-PAGE-PROGRESS--CAPS"><code class="literal">GTK_ASSISTANT_PAGE_PROGRESS</code></a>
after the confirmation page and handle this operation within the
<a class="link" href="GtkAssistant.html#GtkAssistant-prepare" title='The "prepare" signal'><span class="type">"prepare"</span></a> signal of the progress page.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> the <em class="parameter"><code>GtkAssistant</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></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" title='The "cancel" signal'>
<a name="GtkAssistant-cancel"></a><h3>The <code class="literal">"cancel"</code> signal</h3>
<pre class="programlisting">void user_function (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a
href="/usr/share/gtk-doc/html/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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> the <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></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" title='The "close" signal'>
<a name="GtkAssistant-close"></a><h3>The <code class="literal">"close"</code> signal</h3>
<pre class="programlisting">void user_function (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a
href="/usr/share/gtk-doc/html/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 <a class="link" href="GtkAssistant.html#GTK-ASSISTANT-PAGE-CONFIRM--CAPS"><code class="literal">GTK_ASSISTANT_PAGE_CONFIRM</code></a>) is clicked.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> the <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></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" title='The "prepare" signal'>
<a name="GtkAssistant-prepare"></a><h3>The <code class="literal">"prepare"</code> signal</h3>
<pre class="programlisting">void user_function (<a class="link" href="GtkAssistant.html" title="GtkAssistant">GtkAssistant</a> *assistant,
<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *page,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run Last</pre>
<p>
The ::prepare 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><p><span class="term"><em class="parameter"><code>assistant</code></em> :</span></p></td>
<td> the <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td> the current page
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>