<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Graphics.UI.Gtk.Windows.Assistant</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Graphics-UI-Gtk-Windows-Assistant.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-Gtk-Windows-Assistant.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">gtk-0.12.0: Binding to the Gtk+ graphical user interface library.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable (depends on GHC)</td></tr><tr><th>Stability</th><td>provisional</td></tr><tr><th>Maintainer</th><td>gtk2hs-users@lists.sourceforge.net</td></tr></table><p class="caption">Graphics.UI.Gtk.Windows.Assistant</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Detail
</a><ul><li><a href="#g:2">GtkAssistant as GtkBuildable
</a></li></ul></li><li><a href="#g:3">Class Hierarchy
</a></li><li><a href="#g:4">Types
</a></li><li><a href="#g:5">Enums.
</a></li><li><a href="#g:6">Constructors
</a></li><li><a href="#g:7">Methods
</a></li><li><a href="#g:8">Attributes
</a></li><li><a href="#g:9">Child Attributes
</a></li><li><a href="#g:10">Signals
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A widget used to guide users through multi-step operations
</p><ul><li> Module available since Gtk+ version 2.10
</li></ul></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:Assistant">Assistant</a> </li><li class="src short"><span class="keyword">class</span> <a href="Graphics-UI-Gtk-Windows-Window.html#t:WindowClass">WindowClass</a> o => <a href="#t:AssistantClass">AssistantClass</a> o </li><li class="src short"><a href="#v:castToAssistant">castToAssistant</a> :: <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> obj => obj -> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></li><li class="src short"><a href="#v:toAssistant">toAssistant</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> o => o -> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:AssistantPageType">AssistantPageType</a> <ul class="subs"><li>= <a href="#v:AssistantPageContent">AssistantPageContent</a> </li><li>| <a href="#v:AssistantPageIntro">AssistantPageIntro</a> </li><li>| <a href="#v:AssistantPageConfirm">AssistantPageConfirm</a> </li><li>| <a href="#v:AssistantPageSummary">AssistantPageSummary</a> </li><li>| <a href="#v:AssistantPageProgress">AssistantPageProgress</a> </li></ul></li><li class="src short"><a href="#v:assistantNew">assistantNew</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></li><li class="src short"><a href="#v:assistantGetNPages">assistantGetNPages</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:assistantGetNthPage">assistantGetNthPage</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a>)</li><li class="src short"><a href="#v:assistantPrependPage">assistantPrependPage</a> :: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page) => self -> page -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:assistantAppendPage">assistantAppendPage</a> :: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page) => self -> page -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:assistantInsertPage">assistantInsertPage</a> :: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page) => self -> page -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:assistantSetForwardPageFunc">assistantSetForwardPageFunc</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a>) -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:assistantAddActionWidget">assistantAddActionWidget</a> :: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> child) => self -> child -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:assistantRemoveActionWidget">assistantRemoveActionWidget</a> :: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> child) => self -> child -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:assistantUpdateButtonsState">assistantUpdateButtonsState</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:assistantSetPageType">assistantSetPageType</a> :: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page) => self -> page -> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantPageType">AssistantPageType</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:assistantGetPageType">assistantGetPageType</a> :: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page) => self -> page -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantPageType">AssistantPageType</a></li><li class="src short"><a href="#v:assistantSetPageTitle">assistantSetPageTitle</a> :: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page) => self -> page -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:assistantGetPageTitle">assistantGetPageTitle</a> :: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page) => self -> page -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><a href="#v:assistantSetPageHeaderImage">assistantSetPageHeaderImage</a> :: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page) => self -> page -> <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:assistantGetPageHeaderImage">assistantGetPageHeaderImage</a> :: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page) => self -> page -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a>)</li><li class="src short"><a href="#v:assistantSetPageSideImage">assistantSetPageSideImage</a> :: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page) => self -> page -> <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:assistantGetPageSideImage">assistantGetPageSideImage</a> :: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page) => self -> page -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a>)</li><li class="src short"><a href="#v:assistantSetPageComplete">assistantSetPageComplete</a> :: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page) => self -> page -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:assistantGetPageComplete">assistantGetPageComplete</a> :: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page) => self -> page -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:assistantCommit">assistantCommit</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:assistantCurrentPage">assistantCurrentPage</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:assistantChildPageType">assistantChildPageType</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantPageType">AssistantPageType</a></li><li class="src short"><a href="#v:assistantChildTitle">assistantChildTitle</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><a href="#v:assistantChildHeaderImage">assistantChildHeaderImage</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a></li><li class="src short"><a href="#v:assistantChildSidebarImage">assistantChildSidebarImage</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a></li><li class="src short"><a href="#v:assistantChildComplete">assistantChildComplete</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:assistantCancel">assistantCancel</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)</li><li class="src short"><a href="#v:assistantPrepare">assistantPrepare</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)</li><li class="src short"><a href="#v:assistantApply">assistantApply</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)</li><li class="src short"><a href="#v:assistantClose">assistantClose</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)</li></ul></div><div id="interface"><h1 id="g:1">Detail
</h1><div class="doc"><p>A <code><a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></code> 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><h2 id="g:2">GtkAssistant as GtkBuildable
</h2><div class="doc"><p>The <code><a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></code> implementation of the <code>Buildable</code> interface exposes the
<code>actionArea</code> as internal children with the name "action_area".
</p><p>To add pages to an assistant in <code><a href="Graphics-UI-Gtk-Builder.html#t:Builder">Builder</a></code>, simply add it as a <child> to
the <code><a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></code> object, and set its child properties as necessary.
</p></div><h1 id="g:3">Class Hierarchy
</h1><div class="doc"><pre>
| <code><a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObject">GObject</a></code>
| +----<code><a href="Graphics-UI-Gtk-Abstract-Object.html#t:Object">Object</a></code>
| +----<code><a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a></code>
| +----<code><a href="Graphics-UI-Gtk-Abstract-Container.html#t:Container">Container</a></code>
| +----<code><a href="Graphics-UI-Gtk-Abstract-Bin.html#t:Bin">Bin</a></code>
| +----<code><a href="Graphics-UI-Gtk-Windows-Window.html#t:Window">Window</a></code>
| +----Assistant
</pre></div><h1 id="g:4">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Assistant" class="def">Assistant</a> <a href="src/Graphics-UI-Gtk-Types.html#Assistant" class="link">Source</a></p><div class="subs instances"><p id="control.i:Assistant" class="caption collapser" onclick="toggleSection('i:Assistant')">Instances</p><div id="section.i:Assistant" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Ord.html#t:Ord">Ord</a> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Windows-Window.html#t:WindowClass">WindowClass</a> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Abstract-Bin.html#t:BinClass">BinClass</a> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Abstract-Container.html#t:ContainerClass">ContainerClass</a> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Abstract-Object.html#t:ObjectClass">ObjectClass</a> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a href="Graphics-UI-Gtk-Windows-Window.html#t:WindowClass">WindowClass</a> o => <a name="t:AssistantClass" class="def">AssistantClass</a> o <a href="src/Graphics-UI-Gtk-Types.html#AssistantClass" class="link">Source</a></p><div class="subs instances"><p id="control.i:AssistantClass" class="caption collapser" onclick="toggleSection('i:AssistantClass')">Instances</p><div id="section.i:AssistantClass" class="show"><table><tr><td class="src"><a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:castToAssistant" class="def">castToAssistant</a> :: <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> obj => obj -> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a><a href="src/Graphics-UI-Gtk-Types.html#castToAssistant" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:toAssistant" class="def">toAssistant</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> o => o -> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a><a href="src/Graphics-UI-Gtk-Types.html#toAssistant" class="link">Source</a></p></div><h1 id="g:5">Enums.
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:AssistantPageType" class="def">AssistantPageType</a> <a href="src/Graphics-UI-Gtk-Windows-Assistant.html#AssistantPageType" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:AssistantPageContent" class="def">AssistantPageContent</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:AssistantPageIntro" class="def">AssistantPageIntro</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:AssistantPageConfirm" class="def">AssistantPageConfirm</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:AssistantPageSummary" class="def">AssistantPageSummary</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:AssistantPageProgress" class="def">AssistantPageProgress</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:AssistantPageType" class="caption collapser" onclick="toggleSection('i:AssistantPageType')">Instances</p><div id="section.i:AssistantPageType" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Bounded">Bounded</a> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantPageType">AssistantPageType</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Enum">Enum</a> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantPageType">AssistantPageType</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantPageType">AssistantPageType</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantPageType">AssistantPageType</a></td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:6">Constructors
</h1><div class="top"><p class="src"><a name="v:assistantNew" class="def">assistantNew</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantNew" class="link">Source</a></p><div class="doc"><p>Creates a new <code><a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></code>.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><h1 id="g:7">Methods
</h1><div class="top"><p class="src"><a name="v:assistantGetNPages" class="def">assistantGetNPages</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantGetNPages" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p>returns The number of pages in the <code>assistant</code>.
</p></td></tr></table></div><div class="doc"><p>Returns the number of pages in the <code>assistant</code>
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantGetNthPage" class="def">assistantGetNthPage</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantGetNthPage" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p><code>pageNum</code> - The index of a page in the <code>assistant</code>, or -1
to get the last page;
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a>)</td><td class="doc"><p>returns The child widget, or <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> if <code>pageNum</code> is out of bounds.
</p></td></tr></table></div><div class="doc"><p>Returns the child widget contained in page number <code>pageNum</code>.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantPrependPage" class="def">assistantPrependPage</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantPrependPage" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page)</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> page</td><td class="doc"><p><code>page</code> - a <code><a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a></code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p>returns the index (starting at 0) of the inserted page
</p></td></tr></table></div><div class="doc"><p>Prepends a page to the <code>assistant</code>.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantAppendPage" class="def">assistantAppendPage</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantAppendPage" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page)</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> page</td><td class="doc"><p><code>page</code> - a <code><a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a></code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p>returns the index (starting at 0) of the inserted page
</p></td></tr></table></div><div class="doc"><p>Appends a page to the <code>assistant</code>.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantInsertPage" class="def">assistantInsertPage</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantInsertPage" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page)</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> page</td><td class="doc"><p><code>page</code> - a <code><a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a></code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p><code>position</code> - the index (starting at 0) at which to insert the
page, or -1 to append the page to the <code>assistant</code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p>returns the index (starting from 0) of the inserted page
</p></td></tr></table></div><div class="doc"><p>Inserts a page in the <code>assistant</code> at a given position.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantSetForwardPageFunc" class="def">assistantSetForwardPageFunc</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantSetForwardPageFunc" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a>)</td><td class="doc"><p><code>pageFunc</code> - the <code>AssistantPage</code>, or <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> to use the default one.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Sets the page forwarding function to be <code>pageFunc</code>, this function will be
used to determine what will be the next page when the user presses the
forward button. Setting <code>pageFunc</code> to <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> will make the assistant to use the
default forward function, which just goes to the next visible page.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantAddActionWidget" class="def">assistantAddActionWidget</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantAddActionWidget" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> child)</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> child</td><td class="doc"><p><code>child</code> - a <code><a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a></code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Adds a widget to the action area of a <code><a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></code>.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantRemoveActionWidget" class="def">assistantRemoveActionWidget</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantRemoveActionWidget" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> child)</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> child</td><td class="doc"><p><code>child</code> - a <code><a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a></code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Removes a widget from the action area of a <code><a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></code>.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantUpdateButtonsState" class="def">assistantUpdateButtonsState</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantUpdateButtonsState" class="link">Source</a></p><div class="doc"><p>Forces <code>assistant</code> 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><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantSetPageType" class="def">assistantSetPageType</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantSetPageType" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page)</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> page</td><td class="doc"><p><code>page</code> - a page of <code>assistant</code>
</p></td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantPageType">AssistantPageType</a></td><td class="doc"><p><code>type</code> - the new type for <code>page</code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Sets the page type for <code>page</code>. The page type determines the page behavior
in the <code>assistant</code>.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantGetPageType" class="def">assistantGetPageType</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantGetPageType" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page)</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> page</td><td class="doc"><p><code>page</code> - a page of <code>assistant</code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantPageType">AssistantPageType</a></td><td class="doc"><p>returns the page type of <code>page</code>.
</p></td></tr></table></div><div class="doc"><p>Gets the page type of <code>page</code>.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantSetPageTitle" class="def">assistantSetPageTitle</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantSetPageTitle" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page)</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> page</td><td class="doc"><p><code>page</code> - a page of <code>assistant</code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p><code>title</code> - the new title for <code>page</code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Sets a title for <code>page</code>. The title is displayed in the header area of the
assistant when <code>page</code> is the current page.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantGetPageTitle" class="def">assistantGetPageTitle</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantGetPageTitle" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page)</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> page</td><td class="doc"><p><code>page</code> - a page of <code>assistant</code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p>returns the title for <code>page</code>.
</p></td></tr></table></div><div class="doc"><p>Gets the title for <code>page</code>.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantSetPageHeaderImage" class="def">assistantSetPageHeaderImage</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantSetPageHeaderImage" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page)</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> page</td><td class="doc"><p><code>page</code> - a page of <code>assistant</code>
</p></td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a></td><td class="doc"><p><code>pixbuf</code> - the new header image <code>page</code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Sets a header image for <code>page</code>. This image is displayed in the header
area of the assistant when <code>page</code> is the current page.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantGetPageHeaderImage" class="def">assistantGetPageHeaderImage</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantGetPageHeaderImage" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page)</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> page</td><td class="doc"><p><code>page</code> - a page of <code>assistant</code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a>)</td><td class="doc"><p>returns the header image for <code>page</code>, or <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> if there's no header image for the page.
</p></td></tr></table></div><div class="doc"><p>Gets the header image for <code>page</code>.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantSetPageSideImage" class="def">assistantSetPageSideImage</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantSetPageSideImage" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page)</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> page</td><td class="doc"><p><code>page</code> - a page of <code>assistant</code>
</p></td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a></td><td class="doc"><p><code>pixbuf</code> - the new header image <code>page</code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Sets a header image for <code>page</code>. This image is displayed in the side area
of the assistant when <code>page</code> is the current page.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantGetPageSideImage" class="def">assistantGetPageSideImage</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantGetPageSideImage" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page)</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> page</td><td class="doc"><p><code>page</code> - a page of <code>assistant</code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a>)</td><td class="doc"><p>returns the side image for <code>page</code>, or <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> if there's no side image for the page.
</p></td></tr></table></div><div class="doc"><p>Gets the header image for <code>page</code>.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantSetPageComplete" class="def">assistantSetPageComplete</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantSetPageComplete" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page)</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> page</td><td class="doc"><p><code>page</code> - a page of <code>assistant</code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p><code>complete</code> - the completeness status of the page
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Sets whether <code>page</code> contents are complete. This will make <code>assistant</code>
update the buttons state to be able to continue the task.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantGetPageComplete" class="def">assistantGetPageComplete</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantGetPageComplete" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> page)</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> page</td><td class="doc"><p><code>page</code> - a page of <code>assistant</code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p>returns <code>True</code> if <code>page</code> is complete.
</p></td></tr></table></div><div class="doc"><p>Gets whether <code>page</code> is complete.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantCommit" class="def">assistantCommit</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantCommit" class="link">Source</a></p><div class="doc"><p>Erases the visited page history so the back button is not shown on the current page, and removes the
cancel button from subsequent pages.
</p><p>Use this when the information provided up to the current page is hereafter deemed permanent and
cannot be modified or undone. For example, showing a progress page to track a long-running,
unreversible operation after the user has clicked apply on a confirmation page.
</p><ul><li> Available since Gtk+ version 2.22
</li></ul></div></div><h1 id="g:8">Attributes
</h1><div class="top"><p class="src"><a name="v:assistantCurrentPage" class="def">assistantCurrentPage</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantCurrentPage" class="link">Source</a></p><div class="doc"><p>Switches the page to <code>pageNum</code>. Note that this will only be necessary in
custom buttons, as the <code>assistant</code> flow can be set with
<code><a href="Graphics-UI-Gtk-Windows-Assistant.html#v:assistantSetForwardPageFunc">assistantSetForwardPageFunc</a></code>.
</p><p>Returns the page number of the current page
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><h1 id="g:9">Child Attributes
</h1><div class="top"><p class="src"><a name="v:assistantChildPageType" class="def">assistantChildPageType</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantPageType">AssistantPageType</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantChildPageType" class="link">Source</a></p><div class="doc"><p>The type of the assistant page.
</p><p>Default value: <code><a href="Graphics-UI-Gtk-Windows-Assistant.html#v:AssistantPageContent">AssistantPageContent</a></code>
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantChildTitle" class="def">assistantChildTitle</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantChildTitle" class="link">Source</a></p><div class="doc"><p>The title that is displayed in the page header.
</p><p>If title and header-image are both, no header is displayed.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantChildHeaderImage" class="def">assistantChildHeaderImage</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantChildHeaderImage" class="link">Source</a></p><div class="doc"><p>The image that is displayed next to the page.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantChildSidebarImage" class="def">assistantChildSidebarImage</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantChildSidebarImage" class="link">Source</a></p><div class="doc"><p>Sidebar image for the assistant page.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantChildComplete" class="def">assistantChildComplete</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantChildComplete" class="link">Source</a></p><div class="doc"><p>Setting the "complete" child property to <code>True</code> marks a page as
complete (i.e.: all the required fields are filled out). Gtk+ uses this
information to control the sensitivity of the navigation buttons.
</p><p>Default value: <code>False</code>
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><h1 id="g:10">Signals
</h1><div class="top"><p class="src"><a name="v:assistantCancel" class="def">assistantCancel</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)<a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantCancel" class="link">Source</a></p><div class="doc"><p>The ::assistantCancel signal is emitted when then the assistantCancel button is clicked.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantPrepare" class="def">assistantPrepare</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)<a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantPrepare" class="link">Source</a></p><div class="doc"><p>The ::assistantPrepare 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 <code>page</code>.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantApply" class="def">assistantApply</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)<a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantApply" class="link">Source</a></p><div class="doc"><p>The ::assistantApply signal is emitted when the assistantApply button is clicked. The
default behavior of the <code><a href="Graphics-UI-Gtk-Windows-Assistant.html#t:Assistant">Assistant</a></code> is to switch to the page after the
current page, unless the current page is the last one.
</p><p>A handler for the ::assistantApply signal should carry out the actions for which
the wizard has collected data. If the action takes a long time to complete,
you might consider to put a page of type <code><a href="Graphics-UI-Gtk-Windows-Assistant.html#v:AssistantPageProgress">AssistantPageProgress</a></code> after the
confirmation page and handle this operation within the <code><a href="Graphics-UI-Gtk-Windows-Assistant.html#v:assistantPrepare">assistantPrepare</a></code> signal of the progress page.
</p><ul><li> Available since Gtk+ version 2.10
</li></ul></div></div><div class="top"><p class="src"><a name="v:assistantClose" class="def">assistantClose</a> :: <a href="Graphics-UI-Gtk-Windows-Assistant.html#t:AssistantClass">AssistantClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)<a href="src/Graphics-UI-Gtk-Windows-Assistant.html#assistantClose" class="link">Source</a></p><div class="doc"><p>The ::assistantClose signal is emitted either when the assistantClose button of a summary
page is clicked, or when the apply button in the last page in the flow (of
type <code><a href="Graphics-UI-Gtk-Windows-Assistant.html#v:AssistantPageConfirm">AssistantPageConfirm</a></code>) is clicked.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
