<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qwizard.cpp -->
<title>QWizardPage Class | Qt Widgets 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtwidgets-index.html">Qt Widgets</a></td><td ><a href="qtwidgets-module.html">C++ Classes</a></td><td >QWizardPage</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QWizardPage Class</h1>
<!-- $$$QWizardPage-brief -->
<p>The <a href="qwizardpage.html">QWizardPage</a> class is the base class for wizard pages. <a href="#details">More...</a></p>
<!-- @@@QWizardPage -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QWizardPage></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += widgets</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 4.3</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qwidget.html">QWidget</a></td></tr></table></div><ul>
<li><a href="qwizardpage-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qwizardpage.html#subTitle-prop">subTitle</a></b> : QString</li>
<li class="fn"><b><a href="qwizardpage.html#title-prop">title</a></b> : QString</li>
</ul>
<ul>
<li class="fn">59 properties inherited from <a href="qwidget.html#properties">QWidget</a></li>
<li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#QWizardPage">QWizardPage</a></b>(QWidget *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#dtor.QWizardPage">~QWizardPage</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#buttonText">buttonText</a></b>(QWizard::WizardButton <i>which</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#cleanupPage">cleanupPage</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#initializePage">initializePage</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#isCommitPage">isCommitPage</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#isComplete">isComplete</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#isFinalPage">isFinalPage</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#nextId">nextId</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPixmap </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#pixmap">pixmap</a></b>(QWizard::WizardPixmap <i>which</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#setButtonText">setButtonText</a></b>(QWizard::WizardButton <i>which</i>, const QString &<i>text</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#setCommitPage">setCommitPage</a></b>(bool <i>commitPage</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#setFinalPage">setFinalPage</a></b>(bool <i>finalPage</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#setPixmap">setPixmap</a></b>(QWizard::WizardPixmap <i>which</i>, const QPixmap &<i>pixmap</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#subTitle-prop">setSubTitle</a></b>(const QString &<i>subTitle</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#title-prop">setTitle</a></b>(const QString &<i>title</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#subTitle-prop">subTitle</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#title-prop">title</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#validatePage">validatePage</a></b>()</td></tr>
</table></div>
<ul>
<li class="fn">214 public functions inherited from <a href="qwidget.html#public-functions">QWidget</a></li>
<li class="fn">32 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</a></li>
<li class="fn">14 public functions inherited from <a href="../qtgui/qpaintdevice.html#public-functions">QPaintDevice</a></li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#completeChanged">completeChanged</a></b>()</td></tr>
</table></div>
<ul>
<li class="fn">3 signals inherited from <a href="qwidget.html#signals">QWidget</a></li>
<li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h2 id="protected-functions">Protected Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#field">field</a></b>(const QString &<i>name</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#registerField">registerField</a></b>(const QString &<i>name</i>, QWidget *<i>widget</i>, const char *<i>property</i> = Q_NULLPTR, const char *<i>changedSignal</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#setField">setField</a></b>(const QString &<i>name</i>, const QVariant &<i>value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWizard *</td><td class="memItemRight bottomAlign"><b><a href="qwizardpage.html#wizard">wizard</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">35 protected functions inherited from <a href="qwidget.html#protected-functions">QWidget</a></li>
<li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li>
<li class="fn">1 protected function inherited from <a href="../qtgui/qpaintdevice.html#protected-functions">QPaintDevice</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">19 public slots inherited from <a href="qwidget.html#public-slots">QWidget</a></li>
<li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="../qtcore/qobject.html#public-variables">QObject</a></li>
<li class="fn">5 static public members inherited from <a href="qwidget.html#static-public-members">QWidget</a></li>
<li class="fn">10 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li>
<li class="fn">1 protected slot inherited from <a href="qwidget.html#protected-slots">QWidget</a></li>
<li class="fn">2 protected variables inherited from <a href="../qtcore/qobject.html#protected-variables">QObject</a></li>
<li class="fn">1 protected type inherited from <a href="../qtgui/qpaintdevice.html#protected-variables">QPaintDevice</a></li>
</ul>
<a name="details"></a>
<!-- $$$QWizardPage-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qwizardpage.html">QWizardPage</a> class is the base class for wizard pages.</p>
<p><a href="qwizard.html">QWizard</a> represents a wizard. Each page is a <a href="qwizardpage.html">QWizardPage</a>. When you create your own wizards, you can use <a href="qwizardpage.html">QWizardPage</a> directly, or you can subclass it for more control.</p>
<p>A page has the following attributes, which are rendered by <a href="qwizard.html">QWizard</a>: a <a href="qwizardpage.html#title-prop">title</a>, a <a href="qwizardpage.html#subTitle-prop">subTitle</a>, and a <a href="qwizardpage.html#setPixmap">set of pixmaps</a>. See <a href="qwizard.html#elements-of-a-wizard-page">Elements of a Wizard Page</a> for details. Once a page is added to the wizard (using <a href="qwizard.html#addPage">QWizard::addPage</a>() or <a href="qwizard.html#setPage">QWizard::setPage</a>()), <a href="qwizardpage.html#wizard">wizard</a>() returns a pointer to the associated <a href="qwizard.html">QWizard</a> object.</p>
<p>Page provides five virtual functions that can be reimplemented to provide custom behavior:</p>
<ul>
<li><a href="qwizardpage.html#initializePage">initializePage</a>() is called to initialize the page's contents when the user clicks the wizard's <b>Next</b> button. If you want to derive the page's default from what the user entered on previous pages, this is the function to reimplement.</li>
<li><a href="qwizardpage.html#cleanupPage">cleanupPage</a>() is called to reset the page's contents when the user clicks the wizard's <b>Back</b> button.</li>
<li><a href="qwizardpage.html#validatePage">validatePage</a>() validates the page when the user clicks <b>Next</b> or <b>Finish</b>. It is often used to show an error message if the user has entered incomplete or invalid information.</li>
<li><a href="qwizardpage.html#nextId">nextId</a>() returns the ID of the next page. It is useful when <a href="qwizard.html#creating-non-linear-wizards">creating non-linear wizards</a>, which allow different traversal paths based on the information provided by the user.</li>
<li><a href="qwizardpage.html#isComplete">isComplete</a>() is called to determine whether the <b>Next</b> and/or <b>Finish</b> button should be enabled or disabled. If you reimplement <a href="qwizardpage.html#isComplete">isComplete</a>(), also make sure that <a href="qwizardpage.html#completeChanged">completeChanged</a>() is emitted whenever the complete state changes.</li>
</ul>
<p>Normally, the <b>Next</b> button and the <b>Finish</b> button of a wizard are mutually exclusive. If <a href="qwizardpage.html#isFinalPage">isFinalPage</a>() returns <code>true</code>, <b>Finish</b> is available; otherwise, <b>Next</b> is available. By default, <a href="qwizardpage.html#isFinalPage">isFinalPage</a>() is true only when <a href="qwizardpage.html#nextId">nextId</a>() returns -1. If you want to show <b>Next</b> and <b>Final</b> simultaneously for a page (letting the user perform an "early finish"), call <a href="qwizardpage.html#setFinalPage">setFinalPage</a>(true) on that page. For wizards that support early finishes, you might also want to set the <a href="qwizard.html#WizardOption-enum">HaveNextButtonOnLastPage</a> and <a href="qwizard.html#WizardOption-enum">HaveFinishButtonOnEarlyPages</a> options on the wizard.</p>
<p>In many wizards, the contents of a page may affect the default values of the fields of a later page. To make it easy to communicate between pages, <a href="qwizard.html">QWizard</a> supports a <a href="qwizard.html#registering-and-using-fields">"field" mechanism</a> that allows you to register a field (e.g., a <a href="qlineedit.html">QLineEdit</a>) on a page and to access its value from any page. Fields are global to the entire wizard and make it easy for any single page to access information stored by another page, without having to put all the logic in <a href="qwizard.html">QWizard</a> or having the pages know explicitly about each other. Fields are registered using <a href="qwizardpage.html#registerField">registerField</a>() and can be accessed at any time using <a href="qwizardpage.html#field">field</a>() and <a href="qwizardpage.html#setField">setField</a>().</p>
</div>
<p><b>See also </b><a href="qwizard.html">QWizard</a>, <a href="qtwidgets-dialogs-classwizard-example.html">Class Wizard Example</a>, and <a href="qtwidgets-dialogs-licensewizard-example.html">License Wizard Example</a>.</p>
<!-- @@@QWizardPage -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$subTitle-prop$$$subTitle$$$setSubTitleconstQString& -->
<h3 class="fn" id="subTitle-prop"><a name="subTitle-prop"></a><span class="name">subTitle</span> : <span class="type"><a href="../qtcore/qstring.html">QString</a></span></h3>
<p>This property holds the subtitle of the page</p>
<p>The subtitle is shown by the <a href="qwizard.html">QWizard</a>, between the title and the actual page. Subtitles are optional. In <a href="qwizard.html#WizardStyle-enum">ClassicStyle</a> and <a href="qwizard.html#WizardStyle-enum">ModernStyle</a>, using subtitles is necessary to make the header appear. In <a href="qwizard.html#WizardStyle-enum">MacStyle</a>, the subtitle is shown as a text label just above the actual page.</p>
<p>The subtitle may be plain text or HTML, depending on the value of the <a href="qwizard.html#subTitleFormat-prop">QWizard::subTitleFormat</a> property.</p>
<p>By default, this property contains an empty string.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b>subTitle</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSubTitle</b></span>(const QString &<i>subTitle</i>)</td></tr>
</table></div>
<p><b>See also </b><a href="qwizardpage.html#title-prop">title</a>, <a href="qwizard.html#WizardOption-enum">QWizard::IgnoreSubTitles</a>, and <a href="qwizard.html#elements-of-a-wizard-page">Elements of a Wizard Page</a>.</p>
<!-- @@@subTitle -->
<!-- $$$title-prop$$$title$$$setTitleconstQString& -->
<h3 class="fn" id="title-prop"><a name="title-prop"></a><span class="name">title</span> : <span class="type"><a href="../qtcore/qstring.html">QString</a></span></h3>
<p>This property holds the title of the page</p>
<p>The title is shown by the <a href="qwizard.html">QWizard</a>, above the actual page. All pages should have a title.</p>
<p>The title may be plain text or HTML, depending on the value of the <a href="qwizard.html#titleFormat-prop">QWizard::titleFormat</a> property.</p>
<p>By default, this property contains an empty string.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b>title</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setTitle</b></span>(const QString &<i>title</i>)</td></tr>
</table></div>
<p><b>See also </b><a href="qwizardpage.html#subTitle-prop">subTitle</a> and <a href="qwizard.html#elements-of-a-wizard-page">Elements of a Wizard Page</a>.</p>
<!-- @@@title -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QWizardPage[overload1]$$$QWizardPageQWidget* -->
<h3 class="fn" id="QWizardPage"><a name="QWizardPage"></a>QWizardPage::<span class="name">QWizardPage</span>(<span class="type"><a href="qwidget.html#QWidget">QWidget</a></span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Constructs a wizard page with the given <i>parent</i>.</p>
<p>When the page is inserted into a wizard using <a href="qwizard.html#addPage">QWizard::addPage</a>() or <a href="qwizard.html#setPage">QWizard::setPage</a>(), the parent is automatically set to be the wizard.</p>
<p><b>See also </b><a href="qwizardpage.html#wizard">wizard</a>().</p>
<!-- @@@QWizardPage -->
<!-- $$$~QWizardPage[overload1]$$$~QWizardPage -->
<h3 class="fn" id="dtor.QWizardPage"><a name="dtor.QWizardPage"></a>QWizardPage::<span class="name">~QWizardPage</span>()</h3>
<p>Destructor.</p>
<!-- @@@~QWizardPage -->
<!-- $$$buttonText[overload1]$$$buttonTextQWizard::WizardButton -->
<h3 class="fn" id="buttonText"><a name="buttonText"></a><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QWizardPage::<span class="name">buttonText</span>(<span class="type"><a href="qwizard.html#WizardButton-enum">QWizard::WizardButton</a></span> <i>which</i>) const</h3>
<p>Returns the text on button <i>which</i> on this page.</p>
<p>If a text has ben set using <a href="qwizardpage.html#setButtonText">setButtonText</a>(), this text is returned. Otherwise, if a text has been set using <a href="qwizard.html#setButtonText">QWizard::setButtonText</a>(), this text is returned.</p>
<p>By default, the text on buttons depends on the <a href="qwizard.html#wizardStyle-prop">QWizard::wizardStyle</a>. For example, on macOS, the <b>Next</b> button is called <b>Continue</b>.</p>
<p><b>See also </b><a href="qwizardpage.html#setButtonText">setButtonText</a>(), <a href="qwizard.html#buttonText">QWizard::buttonText</a>(), and <a href="qwizard.html#setButtonText">QWizard::setButtonText</a>().</p>
<!-- @@@buttonText -->
<!-- $$$cleanupPage[overload1]$$$cleanupPage -->
<h3 class="fn" id="cleanupPage"><a name="cleanupPage"></a><code>[virtual] </code><span class="type">void</span> QWizardPage::<span class="name">cleanupPage</span>()</h3>
<p>This virtual function is called by <a href="qwizard.html#cleanupPage">QWizard::cleanupPage</a>() when the user leaves the page by clicking <b>Back</b> (unless the <a href="qwizard.html#WizardOption-enum">QWizard::IndependentPages</a> option is set).</p>
<p>The default implementation resets the page's fields to their original values (the values they had before <a href="qwizardpage.html#initializePage">initializePage</a>() was called).</p>
<p><b>See also </b><a href="qwizard.html#cleanupPage">QWizard::cleanupPage</a>(), <a href="qwizardpage.html#initializePage">initializePage</a>(), and <a href="qwizard.html#WizardOption-enum">QWizard::IndependentPages</a>.</p>
<!-- @@@cleanupPage -->
<!-- $$$completeChanged[overload1]$$$completeChanged -->
<h3 class="fn" id="completeChanged"><a name="completeChanged"></a><code>[signal] </code><span class="type">void</span> QWizardPage::<span class="name">completeChanged</span>()</h3>
<p>This signal is emitted whenever the complete state of the page (i.e., the value of <a href="qwizardpage.html#isComplete">isComplete</a>()) changes.</p>
<p>If you reimplement <a href="qwizardpage.html#isComplete">isComplete</a>(), make sure to emit completeChanged() whenever the value of <a href="qwizardpage.html#isComplete">isComplete</a>() changes, to ensure that <a href="qwizard.html">QWizard</a> updates the enabled or disabled state of its buttons.</p>
<p><b>See also </b><a href="qwizardpage.html#isComplete">isComplete</a>().</p>
<!-- @@@completeChanged -->
<!-- $$$field[overload1]$$$fieldconstQString& -->
<h3 class="fn" id="field"><a name="field"></a><code>[protected] </code><span class="type"><a href="../qtcore/qvariant.html">QVariant</a></span> QWizardPage::<span class="name">field</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i>name</i>) const</h3>
<p>Returns the value of the field called <i>name</i>.</p>
<p>This function can be used to access fields on any page of the wizard. It is equivalent to calling <a href="qwizardpage.html#wizard">wizard</a>()-><a href="qwizard.html#field">field</a>(<i>name</i>).</p>
<p>Example:</p>
<pre class="cpp">
<span class="type">void</span> OutputFilesPage<span class="operator">::</span>initializePage()
{
<span class="type"><a href="../qtcore/qstring.html">QString</a></span> className <span class="operator">=</span> field(<span class="string">"className"</span>)<span class="operator">.</span>toString();
headerLineEdit<span class="operator">-</span><span class="operator">></span>setText(className<span class="operator">.</span>toLower() <span class="operator">+</span> <span class="string">".h"</span>);
implementationLineEdit<span class="operator">-</span><span class="operator">></span>setText(className<span class="operator">.</span>toLower() <span class="operator">+</span> <span class="string">".cpp"</span>);
outputDirLineEdit<span class="operator">-</span><span class="operator">></span>setText(<span class="type"><a href="../qtcore/qdir.html">QDir</a></span><span class="operator">::</span>toNativeSeparators(<span class="type"><a href="../qtcore/qdir.html">QDir</a></span><span class="operator">::</span>tempPath()));
}
</pre>
<p><b>See also </b><a href="qwizard.html#field">QWizard::field</a>(), <a href="qwizardpage.html#setField">setField</a>(), and <a href="qwizardpage.html#registerField">registerField</a>().</p>
<!-- @@@field -->
<!-- $$$initializePage[overload1]$$$initializePage -->
<h3 class="fn" id="initializePage"><a name="initializePage"></a><code>[virtual] </code><span class="type">void</span> QWizardPage::<span class="name">initializePage</span>()</h3>
<p>This virtual function is called by <a href="qwizard.html#initializePage">QWizard::initializePage</a>() to prepare the page just before it is shown either as a result of <a href="qwizard.html#restart">QWizard::restart</a>() being called, or as a result of the user clicking <b>Next</b>. (However, if the <a href="qwizard.html#WizardOption-enum">QWizard::IndependentPages</a> option is set, this function is only called the first time the page is shown.)</p>
<p>By reimplementing this function, you can ensure that the page's fields are properly initialized based on fields from previous pages. For example:</p>
<pre class="cpp">
<span class="type">void</span> OutputFilesPage<span class="operator">::</span>initializePage()
{
<span class="type"><a href="../qtcore/qstring.html">QString</a></span> className <span class="operator">=</span> field(<span class="string">"className"</span>)<span class="operator">.</span>toString();
headerLineEdit<span class="operator">-</span><span class="operator">></span>setText(className<span class="operator">.</span>toLower() <span class="operator">+</span> <span class="string">".h"</span>);
implementationLineEdit<span class="operator">-</span><span class="operator">></span>setText(className<span class="operator">.</span>toLower() <span class="operator">+</span> <span class="string">".cpp"</span>);
outputDirLineEdit<span class="operator">-</span><span class="operator">></span>setText(<span class="type"><a href="../qtcore/qdir.html">QDir</a></span><span class="operator">::</span>toNativeSeparators(<span class="type"><a href="../qtcore/qdir.html">QDir</a></span><span class="operator">::</span>tempPath()));
}
</pre>
<p>The default implementation does nothing.</p>
<p><b>See also </b><a href="qwizard.html#initializePage">QWizard::initializePage</a>(), <a href="qwizardpage.html#cleanupPage">cleanupPage</a>(), and <a href="qwizard.html#WizardOption-enum">QWizard::IndependentPages</a>.</p>
<!-- @@@initializePage -->
<!-- $$$isCommitPage[overload1]$$$isCommitPage -->
<h3 class="fn" id="isCommitPage"><a name="isCommitPage"></a><span class="type">bool</span> QWizardPage::<span class="name">isCommitPage</span>() const</h3>
<p>Returns <code>true</code> if this page is a commit page; otherwise returns <code>false</code>.</p>
<p><b>See also </b><a href="qwizardpage.html#setCommitPage">setCommitPage</a>().</p>
<!-- @@@isCommitPage -->
<!-- $$$isComplete[overload1]$$$isComplete -->
<h3 class="fn" id="isComplete"><a name="isComplete"></a><code>[virtual] </code><span class="type">bool</span> QWizardPage::<span class="name">isComplete</span>() const</h3>
<p>This virtual function is called by <a href="qwizard.html">QWizard</a> to determine whether the <b>Next</b> or <b>Finish</b> button should be enabled or disabled.</p>
<p>The default implementation returns <code>true</code> if all <a href="qwizard.html#mandatory-fields">mandatory fields</a> are filled; otherwise, it returns <code>false</code>.</p>
<p>If you reimplement this function, make sure to emit <a href="qwizardpage.html#completeChanged">completeChanged</a>(), from the rest of your implementation, whenever the value of isComplete() changes. This ensures that <a href="qwizard.html">QWizard</a> updates the enabled or disabled state of its buttons. An example of the reimplementation is available <a href="http://doc.qt.io/archives/qq/qq22-qwizard.html#validatebeforeitstoolate">here</a>.</p>
<p><b>See also </b><a href="qwizardpage.html#completeChanged">completeChanged</a>() and <a href="qwizardpage.html#isFinalPage">isFinalPage</a>().</p>
<!-- @@@isComplete -->
<!-- $$$isFinalPage[overload1]$$$isFinalPage -->
<h3 class="fn" id="isFinalPage"><a name="isFinalPage"></a><span class="type">bool</span> QWizardPage::<span class="name">isFinalPage</span>() const</h3>
<p>This function is called by <a href="qwizard.html">QWizard</a> to determine whether the <b>Finish</b> button should be shown for this page or not.</p>
<p>By default, it returns <code>true</code> if there is no next page (i.e., <a href="qwizardpage.html#nextId">nextId</a>() returns -1); otherwise, it returns <code>false</code>.</p>
<p>By explicitly calling <a href="qwizardpage.html#setFinalPage">setFinalPage</a>(true), you can let the user perform an "early finish".</p>
<p><b>See also </b><a href="qwizardpage.html#isComplete">isComplete</a>() and <a href="qwizard.html#WizardOption-enum">QWizard::HaveFinishButtonOnEarlyPages</a>.</p>
<!-- @@@isFinalPage -->
<!-- $$$nextId[overload1]$$$nextId -->
<h3 class="fn" id="nextId"><a name="nextId"></a><code>[virtual] </code><span class="type">int</span> QWizardPage::<span class="name">nextId</span>() const</h3>
<p>This virtual function is called by <a href="qwizard.html#nextId">QWizard::nextId</a>() to find out which page to show when the user clicks the <b>Next</b> button.</p>
<p>The return value is the ID of the next page, or -1 if no page follows.</p>
<p>By default, this function returns the lowest ID greater than the ID of the current page, or -1 if there is no such ID.</p>
<p>By reimplementing this function, you can specify a dynamic page order. For example:</p>
<pre class="cpp">
<span class="type">int</span> IntroPage<span class="operator">::</span>nextId() <span class="keyword">const</span>
{
<span class="keyword">if</span> (evaluateRadioButton<span class="operator">-</span><span class="operator">></span>isChecked()) {
<span class="keyword">return</span> LicenseWizard<span class="operator">::</span>Page_Evaluate;
} <span class="keyword">else</span> {
<span class="keyword">return</span> LicenseWizard<span class="operator">::</span>Page_Register;
}
}
</pre>
<p><b>See also </b><a href="qwizard.html#nextId">QWizard::nextId</a>().</p>
<!-- @@@nextId -->
<!-- $$$pixmap[overload1]$$$pixmapQWizard::WizardPixmap -->
<h3 class="fn" id="pixmap"><a name="pixmap"></a><span class="type"><a href="../qtgui/qpixmap.html">QPixmap</a></span> QWizardPage::<span class="name">pixmap</span>(<span class="type"><a href="qwizard.html#WizardPixmap-enum">QWizard::WizardPixmap</a></span> <i>which</i>) const</h3>
<p>Returns the pixmap set for role <i>which</i>.</p>
<p>Pixmaps can also be set for the entire wizard using <a href="qwizard.html#setPixmap">QWizard::setPixmap</a>(), in which case they apply for all pages that don't specify a pixmap.</p>
<p><b>See also </b><a href="qwizardpage.html#setPixmap">setPixmap</a>(), <a href="qwizard.html#pixmap">QWizard::pixmap</a>(), and <a href="qwizard.html#elements-of-a-wizard-page">Elements of a Wizard Page</a>.</p>
<!-- @@@pixmap -->
<!-- $$$registerField[overload1]$$$registerFieldconstQString&QWidget*constchar*constchar* -->
<h3 class="fn" id="registerField"><a name="registerField"></a><code>[protected] </code><span class="type">void</span> QWizardPage::<span class="name">registerField</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i>name</i>, <span class="type"><a href="qwidget.html#QWidget">QWidget</a></span> *<i>widget</i>, const <span class="type">char</span> *<i>property</i> = Q_NULLPTR, const <span class="type">char</span> *<i>changedSignal</i> = Q_NULLPTR)</h3>
<p>Creates a field called <i>name</i> associated with the given <i>property</i> of the given <i>widget</i>. From then on, that property becomes accessible using <a href="qwizardpage.html#field">field</a>() and <a href="qwizardpage.html#setField">setField</a>().</p>
<p>Fields are global to the entire wizard and make it easy for any single page to access information stored by another page, without having to put all the logic in <a href="qwizard.html">QWizard</a> or having the pages know explicitly about each other.</p>
<p>If <i>name</i> ends with an asterisk (<code>*</code>), the field is a mandatory field. When a page has mandatory fields, the <b>Next</b> and/or <b>Finish</b> buttons are enabled only when all mandatory fields are filled. This requires a <i>changedSignal</i> to be specified, to tell <a href="qwizard.html">QWizard</a> to recheck the value stored by the mandatory field.</p>
<p><a href="qwizard.html">QWizard</a> knows the most common Qt widgets. For these (or their subclasses), you don't need to specify a <i>property</i> or a <i>changedSignal</i>. The table below lists these widgets:</p>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Widget</th><th >Property</th><th >Change Notification Signal</th></tr></thead>
<tr valign="top" class="odd"><td ><a href="qabstractbutton.html">QAbstractButton</a></td><td >bool <a href="qabstractbutton.html#checked-prop">checked</a></td><td ><a href="qabstractbutton.html#toggled">toggled()</a></td></tr>
<tr valign="top" class="even"><td ><a href="qabstractslider.html">QAbstractSlider</a></td><td >int <a href="qabstractslider.html#value-prop">value</a></td><td ><a href="qabstractslider.html#valueChanged">valueChanged()</a></td></tr>
<tr valign="top" class="odd"><td ><a href="qcombobox.html">QComboBox</a></td><td >int <a href="qcombobox.html#currentIndex-prop">currentIndex</a></td><td ><a href="qcombobox.html#currentIndexChanged">currentIndexChanged()</a></td></tr>
<tr valign="top" class="even"><td ><a href="qdatetimeedit.html">QDateTimeEdit</a></td><td ><a href="../qtcore/qdatetime.html">QDateTime</a> <a href="qdatetimeedit.html#dateTime-prop">dateTime</a></td><td ><a href="qdatetimeedit.html#dateTimeChanged">dateTimeChanged()</a></td></tr>
<tr valign="top" class="odd"><td ><a href="qlineedit.html">QLineEdit</a></td><td ><a href="../qtcore/qstring.html">QString</a> <a href="qlineedit.html#text-prop">text</a></td><td ><a href="qlineedit.html#textChanged">textChanged()</a></td></tr>
<tr valign="top" class="even"><td ><a href="qlistwidget.html">QListWidget</a></td><td >int <a href="qlistwidget.html#currentRow-prop">currentRow</a></td><td ><a href="qlistwidget.html#currentRowChanged">currentRowChanged()</a></td></tr>
<tr valign="top" class="odd"><td ><a href="qspinbox.html">QSpinBox</a></td><td >int <a href="qspinbox.html#value-prop">value</a></td><td ><a href="qspinbox.html#valueChanged">valueChanged()</a></td></tr>
</table></div>
<p>You can use <a href="qwizard.html#setDefaultProperty">QWizard::setDefaultProperty</a>() to add entries to this table or to override existing entries.</p>
<p>To consider a field "filled", <a href="qwizard.html">QWizard</a> simply checks that their current value doesn't equal their original value (the value they had before <a href="qwizardpage.html#initializePage">initializePage</a>() was called). For <a href="qlineedit.html">QLineEdit</a>, it also checks that <a href="qlineedit.html#acceptableInput-prop">hasAcceptableInput()</a> returns true, to honor any validator or mask.</p>
<p><a href="qwizard.html">QWizard</a>'s mandatory field mechanism is provided for convenience. It can be bypassed by reimplementing <a href="qwizardpage.html#isComplete">QWizardPage::isComplete</a>().</p>
<p><b>See also </b><a href="qwizardpage.html#field">field</a>(), <a href="qwizardpage.html#setField">setField</a>(), and <a href="qwizard.html#setDefaultProperty">QWizard::setDefaultProperty</a>().</p>
<!-- @@@registerField -->
<!-- $$$setButtonText[overload1]$$$setButtonTextQWizard::WizardButtonconstQString& -->
<h3 class="fn" id="setButtonText"><a name="setButtonText"></a><span class="type">void</span> QWizardPage::<span class="name">setButtonText</span>(<span class="type"><a href="qwizard.html#WizardButton-enum">QWizard::WizardButton</a></span> <i>which</i>, const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i>text</i>)</h3>
<p>Sets the text on button <i>which</i> to be <i>text</i> on this page.</p>
<p>By default, the text on buttons depends on the <a href="qwizard.html#wizardStyle-prop">QWizard::wizardStyle</a>, but may be redefined for the wizard as a whole using <a href="qwizard.html#setButtonText">QWizard::setButtonText</a>().</p>
<p><b>See also </b><a href="qwizardpage.html#buttonText">buttonText</a>(), <a href="qwizard.html#setButtonText">QWizard::setButtonText</a>(), and <a href="qwizard.html#buttonText">QWizard::buttonText</a>().</p>
<!-- @@@setButtonText -->
<!-- $$$setCommitPage[overload1]$$$setCommitPagebool -->
<h3 class="fn" id="setCommitPage"><a name="setCommitPage"></a><span class="type">void</span> QWizardPage::<span class="name">setCommitPage</span>(<span class="type">bool</span> <i>commitPage</i>)</h3>
<p>Sets this page to be a commit page if <i>commitPage</i> is true; otherwise, sets it to be a normal page.</p>
<p>A commit page is a page that represents an action which cannot be undone by clicking <b>Back</b> or <b>Cancel</b>.</p>
<p>A <b>Commit</b> button replaces the <b>Next</b> button on a commit page. Clicking this button simply calls <a href="qwizard.html#next">QWizard::next</a>() just like clicking <b>Next</b> does.</p>
<p>A page entered directly from a commit page has its <b>Back</b> button disabled.</p>
<p><b>See also </b><a href="qwizardpage.html#isCommitPage">isCommitPage</a>().</p>
<!-- @@@setCommitPage -->
<!-- $$$setField[overload1]$$$setFieldconstQString&constQVariant& -->
<h3 class="fn" id="setField"><a name="setField"></a><code>[protected] </code><span class="type">void</span> QWizardPage::<span class="name">setField</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i>name</i>, const <span class="type"><a href="../qtcore/qvariant.html">QVariant</a></span> &<i>value</i>)</h3>
<p>Sets the value of the field called <i>name</i> to <i>value</i>.</p>
<p>This function can be used to set fields on any page of the wizard. It is equivalent to calling <a href="qwizardpage.html#wizard">wizard</a>()-><a href="qwizard.html#setField">setField(<i>name</i>, <i>value</i>)</a>.</p>
<p><b>See also </b><a href="qwizard.html#setField">QWizard::setField</a>(), <a href="qwizardpage.html#field">field</a>(), and <a href="qwizardpage.html#registerField">registerField</a>().</p>
<!-- @@@setField -->
<!-- $$$setFinalPage[overload1]$$$setFinalPagebool -->
<h3 class="fn" id="setFinalPage"><a name="setFinalPage"></a><span class="type">void</span> QWizardPage::<span class="name">setFinalPage</span>(<span class="type">bool</span> <i>finalPage</i>)</h3>
<p>Explicitly sets this page to be final if <i>finalPage</i> is true.</p>
<p>After calling setFinalPage(true), <a href="qwizardpage.html#isFinalPage">isFinalPage</a>() returns <code>true</code> and the <b>Finish</b> button is visible (and enabled if <a href="qwizardpage.html#isComplete">isComplete</a>() returns true).</p>
<p>After calling setFinalPage(false), <a href="qwizardpage.html#isFinalPage">isFinalPage</a>() returns <code>true</code> if <a href="qwizardpage.html#nextId">nextId</a>() returns -1; otherwise, it returns <code>false</code>.</p>
<p><b>See also </b><a href="qwizardpage.html#isFinalPage">isFinalPage</a>(), <a href="qwizardpage.html#isComplete">isComplete</a>(), and <a href="qwizard.html#WizardOption-enum">QWizard::HaveFinishButtonOnEarlyPages</a>.</p>
<!-- @@@setFinalPage -->
<!-- $$$setPixmap[overload1]$$$setPixmapQWizard::WizardPixmapconstQPixmap& -->
<h3 class="fn" id="setPixmap"><a name="setPixmap"></a><span class="type">void</span> QWizardPage::<span class="name">setPixmap</span>(<span class="type"><a href="qwizard.html#WizardPixmap-enum">QWizard::WizardPixmap</a></span> <i>which</i>, const <span class="type"><a href="../qtgui/qpixmap.html">QPixmap</a></span> &<i>pixmap</i>)</h3>
<p>Sets the pixmap for role <i>which</i> to <i>pixmap</i>.</p>
<p>The pixmaps are used by <a href="qwizard.html">QWizard</a> when displaying a page. Which pixmaps are actually used depend on the <a href="qwizard.html#wizard-look-and-feel">wizard style</a>.</p>
<p>Pixmaps can also be set for the entire wizard using <a href="qwizard.html#setPixmap">QWizard::setPixmap</a>(), in which case they apply for all pages that don't specify a pixmap.</p>
<p><b>See also </b><a href="qwizardpage.html#pixmap">pixmap</a>(), <a href="qwizard.html#setPixmap">QWizard::setPixmap</a>(), and <a href="qwizard.html#elements-of-a-wizard-page">Elements of a Wizard Page</a>.</p>
<!-- @@@setPixmap -->
<!-- $$$validatePage[overload1]$$$validatePage -->
<h3 class="fn" id="validatePage"><a name="validatePage"></a><code>[virtual] </code><span class="type">bool</span> QWizardPage::<span class="name">validatePage</span>()</h3>
<p>This virtual function is called by <a href="qwizard.html#validateCurrentPage">QWizard::validateCurrentPage</a>() when the user clicks <b>Next</b> or <b>Finish</b> to perform some last-minute validation. If it returns <code>true</code>, the next page is shown (or the wizard finishes); otherwise, the current page stays up.</p>
<p>The default implementation returns <code>true</code>.</p>
<p>When possible, it is usually better style to disable the <b>Next</b> or <b>Finish</b> button (by specifying <a href="qwizard.html#mandatory-fields">mandatory fields</a> or reimplementing <a href="qwizardpage.html#isComplete">isComplete</a>()) than to reimplement validatePage().</p>
<p><b>See also </b><a href="qwizard.html#validateCurrentPage">QWizard::validateCurrentPage</a>() and <a href="qwizardpage.html#isComplete">isComplete</a>().</p>
<!-- @@@validatePage -->
<!-- $$$wizard[overload1]$$$wizard -->
<h3 class="fn" id="wizard"><a name="wizard"></a><code>[protected] </code><span class="type"><a href="qwizard.html">QWizard</a></span> *QWizardPage::<span class="name">wizard</span>() const</h3>
<p>Returns the wizard associated with this page, or 0 if this page hasn't been inserted into a <a href="qwizard.html">QWizard</a> yet.</p>
<p><b>See also </b><a href="qwizard.html#addPage">QWizard::addPage</a>() and <a href="qwizard.html#setPage">QWizard::setPage</a>().</p>
<!-- @@@wizard -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
distrib
>
Mageia
>
6
>
armv5tl
>
media
>
core-updates
>
by-pkgid
>
768f7d9f703884aa2562bf0a651086df
>
files
>
4649
