 |
Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
|
|
Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
|
The QWizard class provides a framework for wizards. More...
#include <qwizard.h>
Inheritance diagram for QWizard: Collaboration diagram for QWizard:Public Slots | |
| void | back () |
| Goes back to the previous page. | |
| void | next () |
| Advances to the next page. | |
| void | setCurrentId (int id) |
| Sets currentId to id, without visiting the pages between currentId and id. | |
| void | restart () |
| Restarts the wizard at the start page. | |
| Public Slots inherited from QDialog | |
| virtual void | open () |
| virtual int | exec () |
| Shows the dialog as a \l{QDialog::Modal Dialogs}{modal dialog}, blocking until the user closes it. | |
| virtual void | accept () |
Hides the modal dialog and sets the result code to Accepted. | |
| virtual void | reject () |
Hides the modal dialog and sets the result code to Rejected. | |
| Public Slots inherited from QWidget | |
| void | setEnabled (bool) |
| void | setDisabled (bool) |
| Disables widget input events if disable is true; otherwise enables input events. | |
| void | setWindowModified (bool) |
| void | setWindowTitle (const QString &) |
| void | setStyleSheet (const QString &styleSheet) |
| void | setFocus () |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}. | |
| void | update () |
| Updates the widget unless updates are disabled or the widget is hidden. | |
| void | repaint () |
| Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden. | |
| void | setHidden (bool hidden) |
| Convenience function, equivalent to setVisible(!hidden). | |
| void | show () |
| Shows the widget and its child widgets. | |
| void | hide () |
| Hides the widget. | |
| void | showMinimized () |
| Shows the widget minimized, as an icon. | |
| void | showMaximized () |
| Shows the widget maximized. | |
| void | showFullScreen () |
| Shows the widget in full-screen mode. | |
| void | showNormal () |
| Restores the widget after it has been maximized or minimized. | |
| bool | close () |
| Closes this widget. | |
| void | raise () |
| Raises this widget to the top of the parent widget's stack. | |
| void | lower () |
| Lowers the widget to the bottom of the parent widget's stack. | |
| Public Slots inherited from QObject | |
| void | deleteLater () |
| \threadsafe | |
Signals | |
| void | currentIdChanged (int id) |
| This signal is emitted when the current page changes, with the new current id. | |
| void | helpRequested () |
| This signal is emitted when the user clicks the \uicontrol Help button. | |
| void | customButtonClicked (int which) |
| This signal is emitted when the user clicks a custom button. | |
| 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) |
| This signal is emitted when the window's title has changed, with the new title as an argument. | |
| void | windowIconChanged (const QIcon &icon) |
| This signal is emitted when the window's icon has changed, with the new icon as an argument. | |
| void | windowIconTextChanged (const QString &iconText) |
| This signal is emitted when the window's icon text has changed, with the new iconText as an argument. | |
| void | customContextMenuRequested (const QPoint &pos) |
| This signal is emitted when the widget's \l contextMenuPolicy is Qt::CustomContextMenu, and the user has requested a context menu on the widget. | |
| Signals inherited from QObject | |
| void | destroyed (QObject *=nullptr) |
| This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked. | |
| void | objectNameChanged (const QString &objectName, QPrivateSignal) |
| This signal is emitted after the object's name has been changed. | |
Public Member Functions | |
| QWizard (QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags()) | |
| Constructs a wizard with the given parent and window flags. | |
| ~QWizard () | |
| Destroys the wizard and its pages, releasing any allocated resources. | |
| int | addPage (QWizardPage *page) |
| Adds the given page to the wizard, and returns the page's ID. | |
| void | setPage (int id, QWizardPage *page) |
| Adds the given page to the wizard with the given id. | |
| void | removePage (int id) |
| Removes the page with the given id. | |
| QWizardPage * | page (int id) const |
| Returns the page with the given id, or \nullptr if there is no such page. | |
| bool | hasVisitedPage (int id) const |
Returns true if the page history contains page id; otherwise, returns false. | |
| QList< int > | visitedIds () const |
| QList< int > | pageIds () const |
| Returns the list of page IDs. | |
| void | setStartId (int id) |
| int | startId () const |
| QWizardPage * | currentPage () const |
| Returns a pointer to the current page, or \nullptr if there is no current page (e.g., before the wizard is shown). | |
| int | currentId () const |
| virtual bool | validateCurrentPage () |
| This virtual function is called by QWizard when the user clicks \uicontrol Next or \uicontrol Finish to perform some last-minute validation. | |
| virtual int | nextId () const |
| This virtual function is called by QWizard to find out which page to show when the user clicks the \uicontrol Next button. | |
| void | setField (const QString &name, const QVariant &value) |
| Sets the value of the field called name to value. | |
| QVariant | field (const QString &name) const |
| Returns the value of the field called name. | |
| void | setWizardStyle (WizardStyle style) |
| WizardStyle | wizardStyle () const |
| void | setOption (WizardOption option, bool on=true) |
| Sets the given option to be enabled if on is true; otherwise, clears the given option. | |
| bool | testOption (WizardOption option) const |
Returns true if the given option is enabled; otherwise, returns false. | |
| void | setOptions (WizardOptions options) |
| WizardOptions | options () const |
| void | setButtonText (WizardButton which, const QString &text) |
| Sets the text on button which to be text. | |
| QString | buttonText (WizardButton which) const |
| Returns the text on button which. | |
| void | setButtonLayout (const QList< WizardButton > &layout) |
| Sets the order in which buttons are displayed to layout, where layout is a list of \l{WizardButton}s. | |
| void | setButton (WizardButton which, QAbstractButton *button) |
| Sets the button corresponding to role which to button. | |
| QAbstractButton * | button (WizardButton which) const |
| Returns the button corresponding to role which. | |
| 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) |
| Sets the pixmap for role which to pixmap. | |
| QPixmap | pixmap (WizardPixmap which) const |
| Returns the pixmap set for role which. | |
| void | setSideWidget (QWidget *widget) |
| QWidget * | sideWidget () const |
| void | 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. | |
| void | setVisible (bool visible) override |
| \reimp | |
| QSize | sizeHint () const override |
| \reimp | |
| Public Member Functions inherited from QDialog | |
| QDialog (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags()) | |
| Constructs a dialog with parent parent. | |
| ~QDialog () | |
| Destroys the QDialog, deleting all its children. | |
| int | result () const |
In general returns the modal dialog's result code, Accepted or Rejected. | |
| QSize | minimumSizeHint () const override |
| \reimp | |
| void | setSizeGripEnabled (bool) |
| bool | isSizeGripEnabled () const |
| void | setModal (bool modal) |
| void | setResult (int r) |
| Sets the modal dialog's result code to i. | |
| Public Member Functions inherited from QWidget | |
| QWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags()) | |
| Constructs a widget which is a child of parent, with widget flags set to f. | |
| ~QWidget () | |
| Destroys the widget. | |
| int | devType () const override |
| WId | winId () const |
| Returns the window system identifier of the widget. | |
| void | createWinId () |
| WId | internalWinId () const |
| WId | effectiveWinId () const |
| QStyle * | style () const |
| void | setStyle (QStyle *) |
| Sets the widget's GUI style to style. | |
| bool | isWindow () const |
Returns true if the widget is an independent window, otherwise returns false. | |
| bool | isModal () const |
| Qt::WindowModality | windowModality () const |
| void | setWindowModality (Qt::WindowModality windowModality) |
| bool | isEnabled () const |
| bool | isEnabledTo (const QWidget *) const |
Returns true if this widget would become enabled if ancestor is enabled; otherwise returns false. | |
| QRect | frameGeometry () const |
| const QRect & | geometry () 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) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMinimumSize(QSize(minw, minh)). | |
| void | setMaximumSize (const QSize &) |
| void | setMaximumSize (int maxw, int maxh) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMaximumSize(QSize(maxw, 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) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the x (width) size increment to w and the y (height) size increment to h. | |
| QSize | baseSize () const |
| void | setBaseSize (const QSize &) |
| void | setBaseSize (int basew, int baseh) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setBaseSize(QSize(basew, baseh)). | |
| void | setFixedSize (const QSize &) |
| Sets both the minimum and maximum sizes of the widget to s, thereby preventing it from ever growing or shrinking. | |
| void | setFixedSize (int w, int h) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the width of the widget to w and the height to h. | |
| void | setFixedWidth (int w) |
| Sets both the minimum and maximum width of the widget to w without changing the heights. | |
| void | setFixedHeight (int h) |
| Sets both the minimum and maximum heights of the widget to h without changing the widths. | |
| QPointF | mapToGlobal (const QPointF &) const |
| Translates the widget coordinate pos to global screen coordinates. | |
| QPoint | mapToGlobal (const QPoint &) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| QPointF | mapFromGlobal (const QPointF &) const |
| Translates the global screen coordinate pos to widget coordinates. | |
| QPoint | mapFromGlobal (const QPoint &) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| QPointF | mapToParent (const QPointF &) const |
| Translates the widget coordinate pos to a coordinate in the parent widget. | |
| QPoint | mapToParent (const QPoint &) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| QPointF | mapFromParent (const QPointF &) const |
| Translates the parent widget coordinate pos to widget coordinates. | |
| QPoint | mapFromParent (const QPoint &) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| QPointF | mapTo (const QWidget *, const QPointF &) const |
| Translates the widget coordinate pos to the coordinate system of parent. | |
| QPoint | mapTo (const QWidget *, const QPoint &) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| QPointF | mapFrom (const QWidget *, const QPointF &) const |
| Translates the widget coordinate pos from the coordinate system of parent to this widget's coordinate system. | |
| QPoint | mapFrom (const QWidget *, const QPoint &) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| QWidget * | window () const |
| Returns the window for this widget, i.e. | |
| QWidget * | nativeParentWidget () const |
| QWidget * | topLevelWidget () const |
| const QPalette & | palette () const |
| void | setPalette (const QPalette &) |
| void | setBackgroundRole (QPalette::ColorRole) |
| Sets the background role of the widget to role. | |
| QPalette::ColorRole | backgroundRole () const |
| Returns the background role of the widget. | |
| void | setForegroundRole (QPalette::ColorRole) |
| Sets the foreground role of the widget to role. | |
| QPalette::ColorRole | foregroundRole () const |
| Returns the foreground role. | |
| const QFont & | font () const |
| void | setFont (const QFont &) |
| QFontMetrics | fontMetrics () const |
| Returns the font metrics for the widget's current font. | |
| QFontInfo | fontInfo () const |
| Returns the font info for the widget's current font. | |
| QCursor | cursor () const |
| void | setCursor (const QCursor &) |
| void | unsetCursor () |
| void | setMouseTracking (bool enable) |
| bool | hasMouseTracking () const |
| bool | underMouse () const |
Returns true if the widget is under the mouse cursor; otherwise returns false. | |
| void | setTabletTracking (bool enable) |
| bool | hasTabletTracking () const |
| void | setMask (const QBitmap &) |
| Causes only the pixels of the widget for which bitmap has a corresponding 1 bit to be visible. | |
| void | setMask (const QRegion &) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Causes only the parts of the widget which overlap region to be visible. | |
| QRegion | mask () const |
| Returns the mask currently set on a widget. | |
| void | clearMask () |
| Removes any mask set by setMask(). | |
| 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)) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Renders the widget into the painter's QPainter::device(). | |
| Q_INVOKABLE QPixmap | grab (const QRect &rectangle=QRect(QPoint(0, 0), QSize(-1, -1))) |
| void | grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags()) |
| Subscribes the widget to a given gesture with specific flags. | |
| void | ungrabGesture (Qt::GestureType type) |
| Unsubscribes the widget from a given gesture 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 &) |
| Sets the window's role to role. | |
| QString | windowRole () const |
| Returns the window's role, or an empty string. | |
| void | setWindowFilePath (const QString &filePath) |
| QString | windowFilePath () const |
| void | setWindowOpacity (qreal level) |
| qreal | windowOpacity () const |
| bool | isWindowModified () const |
| 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 () |
| Sets the top-level widget containing this widget to be the active window. | |
| void | clearFocus () |
| Takes keyboard input focus from the widget. | |
| void | setFocus (Qt::FocusReason reason) |
| Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}. | |
| Qt::FocusPolicy | focusPolicy () const |
| void | setFocusPolicy (Qt::FocusPolicy policy) |
| bool | hasFocus () const |
| void | setFocusProxy (QWidget *) |
| Sets the widget's focus proxy to widget w. | |
| QWidget * | focusProxy () const |
| Returns the focus proxy, or \nullptr if there is no focus proxy. | |
| Qt::ContextMenuPolicy | contextMenuPolicy () const |
| void | setContextMenuPolicy (Qt::ContextMenuPolicy policy) |
| void | grabMouse () |
| Grabs the mouse input. | |
| void | grabMouse (const QCursor &) |
| void | releaseMouse () |
| Releases the mouse grab. | |
| void | grabKeyboard () |
| Grabs the keyboard input. | |
| void | releaseKeyboard () |
| Releases the keyboard grab. | |
| int | grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut) |
| Adds a shortcut to Qt's shortcut system that watches for the given key sequence in the given context. | |
| void | releaseShortcut (int id) |
| Removes the shortcut with the given id from Qt's shortcut system. | |
| void | setShortcutEnabled (int id, bool enable=true) |
| If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled. | |
| void | setShortcutAutoRepeat (int id, bool enable=true) |
| bool | updatesEnabled () const |
| void | setUpdatesEnabled (bool enable) |
| void | update (int x, int y, int w, int h) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle (x, y, w, h) inside the widget. | |
| void | update (const QRect &) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle rect inside the widget. | |
| void | update (const QRegion &) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget. | |
| void | repaint (int x, int y, int w, int h) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle (x, y, w, h) inside the widget. | |
| void | repaint (const QRect &) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle rect inside the widget. | |
| void | repaint (const QRegion &) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget. | |
| void | stackUnder (QWidget *) |
| Places the widget under w in the parent widget's stack. | |
| void | move (int x, int y) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to move(QPoint(x, y)). | |
| void | move (const QPoint &) |
| void | resize (int w, int h) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to resize(QSize(w, h)). | |
| void | resize (const QSize &) |
| void | setGeometry (int x, int y, int w, int h) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setGeometry(QRect(x, y, w, h)). | |
| void | setGeometry (const QRect &) |
| QByteArray | saveGeometry () const |
| bool | restoreGeometry (const QByteArray &geometry) |
| void | adjustSize () |
| Adjusts the size of the widget to fit its contents. | |
| bool | isVisible () const |
| bool | isVisibleTo (const QWidget *) const |
Returns true if this widget would become visible if ancestor is shown; otherwise returns false. | |
| bool | isHidden () const |
Returns true if the widget is hidden, otherwise returns false. | |
| bool | isMinimized () const |
| bool | isMaximized () const |
| bool | isFullScreen () const |
| Qt::WindowStates | windowState () const |
| Returns the current window state. | |
| void | setWindowState (Qt::WindowStates state) |
| Sets the window state to windowState. | |
| void | overrideWindowState (Qt::WindowStates state) |
| QSizePolicy | sizePolicy () const |
| void | setSizePolicy (QSizePolicy) |
| void | setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the size policy of the widget to horizontal and vertical, with standard stretch and no height-for-width. | |
| virtual int | heightForWidth (int) const |
| Returns the preferred height for this widget, given the width w. | |
| virtual bool | hasHeightForWidth () const |
| QRegion | visibleRegion () const |
| Returns the unobscured region where paint events can occur. | |
| void | setContentsMargins (int left, int top, int right, int bottom) |
| Sets the margins around the contents of the widget to have the sizes left, top, right, and bottom. | |
| void | setContentsMargins (const QMargins &margins) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| QMargins | contentsMargins () const |
| The contentsMargins function returns the widget's contents margins. | |
| QRect | contentsRect () const |
| Returns the area inside the widget's margins. | |
| QLayout * | layout () const |
| Returns the layout manager that is installed on this widget, or \nullptr if no layout manager is installed. | |
| void | setLayout (QLayout *) |
| Sets the layout manager for this widget to layout. | |
| void | updateGeometry () |
| Notifies the layout system that this widget has changed and may need to change geometry. | |
| void | setParent (QWidget *parent) |
| Sets the parent of the widget to parent, and resets the window flags. | |
| void | setParent (QWidget *parent, Qt::WindowFlags f) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function also takes widget flags, f as an argument. | |
| void | scroll (int dx, int dy) |
| Scrolls the widget including its children dx pixels to the right and dy downward. | |
| void | scroll (int dx, int dy, const QRect &) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version only scrolls r and does not move the children of the widget. | |
| QWidget * | focusWidget () const |
| Returns the last child of this widget that setFocus had been called on. | |
| QWidget * | nextInFocusChain () const |
| Returns the next widget in this widget's focus chain. | |
| QWidget * | previousInFocusChain () const |
| The previousInFocusChain function returns the previous widget in this widget's focus chain. | |
| bool | acceptDrops () const |
| void | setAcceptDrops (bool on) |
| void | addAction (QAction *action) |
| Appends the action action to this widget's list of actions. | |
| void | addActions (const QList< QAction * > &actions) |
| Appends the actions actions to this widget's list of actions. | |
| void | insertActions (QAction *before, const QList< QAction * > &actions) |
| Inserts the actions actions to this widget's list of actions, before the action before. | |
| void | insertAction (QAction *before, QAction *action) |
| Inserts the action action to this widget's list of actions, before the action before. | |
| void | removeAction (QAction *action) |
| Removes the action action from this widget's list of actions. | |
| QList< QAction * > | actions () const |
| Returns the (possibly empty) list of this widget's actions. | |
| QAction * | addAction (const QString &text) |
| QAction * | addAction (const QIcon &icon, const QString &text) |
| QAction * | addAction (const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type=Qt::AutoConnection) |
| QAction * | addAction (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...>> | |
| QAction * | addAction (const QString &text, Args &&...args) |
| template<typename... Args, typename = compatible_action_slot_args<Args...>> | |
| QAction * | addAction (const QIcon &icon, const QString &text, Args &&...args) |
| QWidget * | parentWidget () const |
| Returns the parent of this widget, or \nullptr if it does not have any parent widget. | |
| void | setWindowFlags (Qt::WindowFlags type) |
| Qt::WindowFlags | windowFlags () const |
| Window flags are a combination of a type (e.g. | |
| void | setWindowFlag (Qt::WindowType, bool on=true) |
| void | overrideWindowFlags (Qt::WindowFlags type) |
| Sets the window flags for the widget to flags, without telling the window system. | |
| Qt::WindowType | windowType () const |
| Returns the window type of this widget. | |
| QWidget * | childAt (int x, int y) const |
| Returns the visible child widget at the position ({x}, {y}) in the widget's coordinate system. | |
| QWidget * | childAt (const QPoint &p) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the visible child widget at point p in the widget's own coordinate system. | |
| void | setAttribute (Qt::WidgetAttribute, bool on=true) |
| Sets the attribute attribute on this widget if on is true; otherwise clears the attribute. | |
| bool | testAttribute (Qt::WidgetAttribute) const |
Returns true if attribute attribute is set on this widget; otherwise returns false. | |
| QPaintEngine * | paintEngine () const override |
| Returns the widget's paint engine. | |
| void | ensurePolished () const |
| Ensures that the widget and its children have been polished by QStyle (i.e., have a proper font and palette). | |
| bool | isAncestorOf (const QWidget *child) const |
Returns true if this widget is a parent, (or grandparent and so on to any level), of the given child, and both widgets are within the same window; otherwise returns false. | |
| bool | autoFillBackground () const |
| void | setAutoFillBackground (bool enabled) |
| QBackingStore * | backingStore () const |
| QWindow * | windowHandle () const |
| If this is a native widget, return the associated QWindow. | |
| QScreen * | screen () const |
| Returns the screen the widget is on. | |
| void | setScreen (QScreen *) |
| Sets the screen on which the widget should be shown to screen. | |
| virtual QVariant | inputMethodQuery (Qt::InputMethodQuery) const |
| This method is only relevant for input widgets. | |
| Qt::InputMethodHints | inputMethodHints () const |
| void | setInputMethodHints (Qt::InputMethodHints hints) |
| Public Member Functions inherited from QObject | |
| Q_INVOKABLE | QObject (QObject *parent=nullptr) |
| Constructs an object with parent object parent. | |
| virtual | ~QObject () |
| Destroys the object, deleting all its child objects. | |
| QString | objectName () const |
| Q_WEAK_OVERLOAD void | setObjectName (const QString &name) |
| Sets the object's name to name. | |
| void | setObjectName (QAnyStringView name) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| QBindable< QString > | bindableObjectName () |
| bool | isWidgetType () const |
Returns true if the object is a widget; otherwise returns false. | |
| bool | isWindowType () const |
Returns true if the object is a window; otherwise returns false. | |
| bool | isQuickItemType () const |
Returns true if the object is a QQuickItem; otherwise returns false. | |
| bool | signalsBlocked () const noexcept |
Returns true if signals are blocked; otherwise returns false. | |
| bool | blockSignals (bool b) noexcept |
| If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). | |
| QThread * | thread () const |
| Returns the thread in which the object lives. | |
| bool | moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL) |
Changes the thread affinity for this object and its children and returns true on success. | |
| int | startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer) |
| This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds. | |
| int | startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer) |
| void | killTimer (int id) |
| Kills the timer with timer identifier, id. | |
| void | killTimer (Qt::TimerId id) |
| template<typename T > | |
| T | findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object. | |
| template<typename T > | |
| QList< T > | findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. | |
| template<typename T > | |
| T | findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| template<typename T > | |
| QList< T > | findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| const QObjectList & | children () const |
| Returns a list of child objects. | |
| void | setParent (QObject *parent) |
| Makes the object a child of parent. | |
| void | installEventFilter (QObject *filterObj) |
| Installs an event filter filterObj on this object. | |
| void | removeEventFilter (QObject *obj) |
| Removes an event filter object obj from this object. | |
| 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 |
| Dumps a tree of children to the debug output. | |
| void | dumpObjectInfo () const |
| Dumps information about signal connections, etc. | |
| bool | setProperty (const char *name, const QVariant &value) |
| Sets the value of the object's name property to value. | |
| bool | setProperty (const char *name, QVariant &&value) |
| QVariant | property (const char *name) const |
| Returns the value of the object's name property. | |
| QList< QByteArray > | dynamicPropertyNames () const |
| QBindingStorage * | bindingStorage () |
| const QBindingStorage * | bindingStorage () const |
| QObject * | parent () const |
| Returns a pointer to the parent object. | |
| bool | inherits (const char *classname) const |
Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. | |
| 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 |
| \reimp | |
| void | resizeEvent (QResizeEvent *event) override |
| \reimp | |
| void | paintEvent (QPaintEvent *event) override |
| \reimp | |
| void | done (int result) override |
| \reimp | |
| virtual void | initializePage (int id) |
| 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. | |
| virtual void | cleanupPage (int id) |
| 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). | |
| Protected Member Functions inherited from QDialog | |
| QDialog (QDialogPrivate &, QWidget *parent, Qt::WindowFlags f=Qt::WindowFlags()) | |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| void | keyPressEvent (QKeyEvent *) override |
| \reimp | |
| void | closeEvent (QCloseEvent *) override |
| \reimp | |
| void | showEvent (QShowEvent *) override |
| \reimp | |
| void | contextMenuEvent (QContextMenuEvent *) override |
| \reimp | |
| bool | eventFilter (QObject *, QEvent *) override |
| \reimp | |
| void | adjustPosition (QWidget *) |
| Protected Member Functions inherited from QWidget | |
| virtual void | mousePressEvent (QMouseEvent *event) |
| This event handler, for event event, can be reimplemented in a subclass to receive mouse press events for the widget. | |
| virtual void | mouseReleaseEvent (QMouseEvent *event) |
| This event handler, for event event, can be reimplemented in a subclass to receive mouse release events for the widget. | |
| virtual void | mouseDoubleClickEvent (QMouseEvent *event) |
| This event handler, for event event, can be reimplemented in a subclass to receive mouse double click events for the widget. | |
| virtual void | mouseMoveEvent (QMouseEvent *event) |
| This event handler, for event event, can be reimplemented in a subclass to receive mouse move events for the widget. | |
| virtual void | keyReleaseEvent (QKeyEvent *event) |
| This event handler, for event event, can be reimplemented in a subclass to receive key release events for the widget. | |
| virtual void | focusInEvent (QFocusEvent *event) |
| This event handler can be reimplemented in a subclass to receive keyboard focus events (focus received) for the widget. | |
| virtual void | focusOutEvent (QFocusEvent *event) |
| This event handler can be reimplemented in a subclass to receive keyboard focus events (focus lost) for the widget. | |
| virtual void | enterEvent (QEnterEvent *event) |
| This event handler can be reimplemented in a subclass to receive widget enter events which are passed in the event parameter. | |
| virtual void | leaveEvent (QEvent *event) |
| This event handler can be reimplemented in a subclass to receive widget leave events which are passed in the event parameter. | |
| virtual void | moveEvent (QMoveEvent *event) |
| This event handler can be reimplemented in a subclass to receive widget move events which are passed in the event parameter. | |
| virtual void | actionEvent (QActionEvent *event) |
| This event handler is called with the given event whenever the widget's actions are changed. | |
| virtual void | hideEvent (QHideEvent *event) |
| This event handler can be reimplemented in a subclass to receive widget hide events. | |
| virtual bool | nativeEvent (const QByteArray &eventType, void *message, qintptr *result) |
| This special event handler can be reimplemented in a subclass to receive native platform events identified by eventType which are passed in the message parameter. | |
| virtual void | changeEvent (QEvent *) |
| This event handler can be reimplemented to handle state changes. | |
| int | metric (PaintDeviceMetric) const override |
| Internal implementation of the virtual QPaintDevice::metric() function. | |
| void | initPainter (QPainter *painter) const override |
| Initializes the painter pen, background and font to the same as the given widget's. | |
| QPaintDevice * | redirected (QPoint *offset) const override |
| QPainter * | sharedPainter () const override |
| virtual void | inputMethodEvent (QInputMethodEvent *) |
| This event handler, for event event, can be reimplemented in a subclass to receive Input Method composition events. | |
| void | create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true) |
| Creates a new widget window. | |
| void | destroy (bool destroyWindow=true, bool destroySubWindows=true) |
| Frees up window system resources. | |
| virtual bool | focusNextPrevChild (bool next) |
Finds a new widget to give the keyboard focus to, as appropriate for Tab and Shift+Tab, and returns true if it can find a new widget, or false if it can't. | |
| bool | focusNextChild () |
Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Tab, and returns true if it can find a new widget, or false if it can't. | |
| bool | focusPreviousChild () |
Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Shift+Tab, and returns true if it can find a new widget, or false if it can't. | |
| QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f) | |
| Protected Member Functions inherited from QObject | |
| QObject * | sender () const |
| Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr. | |
| int | senderSignalIndex () const |
| int | receivers (const char *signal) const |
| Returns the number of receivers connected to the signal. | |
| bool | isSignalConnected (const QMetaMethod &signal) const |
| virtual void | timerEvent (QTimerEvent *event) |
| This event handler can be reimplemented in a subclass to receive timer events for the object. | |
| virtual void | childEvent (QChildEvent *event) |
| This event handler can be reimplemented in a subclass to receive child events. | |
| virtual void | customEvent (QEvent *event) |
| This event handler can be reimplemented in a subclass to receive custom events. | |
| 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 | |
| WizardOptions | options |
| the various options that affect the look and feel of the wizard | |
| Qt::TextFormat | titleFormat |
| the text format used by page titles | |
| Qt::TextFormat | subTitleFormat |
| the text format used by page subtitles | |
| int | startId |
| the ID of the first page | |
| int | currentId |
| the ID of the current page | |
| Properties inherited from QDialog | |
| bool | sizeGripEnabled |
| whether the size grip is enabled | |
| bool | modal |
| whether show() should pop up the dialog as modal or modeless | |
| Properties inherited from QWidget | |
| bool | modal |
| whether the widget is a modal widget | |
| Qt::WindowModality | windowModality |
| which windows are blocked by the modal widget | |
| bool | enabled |
| whether the widget is enabled | |
| QRect | geometry |
| the geometry of the widget relative to its parent and excluding the window frame | |
| QRect | frameGeometry |
| geometry of the widget relative to its parent including any window frame | |
| QRect | normalGeometry |
| the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget | |
| int | x |
| the x coordinate of the widget relative to its parent including any window frame | |
| int | y |
| the y coordinate of the widget relative to its parent and including any window frame | |
| QPoint | pos |
| the position of the widget within its parent widget | |
| QSize | frameSize |
| the size of the widget including any window frame | |
| QSize | size |
| the size of the widget excluding any window frame | |
| int | width |
| the width of the widget excluding any window frame | |
| int | height |
| the height of the widget excluding any window frame | |
| QRect | rect |
| the internal geometry of the widget excluding any window frame | |
| QRect | childrenRect |
| the bounding rectangle of the widget's children | |
| QRegion | childrenRegion |
| the combined region occupied by the widget's children | |
| QSizePolicy | sizePolicy |
| the default layout behavior of the widget | |
| QSize | minimumSize |
| the widget's minimum size | |
| QSize | maximumSize |
| the widget's maximum size in pixels | |
| int | minimumWidth |
| the widget's minimum width in pixels | |
| int | minimumHeight |
| the widget's minimum height in pixels | |
| int | maximumWidth |
| the widget's maximum width in pixels | |
| int | maximumHeight |
| the widget's maximum height in pixels | |
| QSize | sizeIncrement |
| the size increment of the widget | |
| QSize | baseSize |
| the base size of the widget | |
| QPalette | palette |
| the widget's palette | |
| QFont | font |
| the font currently set for the widget | |
| QCursor | cursor |
| the cursor shape for this widget | |
| bool | mouseTracking |
| whether mouse tracking is enabled for the widget | |
| bool | tabletTracking |
| whether tablet tracking is enabled for the widget | |
| bool | isActiveWindow |
| whether this widget's window is the active window | |
| Qt::FocusPolicy | focusPolicy |
| the way the widget accepts keyboard focus | |
| bool | focus |
| whether this widget (or its focus proxy) has the keyboard input focus | |
| Qt::ContextMenuPolicy | contextMenuPolicy |
| how the widget shows a context menu | |
| bool | updatesEnabled |
| whether updates are enabled | |
| bool | visible |
| whether the widget is visible | |
| bool | minimized |
| whether this widget is minimized (iconified) | |
| bool | maximized |
| whether this widget is maximized | |
| bool | fullScreen |
| whether the widget is shown in full screen mode | |
| QSize | sizeHint |
| the recommended size for the widget | |
| QSize | minimumSizeHint |
| the recommended minimum size for the widget | |
| bool | acceptDrops |
| whether drop events are enabled for this widget | |
| QString | windowTitle |
| the window title (caption) | |
| QIcon | windowIcon |
| the widget's icon | |
| QString | windowIconText |
| the text to be displayed on the icon of a minimized window | |
| double | windowOpacity |
| The level of opacity for the window. | |
| bool | windowModified |
| whether the document shown in the window has unsaved changes | |
| Qt::LayoutDirection | layoutDirection |
| the layout direction for this widget. | |
| bool | autoFillBackground |
| whether the widget background is filled automatically | |
| QString | styleSheet |
| the widget's style sheet | |
| QLocale | locale |
| the widget's locale | |
| QString | windowFilePath |
| the file path associated with a widget | |
| Qt::InputMethodHints | inputMethodHints |
| What input method specific hints the widget has. | |
| Properties inherited from QObject | |
| QString | objectName |
| the name of this object | |
Additional Inherited Members | |
| Static Public Member Functions inherited from QWidget | |
| static void | setTabOrder (QWidget *, QWidget *) |
| Puts the second widget after the first widget in the focus order. | |
| static void | setTabOrder (std::initializer_list< QWidget * > widgets) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| static QWidget * | mouseGrabber () |
| Returns the widget that is currently grabbing the mouse input. | |
| static QWidget * | keyboardGrabber () |
| Returns the widget that is currently grabbing the keyboard input. | |
| static QWidget * | find (WId) |
| Returns a pointer to the widget with window identifier/handle id. | |
| static QWidget * | createWindowContainer (QWindow *window, QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags()) |
| Creates a QWidget that makes it possible to embed window into a QWidget-based application. | |
| 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) |
| \threadsafe | |
| 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::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection) |
| template<typename Func1 , typename Func2 > | |
| static QMetaObject::Connection | connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot) |
| static bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member) |
| \threadsafe | |
| static bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member) |
| static bool | disconnect (const QMetaObject::Connection &) |
| Disconnect a 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) |
| Updates the widget's micro focus and informs input methods that the state specified by query has changed. | |
| Protected Attributes inherited from QObject | |
| QScopedPointer< QObjectData > | d_ptr |
| Protected Attributes inherited from QPaintDevice | |
| ushort | painters |
| Related Symbols inherited from QWidget | |
| setupUi (QWidget *widget) | |
| \macro QWIDGETSIZE_MAX | |
| Related Symbols inherited from QObject | |
| template< class T > T | qobject_cast (const QObject *object) |
| Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr. | |
| template< typename T > T | qFindChildqFindChildren (const QObject *obj, const QString &name)() |
| template< typename T > QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QString &name)() |
| QObjectList | |
| \macro Q_CLASSINFO(Name, Value) | |
The QWizard class provides a framework for wizards.
\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:
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
| Enumerator | |
|---|---|
| BackButton | |
| NextButton | |
| CommitButton | |
| FinishButton | |
| CancelButton | |
| HelpButton | |
| CustomButton1 | |
| CustomButton2 | |
| CustomButton3 | |
| Stretch | |
| NoButton | |
| NStandardButtons | |
| NButtons | |
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.
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
| Enumerator | |
|---|---|
| WatermarkPixmap | |
| LogoPixmap | |
| BannerPixmap | |
| BackgroundPixmap | |
| NPixmaps | |
| enum QWizard::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
| Enumerator | |
|---|---|
| ClassicStyle | |
| ModernStyle | |
| MacStyle | |
| AeroStyle | |
| NStyles | |
Constructs a wizard with the given parent and window flags.
Definition at line 2125 of file qwizard.cpp.
References d.
| QWizard::~QWizard | ( | ) |
Destroys the wizard and its pages, releasing any allocated resources.
Definition at line 2135 of file qwizard.cpp.
References d.
| 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.
Definition at line 2149 of file qwizard.cpp.
References d, page, and setPage().
Here is the call graph for this function:
|
slot |
Goes back to the previous page.
This is equivalent to pressing the \uicontrol Back button.
Definition at line 3031 of file qwizard.cpp.
References QWizardPrivate::Backward, and d.
Referenced by removePage().
Here is the caller graph for this function:| QAbstractButton * QWizard::button | ( | WizardButton | which | ) | const |
Returns the button corresponding to role which.
Definition at line 2732 of file qwizard.cpp.
References AeroStyle, BackButton, and d.
| 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.
Definition at line 2630 of file qwizard.cpp.
References buttonDefaultText(), and d.
Referenced by QWizardPage::buttonText().
Here is the call graph for this function: Here is the caller graph for this function:
|
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).
Definition at line 3282 of file qwizard.cpp.
References page.
Referenced by removePage().
Here is the caller graph for this function:| int QWizard::currentId | ( | ) | const |
Definition at line 2407 of file qwizard.cpp.
References d.
|
signal |
This signal is emitted when the current page changes, with the new current id.
| 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()).
Definition at line 2389 of file qwizard.cpp.
Referenced by QWizardPage::isFinalPage(), nextId(), paintEvent(), setButtonText(), QWizardPage::setCommitPage(), QWizardPage::setFinalPage(), sizeHint(), and validateCurrentPage().
Here is the caller graph for this function:
|
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.
|
overrideprotectedvirtual |
\reimp
Reimplemented from QDialog.
Definition at line 3233 of file qwizard.cpp.
References d, QDialog::done(), QDialog::Rejected, and validateCurrentPage().
Here is the call graph for this function:
|
overrideprotectedvirtual |
\reimp
Reimplemented from QWidget.
Definition at line 3124 of file qwizard.cpp.
References AeroStyle, d, QObject::event(), QWidget::layoutDirection, QEvent::LayoutDirectionChange, QEvent::PaletteChange, QEvent::Resize, Qt::RightToLeft, QEvent::Show, QWidget::style(), QEvent::StyleChange, and QWidget::width.
Here is the call graph for this function:Returns the value of the field called name.
This function can be used to access fields on any page of the wizard.
Definition at line 2443 of file qwizard.cpp.
References d, field(), Q_UNLIKELY, qUtf16Printable, and qWarning.
Referenced by field(), setField(), and setPage().
Here is the call graph for this function: Here is the caller graph for this function:| 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.
Definition at line 2315 of file qwizard.cpp.
References d.
|
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
|
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).
Definition at line 3264 of file qwizard.cpp.
References page.
|
slot |
Advances to the next page.
This is equivalent to pressing the \uicontrol Next or \uicontrol Commit button.
Definition at line 3047 of file qwizard.cpp.
References d, QWizardPrivate::Forward, next(), nextId(), Q_UNLIKELY, qWarning, and validateCurrentPage().
Referenced by next().
Here is the call graph for this function: Here is the caller graph for this function:
|
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.
Definition at line 3328 of file qwizard.cpp.
References currentPage(), and page.
Referenced by QWizardPage::isFinalPage(), and next().
Here is the call graph for this function: Here is the caller graph for this function:| QWizard::WizardOptions QWizard::options | ( | ) | const |
Definition at line 2582 of file qwizard.cpp.
References d.
| QWizardPage * QWizard::page | ( | int | id | ) | const |
Returns the page with the given id, or \nullptr if there is no such page.
Definition at line 2299 of file qwizard.cpp.
References d.
|
signal |
| QList< int > QWizard::pageIds | ( | ) | const |
|
signal |
This signal is emitted whenever a page is removed from the wizard. The page's id is passed as parameter.
Referenced by removePage().
Here is the caller graph for this function:
|
overrideprotectedvirtual |
\reimp
Reimplemented from QWidget.
Definition at line 3180 of file qwizard.cpp.
References BackgroundPixmap, currentPage(), d, QPainter::drawPixmap(), QPixmap::height(), QWidget::height, QPixmap::isNull(), MacStyle, painter, QWizardPage::pixmap(), and Q_UNUSED.
Here is the call graph for this function:| 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.
Definition at line 2814 of file qwizard.cpp.
References BackgroundPixmap, d, NPixmaps, and Q_ASSERT.
Referenced by QWizardPage::pixmap().
Here is the caller graph for this function:| void QWizard::removePage | ( | int | id | ) |
Removes the page with the given id.
cleanupPage() will be called if necessary.
Definition at line 2225 of file qwizard.cpp.
References back(), cleanupPage(), d, emit, i, pageRemoved(), and restart().
Here is the call graph for this function:
|
overrideprotectedvirtual |
\reimp
Reimplemented from QDialog.
Definition at line 3159 of file qwizard.cpp.
References d, and QDialog::resizeEvent().
Here is the call graph for this function:
|
slot |
Restarts the wizard at the start page.
This function is called automatically when the wizard is shown.
Definition at line 3112 of file qwizard.cpp.
References d, QWizardPrivate::Forward, and startId.
Referenced by removePage(), and setVisible().
Here is the caller graph for this function:| 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.
Definition at line 2702 of file qwizard.cpp.
References button, d, NButtons, oldButton(), QWidget::setParent(), and QAbstractButton::text.
Here is the call graph for this function:| 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:
Definition at line 2665 of file qwizard.cpp.
References d, i, j, QWidget::layout(), NoButton, Q_UNLIKELY, qWarning, and Stretch.
Here is the call graph for this function:| 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().
Definition at line 2605 of file qwizard.cpp.
References currentPage(), d, and text.
Here is the call graph for this function:
|
slot |
Sets currentId to id, without visiting the pages between currentId and id.
Returns without page change, if \list
Note: If pages have been forward skipped and id is 0, page visiting history will be deleted
Definition at line 3085 of file qwizard.cpp.
References QWizardPrivate::Backward, currentId, d, QWizardPrivate::Forward, Q_UNLIKELY, qWarning, and validateCurrentPage().
Here is the call graph for this function:| 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
Definition at line 2850 of file qwizard.cpp.
References className, d, i, property, and qstrcmp().
Here is the call graph for this function:Sets the value of the field called name to value.
This function can be used to set fields on any page of the wizard.
Definition at line 2420 of file qwizard.cpp.
References QVariant::constData(), d, field(), Q_UNLIKELY, qUtf16Printable, and qWarning.
Here is the call graph for this function:| void QWizard::setOption | ( | WizardOption | option, |
| bool | on = true ) |
Sets the given option to be enabled if on is true; otherwise, clears the given option.
Definition at line 2521 of file qwizard.cpp.
References d, and setOptions().
Here is the call graph for this function:| void QWizard::setOptions | ( | WizardOptions | options | ) |
Definition at line 2554 of file qwizard.cpp.
References CancelButtonOnLeft, d, DisabledBackButtonOnLastPage, HaveCustomButton1, HaveCustomButton2, HaveCustomButton3, HaveFinishButtonOnEarlyPages, HaveHelpButton, HaveNextButtonOnLastPage, HelpButtonOnRight, IndependentPages, NoBackButtonOnLastPage, NoBackButtonOnStartPage, NoCancelButton, NoCancelButtonOnLastPage, NoDefaultButton, and options.
Referenced by setOption().
Here is the caller graph for this function:| void QWizard::setPage | ( | int | id, |
| QWizardPage * | page ) |
Adds the given page to the wizard with the given id.
Definition at line 2169 of file qwizard.cpp.
References QObject::connect(), QByteArray::count(), d, emit, field(), page, pageAdded(), Q_UNLIKELY, qWarning, SIGNAL, and SLOT.
Referenced by addPage().
Here is the call graph for this function: Here is the caller graph for this function:| 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().
Definition at line 2798 of file qwizard.cpp.
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 2887 of file qwizard.cpp.
| void QWizard::setStartId | ( | int | id | ) |
Definition at line 2355 of file qwizard.cpp.
References d, Q_UNLIKELY, and qWarning.
| void QWizard::setSubTitleFormat | ( | Qt::TextFormat | format | ) |
Definition at line 2773 of file qwizard.cpp.
References d.
| void QWizard::setTitleFormat | ( | Qt::TextFormat | format | ) |
Definition at line 2752 of file qwizard.cpp.
References d.
|
overridevirtual |
\reimp
Reimplemented from QDialog.
Definition at line 2915 of file qwizard.cpp.
References d, restart(), QDialog::setVisible(), and QWidget::visible.
Here is the call graph for this function:| void QWizard::setWizardStyle | ( | WizardStyle | style | ) |
Definition at line 2469 of file qwizard.cpp.
References AeroStyle, d, QWidget::geometry, QT_CONFIG, QCoreApplication::sendEvent(), QWidget::size, QWidget::style(), and QWidget::updateGeometry().
Here is the call graph for this function:| QWidget * QWizard::sideWidget | ( | ) | const |
Returns the widget on the left side of the wizard or \nullptr.
By default, no side widget is present.
Definition at line 2905 of file qwizard.cpp.
References d.
|
overridevirtual |
\reimp
Reimplemented from QDialog.
Definition at line 2928 of file qwizard.cpp.
References BackgroundPixmap, currentPage(), d, MacStyle, pixmap, QSize::setHeight(), QSize::setWidth(), and QWidget::size.
Here is the call graph for this function:| int QWizard::startId | ( | ) | const |
Definition at line 2375 of file qwizard.cpp.
References d.
| Qt::TextFormat QWizard::subTitleFormat | ( | ) | const |
Definition at line 2780 of file qwizard.cpp.
References d.
| bool QWizard::testOption | ( | WizardOption | option | ) | const |
Returns true if the given option is enabled; otherwise, returns false.
Definition at line 2534 of file qwizard.cpp.
References d.
| Qt::TextFormat QWizard::titleFormat | ( | ) | const |
Definition at line 2759 of file qwizard.cpp.
References d.
|
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().
Definition at line 3305 of file qwizard.cpp.
References currentPage(), and page.
Referenced by done(), next(), and setCurrentId().
Here is the call graph for this function: Here is the caller graph for this function:| QList< int > QWizard::visitedIds | ( | ) | const |
Returns the list of IDs of visited pages, in the order in which the pages were visited.
Definition at line 2329 of file qwizard.cpp.
References d.
| QWizard::WizardStyle QWizard::wizardStyle | ( | ) | const |
Definition at line 2509 of file qwizard.cpp.
References d.
|
readwrite |
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.
Definition at line 26 of file qwizard.h.
Referenced by setCurrentId().
|
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
Definition at line 22 of file qwizard.h.
Referenced by setOptions().
|
readwrite |
|
readwrite |
the text format used by page subtitles
The default format is Qt::AutoText.
|
readwrite |
the text format used by page titles
The default format is Qt::AutoText.
|
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.
1.10.0