Qt Reference Documentation

# Q3Wizard Class Reference

The Q3Wizard class provides a framework for wizard dialogs. More...

     #include <Q3Wizard>

This class is part of the Qt 3 support library. It is provided to keep old source code working. We strongly advise against using it in new code. See Porting to Qt 4 for more information.

Inherits: QDialog.

- List of all members, including inherited members
- Obsolete members

## Properties

- titleFont : QFont

- 2 properties inherited from QDialog
- 58 properties inherited from QWidget
- 1 property inherited from QObject

## Public Functions

| Q3Wizard ( QWidget * parent = 0, const char * name = 0, bool modal = false, Qt::WindowFlags f = 0 )
| ~Q3Wizard ()
virtual void | addPage ( QWidget * page, const QString & title )
virtual bool | appropriate ( QWidget * page ) const
QPushButton * | backButton () const
QPushButton * | cancelButton () const
QWidget * | currentPage () const
QPushButton * | finishButton () const
QPushButton * | helpButton () const
int | indexOf ( QWidget * page ) const
virtual void | insertPage ( QWidget * page, const QString & title, int index )
QPushButton * | nextButton () const
QWidget * | page ( int index ) const
int | pageCount () const
virtual void | removePage ( QWidget * page )
virtual void | setAppropriate ( QWidget * page, bool appropriate )
void | setTitle ( QWidget * page, const QString & title )
void | setTitleFont ( const QFont & )
virtual void | showPage ( QWidget * page )
QString | title ( QWidget * page ) const
QFont | titleFont () const

## Reimplemented Public Functions

virtual bool | eventFilter ( QObject * o, QEvent * e )

- 8 public functions inherited from QDialog
- 221 public functions inherited from QWidget
- 29 public functions inherited from QObject
- 13 public functions inherited from QPaintDevice

## Public Slots

virtual void | setBackEnabled ( QWidget * page, bool enable )
virtual void | setFinishEnabled ( QWidget * page, bool enable )
virtual void | setHelpEnabled ( QWidget * page, bool enable )
virtual void | setNextEnabled ( QWidget * page, bool enable )

- 5 public slots inherited from QDialog
- 19 public slots inherited from QWidget
- 1 public slot inherited from QObject

## Signals

void | helpClicked ()
void | selected ( const QString & title )

- 3 signals inherited from QDialog
- 1 signal inherited from QWidget
- 1 signal inherited from QObject

## Protected Functions

virtual void | layOutButtonRow ( QHBoxLayout * layout )
virtual void | layOutTitleRow ( QHBoxLayout * layout, const QString & title )

- 7 protected functions inherited from QDialog
- 37 protected functions inherited from QWidget
- 8 protected functions inherited from QObject
- 1 protected function inherited from QPaintDevice

## Protected Slots

virtual void | back ()
virtual void | help ()
virtual void | next ()

- 1 protected slot inherited from QWidget

### Additional Inherited Members

- 4 static public members inherited from QWidget
- 7 static public members inherited from QObject

## Detailed Description

The Q3Wizard 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.

Q3Wizard 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.

Q3Wizard 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.

## Property Documentation

### titleFont : QFont

This property holds the font used for page titles.

The default is QApplication::font().

Access functions:

QFont | titleFont () const
void | setTitleFont ( const QFont & )

## Member Function Documentation

### Q3Wizard::Q3Wizard ( QWidget * parent = 0, const char * name = 0, bool modal = false, Qt::WindowFlags f = 0 )

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

### Q3Wizard::~Q3Wizard ()

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

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

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

### bool Q3Wizard::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 Q3Wizard and returns false. The default implementation returns the value set using setAppropriate(). The ultimate default is true.

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

See also setAppropriate().

### void Q3Wizard::back ()`[virtual protected slot]`

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

See also appropriate().

### QPushButton * Q3Wizard::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 Q3Wizard subclass. Use setBackEnabled() to enable/disable this button.

### QPushButton * Q3Wizard::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 Q3Wizard subclass.

### QWidget * Q3Wizard::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.

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

Reimplemented from QObject::eventFilter().

### QPushButton * Q3Wizard::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 Q3Wizard subclass. Use setFinishEnabled() to enable/disable this button.

### void Q3Wizard::help ()`[virtual protected slot]`

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

### QPushButton * Q3Wizard::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 Q3Wizard subclass. Use setHelpEnabled() to enable/disable this button.

### void Q3Wizard::helpClicked ()`[signal]`

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

### int Q3Wizard::indexOf ( QWidget * page ) const

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

### void Q3Wizard::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.

### void Q3Wizard::layOutButtonRow ( QHBoxLayout * layout )`[virtual protected]`

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

layout is the horizontal layout of the entire wizard.

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

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.

### void Q3Wizard::next ()`[virtual protected slot]`

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

See also appropriate().

### QPushButton * Q3Wizard::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 Q3Wizard subclass. Use setNextEnabled() to enable/disable this button.

### QWidget * Q3Wizard::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 Q3Wizard::pageCount () const

Returns the number of pages in the wizard.

### void Q3Wizard::removePage ( QWidget * page )`[virtual]`

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

### void Q3Wizard::selected ( const QString & title )`[signal]`

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

### void Q3Wizard::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.

See also appropriate().

### void Q3Wizard::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.

### void Q3Wizard::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 Q3Wizard::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.

### void Q3Wizard::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 Q3Wizard::setTitle ( QWidget * page, const QString & title )

Sets the title for page page to title.

See also title().

### void Q3Wizard::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 Q3Wizard is shown. By reimplementing it (and calling Q3Wizard::showPage()), you can prepare each page prior to it being shown.

### QString Q3Wizard::title ( QWidget * page ) const

Returns the title of page page.

See also setTitle().