QtBase  v6.3.1
Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | Properties | List of all members
QWizard Class Reference

The QWizard class provides a framework for wizards. More...

#include <qwizard.h>

Inheritance diagram for QWizard:
Inheritance graph
[legend]
Collaboration diagram for QWizard:
Collaboration graph
[legend]

Public Types

enum  WizardButton {
  BackButton , NextButton , CommitButton , FinishButton ,
  CancelButton , HelpButton , CustomButton1 , CustomButton2 ,
  CustomButton3 , Stretch , NoButton = -1 , NStandardButtons = 6 ,
  NButtons = 9
}
 
enum  WizardPixmap {
  WatermarkPixmap , LogoPixmap , BannerPixmap , BackgroundPixmap ,
  NPixmaps
}
 
enum  WizardStyle {
  ClassicStyle , ModernStyle , MacStyle , AeroStyle ,
  NStyles
}
 
enum  WizardOption {
  IndependentPages = 0x00000001 , IgnoreSubTitles = 0x00000002 , ExtendedWatermarkPixmap = 0x00000004 , NoDefaultButton = 0x00000008 ,
  NoBackButtonOnStartPage = 0x00000010 , NoBackButtonOnLastPage = 0x00000020 , DisabledBackButtonOnLastPage = 0x00000040 , HaveNextButtonOnLastPage = 0x00000080 ,
  HaveFinishButtonOnEarlyPages = 0x00000100 , NoCancelButton = 0x00000200 , CancelButtonOnLeft = 0x00000400 , HaveHelpButton = 0x00000800 ,
  HelpButtonOnRight = 0x00001000 , HaveCustomButton1 = 0x00002000 , HaveCustomButton2 = 0x00004000 , HaveCustomButton3 = 0x00008000 ,
  NoCancelButtonOnLastPage = 0x00010000
}
 
- Public Types inherited from QDialog
enum  DialogCode { Rejected , Accepted }
 
- Public Types inherited from QWidget
enum  RenderFlag { DrawWindowBackground = 0x1 , DrawChildren = 0x2 , IgnoreMask = 0x4 }
 
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric {
  PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM ,
  PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY ,
  PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled
}
 

Public Slots

void back ()
 
void next ()
 
void restart ()
 
- Public Slots inherited from QDialog
virtual void open ()
 
virtual int exec ()
 
virtual void accept ()
 
virtual void reject ()
 
- Public Slots inherited from QWidget
void setEnabled (bool)
 
void setDisabled (bool)
 
void setWindowModified (bool)
 
void setWindowTitle (const QString &)
 
void setStyleSheet (const QString &styleSheet)
 
void setFocus ()
 
void update ()
 
void repaint ()
 
void setHidden (bool hidden)
 
void show ()
 
void hide ()
 
void showMinimized ()
 
void showMaximized ()
 
void showFullScreen ()
 
void showNormal ()
 
bool close ()
 
void raise ()
 
void lower ()
 
- Public Slots inherited from QObject
void deleteLater ()
 

Signals

void currentIdChanged (int id)
 
void helpRequested ()
 
void customButtonClicked (int which)
 
void pageAdded (int id)
 
void pageRemoved (int id)
 
- Signals inherited from QDialog
void finished (int result)
 
void accepted ()
 
void rejected ()
 
- Signals inherited from QWidget
void windowTitleChanged (const QString &title)
 
void windowIconChanged (const QIcon &icon)
 
void windowIconTextChanged (const QString &iconText)
 
void customContextMenuRequested (const QPoint &pos)
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 

Public Member Functions

 QWizard (QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
 
 ~QWizard ()
 
int addPage (QWizardPage *page)
 
void setPage (int id, QWizardPage *page)
 
void removePage (int id)
 
QWizardPagepage (int id) const
 
bool hasVisitedPage (int id) const
 
QList< int > visitedIds () const
 
QList< int > pageIds () const
 
void setStartId (int id)
 
int startId () const
 
QWizardPagecurrentPage () const
 
int currentId () const
 
virtual bool validateCurrentPage ()
 
virtual int nextId () const
 
void setField (const QString &name, const QVariant &value)
 
QVariant field (const QString &name) const
 
void setWizardStyle (WizardStyle style)
 
WizardStyle wizardStyle () const
 
void setOption (WizardOption option, bool on=true)
 
bool testOption (WizardOption option) const
 
void setOptions (WizardOptions options)
 
WizardOptions options () const
 
void setButtonText (WizardButton which, const QString &text)
 
QString buttonText (WizardButton which) const
 
void setButtonLayout (const QList< WizardButton > &layout)
 
void setButton (WizardButton which, QAbstractButton *button)
 
QAbstractButtonbutton (WizardButton which) const
 
void setTitleFormat (Qt::TextFormat format)
 
Qt::TextFormat titleFormat () const
 
void setSubTitleFormat (Qt::TextFormat format)
 
Qt::TextFormat subTitleFormat () const
 
void setPixmap (WizardPixmap which, const QPixmap &pixmap)
 
QPixmap pixmap (WizardPixmap which) const
 
void setSideWidget (QWidget *widget)
 
QWidgetsideWidget () const
 
void setDefaultProperty (const char *className, const char *property, const char *changedSignal)
 
void setVisible (bool visible) override
 
QSize sizeHint () const override
 
- Public Member Functions inherited from QDialog
 QDialog (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
 
 ~QDialog ()
 
int result () const
 
QSize minimumSizeHint () const override
 
void setSizeGripEnabled (bool)
 
bool isSizeGripEnabled () const
 
void setModal (bool modal)
 
void setResult (int r)
 
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
 
 ~QWidget ()
 
int devType () const override
 
WId winId () const
 
void createWinId ()
 
WId internalWinId () const
 
WId effectiveWinId () const
 
QStylestyle () const
 
void setStyle (QStyle *)
 
bool isWindow () const
 
bool isModal () const
 
Qt::WindowModality windowModality () const
 
void setWindowModality (Qt::WindowModality windowModality)
 
bool isEnabled () const
 
bool isEnabledTo (const QWidget *) const
 
QRect frameGeometry () const
 
const QRectgeometry () const
 
QRect normalGeometry () const
 
int x () const
 
int y () const
 
QPoint pos () const
 
QSize frameSize () const
 
QSize size () const
 
int width () const
 
int height () const
 
QRect rect () const
 
QRect childrenRect () const
 
QRegion childrenRegion () const
 
QSize minimumSize () const
 
QSize maximumSize () const
 
int minimumWidth () const
 
int minimumHeight () const
 
int maximumWidth () const
 
int maximumHeight () const
 
void setMinimumSize (const QSize &)
 
void setMinimumSize (int minw, int minh)
 
void setMaximumSize (const QSize &)
 
void setMaximumSize (int maxw, int maxh)
 
void setMinimumWidth (int minw)
 
void setMinimumHeight (int minh)
 
void setMaximumWidth (int maxw)
 
void setMaximumHeight (int maxh)
 
QSize sizeIncrement () const
 
void setSizeIncrement (const QSize &)
 
void setSizeIncrement (int w, int h)
 
QSize baseSize () const
 
void setBaseSize (const QSize &)
 
void setBaseSize (int basew, int baseh)
 
void setFixedSize (const QSize &)
 
void setFixedSize (int w, int h)
 
void setFixedWidth (int w)
 
void setFixedHeight (int h)
 
QPointF mapToGlobal (const QPointF &) const
 
QPoint mapToGlobal (const QPoint &) const
 
QPointF mapFromGlobal (const QPointF &) const
 
QPoint mapFromGlobal (const QPoint &) const
 
QPointF mapToParent (const QPointF &) const
 
QPoint mapToParent (const QPoint &) const
 
QPointF mapFromParent (const QPointF &) const
 
QPoint mapFromParent (const QPoint &) const
 
QPointF mapTo (const QWidget *, const QPointF &) const
 
QPoint mapTo (const QWidget *, const QPoint &) const
 
QPointF mapFrom (const QWidget *, const QPointF &) const
 
QPoint mapFrom (const QWidget *, const QPoint &) const
 
QWidgetwindow () const
 
QWidgetnativeParentWidget () const
 
QWidgettopLevelWidget () const
 
const QPalettepalette () const
 
void setPalette (const QPalette &)
 
void setBackgroundRole (QPalette::ColorRole)
 
QPalette::ColorRole backgroundRole () const
 
void setForegroundRole (QPalette::ColorRole)
 
QPalette::ColorRole foregroundRole () const
 
const QFontfont () const
 
void setFont (const QFont &)
 
QFontMetrics fontMetrics () const
 
QFontInfo fontInfo () const
 
QCursor cursor () const
 
void setCursor (const QCursor &)
 
void unsetCursor ()
 
void setMouseTracking (bool enable)
 
bool hasMouseTracking () const
 
bool underMouse () const
 
void setTabletTracking (bool enable)
 
bool hasTabletTracking () const
 
void setMask (const QBitmap &)
 
void setMask (const QRegion &)
 
QRegion mask () const
 
void clearMask ()
 
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))
 
Q_INVOKABLE QPixmap grab (const QRect &rectangle=QRect(QPoint(0, 0), QSize(-1, -1)))
 
void grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags())
 
void ungrabGesture (Qt::GestureType type)
 
QString styleSheet () const
 
QString windowTitle () const
 
void setWindowIcon (const QIcon &icon)
 
QIcon windowIcon () const
 
void setWindowIconText (const QString &)
 
QString windowIconText () const
 
void setWindowRole (const QString &)
 
QString windowRole () const
 
void setWindowFilePath (const QString &filePath)
 
QString windowFilePath () const
 
void setWindowOpacity (qreal level)
 
qreal windowOpacity () const
 
bool isWindowModified () const
 
QString accessibleName () const
 
void setAccessibleName (const QString &name)
 
QString accessibleDescription () const
 
void setAccessibleDescription (const QString &description)
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
Qt::LayoutDirection layoutDirection () const
 
void unsetLayoutDirection ()
 
void setLocale (const QLocale &locale)
 
QLocale locale () const
 
void unsetLocale ()
 
bool isRightToLeft () const
 
bool isLeftToRight () const
 
bool isActiveWindow () const
 
void activateWindow ()
 
void clearFocus ()
 
void setFocus (Qt::FocusReason reason)
 
Qt::FocusPolicy focusPolicy () const
 
void setFocusPolicy (Qt::FocusPolicy policy)
 
bool hasFocus () const
 
void setFocusProxy (QWidget *)
 
QWidgetfocusProxy () const
 
Qt::ContextMenuPolicy contextMenuPolicy () const
 
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
 
void grabMouse ()
 
void grabMouse (const QCursor &)
 
void releaseMouse ()
 
void grabKeyboard ()
 
void releaseKeyboard ()
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)
 
void releaseShortcut (int id)
 
void setShortcutEnabled (int id, bool enable=true)
 
void setShortcutAutoRepeat (int id, bool enable=true)
 
bool updatesEnabled () const
 
void setUpdatesEnabled (bool enable)
 
void update (int x, int y, int w, int h)
 
void update (const QRect &)
 
void update (const QRegion &)
 
void repaint (int x, int y, int w, int h)
 
void repaint (const QRect &)
 
void repaint (const QRegion &)
 
void stackUnder (QWidget *)
 
void move (int x, int y)
 
void move (const QPoint &)
 
void resize (int w, int h)
 
void resize (const QSize &)
 
void setGeometry (int x, int y, int w, int h)
 
void setGeometry (const QRect &)
 
QByteArray saveGeometry () const
 
bool restoreGeometry (const QByteArray &geometry)
 
void adjustSize ()
 
bool isVisible () const
 
bool isVisibleTo (const QWidget *) const
 
bool isHidden () const
 
bool isMinimized () const
 
bool isMaximized () const
 
bool isFullScreen () const
 
Qt::WindowStates windowState () const
 
void setWindowState (Qt::WindowStates state)
 
void overrideWindowState (Qt::WindowStates state)
 
QSizePolicy sizePolicy () const
 
void setSizePolicy (QSizePolicy)
 
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
 
virtual int heightForWidth (int) const
 
virtual bool hasHeightForWidth () const
 
QRegion visibleRegion () const
 
void setContentsMargins (int left, int top, int right, int bottom)
 
void setContentsMargins (const QMargins &margins)
 The setContentsMargins function sets the margins around the widget's contents. More...
 
QMargins contentsMargins () const
 The contentsMargins function returns the widget's contents margins. More...
 
QRect contentsRect () const
 
QLayoutlayout () const
 
void setLayout (QLayout *)
 
void updateGeometry ()
 
void setParent (QWidget *parent)
 
void setParent (QWidget *parent, Qt::WindowFlags f)
 
void scroll (int dx, int dy)
 
void scroll (int dx, int dy, const QRect &)
 
QWidgetfocusWidget () const
 
QWidgetnextInFocusChain () const
 
QWidgetpreviousInFocusChain () const
 The previousInFocusChain function returns the previous widget in this widget's focus chain. More...
 
bool acceptDrops () const
 
void setAcceptDrops (bool on)
 
void addAction (QAction *action)
 
void addActions (const QList< QAction * > &actions)
 
void insertActions (QAction *before, const QList< QAction * > &actions)
 
void insertAction (QAction *before, QAction *action)
 
void removeAction (QAction *action)
 
QList< QAction * > actions () const
 
QActionaddAction (const QString &text)
 
QActionaddAction (const QIcon &icon, const QString &text)
 
QActionaddAction (const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type=Qt::AutoConnection)
 
QActionaddAction (const QIcon &icon, const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename... Args, typename = compatible_action_slot_args<Args...>>
QActionaddAction (const QString &text, Args &&...args)
 
template<typename... Args, typename = compatible_action_slot_args<Args...>>
QActionaddAction (const QIcon &icon, const QString &text, Args &&...args)
 
QWidgetparentWidget () const
 
void setWindowFlags (Qt::WindowFlags type)
 
Qt::WindowFlags windowFlags () const
 
void setWindowFlag (Qt::WindowType, bool on=true)
 
void overrideWindowFlags (Qt::WindowFlags type)
 
Qt::WindowType windowType () const
 
QWidgetchildAt (int x, int y) const
 
QWidgetchildAt (const QPoint &p) const
 
void setAttribute (Qt::WidgetAttribute, bool on=true)
 
bool testAttribute (Qt::WidgetAttribute) const
 
QPaintEnginepaintEngine () const override
 
void ensurePolished () const
 
bool isAncestorOf (const QWidget *child) const
 
bool autoFillBackground () const
 
void setAutoFillBackground (bool enabled)
 
QBackingStorebackingStore () const
 
QWindowwindowHandle () const
 
QScreenscreen () const
 
void setScreen (QScreen *)
 
virtual QVariant inputMethodQuery (Qt::InputMethodQuery) const
 
Qt::InputMethodHints inputMethodHints () const
 
void setInputMethodHints (Qt::InputMethodHints hints)
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 
virtual ~QObject ()
 
QString objectName () const
 
void setObjectName (const QString &name)
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 
bool isWindowType () const
 
bool signalsBlocked () const noexcept
 
bool blockSignals (bool b) noexcept
 
QThreadthread () const
 
void moveToThread (QThread *thread)
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 
template<typename T >
T findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
template<typename T >
QList< TfindChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
template<typename T >
QList< TfindChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
const QObjectListchildren () const
 
void setParent (QObject *parent)
 
void installEventFilter (QObject *filterObj)
 
void removeEventFilter (QObject *obj)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 
void dumpObjectInfo () const
 
bool setProperty (const char *name, const QVariant &value)
 
QVariant property (const char *name) const
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 
bool inherits (const char *classname) const
 
- Public Member Functions inherited from QPaintDevice
virtual ~QPaintDevice ()
 
bool paintingActive () const
 
int width () const
 
int height () const
 
int widthMM () const
 
int heightMM () const
 
int logicalDpiX () const
 
int logicalDpiY () const
 
int physicalDpiX () const
 
int physicalDpiY () const
 
qreal devicePixelRatio () const
 
qreal devicePixelRatioF () const
 
int colorCount () const
 
int depth () const
 

Protected Member Functions

bool event (QEvent *event) override
 
void resizeEvent (QResizeEvent *event) override
 
void paintEvent (QPaintEvent *event) override
 
void done (int result) override
 
virtual void initializePage (int id)
 
virtual void cleanupPage (int id)
 
- Protected Member Functions inherited from QDialog
 QDialog (QDialogPrivate &, QWidget *parent, Qt::WindowFlags f=Qt::WindowFlags())
 
void keyPressEvent (QKeyEvent *) override
 
void closeEvent (QCloseEvent *) override
 
void showEvent (QShowEvent *) override
 
void contextMenuEvent (QContextMenuEvent *) override
 
bool eventFilter (QObject *, QEvent *) override
 
void adjustPosition (QWidget *)
 
- Protected Member Functions inherited from QWidget
bool event (QEvent *event) override
 
virtual void mousePressEvent (QMouseEvent *event)
 
virtual void mouseReleaseEvent (QMouseEvent *event)
 
virtual void mouseDoubleClickEvent (QMouseEvent *event)
 
virtual void mouseMoveEvent (QMouseEvent *event)
 
virtual void keyReleaseEvent (QKeyEvent *event)
 
virtual void focusInEvent (QFocusEvent *event)
 
virtual void focusOutEvent (QFocusEvent *event)
 
virtual void enterEvent (QEnterEvent *event)
 
virtual void leaveEvent (QEvent *event)
 
virtual void moveEvent (QMoveEvent *event)
 
virtual void actionEvent (QActionEvent *event)
 
virtual void hideEvent (QHideEvent *event)
 
virtual bool nativeEvent (const QByteArray &eventType, void *message, qintptr *result)
 
virtual void changeEvent (QEvent *)
 
int metric (PaintDeviceMetric) const override
 
void initPainter (QPainter *painter) const override
 
QPaintDeviceredirected (QPoint *offset) const override
 
QPaintersharedPainter () const override
 
virtual void inputMethodEvent (QInputMethodEvent *)
 
void create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)
 
void destroy (bool destroyWindow=true, bool destroySubWindows=true)
 
virtual bool focusNextPrevChild (bool next)
 
bool focusNextChild ()
 
bool focusPreviousChild ()
 
 QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 
virtual void childEvent (QChildEvent *event)
 
virtual void customEvent (QEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Member Functions inherited from QPaintDevice
 QPaintDevice () noexcept
 

Properties

WizardStyle wizardStyle
 the look and feel of the wizard More...
 
WizardOptions options
 the various options that affect the look and feel of the wizard More...
 
Qt::TextFormat titleFormat
 the text format used by page titles More...
 
Qt::TextFormat subTitleFormat
 the text format used by page subtitles More...
 
int startId
 the ID of the first page More...
 
int currentId
 the ID of the current page More...
 
- Properties inherited from QDialog
bool sizeGripEnabled
 whether the size grip is enabled More...
 
bool modal
 whether show() should pop up the dialog as modal or modeless More...
 
- Properties inherited from QWidget
bool modal
 whether the widget is a modal widget More...
 
Qt::WindowModality windowModality
 which windows are blocked by the modal widget More...
 
bool enabled
 whether the widget is enabled More...
 
QRect geometry
 the geometry of the widget relative to its parent and excluding the window frame More...
 
QRect frameGeometry
 geometry of the widget relative to its parent including any window frame More...
 
QRect normalGeometry
 the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget More...
 
int x
 the x coordinate of the widget relative to its parent including any window frame More...
 
int y
 the y coordinate of the widget relative to its parent and including any window frame More...
 
QPoint pos
 the position of the widget within its parent widget More...
 
QSize frameSize
 the size of the widget including any window frame More...
 
QSize size
 the size of the widget excluding any window frame More...
 
int width
 the width of the widget excluding any window frame More...
 
int height
 the height of the widget excluding any window frame More...
 
QRect rect
 the internal geometry of the widget excluding any window frame More...
 
QRect childrenRect
 the bounding rectangle of the widget's children More...
 
QRegion childrenRegion
 the combined region occupied by the widget's children More...
 
QSizePolicy sizePolicy
 the default layout behavior of the widget More...
 
QSize minimumSize
 the widget's minimum size More...
 
QSize maximumSize
 the widget's maximum size in pixels More...
 
int minimumWidth
 the widget's minimum width in pixels More...
 
int minimumHeight
 the widget's minimum height in pixels More...
 
int maximumWidth
 the widget's maximum width in pixels More...
 
int maximumHeight
 the widget's maximum height in pixels More...
 
QSize sizeIncrement
 the size increment of the widget More...
 
QSize baseSize
 the base size of the widget More...
 
QPalette palette
 the widget's palette More...
 
QFont font
 the font currently set for the widget More...
 
QCursor cursor
 the cursor shape for this widget More...
 
bool mouseTracking
 whether mouse tracking is enabled for the widget More...
 
bool tabletTracking
 whether tablet tracking is enabled for the widget More...
 
bool isActiveWindow
 whether this widget's window is the active window More...
 
Qt::FocusPolicy focusPolicy
 the way the widget accepts keyboard focus More...
 
bool focus
 whether this widget (or its focus proxy) has the keyboard input focus More...
 
Qt::ContextMenuPolicy contextMenuPolicy
 how the widget shows a context menu More...
 
bool updatesEnabled
 whether updates are enabled More...
 
bool visible
 whether the widget is visible More...
 
bool minimized
 whether this widget is minimized (iconified) More...
 
bool maximized
 whether this widget is maximized More...
 
bool fullScreen
 whether the widget is shown in full screen mode More...
 
QSize sizeHint
 the recommended size for the widget More...
 
QSize minimumSizeHint
 the recommended minimum size for the widget More...
 
bool acceptDrops
 whether drop events are enabled for this widget More...
 
QString windowTitle
 the window title (caption) More...
 
QIcon windowIcon
 the widget's icon More...
 
QString windowIconText
 the text to be displayed on the icon of a minimized window More...
 
double windowOpacity
 The level of opacity for the window. More...
 
bool windowModified
 whether the document shown in the window has unsaved changes More...
 
QString accessibleName
 the widget's name as seen by assistive technologies More...
 
QString accessibleDescription
 the widget's description as seen by assistive technologies More...
 
Qt::LayoutDirection layoutDirection
 the layout direction for this widget. More...
 
bool autoFillBackground
 whether the widget background is filled automatically More...
 
QString styleSheet
 the widget's style sheet More...
 
QLocale locale
 the widget's locale More...
 
QString windowFilePath
 the file path associated with a widget More...
 
Qt::InputMethodHints inputMethodHints
 What input method specific hints the widget has. More...
 
- Properties inherited from QObject
QString objectName
 the name of this object More...
 

Additional Inherited Members

- Static Public Member Functions inherited from QWidget
static void setTabOrder (QWidget *, QWidget *)
 
static QWidgetmouseGrabber ()
 
static QWidgetkeyboardGrabber ()
 
static QWidgetfind (WId)
 
static QWidgetcreateWindowContainer (QWindow *window, QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)
 
static QMetaObject::Connection ::type connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)
 
static QMetaObject::Connection ::type connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)
 
template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Static Public Member Functions inherited from QPaintDevice
static qreal devicePixelRatioFScale ()
 
- Protected Slots inherited from QWidget
void updateMicroFocus (Qt::InputMethodQuery query=Qt::ImQueryAll)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Protected Attributes inherited from QPaintDevice
ushort painters
 

Detailed Description

The QWizard class provides a framework for wizards.

Since
4.3

\inmodule QtWidgets

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:

Definition at line 54 of file qwizard.h.

Member Enumeration Documentation

◆ WizardButton

This enum specifies the buttons in a wizard.

\value BackButton The \uicontrol Back button (\uicontrol {Go Back} on \macos) \value NextButton The \uicontrol Next button (\uicontrol Continue on \macos) \value CommitButton The \uicontrol Commit button \value FinishButton The \uicontrol Finish button (\uicontrol Done on \macos) \value CancelButton The \uicontrol Cancel button (see also NoCancelButton) \value HelpButton The \uicontrol Help button (see also HaveHelpButton) \value CustomButton1 The first user-defined button (see also HaveCustomButton1) \value CustomButton2 The second user-defined button (see also HaveCustomButton2) \value CustomButton3 The third user-defined button (see also HaveCustomButton3)

The following value is only useful when calling setButtonLayout():

\value Stretch A horizontal stretch in the button layout

\omitvalue NoButton \omitvalue NStandardButtons \omitvalue NButtons

See also
setButton(), setButtonText(), setButtonLayout(), customButtonClicked()
Enumerator
BackButton 
NextButton 
CommitButton 
FinishButton 
CancelButton 
HelpButton 
CustomButton1 
CustomButton2 
CustomButton3 
Stretch 
NoButton 
NStandardButtons 
NButtons 

Definition at line 65 of file qwizard.h.

◆ WizardOption

This enum specifies various options that affect the look and feel of a wizard.

\value IndependentPages The pages are independent of each other (i.e., they don't derive values from each other). \value IgnoreSubTitles Don't show any subtitles, even if they are set. \value ExtendedWatermarkPixmap Extend any WatermarkPixmap all the way down to the window's edge. \value NoDefaultButton Don't make the \uicontrol Next or \uicontrol Finish button the dialog's \l{QPushButton::setDefault()}{default button}. \value NoBackButtonOnStartPage Don't show the \uicontrol Back button on the start page. \value NoBackButtonOnLastPage Don't show the \uicontrol Back button on the last page. \value DisabledBackButtonOnLastPage Disable the \uicontrol Back button on the last page. \value HaveNextButtonOnLastPage Show the (disabled) \uicontrol Next button on the last page. \value HaveFinishButtonOnEarlyPages Show the (disabled) \uicontrol Finish button on non-final pages. \value NoCancelButton Don't show the \uicontrol Cancel button. \value CancelButtonOnLeft Put the \uicontrol Cancel button on the left of \uicontrol Back (rather than on the right of \uicontrol Finish or \uicontrol Next). \value HaveHelpButton Show the \uicontrol Help button. \value HelpButtonOnRight Put the \uicontrol Help button on the far right of the button layout (rather than on the far left). \value HaveCustomButton1 Show the first user-defined button (CustomButton1). \value HaveCustomButton2 Show the second user-defined button (CustomButton2). \value HaveCustomButton3 Show the third user-defined button (CustomButton3). \value NoCancelButtonOnLastPage Don't show the \uicontrol Cancel button on the last page.

See also
setOptions(), setOption(), testOption()
Enumerator
IndependentPages 
IgnoreSubTitles 
ExtendedWatermarkPixmap 
NoDefaultButton 
NoBackButtonOnStartPage 
NoBackButtonOnLastPage 
DisabledBackButtonOnLastPage 
HaveNextButtonOnLastPage 
HaveFinishButtonOnEarlyPages 
NoCancelButton 
CancelButtonOnLeft 
HaveHelpButton 
HelpButtonOnRight 
HaveCustomButton1 
HaveCustomButton2 
HaveCustomButton3 
NoCancelButtonOnLastPage 

Definition at line 99 of file qwizard.h.

◆ WizardPixmap

This enum specifies the pixmaps that can be associated with a page.

\value WatermarkPixmap The tall pixmap on the left side of a ClassicStyle or ModernStyle page \value LogoPixmap The small pixmap on the right side of a ClassicStyle or ModernStyle page header \value BannerPixmap The pixmap that occupies the background of a ModernStyle page header \value BackgroundPixmap The pixmap that occupies the background of a MacStyle wizard

\omitvalue NPixmaps

See also
setPixmap(), QWizardPage::setPixmap(), {Elements of a Wizard Page}
Enumerator
WatermarkPixmap 
LogoPixmap 
BannerPixmap 
BackgroundPixmap 
NPixmaps 

Definition at line 82 of file qwizard.h.

◆ WizardStyle

This enum specifies the different looks supported by QWizard.

\value ClassicStyle Classic Windows look \value ModernStyle Modern Windows look \value MacStyle \macos look \value AeroStyle Windows Aero look

\omitvalue NStyles

See also
setWizardStyle(), WizardOption, {Wizard Look and Feel}
Enumerator
ClassicStyle 
ModernStyle 
MacStyle 
AeroStyle 
NStyles 

Definition at line 90 of file qwizard.h.

Constructor & Destructor Documentation

◆ QWizard()

QWizard::QWizard ( QWidget parent = nullptr,
Qt::WindowFlags  flags = Qt::WindowFlags() 
)
explicit

Constructs a wizard with the given parent and window flags.

See also
parent(), windowFlags()

Definition at line 2199 of file qwizard.cpp.

◆ ~QWizard()

QWizard::~QWizard ( )

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

Definition at line 2209 of file qwizard.cpp.

Member Function Documentation

◆ addPage()

int QWizard::addPage ( QWizardPage page)

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(), pageAdded()

Definition at line 2223 of file qwizard.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ back

void QWizard::back ( )
slot

Goes back to the previous page.

This is equivalent to pressing the \uicontrol Back button.

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

Definition at line 3105 of file qwizard.cpp.

Here is the caller graph for this function:

◆ button()

QAbstractButton * QWizard::button ( WizardButton  which) const

Returns the button corresponding to role which.

See also
setButton(), setButtonText()

Definition at line 2806 of file qwizard.cpp.

Here is the caller graph for this function:

◆ buttonText()

QString QWizard::buttonText ( WizardButton  which) const

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 \uicontrol Next button is called \uicontrol Continue.

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

Definition at line 2704 of file qwizard.cpp.

Here is the caller graph for this function:

◆ cleanupPage()

void QWizard::cleanupPage ( int  id)
protectedvirtual

This virtual function is called by QWizard to clean up page id just before the user leaves it by clicking \uicontrol Back (unless the \l QWizard::IndependentPages option is set).

The default implementation calls QWizardPage::cleanupPage() on page(id).

See also
QWizardPage::cleanupPage(), initializePage()

Definition at line 3331 of file qwizard.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ currentId()

int QWizard::currentId ( ) const

Definition at line 2481 of file qwizard.cpp.

◆ currentIdChanged

void QWizard::currentIdChanged ( int  id)
signal

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

See also
currentId(), currentPage()

◆ currentPage()

QWizardPage * QWizard::currentPage ( ) const

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

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

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

Definition at line 2463 of file qwizard.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ customButtonClicked

void QWizard::customButtonClicked ( int  which)
signal

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()
Here is the caller graph for this function:

◆ done()

void QWizard::done ( int  result)
overrideprotectedvirtual

\reimp

Reimplemented from QDialog.

Definition at line 3282 of file qwizard.cpp.

Here is the call graph for this function:

◆ event()

bool QWizard::event ( QEvent event)
overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Definition at line 3162 of file qwizard.cpp.

Here is the call graph for this function:

◆ field()

QVariant QWizard::field ( const QString name) const

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(), setField()

Definition at line 2517 of file qwizard.cpp.

Here is the caller graph for this function:

◆ hasVisitedPage()

bool QWizard::hasVisitedPage ( int  id) const

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

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

See also
visitedIds()

Definition at line 2389 of file qwizard.cpp.

◆ helpRequested

void QWizard::helpRequested ( )
signal

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

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

Example:

\dots

\dots

\codeline

\dots

\codeline

\codeline

See also
customButtonClicked()
Here is the caller graph for this function:

◆ initializePage()

void QWizard::initializePage ( int  id)
protectedvirtual

This virtual function is called by QWizard to prepare page id just before it is shown either as a result of QWizard::restart() being called, or as a result of the user clicking \uicontrol Next. (However, if the \l QWizard::IndependentPages option is set, this function is only called the first time the page is shown.)

By reimplementing this function, you can ensure that the page's fields are properly initialized based on fields from previous pages.

The default implementation calls QWizardPage::initializePage() on page(id).

See also
QWizardPage::initializePage(), cleanupPage()

Definition at line 3313 of file qwizard.cpp.

Here is the call graph for this function:

◆ next

void QWizard::next ( )
slot

Advances to the next page.

This is equivalent to pressing the \uicontrol Next or \uicontrol Commit button.

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

Definition at line 3121 of file qwizard.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ nextId()

int QWizard::nextId ( ) const
virtual

This virtual function is called by QWizard to find out which page to show when the user clicks the \uicontrol 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(), currentPage()

Definition at line 3377 of file qwizard.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ options()

QWizard::WizardOptions QWizard::options ( ) const

Definition at line 2656 of file qwizard.cpp.

Here is the caller graph for this function:

◆ page()

QWizardPage * QWizard::page ( int  id) const

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

See also
addPage(), setPage()

Definition at line 2373 of file qwizard.cpp.

Here is the caller graph for this function:

◆ pageAdded

void QWizard::pageAdded ( int  id)
signal
Since
4.7

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

See also
addPage(), setPage(), startId()
Here is the caller graph for this function:

◆ pageIds()

QList< int > QWizard::pageIds ( ) const

Returns the list of page IDs.

Since
4.5

Definition at line 2413 of file qwizard.cpp.

◆ pageRemoved

void QWizard::pageRemoved ( int  id)
signal
Since
4.7

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

See also
removePage(), startId()
Here is the caller graph for this function:

◆ paintEvent()

void QWizard::paintEvent ( QPaintEvent event)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 3224 of file qwizard.cpp.

Here is the call graph for this function:

◆ pixmap()

QPixmap QWizard::pixmap ( WizardPixmap  which) const

Returns the pixmap set for role which.

By default, the only pixmap that is set is the BackgroundPixmap on \macos version 10.13 and earlier.

See also
QWizardPage::pixmap(), {Elements of a Wizard Page}

Definition at line 2888 of file qwizard.cpp.

Here is the caller graph for this function:

◆ removePage()

void QWizard::removePage ( int  id)

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.
Since
4.5
See also
addPage(), setPage(), pageRemoved(), startId()

Definition at line 2299 of file qwizard.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ resizeEvent()

void QWizard::resizeEvent ( QResizeEvent event)
overrideprotectedvirtual

\reimp

Reimplemented from QDialog.

Definition at line 3202 of file qwizard.cpp.

Here is the call graph for this function:

◆ restart

void QWizard::restart ( )
slot

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

See also
startId()

Definition at line 3150 of file qwizard.cpp.

Here is the caller graph for this function:

◆ setButton()

void QWizard::setButton ( WizardButton  which,
QAbstractButton button 
)

Sets the button corresponding to role which to button.

To add extra buttons to the wizard (e.g., a \uicontrol 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
setButtonText(), setButtonLayout(), options

Definition at line 2776 of file qwizard.cpp.

Here is the call graph for this function:

◆ setButtonLayout()

void QWizard::setButtonLayout ( const QList< WizardButton > &  layout)

Sets the order in which buttons are displayed to layout, where layout is a list of \l{WizardButton}s.

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 \l options already provides.

You can specify horizontal stretches in the layout using \l Stretch.

Example:

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

Definition at line 2739 of file qwizard.cpp.

Here is the call graph for this function:

◆ setButtonText()

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

Sets the text on button which to be text.

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

To add extra buttons to the wizard (e.g., a \uicontrol 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
setButton(), button(), setButtonLayout(), setOptions(), QWizardPage::setButtonText()

Definition at line 2679 of file qwizard.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setDefaultProperty()

void QWizard::setDefaultProperty ( const char *  className,
const char *  property,
const char *  changedSignal 
)

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:

\table \header

See also
QWizardPage::registerField()

Definition at line 2924 of file qwizard.cpp.

Here is the call graph for this function:

◆ setField()

void QWizard::setField ( const QString name,
const QVariant value 
)

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(), field()

Definition at line 2494 of file qwizard.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setOption()

void QWizard::setOption ( WizardOption  option,
bool  on = true 
)

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

See also
options, testOption(), setWizardStyle()

Definition at line 2595 of file qwizard.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setOptions()

void QWizard::setOptions ( WizardOptions  options)

Definition at line 2628 of file qwizard.cpp.

Here is the caller graph for this function:

◆ setPage()

void QWizard::setPage ( int  id,
QWizardPage page 
)

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(), pageAdded()

Definition at line 2243 of file qwizard.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setPixmap()

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

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 \l{Wizard Look and Feel}{wizard style}.

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

See also
QWizardPage::setPixmap(), {Elements of a Wizard Page}

Definition at line 2872 of file qwizard.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setSideWidget()

void QWizard::setSideWidget ( QWidget widget)
Since
4.7

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 \nullptr shows no side widget.

When the widget is not \nullptr 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 \nullptr).

By default, no side widget is present.

Definition at line 2961 of file qwizard.cpp.

◆ setStartId()

void QWizard::setStartId ( int  id)

Definition at line 2429 of file qwizard.cpp.

Here is the caller graph for this function:

◆ setSubTitleFormat()

void QWizard::setSubTitleFormat ( Qt::TextFormat  format)

Definition at line 2847 of file qwizard.cpp.

◆ setTitleFormat()

void QWizard::setTitleFormat ( Qt::TextFormat  format)

Definition at line 2826 of file qwizard.cpp.

◆ setVisible()

void QWizard::setVisible ( bool  visible)
overridevirtual

\reimp

Reimplemented from QDialog.

Definition at line 2989 of file qwizard.cpp.

Here is the call graph for this function:

◆ setWizardStyle()

void QWizard::setWizardStyle ( WizardStyle  style)

Definition at line 2543 of file qwizard.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ sideWidget()

QWidget * QWizard::sideWidget ( ) const
Since
4.7

Returns the widget on the left side of the wizard or \nullptr.

By default, no side widget is present.

Definition at line 2979 of file qwizard.cpp.

◆ sizeHint()

QSize QWizard::sizeHint ( ) const
overridevirtual

\reimp

Reimplemented from QDialog.

Definition at line 3002 of file qwizard.cpp.

Here is the call graph for this function:

◆ startId()

int QWizard::startId ( ) const

Definition at line 2449 of file qwizard.cpp.

◆ subTitleFormat()

Qt::TextFormat QWizard::subTitleFormat ( ) const

Definition at line 2854 of file qwizard.cpp.

◆ testOption()

bool QWizard::testOption ( WizardOption  option) const

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

See also
options, setOption(), setWizardStyle()

Definition at line 2608 of file qwizard.cpp.

◆ titleFormat()

Qt::TextFormat QWizard::titleFormat ( ) const

Definition at line 2833 of file qwizard.cpp.

◆ validateCurrentPage()

bool QWizard::validateCurrentPage ( )
virtual

This virtual function is called by QWizard when the user clicks \uicontrol Next or \uicontrol 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 \uicontrol Next or \uicontrol Finish button (by specifying \l{mandatory fields} or by reimplementing QWizardPage::isComplete()) than to reimplement validateCurrentPage().

See also
QWizardPage::validatePage(), currentPage()

Definition at line 3354 of file qwizard.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ visitedIds()

QList< int > QWizard::visitedIds ( ) const
Since
5.15

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

See also
hasVisitedPage()

Definition at line 2403 of file qwizard.cpp.

◆ wizardStyle()

QWizard::WizardStyle QWizard::wizardStyle ( ) const

Definition at line 2583 of file qwizard.cpp.

Property Documentation

◆ currentId

QWizard::currentId
read

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.

See also
currentPage()

Definition at line 260 of file qwizard.h.

◆ options

QWizard::options
readwrite

the various options that affect the look and feel of the wizard

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

\list

  • Windows: HelpButtonOnRight.
  • \macos: NoDefaultButton and NoCancelButton.
  • X11 and QWS (Qt for Embedded Linux): none. \endlist
See also
wizardStyle

Definition at line 260 of file qwizard.h.

◆ startId

QWizard::startId
readwrite

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.

See also
restart(), nextId()

Definition at line 260 of file qwizard.h.

◆ subTitleFormat

QWizard::subTitleFormat
readwrite

the text format used by page subtitles

The default format is Qt::AutoText.

See also
QWizardPage::title, titleFormat

Definition at line 260 of file qwizard.h.

◆ titleFormat

QWizard::titleFormat
readwrite

the text format used by page titles

The default format is Qt::AutoText.

See also
QWizardPage::title, subTitleFormat

Definition at line 260 of file qwizard.h.

◆ wizardStyle

QWizard::wizardStyle
readwrite

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.

See also
{Wizard Look and Feel}, options

Definition at line 260 of file qwizard.h.


The documentation for this class was generated from the following files: