Struct qt_widgets::QWizard

#[repr(C)]
pub struct QWizard { /* fields omitted */ }

The QWizard class provides a framework for wizards.

C++ class: QWizard.

C++ documentation:

The QWizard class provides a framework for wizards.

A wizard (also called an assistant on macOS) is a special type of input dialog that consists of a sequence of pages. A wizard's purpose is to guide the user through a process step by step. Wizards are useful for complex or infrequent tasks that users may find difficult to learn.

QWizard inherits QDialog and represents a wizard. Each page is a QWizardPage (a QWidget subclass). To create your own wizards, you can use these classes directly, or you can subclass them for more control.

Topics:

Methods

impl QWizard

pub fn current_id_changed(&self) -> Signal<(c_int,)>

This signal is emitted when the current page changes, with the new current id.

Returns a built-in Qt signal QWizard::currentIdChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted when the current page changes, with the new current id.

Note: Notifier signal for property currentId.

See also currentId() and currentPage().

pub fn help_requested(&self) -> Signal<()>

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

Returns a built-in Qt signal QWizard::helpRequested that can be passed to qt_core::Signal::connect.

C++ documentation:

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

By default, no Help button is shown. Call setOption(HaveHelpButton, true) to have one.

Example:

LicenseWizard::LicenseWizard(QWidget *parent)
      : QWizard(parent)
{
      ...
      setOption(HaveHelpButton, true);
      connect(this, &QWizard::helpRequested, this, &LicenseWizard::showHelp);
      ...
}
void LicenseWizard::showHelp()
{
      static QString lastHelpMessage;
      QString message;
      switch (currentId()) {
      case Page_Intro:
          message = tr("The decision you make here will affect which page you "
                       "get to see next.");
          break;
      ...
      default:
          message = tr("This help is likely not to be of any help.");
      }
      QMessageBox::information(this, tr("License Wizard Help"), message);
}

See also customButtonClicked().

pub fn custom_button_clicked(&self) -> Signal<(c_int,)>

This signal is emitted when the user clicks a custom button. which can be CustomButton1, CustomButton2, or CustomButton3.

Returns a built-in Qt signal QWizard::customButtonClicked that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted when the user clicks a custom button. which can be CustomButton1, CustomButton2, or CustomButton3.

By default, no custom button is shown. Call setOption() with HaveCustomButton1, HaveCustomButton2, or HaveCustomButton3 to have one, and use setButtonText() or setButton() to configure it.

See also helpRequested().

pub fn page_added(&self) -> Signal<(c_int,)>

This signal is emitted whenever a page is added to the wizard. The page's id is passed as parameter.

Returns a built-in Qt signal QWizard::pageAdded that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted whenever a page is added to the wizard. The page's id is passed as parameter.

This function was introduced in Qt 4.7.

See also addPage(), setPage(), and startId().

pub fn page_removed(&self) -> Signal<(c_int,)>

This signal is emitted whenever a page is removed from the wizard. The page's id is passed as parameter.

Returns a built-in Qt signal QWizard::pageRemoved that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted whenever a page is removed from the wizard. The page's id is passed as parameter.

This function was introduced in Qt 4.7.

See also removePage() and startId().

pub fn slot_back(&self) -> Receiver<()>

Goes back to the previous page.

Returns a built-in Qt slot QWizard::back that can be passed to qt_core::Signal::connect.

C++ documentation:

Goes back to the previous page.

This is equivalent to pressing the Back button.

See also next(), accept(), reject(), and restart().

pub fn slot_next(&self) -> Receiver<()>

Advances to the next page.

Returns a built-in Qt slot QWizard::next that can be passed to qt_core::Signal::connect.

C++ documentation:

Advances to the next page.

This is equivalent to pressing the Next or Commit button.

See also nextId(), back(), accept(), reject(), and restart().

pub fn slot_restart(&self) -> Receiver<()>

Restarts the wizard at the start page. This function is called automatically when the wizard is shown.

Returns a built-in Qt slot QWizard::restart that can be passed to qt_core::Signal::connect.

C++ documentation:

Restarts the wizard at the start page. This function is called automatically when the wizard is shown.

See also startId().

pub unsafe fn add_page(
    &mut self,
    page: impl CastInto<MutPtr<QWizardPage>>
) -> c_int

Adds the given page to the wizard, and returns the page's ID.

Calls C++ function: int QWizard::addPage(QWizardPage* page).

C++ documentation:

Adds the given page to the wizard, and returns the page's ID.

The ID is guaranteed to be larger than any other ID in the QWizard so far.

See also setPage(), page(), and pageAdded().

pub unsafe fn back(&mut self)

Goes back to the previous page.

Calls C++ function: [slot] void QWizard::back().

C++ documentation:

Goes back to the previous page.

This is equivalent to pressing the Back button.

See also next(), accept(), reject(), and restart().

pub unsafe fn button(&self, which: WizardButton) -> MutPtr<QAbstractButton>

Returns the button corresponding to role which.

Calls C++ function: QAbstractButton* QWizard::button(QWizard::WizardButton which) const.

C++ documentation:

Returns the button corresponding to role which.

See also setButton() and setButtonText().

pub unsafe fn button_text(&self, which: WizardButton) -> CppBox<QString>

Returns the text on button which.

Calls C++ function: QString QWizard::buttonText(QWizard::WizardButton which) const.

C++ documentation:

Returns the text on button which.

If a text has ben set using setButtonText(), this text is returned.

By default, the text on buttons depends on the wizardStyle. For example, on macOS, the Next button is called Continue.

See also button(), setButton(), setButtonText(), QWizardPage::buttonText(), and QWizardPage::setButtonText().

pub unsafe fn current_id(&self) -> c_int

This property holds the ID of the current page

Calls C++ function: int QWizard::currentId() const.

C++ documentation:

This property holds the ID of the current page

This property cannot be set directly. To change the current page, call next(), back(), or restart().

By default, this property has a value of -1, indicating that no page is currently shown.

Access functions:

int	currentId() const

Notifier signal:

void	currentIdChanged(int id)

See also currentPage().

pub unsafe fn current_page(&self) -> MutPtr<QWizardPage>

Returns a pointer to the current page, or 0 if there is no current page (e.g., before the wizard is shown).

Calls C++ function: QWizardPage* QWizard::currentPage() const.

C++ documentation:

Returns a pointer to the current page, or 0 if there is no current page (e.g., before the wizard is shown).

This is equivalent to calling page(currentId()).

See also page(), currentId(), and restart().

pub unsafe fn field(
    &self,
    name: impl CastInto<Ref<QString>>
) -> CppBox<QVariant>

Returns the value of the field called name.

Calls C++ function: QVariant QWizard::field(const QString& name) const.

C++ documentation:

Returns the value of the field called name.

This function can be used to access fields on any page of the wizard.

See also QWizardPage::registerField(), QWizardPage::field(), and setField().

pub unsafe fn has_visited_page(&self, id: c_int) -> bool

Returns true if the page history contains page id; otherwise, returns false.

Calls C++ function: bool QWizard::hasVisitedPage(int id) const.

C++ documentation:

Returns true if the page history contains page id; otherwise, returns false.

Pressing Back marks the current page as "unvisited" again.

See also visitedPages().

pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>

Calls C++ function: virtual const QMetaObject* QWizard::metaObject() const.

pub unsafe fn new_2a(
    parent: impl CastInto<MutPtr<QWidget>>,
    flags: QFlags<WindowType>
) -> CppBox<QWizard>

Constructs a wizard with the given parent and window flags.

Calls C++ function: [constructor] void QWizard::QWizard(QWidget* parent = …, QFlags<Qt::WindowType> flags = …).

C++ documentation:

Constructs a wizard with the given parent and window flags.

See also parent() and windowFlags().

pub unsafe fn new_0a() -> CppBox<QWizard>

The QWizard class provides a framework for wizards.

Calls C++ function: [constructor] void QWizard::QWizard().

C++ documentation:

The QWizard class provides a framework for wizards.

A wizard (also called an assistant on macOS) is a special type of input dialog that consists of a sequence of pages. A wizard's purpose is to guide the user through a process step by step. Wizards are useful for complex or infrequent tasks that users may find difficult to learn.

QWizard inherits QDialog and represents a wizard. Each page is a QWizardPage (a QWidget subclass). To create your own wizards, you can use these classes directly, or you can subclass them for more control.

Topics:

pub unsafe fn new_1a(parent: impl CastInto<MutPtr<QWidget>>) -> CppBox<QWizard>

Constructs a wizard with the given parent and window flags.

Calls C++ function: [constructor] void QWizard::QWizard(QWidget* parent = …).

C++ documentation:

Constructs a wizard with the given parent and window flags.

See also parent() and windowFlags().

pub unsafe fn next(&mut self)

Advances to the next page.

Calls C++ function: [slot] void QWizard::next().

C++ documentation:

Advances to the next page.

This is equivalent to pressing the Next or Commit button.

See also nextId(), back(), accept(), reject(), and restart().

pub unsafe fn next_id(&self) -> c_int

This virtual function is called by QWizard to find out which page to show when the user clicks the Next button.

Calls C++ function: virtual int QWizard::nextId() const.

C++ documentation:

This virtual function is called by QWizard 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 default implementation calls QWizardPage::nextId() on the currentPage().

By reimplementing this function, you can specify a dynamic page order.

See also QWizardPage::nextId() and currentPage().

pub unsafe fn options(&self) -> QFlags<WizardOption>

This property holds the various options that affect the look and feel of the wizard

Calls C++ function: QFlags<QWizard::WizardOption> QWizard::options() const.

C++ documentation:

This property holds the various options that affect the look and feel of the wizard

By default, the following options are set (depending on the platform):

• Windows: HelpButtonOnRight.
• macOS: NoDefaultButton and NoCancelButton.
• X11 and QWS (Qt for Embedded Linux): none.

Access functions:

WizardOptions	options() const
void	setOptions(WizardOptions options)

See also wizardStyle.

pub unsafe fn page(&self, id: c_int) -> MutPtr<QWizardPage>

Returns the page with the given id, or 0 if there is no such page.

Calls C++ function: QWizardPage* QWizard::page(int id) const.

C++ documentation:

Returns the page with the given id, or 0 if there is no such page.

See also addPage() and setPage().

pub unsafe fn page_ids(&self) -> CppBox<QListOfInt>

Returns the list of page IDs.

Calls C++ function: QList<int> QWizard::pageIds() const.

C++ documentation:

Returns the list of page IDs.

This function was introduced in Qt 4.5.

pub unsafe fn pixmap(&self, which: WizardPixmap) -> CppBox<QPixmap>

Returns the pixmap set for role which.

Calls C++ function: QPixmap QWizard::pixmap(QWizard::WizardPixmap which) const.

C++ documentation:

Returns the pixmap set for role which.

By default, the only pixmap that is set is the BackgroundPixmap on macOS.

See also setPixmap(), QWizardPage::pixmap(), and Elements of a Wizard Page.

pub unsafe fn qt_metacall(
    &mut self,
    arg1: Call,
    arg2: c_int,
    arg3: impl CastInto<MutPtr<*mut c_void>>
) -> c_int

Calls C++ function: virtual int QWizard::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3).

pub unsafe fn qt_metacast(
    &mut self,
    arg1: impl CastInto<Ptr<c_char>>
) -> MutPtr<c_void>

Calls C++ function: virtual void* QWizard::qt_metacast(const char* arg1).

pub unsafe fn remove_page(&mut self, id: c_int)

Removes the page with the given id. cleanupPage() will be called if necessary.

Calls C++ function: void QWizard::removePage(int id).

C++ documentation:

Removes the page with the given id. cleanupPage() will be called if necessary.

Note: Removing a page may influence the value of the startId property.

This function was introduced in Qt 4.5.

See also addPage(), setPage(), pageRemoved(), and startId().

pub unsafe fn restart(&mut self)

Restarts the wizard at the start page. This function is called automatically when the wizard is shown.

Calls C++ function: [slot] void QWizard::restart().

C++ documentation:

Restarts the wizard at the start page. This function is called automatically when the wizard is shown.

See also startId().

pub unsafe fn set_button(
    &mut self,
    which: WizardButton,
    button: impl CastInto<MutPtr<QAbstractButton>>
)

Sets the button corresponding to role which to button.

Calls C++ function: void QWizard::setButton(QWizard::WizardButton which, QAbstractButton* button).

C++ documentation:

Sets the button corresponding to role which to button.

To add extra buttons to the wizard (e.g., a Print button), one way is to call setButton() with CustomButton1 to CustomButton3, and make the buttons visible using the HaveCustomButton1 to HaveCustomButton3 options.

See also button(), setButtonText(), setButtonLayout(), and options.

pub unsafe fn set_button_layout(
    &mut self,
    layout: impl CastInto<Ref<QListOfWizardButton>>
)

Sets the order in which buttons are displayed to layout, where layout is a list of WizardButtons.

Calls C++ function: void QWizard::setButtonLayout(const QList<QWizard::WizardButton>& layout).

C++ documentation:

Sets the order in which buttons are displayed to layout, where layout is a list of WizardButtons.

The default layout depends on the options (e.g., whether HelpButtonOnRight) that are set. You can call this function if you need more control over the buttons' layout than what options already provides.

You can specify horizontal stretches in the layout using Stretch.

Example:

MyWizard::MyWizard(QWidget *parent)
      : QWizard(parent)
{
      ...
      QList<QWizard::WizardButton> layout;
      layout << QWizard::Stretch << QWizard::BackButton << QWizard::CancelButton
             << QWizard::NextButton << QWizard::FinishButton;
      setButtonLayout(layout);
      ...
}

See also setButton(), setButtonText(), and setOptions().

pub unsafe fn set_button_text(
    &mut self,
    which: WizardButton,
    text: impl CastInto<Ref<QString>>
)

Sets the text on button which to be text.

Calls C++ function: void QWizard::setButtonText(QWizard::WizardButton which, const QString& text).

C++ documentation:

Sets the text on button which to be text.

By default, the text on buttons depends on the wizardStyle. For example, on macOS, the Next button is called Continue.

To add extra buttons to the wizard (e.g., a Print button), one way is to call setButtonText() with CustomButton1, CustomButton2, or CustomButton3 to set their text, and make the buttons visible using the HaveCustomButton1, HaveCustomButton2, and/or HaveCustomButton3 options.

Button texts may also be set on a per-page basis using QWizardPage::setButtonText().

See also buttonText(), setButton(), button(), setButtonLayout(), setOptions(), and QWizardPage::setButtonText().

pub unsafe fn set_default_property(
    &mut self,
    class_name: impl CastInto<Ptr<c_char>>,
    property: impl CastInto<Ptr<c_char>>,
    changed_signal: impl CastInto<Ptr<c_char>>
)

Sets the default property for className to be property, and the associated change signal to be changedSignal.

Calls C++ function: void QWizard::setDefaultProperty(const char* className, const char* property, const char* changedSignal).

C++ documentation:

Sets the default property for className to be property, and the associated change signal to be changedSignal.

The default property is used when an instance of className (or of one of its subclasses) is passed to QWizardPage::registerField() and no property is specified.

QWizard knows the most common Qt widgets. For these (or their subclasses), you don't need to specify a property or a changedSignal. The table below lists these widgets:

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 QWizardPage::registerField().

pub unsafe fn set_field(
    &mut self,
    name: impl CastInto<Ref<QString>>,
    value: impl CastInto<Ref<QVariant>>
)

Sets the value of the field called name to value.

Calls C++ function: void QWizard::setField(const QString& name, const QVariant& value).

C++ documentation:

Sets the value of the field called name to value.

This function can be used to set fields on any page of the wizard.

See also QWizardPage::registerField(), QWizardPage::setField(), and field().

pub unsafe fn set_option_2a(&mut self, option: WizardOption, on: bool)

Sets the given option to be enabled if on is true; otherwise, clears the given option.

Calls C++ function: void QWizard::setOption(QWizard::WizardOption option, bool on = …).

C++ documentation:

Sets the given option to be enabled if on is true; otherwise, clears the given option.

See also options, testOption(), and setWizardStyle().

pub unsafe fn set_option_1a(&mut self, option: WizardOption)

Sets the given option to be enabled if on is true; otherwise, clears the given option.

Calls C++ function: void QWizard::setOption(QWizard::WizardOption option).

C++ documentation:

Sets the given option to be enabled if on is true; otherwise, clears the given option.

See also options, testOption(), and setWizardStyle().

pub unsafe fn set_options(&mut self, options: QFlags<WizardOption>)

This property holds the various options that affect the look and feel of the wizard

Calls C++ function: void QWizard::setOptions(QFlags<QWizard::WizardOption> options).

C++ documentation:

This property holds the various options that affect the look and feel of the wizard

By default, the following options are set (depending on the platform):

• Windows: HelpButtonOnRight.
• macOS: NoDefaultButton and NoCancelButton.
• X11 and QWS (Qt for Embedded Linux): none.

Access functions:

WizardOptions	options() const
void	setOptions(WizardOptions options)

See also wizardStyle.

pub unsafe fn set_page(
    &mut self,
    id: c_int,
    page: impl CastInto<MutPtr<QWizardPage>>
)

Adds the given page to the wizard with the given id.

Calls C++ function: void QWizard::setPage(int id, QWizardPage* page).

C++ documentation:

Adds the given page to the wizard with the given id.

Note: Adding a page may influence the value of the startId property in case it was not set explicitly.

See also addPage(), page(), and pageAdded().

pub unsafe fn set_pixmap(
    &mut self,
    which: WizardPixmap,
    pixmap: impl CastInto<Ref<QPixmap>>
)

Sets the pixmap for role which to pixmap.

Calls C++ function: void QWizard::setPixmap(QWizard::WizardPixmap which, const QPixmap& pixmap).

C++ documentation:

Sets the pixmap for role which to pixmap.

The pixmaps are used by QWizard when displaying a page. Which pixmaps are actually used depend on the wizard style.

Pixmaps can also be set for a specific page using QWizardPage::setPixmap().

See also pixmap(), QWizardPage::setPixmap(), and Elements of a Wizard Page.

pub unsafe fn set_side_widget(&mut self, widget: impl CastInto<MutPtr<QWidget>>)

Sets the given widget to be shown on the left side of the wizard. For styles which use the WatermarkPixmap (ClassicStyle and ModernStyle) the side widget is displayed on top of the watermark, for other styles or when the watermark is not provided the side widget is displayed on the left side of the wizard.

Calls C++ function: void QWizard::setSideWidget(QWidget* widget).

C++ documentation:

Sets the given widget to be shown on the left side of the wizard. For styles which use the WatermarkPixmap (ClassicStyle and ModernStyle) the side widget is displayed on top of the watermark, for other styles or when the watermark is not provided the side widget is displayed on the left side of the wizard.

Passing 0 shows no side widget.

When the widget is not 0 the wizard reparents it.

Any previous side widget is hidden.

You may call setSideWidget() with the same widget at different times.

All widgets set here will be deleted by the wizard when it is destroyed unless you separately reparent the widget after setting some other side widget (or 0).

By default, no side widget is present.

This function was introduced in Qt 4.7.

See also sideWidget().

pub unsafe fn set_start_id(&mut self, id: c_int)

This property holds the ID of the first page

Calls C++ function: void QWizard::setStartId(int id).

C++ documentation:

This property holds the ID of the first page

If this property isn't explicitly set, this property defaults to the lowest page ID in this wizard, or -1 if no page has been inserted yet.

Access functions:

int	startId() const
void	setStartId(int id)

See also restart() and nextId().

pub unsafe fn set_sub_title_format(&mut self, format: TextFormat)

This property holds the text format used by page subtitles

Calls C++ function: void QWizard::setSubTitleFormat(Qt::TextFormat format).

C++ documentation:

This property holds the text format used by page subtitles

The default format is Qt::AutoText.

Access functions:

Qt::TextFormat	subTitleFormat() const
void	setSubTitleFormat(Qt::TextFormat format)

See also QWizardPage::title and titleFormat.

pub unsafe fn set_title_format(&mut self, format: TextFormat)

This property holds the text format used by page titles

Calls C++ function: void QWizard::setTitleFormat(Qt::TextFormat format).

C++ documentation:

This property holds the text format used by page titles

The default format is Qt::AutoText.

Access functions:

Qt::TextFormat	titleFormat() const
void	setTitleFormat(Qt::TextFormat format)

See also QWizardPage::title and subTitleFormat.

pub unsafe fn set_visible(&mut self, visible: bool)

Reimplemented from QWidget::setVisible().

Calls C++ function: virtual void QWizard::setVisible(bool visible).

C++ documentation:

Reimplemented from QWidget::setVisible().

pub unsafe fn set_wizard_style(&mut self, style: WizardStyle)

This property holds the look and feel of the wizard

Calls C++ function: void QWizard::setWizardStyle(QWizard::WizardStyle style).

C++ documentation:

This property holds the look and feel of the wizard

By default, QWizard uses the AeroStyle on a Windows Vista system with alpha compositing enabled, regardless of the current widget style. If this is not the case, the default wizard style depends on the current widget style as follows: MacStyle is the default if the current widget style is QMacStyle, ModernStyle is the default if the current widget style is QWindowsStyle, and ClassicStyle is the default in all other cases.

Access functions:

WizardStyle	wizardStyle() const
void	setWizardStyle(WizardStyle style)

See also Wizard Look and Feel and options.

pub unsafe fn side_widget(&self) -> MutPtr<QWidget>

Returns the widget on the left side of the wizard or 0.

Calls C++ function: QWidget* QWizard::sideWidget() const.

C++ documentation:

Returns the widget on the left side of the wizard or 0.

By default, no side widget is present.

This function was introduced in Qt 4.7.

See also setSideWidget().

pub unsafe fn size_hint(&self) -> CppBox<QSize>

Reimplemented from QWidget::sizeHint().

Calls C++ function: virtual QSize QWizard::sizeHint() const.

C++ documentation:

Reimplemented from QWidget::sizeHint().

pub unsafe fn start_id(&self) -> c_int

This property holds the ID of the first page

Calls C++ function: int QWizard::startId() const.

C++ documentation:

This property holds the ID of the first page

If this property isn't explicitly set, this property defaults to the lowest page ID in this wizard, or -1 if no page has been inserted yet.

Access functions:

int	startId() const
void	setStartId(int id)

See also restart() and nextId().

pub unsafe fn static_meta_object() -> Ref<QMetaObject>

Returns a reference to the staticMetaObject field.

pub unsafe fn sub_title_format(&self) -> TextFormat

This property holds the text format used by page subtitles

Calls C++ function: Qt::TextFormat QWizard::subTitleFormat() const.

C++ documentation:

This property holds the text format used by page subtitles

The default format is Qt::AutoText.

Access functions:

Qt::TextFormat	subTitleFormat() const
void	setSubTitleFormat(Qt::TextFormat format)

See also QWizardPage::title and titleFormat.

pub unsafe fn test_option(&self, option: WizardOption) -> bool

Returns true if the given option is enabled; otherwise, returns false.

Calls C++ function: bool QWizard::testOption(QWizard::WizardOption option) const.

C++ documentation:

Returns true if the given option is enabled; otherwise, returns false.

See also options, setOption(), and setWizardStyle().

pub unsafe fn title_format(&self) -> TextFormat

This property holds the text format used by page titles

Calls C++ function: Qt::TextFormat QWizard::titleFormat() const.

C++ documentation:

This property holds the text format used by page titles

The default format is Qt::AutoText.

Access functions:

Qt::TextFormat	titleFormat() const
void	setTitleFormat(Qt::TextFormat format)

See also QWizardPage::title and subTitleFormat.

pub unsafe fn tr(
    s: impl CastInto<Ptr<c_char>>,
    c: impl CastInto<Ptr<c_char>>,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString QWizard::tr(const char* s, const char* c, int n).

pub unsafe fn tr_utf8(
    s: impl CastInto<Ptr<c_char>>,
    c: impl CastInto<Ptr<c_char>>,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString QWizard::trUtf8(const char* s, const char* c, int n).

pub unsafe fn validate_current_page(&mut self) -> bool

This virtual function is called by QWizard when the user clicks Next or Finish to perform some last-minute validation. If it returns true, the next page is shown (or the wizard finishes); otherwise, the current page stays up.

Calls C++ function: virtual bool QWizard::validateCurrentPage().

C++ documentation:

This virtual function is called by QWizard when the user clicks Next or Finish to perform some last-minute validation. If it returns true, the next page is shown (or the wizard finishes); otherwise, the current page stays up.

The default implementation calls QWizardPage::validatePage() on the currentPage().

When possible, it is usually better style to disable the Next or Finish button (by specifying mandatory fields or by reimplementing QWizardPage::isComplete()) than to reimplement validateCurrentPage().

See also QWizardPage::validatePage() and currentPage().

pub unsafe fn visited_pages(&self) -> CppBox<QListOfInt>

Returns the list of IDs of visited pages, in the order in which the pages were visited.

Calls C++ function: QList<int> QWizard::visitedPages() const.

C++ documentation:

Returns the list of IDs of visited pages, in the order in which the pages were visited.

Pressing Back marks the current page as "unvisited" again.

See also hasVisitedPage().

pub unsafe fn wizard_style(&self) -> WizardStyle

This property holds the look and feel of the wizard

Calls C++ function: QWizard::WizardStyle QWizard::wizardStyle() const.

C++ documentation:

This property holds the look and feel of the wizard

By default, QWizard uses the AeroStyle on a Windows Vista system with alpha compositing enabled, regardless of the current widget style. If this is not the case, the default wizard style depends on the current widget style as follows: MacStyle is the default if the current widget style is QMacStyle, ModernStyle is the default if the current widget style is QWindowsStyle, and ClassicStyle is the default in all other cases.

Access functions:

WizardStyle	wizardStyle() const
void	setWizardStyle(WizardStyle style)

See also Wizard Look and Feel and options.

Methods from Deref<Target = QDialog>

pub fn finished(&self) -> Signal<(c_int,)>

This signal is emitted when the dialog's result code has been set, either by the user or by calling done(), accept(), or reject().

Returns a built-in Qt signal QDialog::finished that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted when the dialog's result code has been set, either by the user or by calling done(), accept(), or reject().

Note that this signal is not emitted when hiding the dialog with hide() or setVisible(false). This includes deleting the dialog while it is visible.

This function was introduced in Qt 4.1.

See also accepted() and rejected().

pub fn accepted(&self) -> Signal<()>

This signal is emitted when the dialog has been accepted either by the user or by calling accept() or done() with the QDialog::Accepted argument.

Returns a built-in Qt signal QDialog::accepted that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted when the dialog has been accepted either by the user or by calling accept() or done() with the QDialog::Accepted argument.

Note that this signal is not emitted when hiding the dialog with hide() or setVisible(false). This includes deleting the dialog while it is visible.

This function was introduced in Qt 4.1.

See also finished() and rejected().

pub fn rejected(&self) -> Signal<()>

This signal is emitted when the dialog has been rejected either by the user or by calling reject() or done() with the QDialog::Rejected argument.

Returns a built-in Qt signal QDialog::rejected that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted when the dialog has been rejected either by the user or by calling reject() or done() with the QDialog::Rejected argument.

Note that this signal is not emitted when hiding the dialog with hide() or setVisible(false). This includes deleting the dialog while it is visible.

This function was introduced in Qt 4.1.

See also finished() and accepted().

pub fn slot_open(&self) -> Receiver<()>

Shows the dialog as a window modal dialog, returning immediately.

Returns a built-in Qt slot QDialog::open that can be passed to qt_core::Signal::connect.

C++ documentation:

Shows the dialog as a window modal dialog, returning immediately.

This function was introduced in Qt 4.5.

See also exec(), show(), result(), and setWindowModality().

pub fn slot_exec(&self) -> Receiver<()>

Shows the dialog as a modal dialog, blocking until the user closes it. The function returns a DialogCode result.

Returns a built-in Qt slot QDialog::exec that can be passed to qt_core::Signal::connect.

C++ documentation:

Shows the dialog as a modal dialog, blocking until the user closes it. The function returns a DialogCode result.

If the dialog is application modal, users cannot interact with any other window in the same application until they close the dialog. If the dialog is window modal, only interaction with the parent window is blocked while the dialog is open. By default, the dialog is application modal.

See also open(), show(), result(), and setWindowModality().

pub fn slot_done(&self) -> Receiver<(c_int,)>

Closes the dialog and sets its result code to r. If this dialog is shown with exec(), done() causes the local event loop to finish, and exec() to return r.

Returns a built-in Qt slot QDialog::done that can be passed to qt_core::Signal::connect.

C++ documentation:

Closes the dialog and sets its result code to r. If this dialog is shown with exec(), done() causes the local event loop to finish, and exec() to return r.

As with QWidget::close(), done() deletes the dialog if the Qt::WA_DeleteOnClose flag is set. If the dialog is the application's main widget, the application terminates. If the dialog is the last window closed, the QApplication::lastWindowClosed() signal is emitted.

See also accept(), reject(), QApplication::activeWindow(), and QCoreApplication::quit().

pub fn slot_accept(&self) -> Receiver<()>

Hides the modal dialog and sets the result code to Accepted.

Returns a built-in Qt slot QDialog::accept that can be passed to qt_core::Signal::connect.

C++ documentation:

Hides the modal dialog and sets the result code to Accepted.

See also reject() and done().

pub fn slot_reject(&self) -> Receiver<()>

Hides the modal dialog and sets the result code to Rejected.

Returns a built-in Qt slot QDialog::reject that can be passed to qt_core::Signal::connect.

C++ documentation:

Hides the modal dialog and sets the result code to Rejected.

See also accept() and done().

pub fn slot_show_extension(&self) -> Receiver<(bool,)>

If showIt is true, the dialog's extension is shown; otherwise the extension is hidden.

Returns a built-in Qt slot QDialog::showExtension that can be passed to qt_core::Signal::connect.

C++ documentation:

If showIt is true, the dialog's extension is shown; otherwise the extension is hidden.

Instead of using this functionality, we recommend that you simply call show() or hide() on the part of the dialog that you want to use as an extension. See the Extension Example for details.

See also show(), setExtension(), and setOrientation().

pub unsafe fn accept(&mut self)

Hides the modal dialog and sets the result code to Accepted.

Calls C++ function: virtual [slot] void QDialog::accept().

C++ documentation:

Hides the modal dialog and sets the result code to Accepted.

See also reject() and done().

pub unsafe fn done(&mut self, arg1: c_int)

Closes the dialog and sets its result code to r. If this dialog is shown with exec(), done() causes the local event loop to finish, and exec() to return r.

Calls C++ function: virtual [slot] void QDialog::done(int arg1).

C++ documentation:

Closes the dialog and sets its result code to r. If this dialog is shown with exec(), done() causes the local event loop to finish, and exec() to return r.

As with QWidget::close(), done() deletes the dialog if the Qt::WA_DeleteOnClose flag is set. If the dialog is the application's main widget, the application terminates. If the dialog is the last window closed, the QApplication::lastWindowClosed() signal is emitted.

See also accept(), reject(), QApplication::activeWindow(), and QCoreApplication::quit().

pub unsafe fn exec(&mut self) -> c_int

Shows the dialog as a modal dialog, blocking until the user closes it. The function returns a DialogCode result.

Calls C++ function: virtual [slot] int QDialog::exec().

C++ documentation:

Shows the dialog as a modal dialog, blocking until the user closes it. The function returns a DialogCode result.

If the dialog is application modal, users cannot interact with any other window in the same application until they close the dialog. If the dialog is window modal, only interaction with the parent window is blocked while the dialog is open. By default, the dialog is application modal.

See also open(), show(), result(), and setWindowModality().

pub unsafe fn extension(&self) -> MutPtr<QWidget>

Returns the dialog's extension or 0 if no extension has been defined.

Calls C++ function: QWidget* QDialog::extension() const.

C++ documentation:

Returns the dialog's extension or 0 if no extension has been defined.

Instead of using this functionality, we recommend that you simply call show() or hide() on the part of the dialog that you want to use as an extension. See the Extension Example for details.

See also setExtension(), showExtension(), and setOrientation().

pub unsafe fn is_size_grip_enabled(&self) -> bool

This property holds whether the size grip is enabled

Calls C++ function: bool QDialog::isSizeGripEnabled() const.

C++ documentation:

This property holds whether the size grip is enabled

A QSizeGrip is placed in the bottom-right corner of the dialog when this property is enabled. By default, the size grip is disabled.

Access functions:

bool	isSizeGripEnabled() const
void	setSizeGripEnabled(bool)

pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>

Calls C++ function: virtual const QMetaObject* QDialog::metaObject() const.

pub unsafe fn minimum_size_hint(&self) -> CppBox<QSize>

Reimplemented from QWidget::minimumSizeHint().

Calls C++ function: virtual QSize QDialog::minimumSizeHint() const.

C++ documentation:

Reimplemented from QWidget::minimumSizeHint().

pub unsafe fn open(&mut self)

Shows the dialog as a window modal dialog, returning immediately.

Calls C++ function: virtual [slot] void QDialog::open().

C++ documentation:

Shows the dialog as a window modal dialog, returning immediately.

This function was introduced in Qt 4.5.

See also exec(), show(), result(), and setWindowModality().

pub unsafe fn orientation(&self) -> Orientation

Returns the dialog's extension orientation.

Calls C++ function: Qt::Orientation QDialog::orientation() const.

C++ documentation:

Returns the dialog's extension orientation.

Instead of using this functionality, we recommend that you simply call show() or hide() on the part of the dialog that you want to use as an extension. See the Extension Example for details.

See also setOrientation() and extension().

pub unsafe fn qt_metacall(
    &mut self,
    arg1: Call,
    arg2: c_int,
    arg3: impl CastInto<MutPtr<*mut c_void>>
) -> c_int

Calls C++ function: virtual int QDialog::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3).

pub unsafe fn qt_metacast(
    &mut self,
    arg1: impl CastInto<Ptr<c_char>>
) -> MutPtr<c_void>

Calls C++ function: virtual void* QDialog::qt_metacast(const char* arg1).

pub unsafe fn reject(&mut self)

Hides the modal dialog and sets the result code to Rejected.

Calls C++ function: virtual [slot] void QDialog::reject().

C++ documentation:

Hides the modal dialog and sets the result code to Rejected.

See also accept() and done().

pub unsafe fn result(&self) -> c_int

In general returns the modal dialog's result code, Accepted or Rejected.

Calls C++ function: int QDialog::result() const.

C++ documentation:

In general returns the modal dialog's result code, Accepted or Rejected.

Note: When called on a QMessageBox instance, the returned value is a value of the QMessageBox::StandardButton enum.

Do not call this function if the dialog was constructed with the Qt::WA_DeleteOnClose attribute.

See also setResult().

pub unsafe fn set_extension(
    &mut self,
    extension: impl CastInto<MutPtr<QWidget>>
)

Sets the widget, extension, to be the dialog's extension, deleting any previous extension. The dialog takes ownership of the extension. Note that if 0 is passed any existing extension will be deleted. This function must only be called while the dialog is hidden.

Calls C++ function: void QDialog::setExtension(QWidget* extension).

C++ documentation:

Sets the widget, extension, to be the dialog's extension, deleting any previous extension. The dialog takes ownership of the extension. Note that if 0 is passed any existing extension will be deleted. This function must only be called while the dialog is hidden.

Instead of using this functionality, we recommend that you simply call show() or hide() on the part of the dialog that you want to use as an extension. See the Extension Example for details.

See also extension(), showExtension(), and setOrientation().

pub unsafe fn set_modal(&mut self, modal: bool)

This property holds whether show() should pop up the dialog as modal or modeless

Calls C++ function: void QDialog::setModal(bool modal).

C++ documentation:

This property holds whether show() should pop up the dialog as modal or modeless

By default, this property is false and show() pops up the dialog as modeless. Setting this property to true is equivalent to setting QWidget::windowModality to Qt::ApplicationModal.

exec() ignores the value of this property and always pops up the dialog as modal.

Access functions:

bool	isModal() const
void	setModal(bool modal)

See also QWidget::windowModality, show(), and exec().

pub unsafe fn set_orientation(&mut self, orientation: Orientation)

If orientation is Qt::Horizontal, the extension will be displayed to the right of the dialog's main area. If orientation is Qt::Vertical, the extension will be displayed below the dialog's main area.

Calls C++ function: void QDialog::setOrientation(Qt::Orientation orientation).

C++ documentation:

If orientation is Qt::Horizontal, the extension will be displayed to the right of the dialog's main area. If orientation is Qt::Vertical, the extension will be displayed below the dialog's main area.

Instead of using this functionality, we recommend that you simply call show() or hide() on the part of the dialog that you want to use as an extension. See the Extension Example for details.

See also orientation() and setExtension().

pub unsafe fn set_result(&mut self, r: c_int)

Sets the modal dialog's result code to i.

Calls C++ function: void QDialog::setResult(int r).

C++ documentation:

Sets the modal dialog's result code to i.

Note: We recommend that you use one of the values defined by QDialog::DialogCode.

See also result().

pub unsafe fn set_size_grip_enabled(&mut self, arg1: bool)

This property holds whether the size grip is enabled

Calls C++ function: void QDialog::setSizeGripEnabled(bool arg1).

C++ documentation:

This property holds whether the size grip is enabled

A QSizeGrip is placed in the bottom-right corner of the dialog when this property is enabled. By default, the size grip is disabled.

Access functions:

bool	isSizeGripEnabled() const
void	setSizeGripEnabled(bool)

pub unsafe fn set_visible(&mut self, visible: bool)

Reimplemented from QWidget::setVisible().

Calls C++ function: virtual void QDialog::setVisible(bool visible).

C++ documentation:

Reimplemented from QWidget::setVisible().

pub unsafe fn show_extension(&mut self, arg1: bool)

If showIt is true, the dialog's extension is shown; otherwise the extension is hidden.

Calls C++ function: [slot] void QDialog::showExtension(bool arg1).

C++ documentation:

If showIt is true, the dialog's extension is shown; otherwise the extension is hidden.

Instead of using this functionality, we recommend that you simply call show() or hide() on the part of the dialog that you want to use as an extension. See the Extension Example for details.

See also show(), setExtension(), and setOrientation().

pub unsafe fn size_hint(&self) -> CppBox<QSize>

Reimplemented from QWidget::sizeHint().

Calls C++ function: virtual QSize QDialog::sizeHint() const.

C++ documentation:

Reimplemented from QWidget::sizeHint().

Trait Implementations

impl CppDeletable for QWizard

unsafe fn delete(&mut self)

Destroys the wizard and its pages, releasing any allocated resources.

Calls C++ function: virtual [destructor] void QWizard::~QWizard().

C++ documentation:

Destroys the wizard and its pages, releasing any allocated resources.

impl Deref for QWizard

type Target = QDialog

The resulting type after dereferencing.

fn deref(&self) -> &QDialog

Calls C++ function: QDialog* static_cast<QDialog*>(QWizard* ptr).

impl DerefMut for QWizard

fn deref_mut(&mut self) -> &mut QDialog

Calls C++ function: QDialog* static_cast<QDialog*>(QWizard* ptr).

impl DynamicCast<QWizard> for QDialog

unsafe fn dynamic_cast(ptr: Ptr<QDialog>) -> Ptr<QWizard>

Calls C++ function: QWizard* dynamic_cast<QWizard*>(QDialog* ptr).

unsafe fn dynamic_cast_mut(ptr: MutPtr<QDialog>) -> MutPtr<QWizard>

Calls C++ function: QWizard* dynamic_cast<QWizard*>(QDialog* ptr).

impl DynamicCast<QWizard> for QWidget

unsafe fn dynamic_cast(ptr: Ptr<QWidget>) -> Ptr<QWizard>

Calls C++ function: QWizard* dynamic_cast<QWizard*>(QWidget* ptr).

unsafe fn dynamic_cast_mut(ptr: MutPtr<QWidget>) -> MutPtr<QWizard>

Calls C++ function: QWizard* dynamic_cast<QWizard*>(QWidget* ptr).

impl DynamicCast<QWizard> for QObject

unsafe fn dynamic_cast(ptr: Ptr<QObject>) -> Ptr<QWizard>

Calls C++ function: QWizard* dynamic_cast<QWizard*>(QObject* ptr).

unsafe fn dynamic_cast_mut(ptr: MutPtr<QObject>) -> MutPtr<QWizard>

Calls C++ function: QWizard* dynamic_cast<QWizard*>(QObject* ptr).

impl DynamicCast<QWizard> for QPaintDevice

unsafe fn dynamic_cast(ptr: Ptr<QPaintDevice>) -> Ptr<QWizard>

Calls C++ function: QWizard* dynamic_cast<QWizard*>(QPaintDevice* ptr).

unsafe fn dynamic_cast_mut(ptr: MutPtr<QPaintDevice>) -> MutPtr<QWizard>

Calls C++ function: QWizard* dynamic_cast<QWizard*>(QPaintDevice* ptr).

impl StaticDowncast<QWizard> for QDialog

unsafe fn static_downcast(ptr: Ptr<QDialog>) -> Ptr<QWizard>

Calls C++ function: QWizard* static_cast<QWizard*>(QDialog* ptr).

unsafe fn static_downcast_mut(ptr: MutPtr<QDialog>) -> MutPtr<QWizard>

Calls C++ function: QWizard* static_cast<QWizard*>(QDialog* ptr).

impl StaticDowncast<QWizard> for QWidget

unsafe fn static_downcast(ptr: Ptr<QWidget>) -> Ptr<QWizard>

Calls C++ function: QWizard* static_cast<QWizard*>(QWidget* ptr).

unsafe fn static_downcast_mut(ptr: MutPtr<QWidget>) -> MutPtr<QWizard>

Calls C++ function: QWizard* static_cast<QWizard*>(QWidget* ptr).

impl StaticDowncast<QWizard> for QObject

unsafe fn static_downcast(ptr: Ptr<QObject>) -> Ptr<QWizard>

Calls C++ function: QWizard* static_cast<QWizard*>(QObject* ptr).

unsafe fn static_downcast_mut(ptr: MutPtr<QObject>) -> MutPtr<QWizard>

Calls C++ function: QWizard* static_cast<QWizard*>(QObject* ptr).

impl StaticDowncast<QWizard> for QPaintDevice

unsafe fn static_downcast(ptr: Ptr<QPaintDevice>) -> Ptr<QWizard>

Calls C++ function: QWizard* static_cast<QWizard*>(QPaintDevice* ptr).

unsafe fn static_downcast_mut(ptr: MutPtr<QPaintDevice>) -> MutPtr<QWizard>

Calls C++ function: QWizard* static_cast<QWizard*>(QPaintDevice* ptr).

impl StaticUpcast<QDialog> for QWizard

unsafe fn static_upcast(ptr: Ptr<QWizard>) -> Ptr<QDialog>

Calls C++ function: QDialog* static_cast<QDialog*>(QWizard* ptr).

unsafe fn static_upcast_mut(ptr: MutPtr<QWizard>) -> MutPtr<QDialog>

Calls C++ function: QDialog* static_cast<QDialog*>(QWizard* ptr).

impl StaticUpcast<QObject> for QWizard

unsafe fn static_upcast(ptr: Ptr<QWizard>) -> Ptr<QObject>

Calls C++ function: QObject* static_cast<QObject*>(QWizard* ptr).

unsafe fn static_upcast_mut(ptr: MutPtr<QWizard>) -> MutPtr<QObject>

Calls C++ function: QObject* static_cast<QObject*>(QWizard* ptr).

impl StaticUpcast<QPaintDevice> for QWizard

unsafe fn static_upcast(ptr: Ptr<QWizard>) -> Ptr<QPaintDevice>

Calls C++ function: QPaintDevice* static_cast<QPaintDevice*>(QWizard* ptr).

unsafe fn static_upcast_mut(ptr: MutPtr<QWizard>) -> MutPtr<QPaintDevice>

Calls C++ function: QPaintDevice* static_cast<QPaintDevice*>(QWizard* ptr).

impl StaticUpcast<QWidget> for QWizard

unsafe fn static_upcast(ptr: Ptr<QWizard>) -> Ptr<QWidget>

Calls C++ function: QWidget* static_cast<QWidget*>(QWizard* ptr).

unsafe fn static_upcast_mut(ptr: MutPtr<QWizard>) -> MutPtr<QWidget>

Calls C++ function: QWidget* static_cast<QWidget*>(QWizard* ptr).