<!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/xhtml;charset=UTF-8"/>
<title>gtkmm: Gtk::Assistant Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">gtkmm <span id="projectnumber">2.24.4</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceGtk.html">Gtk</a> </li>
<li class="navelem"><a class="el" href="classGtk_1_1Assistant.html">Assistant</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#related">Related Functions</a> </div>
<div class="headertitle">
<h1>Gtk::Assistant Class Reference<div class="ingroups"><a class="el" href="group__Dialogs.html">Dialogs</a></div></h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Gtk::Assistant" --><!-- doxytag: inherits="Gtk::Window" -->
<p>A widget used to guide users through multi-step operations. <a href="#_details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Gtk::Assistant:</div>
<div class="dyncontent">
<div class="center"><img src="classGtk_1_1Assistant__inherit__graph.png" border="0" usemap="#Gtk_1_1Assistant_inherit__map" alt="Inheritance graph"/></div>
<map name="Gtk_1_1Assistant_inherit__map" id="Gtk_1_1Assistant_inherit__map">
<area shape="rect" id="node2" href="classGtk_1_1Window.html" title="Toplevel Window This represents all widgets which are physical windows controlled by the window manag..." alt="" coords="87,547,185,576"/><area shape="rect" id="node4" href="classGtk_1_1Bin.html" title="A container with just one child." alt="" coords="100,469,172,499"/><area shape="rect" id="node6" href="classGtk_1_1Container.html" title="Abstract container class." alt="" coords="79,392,193,421"/><area shape="rect" id="node8" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)" alt="" coords="89,315,183,344"/><area shape="rect" id="node10" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non-widget objects such as Gtk::Adjustme..." alt="" coords="21,237,115,267"/><area shape="rect" id="node12" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="21,160,115,189"/><area shape="rect" id="node14" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,83,131,112"/><area shape="rect" id="node16" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="11,5,125,35"/><area shape="rect" id="node18" href="classAtk_1_1Implementor.html" title="Atk::Implementor" alt="" coords="139,237,272,267"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Gtk::Assistant:</div>
<div class="dyncontent">
<div class="center"><img src="classGtk_1_1Assistant__coll__graph.png" border="0" usemap="#Gtk_1_1Assistant_coll__map" alt="Collaboration graph"/></div>
<map name="Gtk_1_1Assistant_coll__map" id="Gtk_1_1Assistant_coll__map">
<area shape="rect" id="node2" href="classGtk_1_1Window.html" title="Toplevel Window This represents all widgets which are physical windows controlled by the window manag..." alt="" coords="231,597,329,627"/><area shape="rect" id="node4" href="classGtk_1_1Bin.html" title="A container with just one child." alt="" coords="144,501,216,531"/><area shape="rect" id="node6" href="classGtk_1_1Container.html" title="Abstract container class." alt="" coords="113,405,228,435"/><area shape="rect" id="node8" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)" alt="" coords="124,325,217,355"/><area shape="rect" id="node10" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non-widget objects such as Gtk::Adjustme..." alt="" coords="21,245,115,275"/><area shape="rect" id="node12" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="21,165,115,195"/><area shape="rect" id="node14" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,85,131,115"/><area shape="rect" id="node16" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="11,5,125,35"/><area shape="rect" id="node18" href="classAtk_1_1Implementor.html" title="Atk::Implementor" alt="" coords="139,245,272,275"/><area shape="rect" id="node20" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html" title="Glib::RefPtr\< AccelGroup \>" alt="" coords="252,501,447,531"/><area shape="rect" id="node22" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html" title="Glib::RefPtr\< T_CppObject \>" alt="" coords="252,405,452,435"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classGtk_1_1Assistant-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">sigc::slot</a>< int, int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a7326470851a3e83b10aa2023409e6a32">SlotForwardPage</a></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a00edd5c5e459688e1b22c1df8f585354">~Assistant</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkAssistant* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a78d17b7343a51083a6b1b9e02d32b730">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#a78d17b7343a51083a6b1b9e02d32b730"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GtkAssistant* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#ae800c8149e8e6b3daa32f61a5862ffab">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#ae800c8149e8e6b3daa32f61a5862ffab"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a907f6de87e742c7174eaa95e6a536324">Assistant</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a86f6fde497bf4e1c356f918d226510a6">get_current_page</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the page number of the current page. <a href="#a86f6fde497bf4e1c356f918d226510a6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#ad9b263c4058a718fcaf560a6a1e9d847">set_current_page</a> (int page_num)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Switches the page to <em>page_num</em>. <a href="#ad9b263c4058a718fcaf560a6a1e9d847"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#addd90d0ebcb5d5403c3e20f157ed1c39">get_n_pages</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of pages in the <em>assistant</em>. <a href="#addd90d0ebcb5d5403c3e20f157ed1c39"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1Widget.html">Widget</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#af71ab8d6e2bd0e0d5d6631190388deaa">get_nth_page</a> (int page_num)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the child widget contained in page number <em>page_num</em>. <a href="#af71ab8d6e2bd0e0d5d6631190388deaa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classGtk_1_1Widget.html">Widget</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a093c3c536d875da20eaec3081efbc175">get_nth_page</a> (int page_num) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the child widget contained in page number <em>page_num</em>. <a href="#a093c3c536d875da20eaec3081efbc175"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a25de78cb8625390ad5a41eb3163b3443">prepend_page</a> (<a class="el" href="classGtk_1_1Widget.html">Widget</a>& page)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prepends a page to the <em>assistant</em>. <a href="#a25de78cb8625390ad5a41eb3163b3443"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#ab8f7c8233130394b2180c109ae7cf71e">append_page</a> (<a class="el" href="classGtk_1_1Widget.html">Widget</a>& page)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Appends a page to the <em>assistant</em>. <a href="#ab8f7c8233130394b2180c109ae7cf71e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#abfe5aac9da831bd99cd5c64a1bd5de23">insert_page</a> (<a class="el" href="classGtk_1_1Widget.html">Widget</a>& page, int position)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inserts a page in the <em>assistant</em> at a given position. <a href="#abfe5aac9da831bd99cd5c64a1bd5de23"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#ab8cc9c392b6690da67c0b4ee4b309869">set_forward_page_func</a> (const <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">SlotForwardPage</a>& slot)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#acf47c5b95dd64ffd7415d724f18b178d">set_page_type</a> (const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& page, <a class="el" href="group__gtkmmEnums.html#ga0cc30724e08e01366c885a8051ffe635">AssistantPageType</a> <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01173.html#ga2c2933c16c723af4d77eb939438617ca">type</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the page type for <em>page</em>. <a href="#acf47c5b95dd64ffd7415d724f18b178d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__gtkmmEnums.html#ga0cc30724e08e01366c885a8051ffe635">AssistantPageType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a90b5c7f6bf1ba77d8609a92df8ba5e40">get_page_type</a> (const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& page) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the page type of <em>page</em>. <a href="#a90b5c7f6bf1ba77d8609a92df8ba5e40"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a8c146518969bda1e9a003d36a4c0a086">set_page_title</a> (const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& page, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& title)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a title for <em>page</em>. <a href="#a8c146518969bda1e9a003d36a4c0a086"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#ac24d116d8b92040c201db363a7a046b4">get_page_title</a> (const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& page) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the title for <em>page</em>. <a href="#ac24d116d8b92040c201db363a7a046b4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a8df579b8b96827711c320374f3dca85a">set_page_header_image</a> (const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& page, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> >& pixbuf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a header image for <em>page</em>. <a href="#a8df579b8b96827711c320374f3dca85a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a33901fb13ebddeabea8fa33910a6f3c1">get_page_header_image</a> (const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& page)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the header image for <em>page</em>. <a href="#a33901fb13ebddeabea8fa33910a6f3c1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a3db74dcabe52f18bc61790a70b1a9a64">get_page_header_image</a> (const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& page) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the header image for <em>page</em>. <a href="#a3db74dcabe52f18bc61790a70b1a9a64"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a144eb1e3290c8254a073eabb88caff4b">set_page_side_image</a> (const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& page, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> >& pixbuf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a header image for <em>page</em>. <a href="#a144eb1e3290c8254a073eabb88caff4b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#aa3a9d09a703d923ea5f69ddab324d58d">get_page_side_image</a> (const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& page)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the header image for <em>page</em>. <a href="#aa3a9d09a703d923ea5f69ddab324d58d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a59a448e05847cbdb768adb4002f034a3">get_page_side_image</a> (const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& page) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the header image for <em>page</em>. <a href="#a59a448e05847cbdb768adb4002f034a3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a65f6446ad7ec44df70ac55ceb859e30a">set_page_complete</a> (const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& page, bool complete=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether <em>page</em> contents are complete. <a href="#a65f6446ad7ec44df70ac55ceb859e30a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a74e1f0a27640d1c5c83e3aff7126f71d">get_page_complete</a> (const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& page) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets whether <em>page</em> is complete. <a href="#a74e1f0a27640d1c5c83e3aff7126f71d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#acaca72842488d02a69c70f5887579aef">add_action_widget</a> (<a class="el" href="classGtk_1_1Widget.html">Widget</a>& child)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a widget to the action area of a <a class="el" href="classGtk_1_1Assistant.html" title="A widget used to guide users through multi-step operations.">Gtk::Assistant</a>. <a href="#acaca72842488d02a69c70f5887579aef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a2979d33243ff74a9ef8a711960902b2f">remove_action_widget</a> (<a class="el" href="classGtk_1_1Widget.html">Widget</a>& child)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes a widget from the action area of a <a class="el" href="classGtk_1_1Assistant.html" title="A widget used to guide users through multi-step operations.">Gtk::Assistant</a>. <a href="#a2979d33243ff74a9ef8a711960902b2f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a7d791a2376d7e804e4dc598d370e7680">update_buttons_state</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Forces <em>assistant</em> to recompute the buttons state. <a href="#a7d791a2376d7e804e4dc598d370e7680"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a331e783f3f63f83392dd5506e5256d09">commit</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Erases the visited page history so the back button is not shown on the current page, and removes the cancel button from subsequent pages. <a href="#a331e783f3f63f83392dd5506e5256d09"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy1.html">Glib::SignalProxy1</a>< void, <br class="typebreak"/>
<a class="el" href="classGtk_1_1Widget.html">Gtk::Widget</a>* > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a2b73a4b19f68348fe3366d1e5cca82a9">signal_prepare</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#aa1fd7f4490c1f01e2383077503d55c49">signal_apply</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#ac3cceed1a4a33f40e299cab756452523">signal_close</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a7bfae47059d04693d83f4401f1f8a57e">signal_cancel</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#ac7b7308394dd9c5985ecd0dc69167b59">on_prepare</a> (<a class="el" href="classGtk_1_1Widget.html">Gtk::Widget</a>* page)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#aca17cedc0c87fc1b5f21113e672393a0">on_apply</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#a2f5bedd0787ccf334d4224cf24641d1e">on_close</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#af4d8858cd18fb44396c8a717e65f1751">on_cancel</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1Assistant.html">Gtk::Assistant</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Assistant.html#abf6f2a854862d49bd3c354eab9528cfb">wrap</a> (GtkAssistant* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#abf6f2a854862d49bd3c354eab9528cfb"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A widget used to guide users through multi-step operations. </p>
<p>A <a class="el" href="classGtk_1_1Assistant.html" title="A widget used to guide users through multi-step operations.">Gtk::Assistant</a> is a widget used to represent a generally complex operation split into several steps, guiding the user through its pages and controlling the page flow to collect the necessary data.</p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000022">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
</div><hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a7326470851a3e83b10aa2023409e6a32"></a><!-- doxytag: member="Gtk::Assistant::SlotForwardPage" ref="a7326470851a3e83b10aa2023409e6a32" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">sigc::slot</a><int, int > <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">Gtk::Assistant::SlotForwardPage</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a00edd5c5e459688e1b22c1df8f585354"></a><!-- doxytag: member="Gtk::Assistant::~Assistant" ref="a00edd5c5e459688e1b22c1df8f585354" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gtk::Assistant::~Assistant </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a907f6de87e742c7174eaa95e6a536324"></a><!-- doxytag: member="Gtk::Assistant::Assistant" ref="a907f6de87e742c7174eaa95e6a536324" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::Assistant::Assistant </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acaca72842488d02a69c70f5887579aef"></a><!-- doxytag: member="Gtk::Assistant::add_action_widget" ref="acaca72842488d02a69c70f5887579aef" args="(Widget &child)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Assistant::add_action_widget </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>child</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a widget to the action area of a <a class="el" href="classGtk_1_1Assistant.html" title="A widget used to guide users through multi-step operations.">Gtk::Assistant</a>. </p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000043">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">child</td><td>A <a class="el" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)">Gtk::Widget</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab8f7c8233130394b2180c109ae7cf71e"></a><!-- doxytag: member="Gtk::Assistant::append_page" ref="ab8f7c8233130394b2180c109ae7cf71e" args="(Widget &page)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Gtk::Assistant::append_page </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>page</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Appends a page to the <em>assistant</em>. </p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000029">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">page</td><td>A <a class="el" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)">Gtk::Widget</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The index (starting at 0) of the inserted page. </dd></dl>
</div>
</div>
<a class="anchor" id="a331e783f3f63f83392dd5506e5256d09"></a><!-- doxytag: member="Gtk::Assistant::commit" ref="a331e783f3f63f83392dd5506e5256d09" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Assistant::commit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
<dl class="since_2_22"><dt><b><a class="el" href="since_2_22.html#_since_2_22000052">Since gtkmm 2.22:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a86f6fde497bf4e1c356f918d226510a6"></a><!-- doxytag: member="Gtk::Assistant::get_current_page" ref="a86f6fde497bf4e1c356f918d226510a6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Gtk::Assistant::get_current_page </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the page number of the current page. </p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000023">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The index (starting from 0) of the current page in the <em>assistant</em>, if the <em>assistant</em> has no pages, -1 will be returned. </dd></dl>
</div>
</div>
<a class="anchor" id="addd90d0ebcb5d5403c3e20f157ed1c39"></a><!-- doxytag: member="Gtk::Assistant::get_n_pages" ref="addd90d0ebcb5d5403c3e20f157ed1c39" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Gtk::Assistant::get_n_pages </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of pages in the <em>assistant</em>. </p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000025">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of pages in the <em>assistant</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="af71ab8d6e2bd0e0d5d6631190388deaa"></a><!-- doxytag: member="Gtk::Assistant::get_nth_page" ref="af71ab8d6e2bd0e0d5d6631190388deaa" args="(int page_num)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1Widget.html">Widget</a>* Gtk::Assistant::get_nth_page </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>page_num</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the child widget contained in page number <em>page_num</em>. </p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000026">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">page_num</td><td>The index of a page in the <em>assistant</em>, or -1 to get the last page;. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The child widget, or <code>0</code> if <em>page_num</em> is out of bounds. </dd></dl>
</div>
</div>
<a class="anchor" id="a093c3c536d875da20eaec3081efbc175"></a><!-- doxytag: member="Gtk::Assistant::get_nth_page" ref="a093c3c536d875da20eaec3081efbc175" args="(int page_num) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classGtk_1_1Widget.html">Widget</a>* Gtk::Assistant::get_nth_page </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>page_num</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the child widget contained in page number <em>page_num</em>. </p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000027">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">page_num</td><td>The index of a page in the <em>assistant</em>, or -1 to get the last page;. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The child widget, or <code>0</code> if <em>page_num</em> is out of bounds. </dd></dl>
</div>
</div>
<a class="anchor" id="a74e1f0a27640d1c5c83e3aff7126f71d"></a><!-- doxytag: member="Gtk::Assistant::get_page_complete" ref="a74e1f0a27640d1c5c83e3aff7126f71d" args="(const Widget &page) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gtk::Assistant::get_page_complete </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>page</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets whether <em>page</em> is complete. </p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000042">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">page</td><td>A page of <em>assistant</em>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if <em>page</em> is complete. </dd></dl>
</div>
</div>
<a class="anchor" id="a33901fb13ebddeabea8fa33910a6f3c1"></a><!-- doxytag: member="Gtk::Assistant::get_page_header_image" ref="a33901fb13ebddeabea8fa33910a6f3c1" args="(const Widget &page)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>> Gtk::Assistant::get_page_header_image </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>page</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the header image for <em>page</em>. </p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000036">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">page</td><td>A page of <em>assistant</em>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The header image for <em>page</em>, or <code>0</code> if there's no header image for the page. </dd></dl>
</div>
</div>
<a class="anchor" id="a3db74dcabe52f18bc61790a70b1a9a64"></a><!-- doxytag: member="Gtk::Assistant::get_page_header_image" ref="a3db74dcabe52f18bc61790a70b1a9a64" args="(const Widget &page) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>> Gtk::Assistant::get_page_header_image </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>page</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the header image for <em>page</em>. </p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000037">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">page</td><td>A page of <em>assistant</em>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The header image for <em>page</em>, or <code>0</code> if there's no header image for the page. </dd></dl>
</div>
</div>
<a class="anchor" id="a59a448e05847cbdb768adb4002f034a3"></a><!-- doxytag: member="Gtk::Assistant::get_page_side_image" ref="a59a448e05847cbdb768adb4002f034a3" args="(const Widget &page) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>> Gtk::Assistant::get_page_side_image </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>page</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the header image for <em>page</em>. </p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000040">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">page</td><td>A page of <em>assistant</em>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The side image for <em>page</em>, or <code>0</code> if there's no side image for the page. </dd></dl>
</div>
</div>
<a class="anchor" id="aa3a9d09a703d923ea5f69ddab324d58d"></a><!-- doxytag: member="Gtk::Assistant::get_page_side_image" ref="aa3a9d09a703d923ea5f69ddab324d58d" args="(const Widget &page)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>> Gtk::Assistant::get_page_side_image </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>page</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the header image for <em>page</em>. </p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000039">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">page</td><td>A page of <em>assistant</em>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The side image for <em>page</em>, or <code>0</code> if there's no side image for the page. </dd></dl>
</div>
</div>
<a class="anchor" id="ac24d116d8b92040c201db363a7a046b4"></a><!-- doxytag: member="Gtk::Assistant::get_page_title" ref="ac24d116d8b92040c201db363a7a046b4" args="(const Widget &page) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Gtk::Assistant::get_page_title </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>page</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the title for <em>page</em>. </p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000034">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">page</td><td>A page of <em>assistant</em>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The title for <em>page</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="a90b5c7f6bf1ba77d8609a92df8ba5e40"></a><!-- doxytag: member="Gtk::Assistant::get_page_type" ref="a90b5c7f6bf1ba77d8609a92df8ba5e40" args="(const Widget &page) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__gtkmmEnums.html#ga0cc30724e08e01366c885a8051ffe635">AssistantPageType</a> Gtk::Assistant::get_page_type </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>page</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the page type of <em>page</em>. </p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000032">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">page</td><td>A page of <em>assistant</em>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The page type of <em>page</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="ae800c8149e8e6b3daa32f61a5862ffab"></a><!-- doxytag: member="Gtk::Assistant::gobj" ref="ae800c8149e8e6b3daa32f61a5862ffab" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GtkAssistant* Gtk::Assistant::gobj </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GtkObject. </p>
<p>Reimplemented from <a class="el" href="classGtk_1_1Window.html#afe314a1e65505be026688060dc98ad3a">Gtk::Window</a>.</p>
</div>
</div>
<a class="anchor" id="a78d17b7343a51083a6b1b9e02d32b730"></a><!-- doxytag: member="Gtk::Assistant::gobj" ref="a78d17b7343a51083a6b1b9e02d32b730" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkAssistant* Gtk::Assistant::gobj </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GtkObject. </p>
<p>Reimplemented from <a class="el" href="classGtk_1_1Window.html#a467102527550b51eb4036390caeedb5c">Gtk::Window</a>.</p>
</div>
</div>
<a class="anchor" id="abfe5aac9da831bd99cd5c64a1bd5de23"></a><!-- doxytag: member="Gtk::Assistant::insert_page" ref="abfe5aac9da831bd99cd5c64a1bd5de23" args="(Widget &page, int position)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Gtk::Assistant::insert_page </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>page</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>position</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Inserts a page in the <em>assistant</em> at a given position. </p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000030">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">page</td><td>A <a class="el" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)">Gtk::Widget</a>. </td></tr>
<tr><td class="paramname">position</td><td>The index (starting at 0) at which to insert the page, or -1 to append the page to the <em>assistant</em>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The index (starting from 0) of the inserted page. </dd></dl>
</div>
</div>
<a class="anchor" id="aca17cedc0c87fc1b5f21113e672393a0"></a><!-- doxytag: member="Gtk::Assistant::on_apply" ref="aca17cedc0c87fc1b5f21113e672393a0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Gtk::Assistant::on_apply </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af4d8858cd18fb44396c8a717e65f1751"></a><!-- doxytag: member="Gtk::Assistant::on_cancel" ref="af4d8858cd18fb44396c8a717e65f1751" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Gtk::Assistant::on_cancel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a2f5bedd0787ccf334d4224cf24641d1e"></a><!-- doxytag: member="Gtk::Assistant::on_close" ref="a2f5bedd0787ccf334d4224cf24641d1e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Gtk::Assistant::on_close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac7b7308394dd9c5985ecd0dc69167b59"></a><!-- doxytag: member="Gtk::Assistant::on_prepare" ref="ac7b7308394dd9c5985ecd0dc69167b59" args="(Gtk::Widget *page)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Gtk::Assistant::on_prepare </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1Widget.html">Gtk::Widget</a>* </td>
<td class="paramname"><em>page</em></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a25de78cb8625390ad5a41eb3163b3443"></a><!-- doxytag: member="Gtk::Assistant::prepend_page" ref="a25de78cb8625390ad5a41eb3163b3443" args="(Widget &page)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Gtk::Assistant::prepend_page </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>page</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Prepends a page to the <em>assistant</em>. </p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000028">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">page</td><td>A <a class="el" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)">Gtk::Widget</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The index (starting at 0) of the inserted page. </dd></dl>
</div>
</div>
<a class="anchor" id="a2979d33243ff74a9ef8a711960902b2f"></a><!-- doxytag: member="Gtk::Assistant::remove_action_widget" ref="a2979d33243ff74a9ef8a711960902b2f" args="(Widget &child)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Assistant::remove_action_widget </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>child</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes a widget from the action area of a <a class="el" href="classGtk_1_1Assistant.html" title="A widget used to guide users through multi-step operations.">Gtk::Assistant</a>. </p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000044">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">child</td><td>A <a class="el" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)">Gtk::Widget</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad9b263c4058a718fcaf560a6a1e9d847"></a><!-- doxytag: member="Gtk::Assistant::set_current_page" ref="ad9b263c4058a718fcaf560a6a1e9d847" args="(int page_num)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Assistant::set_current_page </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>page_num</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Switches the page to <em>page_num</em>. </p>
<p>Note that this will only be necessary in custom buttons, as the <em>assistant</em> flow can be set with <a class="el" href="classGtk_1_1Assistant.html#ab8cc9c392b6690da67c0b4ee4b309869">set_forward_page_func()</a>.</p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000024">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">page_num</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>assistant</em>, nothing will be done. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab8cc9c392b6690da67c0b4ee4b309869"></a><!-- doxytag: member="Gtk::Assistant::set_forward_page_func" ref="ab8cc9c392b6690da67c0b4ee4b309869" args="(const SlotForwardPage &slot)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Assistant::set_forward_page_func </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">SlotForwardPage</a> & </td>
<td class="paramname"><em>slot</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a65f6446ad7ec44df70ac55ceb859e30a"></a><!-- doxytag: member="Gtk::Assistant::set_page_complete" ref="a65f6446ad7ec44df70ac55ceb859e30a" args="(const Widget &page, bool complete=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Assistant::set_page_complete </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>page</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>complete</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets whether <em>page</em> contents are complete. </p>
<p>This will make <em>assistant</em> update the buttons state to be able to continue the task.</p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000041">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">page</td><td>A page of <em>assistant</em>. </td></tr>
<tr><td class="paramname">complete</td><td>The completeness status of the page. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8df579b8b96827711c320374f3dca85a"></a><!-- doxytag: member="Gtk::Assistant::set_page_header_image" ref="a8df579b8b96827711c320374f3dca85a" args="(const Widget &page, const Glib::RefPtr< Gdk::Pixbuf > &pixbuf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Assistant::set_page_header_image </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>page</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> >& </td>
<td class="paramname"><em>pixbuf</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a header image for <em>page</em>. </p>
<p>This image is displayed in the header area of the assistant when <em>page</em> is the current page.</p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000035">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">page</td><td>A page of <em>assistant</em>. </td></tr>
<tr><td class="paramname">pixbuf</td><td>The new header image <em>page</em>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a144eb1e3290c8254a073eabb88caff4b"></a><!-- doxytag: member="Gtk::Assistant::set_page_side_image" ref="a144eb1e3290c8254a073eabb88caff4b" args="(const Widget &page, const Glib::RefPtr< Gdk::Pixbuf > &pixbuf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Assistant::set_page_side_image </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>page</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> >& </td>
<td class="paramname"><em>pixbuf</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a header image for <em>page</em>. </p>
<p>This image is displayed in the side area of the assistant when <em>page</em> is the current page.</p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000038">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">page</td><td>A page of <em>assistant</em>. </td></tr>
<tr><td class="paramname">pixbuf</td><td>The new header image <em>page</em>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8c146518969bda1e9a003d36a4c0a086"></a><!-- doxytag: member="Gtk::Assistant::set_page_title" ref="a8c146518969bda1e9a003d36a4c0a086" args="(const Widget &page, const Glib::ustring &title)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Assistant::set_page_title </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>page</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"><em>title</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a title for <em>page</em>. </p>
<p>The title is displayed in the header area of the assistant when <em>page</em> is the current page.</p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000033">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">page</td><td>A page of <em>assistant</em>. </td></tr>
<tr><td class="paramname">title</td><td>The new title for <em>page</em>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acf47c5b95dd64ffd7415d724f18b178d"></a><!-- doxytag: member="Gtk::Assistant::set_page_type" ref="acf47c5b95dd64ffd7415d724f18b178d" args="(const Widget &page, AssistantPageType type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Assistant::set_page_type </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>page</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__gtkmmEnums.html#ga0cc30724e08e01366c885a8051ffe635">AssistantPageType</a> </td>
<td class="paramname"><em>type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the page type for <em>page</em>. </p>
<p>The page type determines the page behavior in the <em>assistant</em>.</p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000031">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">page</td><td>A page of <em>assistant</em>. </td></tr>
<tr><td class="paramname">type</td><td>The new type for <em>page</em>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa1fd7f4490c1f01e2383077503d55c49"></a><!-- doxytag: member="Gtk::Assistant::signal_apply" ref="aa1fd7f4490c1f01e2383077503d55c49" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > Gtk::Assistant::signal_apply </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_apply()</code> </dd></dl>
</div>
</div>
<a class="anchor" id="a7bfae47059d04693d83f4401f1f8a57e"></a><!-- doxytag: member="Gtk::Assistant::signal_cancel" ref="a7bfae47059d04693d83f4401f1f8a57e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > Gtk::Assistant::signal_cancel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_cancel()</code> </dd></dl>
</div>
</div>
<a class="anchor" id="ac3cceed1a4a33f40e299cab756452523"></a><!-- doxytag: member="Gtk::Assistant::signal_close" ref="ac3cceed1a4a33f40e299cab756452523" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > Gtk::Assistant::signal_close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_close()</code> </dd></dl>
</div>
</div>
<a class="anchor" id="a2b73a4b19f68348fe3366d1e5cca82a9"></a><!-- doxytag: member="Gtk::Assistant::signal_prepare" ref="a2b73a4b19f68348fe3366d1e5cca82a9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy1.html">Glib::SignalProxy1</a>< void,<a class="el" href="classGtk_1_1Widget.html">Gtk::Widget</a>* > Gtk::Assistant::signal_prepare </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_prepare(<a class="el" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)">Gtk::Widget</a>* page)</code> </dd></dl>
</div>
</div>
<a class="anchor" id="a7d791a2376d7e804e4dc598d370e7680"></a><!-- doxytag: member="Gtk::Assistant::update_buttons_state" ref="a7d791a2376d7e804e4dc598d370e7680" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Assistant::update_buttons_state </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Forces <em>assistant</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>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000045">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="abf6f2a854862d49bd3c354eab9528cfb"></a><!-- doxytag: member="Gtk::Assistant::wrap" ref="abf6f2a854862d49bd3c354eab9528cfb" args="(GtkAssistant *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1Assistant.html">Gtk::Assistant</a>* wrap </td>
<td>(</td>
<td class="paramtype">GtkAssistant * </td>
<td class="paramname"><em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>take_copy</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
<tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>gtkmm/assistant.h</li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Jun 25 2013 for gtkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
