The QWizard class provides a framework for wizard dialogs. Más...

#include <qwizard.h>

Diagrama de herencias de QWizard

Slots públicos
virtual void	setBackEnabled (QWidget *, bool)
virtual void	setNextEnabled (QWidget *, bool)
virtual void	setFinishEnabled (QWidget *, bool)
virtual void	setHelpEnabled (QWidget *, bool)
virtual void	setFinish (QWidget *, bool)
virtual void	setBackEnabled (QWidget *, bool)
virtual void	setNextEnabled (QWidget *, bool)
virtual void	setFinishEnabled (QWidget *, bool)
virtual void	setHelpEnabled (QWidget *, bool)
virtual void	setFinish (QWidget *, bool)
Señales
void	helpClicked ()
void	selected (const QString &)
void	helpClicked ()
void	selected (const QString &)
Métodos públicos
	QWizard (QWidget parent=0, const char name=0, bool modal=FALSE, WFlags f=0)
	~QWizard ()
void	show ()
void	setFont (const QFont &font)
virtual void	addPage (QWidget *, const QString &)
virtual void	insertPage (QWidget *, const QString &, int)
virtual void	removePage (QWidget *)
QString	title (QWidget *) const
void	setTitle (QWidget *, const QString &)
QFont	titleFont () const
void	setTitleFont (const QFont &)
virtual void	showPage (QWidget *)
QWidget *	currentPage () const
QWidget *	page (int) const
int	pageCount () const
int	indexOf (QWidget *) const
virtual bool	appropriate (QWidget *) const
virtual void	setAppropriate (QWidget *, bool)
QPushButton *	backButton () const
QPushButton *	nextButton () const
QPushButton *	finishButton () const
QPushButton *	cancelButton () const
QPushButton *	helpButton () const
bool	eventFilter (QObject , QEvent )
	QWizard (QWidget parent=0, const char name=0, bool modal=FALSE, WFlags f=0)
	~QWizard ()
void	show ()
void	setFont (const QFont &font)
virtual void	addPage (QWidget *, const QString &)
virtual void	insertPage (QWidget *, const QString &, int)
virtual void	removePage (QWidget *)
QString	title (QWidget *) const
void	setTitle (QWidget *, const QString &)
QFont	titleFont () const
void	setTitleFont (const QFont &)
virtual void	showPage (QWidget *)
QWidget *	currentPage () const
QWidget *	page (int) const
int	pageCount () const
int	indexOf (QWidget *) const
virtual bool	appropriate (QWidget *) const
virtual void	setAppropriate (QWidget *, bool)
QPushButton *	backButton () const
QPushButton *	nextButton () const
QPushButton *	finishButton () const
QPushButton *	cancelButton () const
QPushButton *	helpButton () const
bool	eventFilter (QObject , QEvent )
Slots protegidos
virtual void	back ()
virtual void	next ()
virtual void	help ()
virtual void	back ()
virtual void	next ()
virtual void	help ()
Métodos protegidos
virtual void	layOutButtonRow (QHBoxLayout *)
virtual void	layOutTitleRow (QHBoxLayout *, const QString &)
virtual void	layOutButtonRow (QHBoxLayout *)
virtual void	layOutTitleRow (QHBoxLayout *, const QString &)
Propiedades
QFont	titleFont
	the font used for page titles

Descripción detallada

The QWizard class provides a framework for wizard dialogs.

A wizard is a special type of input dialog that consists of a sequence of dialog pages. A wizard's purpose is to walk the user through a process step by step. Wizards are useful for complex or infrequently occurring tasks that people may find difficult to learn or do.

QWizard provides page titles and displays Next, Back, Finish, Cancel, and Help push buttons, as appropriate to the current position in the page sequence. These buttons can be enabled/disabled using setBackEnabled(), setNextEnabled(), setFinishEnabled() and setHelpEnabled().

Create and populate dialog pages that inherit from QWidget and add them to the wizard using addPage(). Use insertPage() to add a dialog page at a certain position in the page sequence. Use removePage() to remove a page from the page sequence.

Use currentPage() to retrieve a pointer to the currently displayed page. page() returns a pointer to the page at a certain position in the page sequence.

Use pageCount() to retrieve the total number of pages in the page sequence. indexOf() will return the index of a page in the page sequence.

QWizard provides functionality to mark pages as appropriate (or not) in the current context with setAppropriate(). The idea is that a page may be irrelevant and should be skipped depending on the data entered by the user on a preceding page.

It is generally considered good design to provide a greater number of simple pages with fewer choices rather than a smaller number of complex pages.

Example code is available here: wizard/wizard.cpp wizard/wizard.h

qwizard.png A QWizard page A QWizard page

Documentación del constructor y destructor

QWizard::QWizard	(	QWidget *	parent = `0`,
		const char *	name = `0`,
		bool	modal = `FALSE`,
		WFlags	f = `0`
	)

Constructs an empty wizard dialog. The parent, name, modal and f arguments are passed to the QDialog constructor.

QWizard::~QWizard ( )

Destroys the object and frees any allocated resources, including all pages and controllers.

QWizard::QWizard	(	QWidget *	parent = `0`,
		const char *	name = `0`,
		bool	modal = `FALSE`,
		WFlags	f = `0`
	)

QWizard::~QWizard ( )

Documentación de las funciones miembro

void QWizard::addPage	(	QWidget *	page,
		const QString &	title
	)		`[virtual]`

Adds page to the end of the page sequence, with the title, title.

Reimplementado en QDesignerWizard.

virtual void QWizard::addPage	(	QWidget *	,
		const QString &
	)		`[virtual]`

Reimplementado en QDesignerWizard.

bool QWizard::appropriate ( QWidget * page ) const [virtual]

Called when the Next button is clicked; this virtual function returns TRUE if page is relevant for display in the current context; otherwise it is ignored by QWizard and returns FALSE. The default implementation returns the value set using setAppropriate(). The ultimate default is TRUE.

Atención:: The last page of the wizard will be displayed if no page is relevant in the current context.

virtual bool QWizard::appropriate ( QWidget * ) const [virtual]

void QWizard::back ( ) [protected, virtual, slot]

Called when the user clicks the Back button; this function shows the preceding relevant page in the sequence.

Ver también:: appropriate()

virtual void QWizard::back ( ) [protected, virtual, slot]

QPushButton * QWizard::backButton ( ) const

Returns a pointer to the dialog's Back button

By default, this button is connected to the back() slot, which is virtual so you can reimplement it in a QWizard subclass. Use setBackEnabled() to enable/disable this button.

QPushButton* QWizard::backButton ( ) const

QPushButton * QWizard::cancelButton ( ) const

Returns a pointer to the dialog's Cancel button

By default, this button is connected to the QDialog::reject() slot, which is virtual so you can reimplement it in a QWizard subclass.

QPushButton* QWizard::cancelButton ( ) const

QWidget * QWizard::currentPage ( ) const

Returns a pointer to the current page in the sequence. Although the wizard does its best to make sure that this value is never 0, it can be if you try hard enough.

QWidget* QWizard::currentPage ( ) const

bool QWizard::eventFilter	(	QObject *	o,
		QEvent *	e
	)		`[virtual]`

Reimplementado de QDialog.

bool QWizard::eventFilter	(	QObject *	o,
		QEvent *	e
	)		`[virtual]`

Reimplementado de QDialog.

QPushButton * QWizard::finishButton ( ) const

Returns a pointer to the dialog's Finish button

By default, this button is connected to the QDialog::accept() slot, which is virtual so you can reimplement it in a QWizard subclass. Use setFinishEnabled() to enable/disable this button.

QPushButton* QWizard::finishButton ( ) const

virtual void QWizard::help ( ) [protected, virtual, slot]

void QWizard::help ( ) [protected, virtual, slot]

Called when the user clicks the Help button, this function emits the helpClicked() signal.

QPushButton * QWizard::helpButton ( ) const

Returns a pointer to the dialog's Help button

By default, this button is connected to the help() slot, which is virtual so you can reimplement it in a QWizard subclass. Use setHelpEnabled() to enable/disable this button.

QPushButton* QWizard::helpButton ( ) const

void QWizard::helpClicked ( ) [signal]

This signal is emitted when the user clicks on the Help button.

int QWizard::indexOf ( QWidget * ) const

int QWizard::indexOf ( QWidget * page ) const

Returns the position of page page. If the page is not part of the wizard -1 is returned.

virtual void QWizard::insertPage	(	QWidget *	,
		const QString &	,
		int
	)		`[virtual]`

Reimplementado en QDesignerWizard.

void QWizard::insertPage	(	QWidget *	page,
		const QString &	title,
		int	index
	)		`[virtual]`

Inserts page at position index into the page sequence, with title title. If index is -1, the page will be appended to the end of the wizard's page sequence.

Reimplementado en QDesignerWizard.

void QWizard::layOutButtonRow ( QHBoxLayout * layout ) [protected, virtual]

This virtual function is responsible for adding the buttons below the bottom divider.

layout is the horizontal layout of the entire wizard.

virtual void QWizard::layOutButtonRow ( QHBoxLayout * ) [protected, virtual]

void QWizard::layOutTitleRow	(	QHBoxLayout *	layout,
		const QString &	title
	)		`[protected, virtual]`

This virtual function is responsible for laying out the title row.

layout is the horizontal layout for the wizard, and title is the title for this page. This function is called every time title changes.

virtual void QWizard::layOutTitleRow	(	QHBoxLayout *	,
		const QString &
	)		`[protected, virtual]`

virtual void QWizard::next ( ) [protected, virtual, slot]

void QWizard::next ( ) [protected, virtual, slot]

Called when the user clicks the Next button, this function shows the next relevant page in the sequence.

Ver también:: appropriate()

QPushButton * QWizard::nextButton ( ) const

Returns a pointer to the dialog's Next button

By default, this button is connected to the next() slot, which is virtual so you can reimplement it in a QWizard subclass. Use setNextEnabled() to enable/disable this button.

QPushButton* QWizard::nextButton ( ) const

QWidget* QWizard::page ( int ) const

QWidget * QWizard::page ( int index ) const

Returns a pointer to the page at position index in the sequence, or 0 if index is out of range. The first page has index 0.

int QWizard::pageCount ( ) const

Returns the number of pages in the wizard.

int QWizard::pageCount ( ) const

virtual void QWizard::removePage ( QWidget * ) [virtual]

Reimplementado en QDesignerWizard.

void QWizard::removePage ( QWidget * page ) [virtual]

Removes page from the page sequence but does not delete the page. If page is currently being displayed, QWizard will display the page that precedes it, or the first page if this was the first page.

Reimplementado en QDesignerWizard.

void QWizard::selected ( const QString & ) [signal]

void QWizard::selected ( const QString & t0 ) [signal]

This signal is emitted when the current page changes. The parameter contains the title of the selected page.

virtual void QWizard::setAppropriate	(	QWidget *	,
		bool
	)		`[virtual]`

void QWizard::setAppropriate	(	QWidget *	page,
		bool	appropriate
	)		`[virtual]`

If appropriate is TRUE then page page is considered relevant in the current context and should be displayed in the page sequence; otherwise page should not be displayed in the page sequence.

Ver también:: appropriate()

virtual void QWizard::setBackEnabled	(	QWidget *	,
		bool
	)		`[virtual, slot]`

void QWizard::setBackEnabled	(	QWidget *	page,
		bool	enable
	)		`[virtual, slot]`

If enable is TRUE, page page has a Back button; otherwise page has no Back button. By default all pages have this button.

virtual void QWizard::setFinish	(	QWidget *	,
		bool
	)		`[inline, virtual, slot]`

void QWizard::setFinish	(	QWidget *	,
		bool
	)		`[inline, virtual, slot]`

Use setFinishEnabled instead

virtual void QWizard::setFinishEnabled	(	QWidget *	,
		bool
	)		`[virtual, slot]`

void QWizard::setFinishEnabled	(	QWidget *	page,
		bool	enable
	)		`[virtual, slot]`

If enable is TRUE, page page has a Finish button; otherwise page has no Finish button. By default no page has this button.

void QWizard::setFont ( const QFont & font ) [virtual]

Reimplementado de QWidget.

void QWizard::setFont ( const QFont & font ) [virtual]

Reimplementado de QWidget.

void QWizard::setHelpEnabled	(	QWidget *	page,
		bool	enable
	)		`[virtual, slot]`

If enable is TRUE, page page has a Help button; otherwise page has no Help button. By default all pages have this button.

virtual void QWizard::setHelpEnabled	(	QWidget *	,
		bool
	)		`[virtual, slot]`

virtual void QWizard::setNextEnabled	(	QWidget *	,
		bool
	)		`[virtual, slot]`

void QWizard::setNextEnabled	(	QWidget *	page,
		bool	enable
	)		`[virtual, slot]`

If enable is TRUE, page page has a Next button; otherwise the Next button on page is disabled. By default all pages have this button.

void QWizard::setTitle	(	QWidget *	page,
		const QString &	title
	)

Sets the title for page page to title.

void QWizard::setTitle	(	QWidget *	,
		const QString &
	)

void QWizard::setTitleFont ( const QFont & )

void QWizard::setTitleFont ( const QFont & font )

void QWizard::show ( ) [virtual]

Shows the dialog as a modeless dialog. Control returns immediately to the calling code.

The dialog will be modal or modeless according to the value of the modal property.

Ver también:: exec(), modal

Reimplementado de QDialog.

void QWizard::show ( ) [virtual]

Reimplementado de QDialog.

void QWizard::showPage ( QWidget * page ) [virtual]

Makes page the current page and emits the selected() signal.

This virtual function is called whenever a different page is to be shown, including the first time the QWizard is shown. By reimplementing it (and calling QWizard::showPage()), you can prepare each page prior to it being shown.

virtual void QWizard::showPage ( QWidget * ) [virtual]

QString QWizard::title ( QWidget * page ) const

Returns the title of page page.

QString QWizard::title ( QWidget * ) const

QFont QWizard::titleFont ( ) const

Documentación de propiedades

QFont QWizard::titleFont [read, write]

the font used for page titles

The default is QApplication::font().

La documentación para esta clase fue generada a partir de los siguientes ficheros:

src/qt/include/qwizard.h
src/qt/src/dialogs/qwizard.h
src/qt/src/.moc/release-shared-mt/moc_qwizard.cpp
src/qt/src/dialogs/qwizard.cpp

Slots públicos

Señales

Métodos públicos

Slots protegidos

Métodos protegidos

Propiedades

Descripción detallada

Documentación del constructor y destructor

Documentación de las funciones miembro

Documentación de propiedades