Base class for wizard pages. More...

Inheritance diagram for QWizardPage:

Public Signals
void	completeChanged ()

Public Signals inherited from QWidget
void	customContextMenuRequested (const QPoint &pos)

void	windowIconChanged (const QIcon &icon)

void	windowIconTextChanged (const QString &iconText)

void	windowTitleChanged (const QString &title)

Public Signals inherited from QObject
void	destroyed (QObject *obj=nullptr)

void	objectNameChanged (const QString &objectName)

Public Methods
	QWizardPage (QWidget *parent=nullptr)

QString	buttonText (QWizard::WizardButton which) const

virtual void	cleanupPage ()

virtual void	initializePage ()

bool	isCommitPage () const

virtual bool	isComplete () const

bool	isFinalPage () const

virtual int	nextId () const

QPixmap	pixmap (QWizard::WizardPixmap which) const

void	setButtonText (QWizard::WizardButton which, const QString &text)

void	setCommitPage (bool commitPage)

void	setFinalPage (bool finalPage)

void	setPixmap (QWizard::WizardPixmap which, const QPixmap &pixmap)

void	setSubTitle (const QString &subTitle)

void	setTitle (const QString &title)

QString	subTitle () const

QString	title () const

virtual bool	validatePage ()

Public Methods inherited from QWidget
	QWidget (QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::EmptyFlag)

	~QWidget ()

bool	acceptDrops () const

QString	accessibleDescription () const

QString	accessibleName () const

QList< QAction * >	actions () const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (const QList< QAction * > &actions)

void	adjustSize ()

bool	autoFillBackground () const

QPalette::ColorRole	backgroundRole () const

QBackingStore *	backingStore () const

QSize	baseSize () const

QWidget *	childAt (const QPoint &position) const

QWidget *	childAt (int x, int y) const

QRect	childrenRect () const

QRegion	childrenRegion () const

void	clearFocus ()

void	clearMask ()

QMargins	contentsMargins () const

QRect	contentsRect () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

QCursor	cursor () const

WId	effectiveWinId () const

void	ensurePolished () const

Qt::FocusPolicy	focusPolicy () const

QWidget *	focusProxy () const

QWidget *	focusWidget () const

const QFont &	font () const

QFontInfo	fontInfo () const

QFontMetrics	fontMetrics () const

QPalette::ColorRole	foregroundRole () const

QRect	frameGeometry () const

QSize	frameSize () const

const QRect &	geometry () const

void	getContentsMargins (int left, int top, int right, int bottom) const

QPixmap	grab (const QRect &rectangle=QRect (QPoint (0, 0), QSize (-1,-1)))

void	grabGesture (Qt::GestureType gestureType, Qt::GestureFlags flags=Qt::GestureFlags ())

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)

QGraphicsEffect *	graphicsEffect () const

QGraphicsProxyWidget *	graphicsProxyWidget () const

bool	hasEditFocus () const

bool	hasFocus () const

virtual bool	hasHeightForWidth () const

bool	hasMouseTracking () const

int	height () const

virtual int	heightForWidth (int width) const

Qt::InputMethodHints	inputMethodHints () const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const

bool	isAncestorOf (const QWidget *child) const

bool	isEnabled () const

bool	isEnabledTo (const QWidget *parent) const

bool	isEnabledToTLW () const

bool	isFullScreen () const

bool	isHidden () const

bool	isMaximized () const

bool	isMinimized () const

bool	isModal () const

bool	isTopLevel () const

bool	isVisible () const

bool	isVisibleTo (const QWidget *parent) const

bool	isWindow () const

bool	isWindowModified () const

QLayout *	layout () const

Qt::LayoutDirection	layoutDirection () const

QLocale	locale () const

QPoint	mapFrom (const QWidget *parent, const QPoint &pos) const

QPoint	mapFromGlobal (const QPoint &pos) const

QPoint	mapFromParent (const QPoint &pos) const

QPoint	mapTo (const QWidget *parent, const QPoint &pos) const

QPoint	mapToGlobal (const QPoint &pos) const

QPoint	mapToParent (const QPoint &pos) const

QRegion	mask () const

int	maximumHeight () const

QSize	maximumSize () const

int	maximumWidth () const

int	minimumHeight () const

QSize	minimumSize () const

virtual QSize	minimumSizeHint () const

int	minimumWidth () const

void	move (const QPoint &point)

void	move (int x, int y)

QWidget *	nativeParentWidget () const

QWidget *	nextInFocusChain () const

QRect	normalGeometry () const

void	overrideWindowFlags (Qt::WindowFlags flags)

QPaintEngine *	paintEngine () const override

const QPalette &	palette () const

QWidget *	parentWidget () const

QPoint	pos () const

QWidget *	previousInFocusChain () const

QRect	rect () const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset=QPoint (), const QRegion &sourceRegion=QRegion (), RenderFlags renderFlags=RenderFlags (DrawWindowBackground\|DrawChildren))

void	render (QPainter *painter, const QPoint &targetOffset=QPoint (), const QRegion &sourceRegion=QRegion (), RenderFlags renderFlags=RenderFlags (DrawWindowBackground\|DrawChildren))

void	repaint (const QRect &rect)

void	repaint (const QRegion &region)

void	repaint (int x, int y, int w, int h)

void	resize (const QSize &size)

void	resize (int w, int h)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &rect)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setAttribute (Qt::WidgetAttribute attribute, bool enable=true)

void	setAutoFillBackground (bool enable)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &size)

void	setBaseSize (int basew, int baseh)

void	setContentsMargins (const QMargins &margins)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &cursor)

void	setEditFocus (bool enable)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &size)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus (Qt::FocusReason reason)

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *widget)

void	setFont (const QFont &font)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (const QRect &rect)

void	setGeometry (int x, int y, int w, int h)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setInputMethodHints (Qt::InputMethodHints hints)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &size)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (const QSize &size)

void	setMinimumSize (int minw, int minh)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &palette)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, Qt::WindowFlags flags)

void	setShortcutAutoRepeat (int id, bool enable=true)

void	setShortcutEnabled (int id, bool enable=true)

void	setSizeIncrement (const QSize &size)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy policy)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setStatusTip (const QString &data)

void	setStyle (QStyle *style)

void	setToolTip (const QString &data)

void	setToolTipDuration (int msec)

void	setUpdatesEnabled (bool enable)

void	setWhatsThis (const QString &str)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlags (Qt::WindowFlags flags)

void	setWindowIcon (const QIcon &icon)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (Qt::WindowStates windowState)

QSize	size () const

virtual QSize	sizeHint () const

QSize	sizeIncrement () const

QSizePolicy	sizePolicy () const

void	stackUnder (QWidget *widget)

QString	statusTip () const

QStyle *	style () const

QString	styleSheet () const

bool	testAttribute (Qt::WidgetAttribute attribute) const

QString	toolTip () const

int	toolTipDuration () const

QWidget *	topLevelWidget () const

bool	underMouse () const

void	ungrabGesture (Qt::GestureType gestureType)

void	unsetCursor ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	update (const QRect &rect)

void	update (const QRegion &region)

void	update (int x, int y, int w, int h)

void	updateGeometry ()

bool	updatesEnabled () const

QRegion	visibleRegion () const

QString	whatsThis () const

int	width () const

QWidget *	window () const

QString	windowFilePath () const

Qt::WindowFlags	windowFlags () const

QWindow *	windowHandle () const

QIcon	windowIcon () const

Qt::WindowModality	windowModality () const

qreal	windowOpacity () const

QString	windowRole () const

Qt::WindowStates	windowState () const

QString	windowTitle () const

Qt::WindowType	windowType () const

WId	winId () const

int	x () const

int	y () const

Public Methods inherited from QObject
	QObject (QObject *parent=nullptr)

	~QObject ()

bool	blockSignals (bool block)

const QList< QObject * > &	children () const

bool	connect (const QObject *sender, const QString &signalMethod, const QString &location, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)

bool	connect (const QObject *sender, const QString &signalMethod, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)

bool	disconnect (const QObject *receiver, const QString &slotMethod=QString ()) const

bool	disconnect (const QString &signalMethod, const QString &location, const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const

bool	disconnect (const QString &signalMethod=QString (), const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QString >	dynamicPropertyNames () const

virtual bool	event (QEvent *event)

virtual bool	eventFilter (QObject watched, QEvent event)

template<typename T >
T	findChild (const QString &childName=QString ()) const

template<class T >
QList< T >	findChildren (const QRegularExpression &regExp, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<class T >
QList< T >	findChildren (const QString &childName=QString (), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

bool	inherits (const QString &className) const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const

bool	isWindowType () const

void	killTimer (int id)

const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

QString	objectName () const

QObject *	parent () const

template<class T = QVariant>
T	property (const QString &name) const

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const QString &name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)

QThread *	thread () const

Public Methods inherited from QPaintDevice
virtual	~QPaintDevice ()

int	colorCount () const

int	depth () const

int	devicePixelRatio () const

qreal	devicePixelRatioF () const

int	height () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

bool	paintingActive () const

int	physicalDpiX () const

int	physicalDpiY () const

int	width () const

int	widthMM () const

Protected Methods
QVariant	field (const QString &name) const

void	registerField (const QString &name, QWidget *widget, const QString &property=QString (), const QString &changedSignal=QString ())

void	setField (const QString &name, const QVariant &value)

QWizard *	wizard () const

Protected Methods inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	changeEvent (QEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

void	create (WId window=0, bool initializeWindow=true, bool destroyOldWindow=true)

void	destroy (bool destroyWindow=true, bool destroySubWindows=true)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEvent *event)

bool	event (QEvent *event) override

virtual void	focusInEvent (QFocusEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

void	initPainter (QPainter *painter) const override

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	leaveEvent (QEvent *event)

int	metric (PaintDeviceMetric metric) const override

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual bool	nativeEvent (const QByteArray &eventType, void message, long result)

virtual void	paintEvent (QPaintEvent *event)

virtual void	resizeEvent (QResizeEvent *event)

virtual void	showEvent (QShowEvent *event)

virtual void	tabletEvent (QTabletEvent *event)

virtual void	wheelEvent (QWheelEvent *event)

Protected Methods inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signalMethod) const

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signalMethod) const

bool	isSignalConnected (const QMetaMethod &signalMethod) const

int	receivers (const QString &signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Protected Methods inherited from QPaintDevice
	QPaintDevice ()

Properties
	subTitle

	title

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	toolTip

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Friends
class	QWizard

Additional Inherited Members
Public Typedefs inherited from QWidget
using	RenderFlags = QFlags< RenderFlag >

Public Types inherited from QWidget
enum	RenderFlag

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric

Public Slots inherited from QWidget
bool	close ()

void	hide ()

void	lower ()

void	raise ()

void	repaint ()

void	setDisabled (bool disable)

void	setEnabled (bool enable)

void	setFocus ()

void	setHidden (bool hidden)

void	setStyleSheet (const QString &styleSheet)

virtual void	setVisible (bool visible)

void	setWindowModified (bool modified)

void	setWindowTitle (const QString &title)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

void	update ()

Public Slots inherited from QObject
void	deleteLater ()

Static Public Methods inherited from QWidget
static QWidget *	createWindowContainer (QWindow window, QWidget parent=nullptr, Qt::WindowFlags flags=Qt::EmptyFlag)

static QWidget *	find (WId id)

static QWidget *	keyboardGrabber ()

static QWidget *	mouseGrabber ()

static void	setTabOrder (QWidget firstWidget, QWidget secondWidget)

Static Public Methods inherited from QObject
static bool	connect (const QObject sender, const QMetaMethod &signalMethod, const QObject receiver, const QMetaMethod &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)

static bool	connect (const QObject sender, const QString &signalMethod, const QObject receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection, const QString &location=QString ())

static bool	connect (const QObject sender, const QString &signalMethod, const QString &location, const QObject receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)

template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool	connect (const Sender sender, void (SignalClass::signalMethod)(SignalArgs...), const Receiver receiver, SlotReturn (SlotClass::slotMethod)(SlotArgs...), Qt::ConnectionType type=Qt::AutoConnection)

template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool	connect (const Sender sender, void (SignalClass::signalMethod)(SignalArgs...), const Receiver *receiver, T slotLambda, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const QMetaMethod &signalMethod, const QObject receiver, const QMetaMethod &slotMethod)

static bool	disconnect (const QObject sender, const QString &signalMethod, const QObject receiver, const QString &slotMethod)

static bool	disconnect (const QObject sender, const QString &signalMethod, const QString &location, const QObject receiver, const QString &slotMethod)

static bool	disconnect (const QObject sender, std::nullptr_t, const QObject receiver, std::nullptr_t)

template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool	disconnect (const Sender sender, void (SignalClass::signalMethod)(SignalArgs...), const Receiver receiver, SlotReturn (SlotClass::slotMethod)(SlotArgs...))

template<class Sender , class SignalClass , class... SignalArgs, class Receiver >
static bool	disconnect (const Sender sender, void (SignalClass::signalMethod)(SignalArgs...), const Receiver *receiver, std::nullptr_t slotMethod=nullptr)

template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool	disconnect (const Sender sender, void (SignalClass::signalMethod)(SignalArgs...), const Receiver *receiver, T slotMethod)

static QMetaObject &	staticMetaObject ()

static QString	tr (const char text, const char comment=nullptr, std::optional< int > numArg=std::optional< int >())

Protected Slots inherited from QWidget
void	updateMicroFocus ()

Related Functions inherited from QWidget
	QWidgetList

	WId

Related Functions inherited from QObject
T	qobject_cast (QObject *object)

	QObjectList

Detailed Description

The QWizardPage class is the base class for wizard pages. A wizard page has a title, subTitle, and a set of pixmaps. A page is added to a QWizard using QWizard::addPage() or QWizard::setPage(). The contents of one page can affect the default values of the fields on a later page. To communicate between pages QWizard supports a "field" mechanism. Fields are registered using registerField() and the values can be accessed at any time by calling field() and setField(). Any registered field can be accessed from any page.

Customizing Pages

There are five virtual methods which can be used to provide custom behavior. Iherit from QWizardPage and reimplemented any or all of these methods.

initializePage(): Initialize the page's contents when the user clicks the wizard's Next button. If you want to derive the page's default from what the user entered on previous pages, reimplement this method.
cleanupPage(): Reset the page's contents when the user clicks the wizard's Back button.
validatePage(): Validates the page when the user clicks Next or Finish. It is often used to show an error message if the user has entered incomplete or invalid information.
nextId(): Returns the ID of the next page. It is useful when creating non-linear wizards, which allow different traversal paths based on the information provided by the user.
isComplete(): Determines whether the Next and/or Finish buttons should be enabled or disabled. If you reimplement isComplete() make sure the completeChanged() signal is emitted when the complete state changes.

Displaying Buttons

The following rules are used to determine when the various wizard buttons should be displayed.

Normally the Next button and the Finish button are mutually exclusive.

If isFinalPage() returns true the Finish button will be available, otherwise Next is displayed.

To show the Next and Final buttons simultaneously call setFinalPage(true) for that page.

For wizards which can finish early set the QWizard::HaveNextButtonOnLastPage and QWizard::HaveFinishButtonOnEarlyPages options on the wizard.

See also: QWizard

Constructor & Destructor Documentation

QWizardPage::QWizardPage ( QWidget * parent = nullptr )

explicit

Constructs a QWizardPage with the given parent. The page is added to an existing QWizard using QWizard::addPage() or QWizard::setPage() and the parent is automatically set to the QWizard.

QWizardPage *somePage()
{
   QWizardPage *page = new QWizardPage;
 
   // ...
 
   return page;
}
 
QWizard *wizard = new QWizard;
wizard->addPage(somePage());

See also: wizard()

Method Documentation

QString QWizardPage::buttonText ( QWizard::WizardButton which ) const

Returns the text on the button corresponding to the enum value which for this QWizardPage. If text was set using setButtonText(), the custom text is returned. By default the text on a button depends on the QWizard::wizardStyle. For example, on Mac OS X the Next button is called Continue.

See also: setButtonText(), QWizard::buttonText(), QWizard::setButtonText()

void QWizardPage::cleanupPage ( )

virtual

Called by QWizard::cleanupPage() to clean up the page with the given id. This method is called when the user clicks the Back button. If QWizard::IndependentPages option is set this method will not be invoked. The default implementation resets the page's fields to their original values.

See also: initializePage(), QWizard::cleanupPage(), QWizard::WizardOption

void QWizardPage::completeChanged ( )

signal

This signal is emitted when the complete state of the page changes. If you override the method isComplete() make sure to emit completeChanged() when the value of isComplete() changes. This will ensure QWizard updates the enabled or disabled state of its buttons.

See also: isComplete()

QVariant QWizardPage::field ( const QString & name ) const

protected

Returns the value of the field called name. This method can be used to access fields on any page of the wizard. Equivalent to calling QWizard::field(name).

See also: setField(), initializePage(), registerField(), QWizard::field()

void QWizardPage::initializePage ( )

virtual

Called by QWizard::initializePage() to prepare the page just before it is shown either as a result of QWizard::restart() being called or as a result of the user clicking Next. If the QWizard::IndependentPages option is set this method is only called the first time the page is shown.

The default implementation does nothing. If you override this method ensure the page fields are properly initialized.

void OutputFilesPage::initializePage()
{
    QString data = field("className").toString();
 
    headerLineEdit->setText(data.toLower() + ".h");
    implementationLineEdit->setText(data.toLower() + ".cpp");
    outputDirLineEdit->setText(QDir::toNativeSeparators(QDir::tempPath()));
}

See also: cleanupPage(), QWizard::initializePage(), QWizard::WizardOption

bool QWizardPage::isCommitPage ( ) const

Returns true if this page is a commit page, otherwise returns false.

See also: setCommitPage()

bool QWizardPage::isComplete ( ) const

virtual

Called by QWizard to determine whether the Next or Finish button should be enabled or disabled. The default implementation returns true if all mandatory fields are filled, otherwise returns false. If you override this method emit completeChanged() when the value of isComplete() changes. This ensures QWizard will update the enabled or disabled state of its buttons.

See also: completeChanged(), isFinalPage()

bool QWizardPage::isFinalPage ( ) const

This method is called by QWizard to determine whether the Finish button should be shown for this page or not. By default this method returns true if there is no next page, otherwise returns false. By calling setFinalPage(true) the user can complete the wizard early.

See also: isComplete(), QWizard::WizardOption

int QWizardPage::nextId ( ) const

virtual

Called by QWizard::nextId() to find out which page to show when the user clicks the Next button. The return value is the ID of the next page or -1 if no page follows the current page. By default this method returns the lowest ID greater than the ID of the current page. If you override this method a specific page ID can be returned.

int IntroPage::nextId() const
{
   if (evaluateRadioButton->isChecked()) {
      return LicenseWizard::Page_Evaluate;
   } else {
      return LicenseWizard::Page_Register;
   }
}

See also: QWizard::nextId()

QPixmap QWizardPage::pixmap ( QWizard::WizardPixmap which ) const

Returns the pixmap set for role which. Pixmaps can also be set for the entire wizard using QWizard::setPixmap() in which case they apply for all pages that do not specify a pixmap.

See also: setPixmap(), QWizard::pixmap(), Elements of a Wizard Page

void QWizardPage::registerField	(	const QString &	name,
		QWidget *	widget,
		const QString &	property = `QString()`,
		const QString &	changedSignal = `QString()`
	)

protected

Creates a field called name associated with the given property of the given widget. From then on, that property becomes accessible using field() and setField(). 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 QWizard or having the pages know explicitly about each other.

If name ends with an asterisk the field is a mandatory field. When a page has mandatory fields, the Next and/or Finish buttons are enabled only when all mandatory fields are filled. This requires a changedSignal to be specified, to tell QWizard to recheck the value stored by the mandatory field.

To consider a field "filled" QWizard compares the current value of the field to the original value. If they are different the field is considered filled. For QLineEdit and QAbstractSpinBox subclasses, QWizard also checks that hasAcceptableInput() returns true.

QWizard knows the most common CopperSpice widgets. For the following classes or child classes, you do not need to specify a property or a changedSignal. This table shows the widgets which are supported automatically in QWizard. Use QWizard::setDefaultProperty() to support other classes or override existing values.

Widget	Property	Change Notification Signal
QAbstractButton	bool checked	toggled()
QAbstractSlider	int value	valueChanged()
QComboBox	int currentIndex	currentIndexChanged()
QDateTimeEdit	QDateTime dateTime	dateTimeChanged()
QLineEdit	QString text	textChanged()
QListWidget	int currentRow	currentRowChanged()
QSpinBox	int value	valueChanged()

See also: field(), setField(), QWizard::setDefaultProperty()

void QWizardPage::setButtonText	(	QWizard::WizardButton	which,
		const QString &	text
	)

Sets the text on the button corresponding to the enum value which to the given text on this QWizardPage. By default the text on a button depends on the QWizard::wizardStyle.

See also: buttonText(), QWizard::buttonText(), QWizard::setButtonText()

void QWizardPage::setCommitPage ( bool commitPage )

Sets this QWizardPage to be a commit page if commitPage is true, otherwise sets it to be a normal page. A commit page is a page which represents an action that can not be undone by clicking Back or Cancel. A Commit button replaces the Next button on a commit page. Clicking the Commit button calls QWizard::next() just like clicking Next. A page entered directly from a commit page has its Back button disabled.

See also: isCommitPage()

void QWizardPage::setField	(	const QString &	name,
		const QVariant &	value
	)

protected

Sets the value of the field name to value. This method can be used to set fields on any page of the wizard. Equivalent to calling QWizard::setField(name, value).

See also: field(), registerField(), QWizard::setField()

void QWizardPage::setFinalPage ( bool finalPage )

Sets this page to be final if finalPage is true. After calling setFinalPage(true), isFinalPage() returns true and the Finish button is visible. After calling setFinalPage(false) the method isFinalPage() returns true if nextId() returns -1, otherwise returns false.

See also: isFinalPage(), isComplete(), nextId(), QWizard::WizardOption

void QWizardPage::setPixmap	(	QWizard::WizardPixmap	which,
		const QPixmap &	pixmap
	)

Sets the pixmap for role which to pixmap. The pixmaps are used by QWizard when displaying a page. The exact pixmap displayed depends on the wizard style. Pixmaps can also be set for the entire wizard using QWizard::setPixmap() in which case they apply for all pages that do not specify a pixmap.

See also: pixmap(), QWizard::setPixmap(), Elements of a Wizard Page

void QWizardPage::setSubTitle ( const QString & subTitle )

Sets the value of the QWizardPage::subTitle property to subTitle.

void QWizardPage::setTitle ( const QString & title )

Sets the value of the QWizardPage::title property to title.

QString QWizardPage::subTitle ( ) const

Returns the value of the QWizardPage::subTitle property.

QString QWizardPage::title ( ) const

Returns the value of the QWizardPage::title property.

bool QWizardPage::validatePage ( )

virtual

Called by QWizard::validateCurrentPage() to perform validation when the user clicks Next or Finish. If this methods returns true the next page is shown or the wizard finishes. If false is returned the current page will remain active. The default implementation returns true.

It is usually better to disable the Next or Finish buttons by specifying mandatory fields or reimplementing the isComplete() method.

See also: isComplete(), QWizard::validateCurrentPage()

QWizard * QWizardPage::wizard ( ) const

protected

Returns the QWizard associated with this QWizardPage or nullptr if this page has not been inserted into a QWizard.

See also: QWizard::addPage(), QWizard::setPage()

Property Documentation

QWizardPage::subTitle

This property holds the subtitle of the page. The subtitle is shown by the QWizard between the title and the contents of the page. By default this property contains an empty string and subtitles are optional.

In QWizardStyle::ClassicStyle and QWizardStyle::ModernStyle using a subtitle is necessary to make the header appear. In QWizardStyle::MacStyle the subtitle is shown as a text label just above the actual page. The subtitle may be plain text or HTML, depending on the value of the QWizard::subTitleFormat property.

See also: QWizardPage::title, QWizard::WizardOption, Elements of a Wizard Page

Properties	Class Methods
read	subTitle
write	setSubTitle

QWizardPage::title

This property holds the title of the page. The title is shown by the QWizard above the actual page. All pages should have a title. The title may be plain text or HTML, depending on the value of the QWizard::titleFormat property. By default this property contains an empty string.

See also: subTitle, Elements of a Wizard Page

Properties	Class Methods
read	title
write	setTitle

Public Signals

Public Methods

Protected Methods

Properties

Friends

Additional Inherited Members

Detailed Description

Customizing Pages

Displaying Buttons

Constructor & Destructor Documentation

Method Documentation

Property Documentation