 |
Qt 4.8
|
|
Qt 4.8
|
The QWizard class provides a framework for wizards. More...
#include <qwizard.h>
Public Slots | |
| void | back () |
| Goes back to the previous page. More... | |
| void | next () |
| Advances to the next page. More... | |
| void | restart () |
| Restarts the wizard at the start page. More... | |
 Public Slots inherited from QDialog | |
| virtual void | accept () |
Hides the modal dialog and sets the result code to Accepted. More... | |
| int | exec () |
| Shows the dialog as a modal dialog, blocking until the user closes it. More... | |
| void | open () |
| Shows the dialog as a window modal dialog, returning immediately. More... | |
| virtual void | reject () |
Hides the modal dialog and sets the result code to Rejected. More... | |
| void | showExtension (bool) |
| If showIt is true, the dialog's extension is shown; otherwise the extension is hidden. More... | |
| Public Slots inherited from QWidget | |
| bool | close () |
| Closes this widget. More... | |
| void | hide () |
| Hides the widget. More... | |
| void | lower () |
| Lowers the widget to the bottom of the parent widget's stack. More... | |
| void | raise () |
| Raises this widget to the top of the parent widget's stack. More... | |
| void | repaint () |
| Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden. More... | |
| void | setDisabled (bool) |
| Disables widget input events if disable is true; otherwise enables input events. More... | |
| void | setEnabled (bool) |
| void | setFocus () |
| Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the active window. More... | |
| void | setHidden (bool hidden) |
| Convenience function, equivalent to setVisible(!hidden). More... | |
| QT_MOC_COMPAT void | setShown (bool shown) |
| Use setVisible(shown) instead. More... | |
| void | setStyleSheet (const QString &styleSheet) |
| void | setWindowModified (bool) |
| void | setWindowTitle (const QString &) |
| void | show () |
| Shows the widget and its child widgets. More... | |
| void | showFullScreen () |
| Shows the widget in full-screen mode. More... | |
| void | showMaximized () |
| Shows the widget maximized. More... | |
| void | showMinimized () |
| Shows the widget minimized, as an icon. More... | |
| void | showNormal () |
| Restores the widget after it has been maximized or minimized. More... | |
| void | update () |
| Updates the widget unless updates are disabled or the widget is hidden. More... | |
| Public Slots inherited from QObject | |
| void | deleteLater () |
| Schedules this object for deletion. More... | |
Signals | |
| void | currentIdChanged (int id) |
| This signal is emitted when the current page changes, with the new current id. More... | |
| void | customButtonClicked (int which) |
| This signal is emitted when the user clicks a custom button. More... | |
| void | helpRequested () |
| This signal is emitted when the user clicks the Help button. More... | |
| void | pageAdded (int id) |
| This signal is emitted whenever a page is added to the wizard. More... | |
| void | pageRemoved (int id) |
| This signal is emitted whenever a page is removed from the wizard. More... | |
| Signals inherited from QDialog | |
| void | accepted () |
| This signal is emitted when the dialog has been accepted either by the user or by calling accept() or done() with the QDialog::Accepted argument. More... | |
| void | finished (int result) |
| This signal is emitted when the dialog's result code has been set, either by the user or by calling done(), accept(), or reject(). More... | |
| void | rejected () |
| This signal is emitted when the dialog has been rejected either by the user or by calling reject() or done() with the QDialog::Rejected argument. More... | |
| Signals inherited from QWidget | |
| void | customContextMenuRequested (const QPoint &pos) |
| This signal is emitted when the widget's contextMenuPolicy is Qt::CustomContextMenu, and the user has requested a context menu on the widget. More... | |
| Signals inherited from QObject | |
| void | destroyed (QObject *=0) |
| This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More... | |
Public Functions | |
| int | addPage (QWizardPage *page) |
| Adds the given page to the wizard, and returns the page's ID. More... | |
| QAbstractButton * | button (WizardButton which) const |
| Returns the button corresponding to role which. More... | |
| QString | buttonText (WizardButton which) const |
| Returns the text on button which. More... | |
| int | currentId () const |
| QWizardPage * | currentPage () const |
| Returns a pointer to the current page, or 0 if there is no current page (e.g., before the wizard is shown). More... | |
| QVariant | field (const QString &name) const |
| Returns the value of the field called name. More... | |
| bool | hasVisitedPage (int id) const |
| Returns true if the page history contains page id; otherwise, returns false. More... | |
| virtual int | nextId () const |
| This virtual function is called by QWizard to find out which page to show when the user clicks the Next button. More... | |
| WizardOptions | options () const |
| QWizardPage * | page (int id) const |
| Returns the page with the given id, or 0 if there is no such page. More... | |
| QList< int > | pageIds () const |
| Returns the list of page IDs. More... | |
| QPixmap | pixmap (WizardPixmap which) const |
| Returns the pixmap set for role which. More... | |
| QWizard (QWidget *parent=0, Qt::WindowFlags flags=0) | |
| Constructs a wizard with the given parent and window flags. More... | |
| void | removePage (int id) |
| Removes the page with the given id. More... | |
| void | setButton (WizardButton which, QAbstractButton *button) |
| Sets the button corresponding to role which to button. More... | |
| void | setButtonLayout (const QList< WizardButton > &layout) |
| Sets the order in which buttons are displayed to layout, where layout is a list of WizardButton. More... | |
| void | setButtonText (WizardButton which, const QString &text) |
| Sets the text on button which to be text. More... | |
| 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. More... | |
| void | setField (const QString &name, const QVariant &value) |
| Sets the value of the field called name to value. More... | |
| void | setOption (WizardOption option, bool on=true) |
| Sets the given option to be enabled if on is true; otherwise, clears the given option. More... | |
| void | setOptions (WizardOptions options) |
| void | setPage (int id, QWizardPage *page) |
| Adds the given page to the wizard with the given id. More... | |
| void | setPixmap (WizardPixmap which, const QPixmap &pixmap) |
| Sets the pixmap for role which to pixmap. More... | |
| void | setSideWidget (QWidget *widget) |
| Sets the given widget to be shown on the left side of the wizard. More... | |
| void | setStartId (int id) |
| void | setSubTitleFormat (Qt::TextFormat format) |
| void | setTitleFormat (Qt::TextFormat format) |
| void | setVisible (bool visible) |
| Reimplemented Function More... | |
| void | setWizardStyle (WizardStyle style) |
| QWidget * | sideWidget () const |
| Returns the widget on the left side of the wizard or 0. More... | |
| QSize | sizeHint () const |
| Reimplemented Function More... | |
| int | startId () const |
| Qt::TextFormat | subTitleFormat () const |
| bool | testOption (WizardOption option) const |
| Returns true if the given option is enabled; otherwise, returns false. More... | |
| Qt::TextFormat | titleFormat () const |
| virtual bool | validateCurrentPage () |
| This virtual function is called by QWizard when the user clicks Next or Finish to perform some last-minute validation. More... | |
| QList< int > | visitedPages () const |
| Returns the list of IDs of visited pages, in the order in which the pages were visited. More... | |
| WizardStyle | wizardStyle () const |
| ~QWizard () | |
| Destroys the wizard and its pages, releasing any allocated resources. More... | |
| Public Functions inherited from QDialog | |
| QWidget * | extension () const |
| Returns the dialog's extension or 0 if no extension has been defined. More... | |
| bool | isSizeGripEnabled () const |
| QSize | minimumSizeHint () const |
| Reimplemented Function More... | |
| Qt::Orientation | orientation () const |
| Returns the dialog's extension orientation. More... | |
| QDialog (QWidget *parent=0, Qt::WindowFlags f=0) | |
| Constructs a dialog with parent parent. More... | |
| int | result () const |
In general returns the modal dialog's result code, Accepted or Rejected. More... | |
| void | setExtension (QWidget *extension) |
| Sets the widget, extension, to be the dialog's extension, deleting any previous extension. More... | |
| void | setModal (bool modal) |
| void | setOrientation (Qt::Orientation orientation) |
| If orientation is Qt::Horizontal, the extension will be displayed to the right of the dialog's main area. More... | |
| void | setResult (int r) |
| Sets the modal dialog's result code to i. More... | |
| void | setSizeGripEnabled (bool) |
| ~QDialog () | |
| Destroys the QDialog, deleting all its children. More... | |
| Public Functions inherited from QWidget | |
| bool | acceptDrops () const |
| QString | accessibleDescription () const |
| QString | accessibleName () const |
| QList< QAction * > | actions () const |
| Returns the (possibly empty) list of this widget's actions. More... | |
| void | activateWindow () |
| Sets the top-level widget containing this widget to be the active window. More... | |
| void | addAction (QAction *action) |
| Appends the action action to this widget's list of actions. More... | |
| void | addActions (QList< QAction *> actions) |
| Appends the actions actions to this widget's list of actions. More... | |
| void | adjustSize () |
| Adjusts the size of the widget to fit its contents. More... | |
| bool | autoFillBackground () const |
| QPalette::ColorRole | backgroundRole () const |
| Returns the background role of the widget. More... | |
| QSize | baseSize () const |
| QWidget * | childAt (int x, int y) const |
| Returns the visible child widget at the position ({x}, {y}) in the widget's coordinate system. More... | |
| QWidget * | childAt (const QPoint &p) const |
| Returns the visible child widget at point p in the widget's own coordinate system. More... | |
| QRect | childrenRect () const |
| QRegion | childrenRegion () const |
| void | clearFocus () |
| Takes keyboard input focus from the widget. More... | |
| void | clearMask () |
| Removes any mask set by setMask(). More... | |
| QMargins | contentsMargins () const |
| The contentsMargins function returns the widget's contents margins. More... | |
| QRect | contentsRect () const |
| Returns the area inside the widget's margins. More... | |
| Qt::ContextMenuPolicy | contextMenuPolicy () const |
| void | createWinId () |
| QCursor | cursor () const |
| int | devType () const |
| WId | effectiveWinId () const |
| Returns the effective window system identifier of the widget, i. More... | |
| void | ensurePolished () const |
| Ensures that the widget has been polished by QStyle (i.e., has a proper font and palette). More... | |
| Qt::FocusPolicy | focusPolicy () const |
| QWidget * | focusProxy () const |
| Returns the focus proxy, or 0 if there is no focus proxy. More... | |
| QWidget * | focusWidget () const |
| Returns the last child of this widget that setFocus had been called on. More... | |
| const QFont & | font () const |
| QFontInfo | fontInfo () const |
| Returns the font info for the widget's current font. More... | |
| QFontMetrics | fontMetrics () const |
| Returns the font metrics for the widget's current font. More... | |
| QPalette::ColorRole | foregroundRole () const |
| Returns the foreground role. More... | |
| QRect | frameGeometry () const |
| QSize | frameSize () const |
| const QRect & | geometry () const |
| void | getContentsMargins (int *left, int *top, int *right, int *bottom) const |
| Returns the widget's contents margins for left, top, right, and bottom. More... | |
| HDC | getDC () const |
| Returns the window system handle of the widget, for low-level access. More... | |
| void | grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags()) |
| Subscribes the widget to a given gesture with specific flags. More... | |
| void | grabKeyboard () |
| Grabs the keyboard input. More... | |
| void | grabMouse () |
| Grabs the mouse input. More... | |
| void | grabMouse (const QCursor &) |
| 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. More... | |
| QGraphicsEffect * | graphicsEffect () const |
| The graphicsEffect function returns a pointer to the widget's graphics effect. More... | |
| QGraphicsProxyWidget * | graphicsProxyWidget () const |
| Returns the proxy widget for the corresponding embedded widget in a graphics view; otherwise returns 0. More... | |
| bool | hasFocus () const |
| bool | hasMouseTracking () const |
| int | height () const |
| virtual int | heightForWidth (int) const |
| Returns the preferred height for this widget, given the width w. More... | |
| QInputContext * | inputContext () |
| This function returns the QInputContext for this widget. More... | |
| Qt::InputMethodHints | inputMethodHints () const |
| virtual QVariant | inputMethodQuery (Qt::InputMethodQuery) const |
| This method is only relevant for input widgets. More... | |
| void | insertAction (QAction *before, QAction *action) |
| Inserts the action action to this widget's list of actions, before the action before. More... | |
| void | insertActions (QAction *before, QList< QAction *> actions) |
| Inserts the actions actions to this widget's list of actions, before the action before. More... | |
| WId | internalWinId () const |
| Returns the window system identifier of the widget, or 0 if the widget is not created yet. More... | |
| bool | isActiveWindow () const |
| 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. More... | |
| bool | isEnabled () const |
| bool | isEnabledTo (QWidget *) const |
| Returns true if this widget would become enabled if ancestor is enabled; otherwise returns false. More... | |
| bool | isEnabledToTLW () const |
| This function is deprecated. More... | |
| bool | isFullScreen () const |
| bool | isHidden () const |
| Returns true if the widget is hidden, otherwise returns false. More... | |
| bool | isLeftToRight () const |
| bool | isMaximized () const |
| bool | isMinimized () const |
| bool | isModal () const |
| bool | isRightToLeft () const |
| bool | isTopLevel () const |
| Use isWindow() instead. More... | |
| bool | isVisible () const |
| bool | isVisibleTo (QWidget *) const |
| Returns true if this widget would become visible if ancestor is shown; otherwise returns false. More... | |
| bool | isWindow () const |
| Returns true if the widget is an independent window, otherwise returns false. More... | |
| bool | isWindowModified () const |
| QLayout * | layout () const |
| Returns the layout manager that is installed on this widget, or 0 if no layout manager is installed. More... | |
| Qt::LayoutDirection | layoutDirection () const |
| QLocale | locale () const |
| Qt::HANDLE | macCGHandle () const |
| Returns the CoreGraphics handle of the widget. More... | |
| Qt::HANDLE | macQDHandle () const |
| Returns the QuickDraw handle of the widget. More... | |
| QPoint | mapFrom (QWidget *, const QPoint &) const |
| Translates the widget coordinate pos from the coordinate system of parent to this widget's coordinate system. More... | |
| QPoint | mapFromGlobal (const QPoint &) const |
| Translates the global screen coordinate pos to widget coordinates. More... | |
| QPoint | mapFromParent (const QPoint &) const |
| Translates the parent widget coordinate pos to widget coordinates. More... | |
| QPoint | mapTo (QWidget *, const QPoint &) const |
| Translates the widget coordinate pos to the coordinate system of parent. More... | |
| QPoint | mapToGlobal (const QPoint &) const |
| Translates the widget coordinate pos to global screen coordinates. More... | |
| QPoint | mapToParent (const QPoint &) const |
| Translates the widget coordinate pos to a coordinate in the parent widget. More... | |
| QRegion | mask () const |
| Returns the mask currently set on a widget. More... | |
| int | maximumHeight () const |
| QSize | maximumSize () const |
| int | maximumWidth () const |
| int | minimumHeight () const |
| QSize | minimumSize () const |
| int | minimumWidth () const |
| void | move (int x, int y) |
| This corresponds to move(QPoint(x, y)). More... | |
| void | move (const QPoint &) |
| QWidget * | nativeParentWidget () const |
| Returns the native parent for this widget, i. More... | |
| QWidget * | nextInFocusChain () const |
| Returns the next widget in this widget's focus chain. More... | |
| QRect | normalGeometry () const |
| void | overrideWindowFlags (Qt::WindowFlags type) |
| Sets the window flags for the widget to flags, without telling the window system. More... | |
| void | overrideWindowState (Qt::WindowStates state) |
| QPaintEngine * | paintEngine () const |
| Returns the widget's paint engine. More... | |
| const QPalette & | palette () const |
| QWidget * | parentWidget () const |
| Returns the parent of this widget, or 0 if it does not have any parent widget. More... | |
| QPoint | pos () const |
| QWidget * | previousInFocusChain () const |
| The previousInFocusChain function returns the previous widget in this widget's focus chain. More... | |
| QWidget (QWidget *parent=0, Qt::WindowFlags f=0) | |
| Constructs a widget which is a child of parent, with widget flags set to f. More... | |
| QRect | rect () const |
| void | releaseDC (HDC) const |
| Releases the HDC hdc acquired by a previous call to getDC(). More... | |
| void | releaseKeyboard () |
| Releases the keyboard grab. More... | |
| void | releaseMouse () |
| Releases the mouse grab. More... | |
| void | releaseShortcut (int id) |
| Removes the shortcut with the given id from Qt's shortcut system. More... | |
| void | removeAction (QAction *action) |
| Removes the action action from this widget's list of actions. More... | |
| void | render (QPaintDevice *target, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground|DrawChildren)) |
| Renders the sourceRegion of this widget into the target using renderFlags to determine how to render. More... | |
| void | render (QPainter *painter, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground|DrawChildren)) |
| Renders the widget into the painter's QPainter::device(). More... | |
| void | repaint (int x, int y, int w, int h) |
| This version repaints a rectangle (x, y, w, h) inside the widget. More... | |
| void | repaint (const QRect &) |
| This version repaints a rectangle rect inside the widget. More... | |
| void | repaint (const QRegion &) |
| This version repaints a region rgn inside the widget. More... | |
| void | resize (int w, int h) |
| This corresponds to resize(QSize(w, h)). More... | |
| void | resize (const QSize &) |
| bool | restoreGeometry (const QByteArray &geometry) |
| Restores the geometry and state top-level widgets stored in the byte array geometry. More... | |
| QByteArray | saveGeometry () const |
| Saves the current geometry and state for top-level widgets. More... | |
| void | scroll (int dx, int dy) |
| Scrolls the widget including its children dx pixels to the right and dy downward. More... | |
| void | scroll (int dx, int dy, const QRect &) |
| This version only scrolls r and does not move the children of the widget. More... | |
| void | setAcceptDrops (bool on) |
| void | setAccessibleDescription (const QString &description) |
| void | setAccessibleName (const QString &name) |
| void | setAttribute (Qt::WidgetAttribute, bool on=true) |
| Sets the attribute attribute on this widget if on is true; otherwise clears the attribute. More... | |
| void | setAutoFillBackground (bool enabled) |
| void | setBackgroundRole (QPalette::ColorRole) |
| Sets the background role of the widget to role. More... | |
| void | setBaseSize (const QSize &) |
| void | setBaseSize (int basew, int baseh) |
| This corresponds to setBaseSize(QSize(basew, baseh)). More... | |
| 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. More... | |
| void | setContentsMargins (const QMargins &margins) |
| The setContentsMargins function sets the margins around the widget's contents. More... | |
| void | setContextMenuPolicy (Qt::ContextMenuPolicy policy) |
| void | setCursor (const QCursor &) |
| void | setFixedHeight (int h) |
| Sets both the minimum and maximum heights of the widget to h without changing the widths. More... | |
| void | setFixedSize (const QSize &) |
| Sets both the minimum and maximum sizes of the widget to s, thereby preventing it from ever growing or shrinking. More... | |
| void | setFixedSize (int w, int h) |
| Sets the width of the widget to w and the height to h. More... | |
| void | setFixedWidth (int w) |
| Sets both the minimum and maximum width of the widget to w without changing the heights. More... | |
| 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 active window. More... | |
| void | setFocusPolicy (Qt::FocusPolicy policy) |
| void | setFocusProxy (QWidget *) |
| Sets the widget's focus proxy to widget w. More... | |
| void | setFont (const QFont &) |
| Use the single-argument overload instead. More... | |
| void | setForegroundRole (QPalette::ColorRole) |
| Sets the foreground role of the widget to role. More... | |
| 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)). More... | |
| void | setGeometry (const QRect &) |
| void | setGraphicsEffect (QGraphicsEffect *effect) |
| The setGraphicsEffect function is for setting the widget's graphics effect. More... | |
| void | setInputContext (QInputContext *) |
| This function sets the input context context on this widget. More... | |
| void | setInputMethodHints (Qt::InputMethodHints hints) |
| void | setLayout (QLayout *) |
| Sets the layout manager for this widget to layout. More... | |
| void | setLayoutDirection (Qt::LayoutDirection direction) |
| void | setLocale (const QLocale &locale) |
| void | setMask (const QBitmap &) |
| Causes only the pixels of the widget for which bitmap has a corresponding 1 bit to be visible. More... | |
| void | setMask (const QRegion &) |
| Causes only the parts of the widget which overlap region to be visible. More... | |
| void | setMaximumHeight (int maxh) |
| void | setMaximumSize (const QSize &) |
| void | setMaximumSize (int maxw, int maxh) |
| This function corresponds to setMaximumSize(QSize(maxw, maxh)). More... | |
| void | setMaximumWidth (int maxw) |
| void | setMinimumHeight (int minh) |
| void | setMinimumSize (const QSize &) |
| void | setMinimumSize (int minw, int minh) |
| This function corresponds to setMinimumSize(QSize(minw, minh)). More... | |
| void | setMinimumWidth (int minw) |
| void | setMouseTracking (bool enable) |
| void | setPalette (const QPalette &) |
| Use the single-argument overload instead. More... | |
| void | setParent (QWidget *parent) |
| Sets the parent of the widget to parent, and resets the window flags. More... | |
| void | setParent (QWidget *parent, Qt::WindowFlags f) |
| This function also takes widget flags, f as an argument. More... | |
| void | setShortcutAutoRepeat (int id, bool enable=true) |
| If enable is true, auto repeat of the shortcut with the given id is enabled; otherwise it is disabled. More... | |
| void | setShortcutEnabled (int id, bool enable=true) |
| If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled. More... | |
| void | setSizeIncrement (const QSize &) |
| void | setSizeIncrement (int w, int h) |
| Sets the x (width) size increment to w and the y (height) size increment to h. More... | |
| void | setSizePolicy (QSizePolicy) |
| void | setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical) |
| Sets the size policy of the widget to horizontal and vertical, with standard stretch and no height-for-width. More... | |
| void | setStatusTip (const QString &) |
| void | setStyle (QStyle *) |
| Sets the widget's GUI style to style. More... | |
| void | setToolTip (const QString &) |
| void | setUpdatesEnabled (bool enable) |
| void | setupUi (QWidget *widget) |
| Sets up the user interface for the specified widget. More... | |
| void | setWhatsThis (const QString &) |
| void | setWindowFilePath (const QString &filePath) |
| void | setWindowFlags (Qt::WindowFlags type) |
| void | setWindowIcon (const QIcon &icon) |
| void | setWindowIconText (const QString &) |
| void | setWindowModality (Qt::WindowModality windowModality) |
| void | setWindowOpacity (qreal level) |
| void | setWindowRole (const QString &) |
| Sets the window's role to role. More... | |
| void | setWindowState (Qt::WindowStates state) |
| Sets the window state to windowState. More... | |
| void | setWindowSurface (QWindowSurface *surface) |
| Sets the window surface to be the surface specified. More... | |
| QSize | size () const |
| QSize | sizeIncrement () const |
| QSizePolicy | sizePolicy () const |
| void | stackUnder (QWidget *) |
| Places the widget under w in the parent widget's stack. More... | |
| QString | statusTip () const |
| QStyle * | style () const |
| QString | styleSheet () const |
| bool | testAttribute (Qt::WidgetAttribute) const |
| Returns true if attribute attribute is set on this widget; otherwise returns false. More... | |
| QString | toolTip () const |
| QWidget * | topLevelWidget () const |
| bool | underMouse () const |
| Returns true if the widget is under the mouse cursor; otherwise returns false. More... | |
| void | ungrabGesture (Qt::GestureType type) |
| Unsubscribes the widget from a given gesture type. More... | |
| void | unsetCursor () |
| void | unsetLayoutDirection () |
| void | unsetLocale () |
| void | update (int x, int y, int w, int h) |
| This version updates a rectangle (x, y, w, h) inside the widget. More... | |
| void | update (const QRect &) |
| This version updates a rectangle rect inside the widget. More... | |
| void | update (const QRegion &) |
| This version repaints a region rgn inside the widget. More... | |
| void | updateGeometry () |
| Notifies the layout system that this widget has changed and may need to change geometry. More... | |
| bool | updatesEnabled () const |
| QRegion | visibleRegion () const |
| Returns the unobscured region where paint events can occur. More... | |
| QString | whatsThis () const |
| int | width () const |
| QWidget * | window () const |
| Returns the window for this widget, i.e. More... | |
| QString | windowFilePath () const |
| Qt::WindowFlags | windowFlags () const |
| Window flags are a combination of a type (e. More... | |
| QIcon | windowIcon () const |
| QString | windowIconText () const |
| Qt::WindowModality | windowModality () const |
| qreal | windowOpacity () const |
| QString | windowRole () const |
| Returns the window's role, or an empty string. More... | |
| Qt::WindowStates | windowState () const |
| Returns the current window state. More... | |
| QWindowSurface * | windowSurface () const |
| Returns the QWindowSurface this widget will be drawn into. More... | |
| QString | windowTitle () const |
| Qt::WindowType | windowType () const |
| Returns the window type of this widget. More... | |
| WId | winId () const |
| Returns the window system identifier of the widget. More... | |
| int | x () const |
| const QX11Info & | x11Info () const |
| Returns information about the configuration of the X display used to display the widget. More... | |
| Qt::HANDLE | x11PictureHandle () const |
| Returns the X11 Picture handle of the widget for XRender support. More... | |
| int | y () const |
| ~QWidget () | |
| Destroys the widget. More... | |
| Public Functions inherited from QObject | |
| bool | blockSignals (bool b) |
| If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More... | |
| const QObjectList & | children () const |
| Returns a list of child objects. More... | |
| bool | connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const |
| bool | disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0) |
| bool | disconnect (const QObject *receiver, const char *member=0) |
| void | dumpObjectInfo () |
| Dumps information about signal connections, etc. More... | |
| void | dumpObjectTree () |
| Dumps a tree of children to the debug output. More... | |
| QList< QByteArray > | dynamicPropertyNames () const |
| Returns the names of all properties that were dynamically added to the object using setProperty(). More... | |
| template<typename T > | |
| T | findChild (const QString &aName=QString()) const |
| Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More... | |
| template<typename T > | |
| QList< T > | findChildren (const QString &aName=QString()) 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. More... | |
| template<typename T > | |
| QList< T > | findChildren (const QRegExp &re) const |
| 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. More... | |
| void | installEventFilter (QObject *) |
| Installs an event filter filterObj on this object. More... | |
| bool | isWidgetType () const |
| Returns true if the object is a widget; otherwise returns false. More... | |
| void | killTimer (int id) |
| Kills the timer with timer identifier, id. More... | |
| virtual const QMetaObject * | metaObject () const |
| Returns a pointer to the meta-object of this object. More... | |
| void | moveToThread (QThread *thread) |
| Changes the thread affinity for this object and its children. More... | |
| QString | objectName () const |
| QObject * | parent () const |
| Returns a pointer to the parent object. More... | |
| QVariant | property (const char *name) const |
| Returns the value of the object's name property. More... | |
| Q_INVOKABLE | QObject (QObject *parent=0) |
| Constructs an object with parent object parent. More... | |
| void | removeEventFilter (QObject *) |
| Removes an event filter object obj from this object. More... | |
| void | setObjectName (const QString &name) |
| void | setParent (QObject *) |
| Makes the object a child of parent. More... | |
| bool | setProperty (const char *name, const QVariant &value) |
| Sets the value of the object's name property to value. More... | |
| void | setUserData (uint id, QObjectUserData *data) |
| bool | signalsBlocked () const |
| Returns true if signals are blocked; otherwise returns false. More... | |
| int | startTimer (int interval) |
| Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More... | |
| QThread * | thread () const |
| Returns the thread in which the object lives. More... | |
| QObjectUserData * | userData (uint id) const |
| virtual | ~QObject () |
| Destroys the object, deleting all its child objects. More... | |
| Public Functions inherited from QPaintDevice | |
| int | colorCount () const |
| int | depth () const |
| int | height () const |
| int | heightMM () const |
| int | logicalDpiX () const |
| int | logicalDpiY () const |
| QT_DEPRECATED int | numColors () const |
| bool | paintingActive () const |
| int | physicalDpiX () const |
| int | physicalDpiY () const |
| int | width () const |
| int | widthMM () const |
| virtual | ~QPaintDevice () |
Protected Functions | |
| 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 Back (unless the QWizard::IndependentPages option is set). More... | |
| void | done (int result) |
| Reimplemented Function More... | |
| bool | event (QEvent *event) |
| Reimplemented Function More... | |
| 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 Next. More... | |
| void | paintEvent (QPaintEvent *event) |
| Reimplemented Function More... | |
| void | resizeEvent (QResizeEvent *event) |
| Reimplemented Function More... | |
| bool | winEvent (MSG *message, long *result) |
| Reimplemented Function More... | |
| Protected Functions inherited from QDialog | |
| void | adjustPosition (QWidget *) |
| void | closeEvent (QCloseEvent *) |
| Reimplemented Function More... | |
| void | contextMenuEvent (QContextMenuEvent *) |
| Reimplemented Function More... | |
| bool | eventFilter (QObject *, QEvent *) |
| Reimplemented Function More... | |
| void | keyPressEvent (QKeyEvent *) |
| Reimplemented Function More... | |
| QDialog (QDialogPrivate &, QWidget *parent, Qt::WindowFlags f=0) | |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
| void | showEvent (QShowEvent *) |
| This event handler can be reimplemented in a subclass to receive widget show events which are passed in the event parameter. More... | |
| Protected Functions inherited from QWidget | |
| virtual void | actionEvent (QActionEvent *) |
| This event handler is called with the given event whenever the widget's actions are changed. More... | |
| virtual void | changeEvent (QEvent *) |
| This event handler can be reimplemented to handle state changes. More... | |
| void | create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true) |
| Creates a new widget window if window is 0, otherwise sets the widget's window to window. More... | |
| void | destroy (bool destroyWindow=true, bool destroySubWindows=true) |
| Frees up window system resources. More... | |
| virtual void | dragEnterEvent (QDragEnterEvent *) |
| This event handler is called when a drag is in progress and the mouse enters this widget. More... | |
| virtual void | dragLeaveEvent (QDragLeaveEvent *) |
| This event handler is called when a drag is in progress and the mouse leaves this widget. More... | |
| virtual void | dragMoveEvent (QDragMoveEvent *) |
| This event handler is called if a drag is in progress, and when any of the following conditions occur: the cursor enters this widget, the cursor moves within this widget, or a modifier key is pressed on the keyboard while this widget has the focus. More... | |
| virtual void | dropEvent (QDropEvent *) |
| This event handler is called when the drag is dropped on this widget. More... | |
| virtual void | enabledChange (bool) |
| virtual void | enterEvent (QEvent *) |
| This event handler can be reimplemented in a subclass to receive widget enter events which are passed in the event parameter. More... | |
| bool | event (QEvent *) |
| This is the main event handler; it handles event event. More... | |
| virtual void | focusInEvent (QFocusEvent *) |
| This event handler can be reimplemented in a subclass to receive keyboard focus events (focus received) for the widget. More... | |
| bool | focusNextChild () |
| Finds a new widget to give the keyboard focus to, as appropriate for Tab, and returns true if it can find a new widget, or false if it can't. More... | |
| 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. More... | |
| virtual void | focusOutEvent (QFocusEvent *) |
| This event handler can be reimplemented in a subclass to receive keyboard focus events (focus lost) for the widget. More... | |
| bool | focusPreviousChild () |
| Finds a new widget to give the keyboard focus to, as appropriate for Shift+Tab, and returns true if it can find a new widget, or false if it can't. More... | |
| virtual void | fontChange (const QFont &) |
| virtual void | hideEvent (QHideEvent *) |
| This event handler can be reimplemented in a subclass to receive widget hide events. More... | |
| virtual void | inputMethodEvent (QInputMethodEvent *) |
| This event handler, for event event, can be reimplemented in a subclass to receive Input Method composition events. More... | |
| virtual void | keyReleaseEvent (QKeyEvent *) |
| This event handler, for event event, can be reimplemented in a subclass to receive key release events for the widget. More... | |
| virtual void | languageChange () |
| virtual void | leaveEvent (QEvent *) |
| This event handler can be reimplemented in a subclass to receive widget leave events which are passed in the event parameter. More... | |
| virtual bool | macEvent (EventHandlerCallRef, EventRef) |
| This special event handler can be reimplemented in a subclass to receive native Macintosh events. More... | |
| int | metric (PaintDeviceMetric) const |
| Internal implementation of the virtual QPaintDevice::metric() function. More... | |
| virtual void | mouseDoubleClickEvent (QMouseEvent *) |
| This event handler, for event event, can be reimplemented in a subclass to receive mouse double click events for the widget. More... | |
| virtual void | mouseMoveEvent (QMouseEvent *) |
| This event handler, for event event, can be reimplemented in a subclass to receive mouse move events for the widget. More... | |
| virtual void | mousePressEvent (QMouseEvent *) |
| This event handler, for event event, can be reimplemented in a subclass to receive mouse press events for the widget. More... | |
| virtual void | mouseReleaseEvent (QMouseEvent *) |
| This event handler, for event event, can be reimplemented in a subclass to receive mouse release events for the widget. More... | |
| virtual void | moveEvent (QMoveEvent *) |
| This event handler can be reimplemented in a subclass to receive widget move events which are passed in the event parameter. More... | |
| virtual void | paletteChange (const QPalette &) |
| QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f) | |
| virtual bool | qwsEvent (QWSEvent *) |
| This special event handler can be reimplemented in a subclass to receive native Qt for Embedded Linux events which are passed in the event parameter. More... | |
| void | resetInputContext () |
| This function can be called on the widget that currently has focus to reset the input method operating on it. More... | |
| virtual void | styleChange (QStyle &) |
| virtual void | tabletEvent (QTabletEvent *) |
| This event handler, for event event, can be reimplemented in a subclass to receive tablet events for the widget. More... | |
| virtual void | wheelEvent (QWheelEvent *) |
| This event handler, for event event, can be reimplemented in a subclass to receive wheel events for the widget. More... | |
| virtual void | windowActivationChange (bool) |
| virtual bool | x11Event (XEvent *) |
| This special event handler can be reimplemented in a subclass to receive native X11 events passed in the event parameter. More... | |
| Protected Functions inherited from QObject | |
| virtual void | childEvent (QChildEvent *) |
| This event handler can be reimplemented in a subclass to receive child events. More... | |
| virtual void | connectNotify (const char *signal) |
| This virtual function is called when something has been connected to signal in this object. More... | |
| virtual void | customEvent (QEvent *) |
| This event handler can be reimplemented in a subclass to receive custom events. More... | |
| virtual void | disconnectNotify (const char *signal) |
| This virtual function is called when something has been disconnected from signal in this object. More... | |
| QObject (QObjectPrivate &dd, QObject *parent=0) | |
| int | receivers (const char *signal) const |
| Returns the number of receivers connected to the signal. More... | |
| 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 0. More... | |
| int | senderSignalIndex () const |
| virtual void | timerEvent (QTimerEvent *) |
| This event handler can be reimplemented in a subclass to receive timer events for the object. More... | |
| Protected Functions inherited from QPaintDevice | |
| QPaintDevice () | |
Properties | |
| int | currentId |
| the ID of the current page More... | |
| WizardOptions | options |
| the various options that affect the look and feel of the wizard More... | |
| int | startId |
| the ID of the first page More... | |
| Qt::TextFormat | subTitleFormat |
| the text format used by page subtitles More... | |
| Qt::TextFormat | titleFormat |
| the text format used by page titles More... | |
| WizardStyle | wizardStyle |
| the look and feel of the wizard More... | |
Friends | |
| class | QWizardPage |
Additional Inherited Members | |
| Static Public Functions inherited from QWidget | |
| static QWidget * | find (WId) |
| Returns a pointer to the widget with window identifer/handle id. More... | |
| static QWidget * | keyboardGrabber () |
| Returns the widget that is currently grabbing the keyboard input. More... | |
| static QWidget * | mouseGrabber () |
| Returns the widget that is currently grabbing the mouse input. More... | |
| static void | setTabOrder (QWidget *, QWidget *) |
| Puts the second widget after the first widget in the focus order. More... | |
| Static Public Functions inherited from QObject | |
| static bool | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection) |
| Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More... | |
| static bool | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection) |
| static bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member) |
| Disconnects signal in object sender from method in object receiver. More... | |
| static bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member) |
| static uint | registerUserData () |
| static QString | tr (const char *sourceText, const char *comment=0, int n=-1) |
| static QString | trUtf8 (const char *sourceText, const char *comment=0, int n=-1) |
| Static Public Functions inherited from QPaintDevice | |
| static QWSDisplay * | qwsDisplay () |
| Static Public Variables inherited from QObject | |
| static const QMetaObject | staticMetaObject |
| This variable stores the meta-object for the class. More... | |
| Protected Slots inherited from QWidget | |
| void | updateMicroFocus () |
| Updates the widget's micro focus. More... | |
| Protected Variables inherited from QObject | |
| QScopedPointer< QObjectData > | d_ptr |
| Protected Variables inherited from QPaintDevice | |
| ushort | painters |
| Static Protected Variables inherited from QObject | |
| static const QMetaObject | staticQtMetaObject |
| Related Functions inherited from QWidget | |
| QWidgetList | |
| WId | |
| Platform dependent window identifier. More... | |
| Related Functions inherited from QObject | |
| T | qFindChildqFindChildren (const QObject *obj, const QString &name)() |
| QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QString &name)() |
| QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QRegExp ®Exp)() |
| T * | qobject_cast (QObject *object) |
| QObjectList | |
| void * | qt_find_obj_child (QObject *parent, const char *type, const QString &name) |
| Returns a pointer to the object named name that inherits type and with a given parent. More... | |
| Related Functions inherited from QPaintDevice | |
| const Q_GUI_EXPORT QX11Info * | qt_x11Info (const QPaintDevice *pd) |
| Returns the QX11Info structure for the pd paint device. More... | |
The QWizard class provides a framework for wizards.
A wizard (also called an assistant on Mac OS X) 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:
The following example illustrates how to create wizard pages and add them to a wizard. For more advanced examples, see Class Wizard and License Wizard.
...
...
QWizard supports four wizard looks:
You can explicitly set the look to use using setWizardStyle() (e.g., if you want the same look on all platforms).
| ClassicStyle | ModernStyle | MacStyle | AeroStyle |
| 
| 
| 
|
| 
| 
| 
|
Note: AeroStyle has effect only on a Windows Vista system with alpha compositing enabled. ModernStyle is used as a fallback when this condition is not met.
In addition to the wizard style, there are several options that control the look and feel of the wizard. These can be set using setOption() or setOptions(). For example, HaveHelpButton makes QWizard show a Help button along with the other wizard buttons.
You can even change the order of the wizard buttons to any arbitrary order using setButtonLayout(), and you can add up to three custom buttons (e.g., a Print button) to the button row. This is achieved by calling setButton() or setButtonText() with CustomButton1, CustomButton2, or CustomButton3 to set up the button, and by enabling the HaveCustomButton1, HaveCustomButton2, or HaveCustomButton3 options. Whenever the user clicks a custom button, customButtonClicked() is emitted. For example:
Wizards consist of a sequence of QWizardPage. At any time, only one page is shown. A page has the following attributes:
The diagram belows shows how QWizard renders these attributes, assuming they are all present and ModernStyle is used:
When a QWizardPage::subTitle is set, QWizard displays it in a header, in which case it also uses the BannerPixmap and the LogoPixmap to decorate the header. The WatermarkPixmap is displayed on the left side, below the header. At the bottom, there is a row of buttons allowing the user to navigate through the pages.
The page itself (the QWizardPage widget) occupies the area between the header, the watermark, and the button row. Typically, the page is a QWizardPage on which a QGridLayout is installed, with standard child widgets (QLabel, QLineEdit, etc.).
If the wizard's style is MacStyle, the page looks radically different:
The watermark, banner, and logo pixmaps are ignored by the MacStyle. If the BackgroundPixmap is set, it is used as the background for the wizard; otherwise, a default "assistant" image is used.
The title and subtitle are set by calling QWizardPage::setTitle() and QWizardPage::setSubTitle() on the individual pages. They may be plain text or HTML (see titleFormat and subTitleFormat). The pixmaps can be set globally for the entire wizard using setPixmap(), or on a per-page basis using QWizardPage::setPixmap().
In many wizards, the contents of a page may affect the default values of the fields of a later page. To make it easy to communicate between pages, QWizard supports a "field" mechanism that allows you to register a field (e.g., a QLineEdit) on a page and to access its value from any page. It is also possible to specify mandatory fields (i.e., fields that must be filled before the user can advance to the next page).
To register a field, call QWizardPage::registerField() field. For example:
...
...
The above code registers three fields, className, baseClass, and qobjectMacro, which are associated with three child widgets. The asterisk (*) next to className denotes a mandatory field.
The fields of any page are accessible from any other page. For example:
Here, we call QWizardPage::field() to access the contents of the className field (which was defined in the ClassInfoPage) and use it to initialize the OuputFilePage. The field's contents is returned as a QVariant.
When we create a field using QWizardPage::registerField(), we pass a unique field name and a widget. We can also provide a Qt property name and a "changed" signal (a signal that is emitted when the property changes) as third and fourth arguments; however, this is not necessary for the most common Qt widgets, such as QLineEdit, QCheckBox, and QComboBox, because QWizard knows which properties to look for.
If an asterisk (*) is appended to the name when the property is registered, the field is a mandatory field. When a page has mandatory fields, the Next and/or Finish buttons are enabled only when all mandatory fields are filled.
To consider a field "filled", QWizard simply checks that the field's current value doesn't equal the original value (the value it had when initializePage() was called). For QLineEdit and QAbstractSpinBox subclasses, QWizard also checks that hasAcceptableInput() returns true, to honor any validator or mask.
QWizard's mandatory field mechanism is provided for convenience. A more powerful (but also more cumbersome) alternative is to reimplement QWizardPage::isComplete() and to emit the QWizardPage::completeChanged() signal whenever the page becomes complete or incomplete.
The enabled/disabled state of the Next and/or Finish buttons is one way to perform validation on the user input. Another way is to reimplement validateCurrentPage() (or QWizardPage::validatePage()) to perform some last-minute validation (and show an error message if the user has entered incomplete or invalid information). If the function returns true, the next page is shown (or the wizard finishes); otherwise, the current page stays up.
Most wizards have a linear structure, with page 1 followed by page 2 and so on until the last page. The Class Wizard example is such a wizard. With QWizard, linear wizards are created by instantiating the QWizardPage and inserting them using addPage(). By default, the pages are shown in the order in which they were added. For example:
...
When a page is about to be shown, QWizard calls initializePage() (which in turn calls QWizardPage::initializePage()) to fill the page with default values. By default, this function does nothing, but it can be reimplemented to initialize the page's contents based on other pages' fields (see the initialize page{example above}).
If the user presses Back, cleanupPage() is called (which in turn calls QWizardPage::cleanupPage()). The default implementation resets the page's fields to their original values (the values they had before initializePage() was called). If you want the Back button to be non-destructive and keep the values entered by the user, simply enable the IndependentPages option.
Some wizards are more complex in that they allow different traversal paths based on the information provided by the user. The License Wizard example illustrates this. It provides five wizard pages; depending on which options are selected, the user can reach different pages.
In complex wizards, pages are identified by IDs. These IDs are typically defined using an enum. For example:
...
...
The pages are inserted using setPage(), which takes an ID and an instance of QWizardPage (or of a subclass):
...
By default, the pages are shown in increasing ID order. To provide a dynamic order that depends on the options chosen by the user, we must reimplement QWizardPage::nextId(). For example:
It would also be possible to put all the logic in one place, in a QWizard::nextId() reimplementation. For example:
To start at another page than the page with the lowest ID, call setStartId().
To test whether a page has been visited or not, call hasVisitedPage(). For example:
This enum specifies the buttons in a wizard.
The following value is only useful when calling setButtonLayout():
| Enumerator | |
|---|---|
| BackButton | |
| NextButton | |
| CommitButton | |
| FinishButton | |
| CancelButton | |
| HelpButton | |
| CustomButton1 | |
| CustomButton2 | |
| CustomButton3 | |
| Stretch | |
| NoButton | |
| NStandardButtons | |
| NButtons | |
Definition at line 72 of file qwizard.h.
This enum specifies various options that affect the look and feel of a wizard.
Definition at line 105 of file qwizard.h.
This enum specifies the pixmaps that can be associated with a page.
| Enumerator | |
|---|---|
| WatermarkPixmap | |
| LogoPixmap | |
| BannerPixmap | |
| BackgroundPixmap | |
| NPixmaps | |
Definition at line 89 of file qwizard.h.
| enum QWizard::WizardStyle |
This enum specifies the different looks supported by QWizard.
| Enumerator | |
|---|---|
| ClassicStyle | |
| ModernStyle | |
| MacStyle | |
| AeroStyle | |
| NStyles | |
Definition at line 97 of file qwizard.h.
|
explicit |
Constructs a wizard with the given parent and window flags.
Definition at line 2214 of file qwizard.cpp.
| QWizard::~QWizard | ( | ) |
Destroys the wizard and its pages, releasing any allocated resources.
Definition at line 2228 of file qwizard.cpp.
| 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 2242 of file qwizard.cpp.
|
slot |
Goes back to the previous page.
This is equivalent to pressing the Back button.
Definition at line 3159 of file qwizard.cpp.
Referenced by removePage().
| QAbstractButton * QWizard::button | ( | WizardButton | which | ) | const |
Returns the button corresponding to role which.
Definition at line 2829 of file qwizard.cpp.
Referenced by setButton().
| 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 Mac OS X, the Next button is called Continue.
Definition at line 2729 of file qwizard.cpp.
Referenced by QWizardPage::buttonText().
|
protectedvirtual |
This virtual function is called by QWizard to clean up page id just before the user leaves it by clicking Back (unless the QWizard::IndependentPages option is set).
The default implementation calls QWizardPage::cleanupPage() on page(id).
Definition at line 3378 of file qwizard.cpp.
Referenced by removePage().
| int QWizard::currentId | ( | ) | const |
Referenced by currentPage().
|
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 0 if there is no current page (e.g., before the wizard is shown).
This is equivalent to calling page(currentId()).
Definition at line 2488 of file qwizard.cpp.
Referenced by QWizardPage::isFinalPage(), nextId(), paintEvent(), setButtonText(), QWizardPage::setCommitPage(), QWizardPage::setFinalPage(), sizeHint(), and validateCurrentPage().
|
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.
|
protectedvirtual |
Reimplemented Function
Reimplemented from QDialog.
Definition at line 3324 of file qwizard.cpp.
|
protectedvirtual |
Reimplemented Function
Reimplemented from QDialog.
Definition at line 3216 of file qwizard.cpp.
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 2545 of file qwizard.cpp.
Referenced by setField().
| bool QWizard::hasVisitedPage | ( | int | id | ) | const |
Returns true if the page history contains page id; otherwise, returns false.
Pressing Back marks the current page as "unvisited" again.
Definition at line 2411 of file qwizard.cpp.
|
signal |
This signal is emitted when the user clicks the Help button.
By default, no Help button is shown. Call setOption(HaveHelpButton, true) to have one.
Example:
...
...
...
|
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 Next.
(However, if the 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 3357 of file qwizard.cpp.
|
slot |
Advances to the next page.
This is equivalent to pressing the Next or Commit button.
Definition at line 3175 of file qwizard.cpp.
|
virtual |
This virtual function is called by QWizard to find out which page to show when the user clicks the Next button.
The return value is the ID of the next page, or -1 if no page follows.
The default implementation calls QWizardPage::nextId() on the currentPage().
By reimplementing this function, you can specify a dynamic page order.
Definition at line 3424 of file qwizard.cpp.
Referenced by QWizardPage::isFinalPage(), and next().
| WizardOptions QWizard::options | ( | ) | const |
Referenced by setOptions().
| QWizardPage * QWizard::page | ( | int | id | ) | const |
Returns the page with the given id, or 0 if there is no such page.
Definition at line 2392 of file qwizard.cpp.
Referenced by cleanupPage(), currentPage(), initializePage(), nextId(), and validateCurrentPage().
|
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().
|
protectedvirtual |
Reimplemented Function
Reimplemented from QWidget.
Definition at line 3271 of file qwizard.cpp.
| 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 Mac OS X.
Definition at line 2917 of file qwizard.cpp.
Referenced by QWizardPage::pixmap(), setPixmap(), and sizeHint().
| void QWizard::removePage | ( | int | id | ) |
Removes the page with the given id.
cleanupPage() will be called if necessary.
Definition at line 2318 of file qwizard.cpp.
|
protectedvirtual |
Reimplemented Function
Reimplemented from QDialog.
Definition at line 3249 of file qwizard.cpp.
|
slot |
Restarts the wizard at the start page.
This function is called automatically when the wizard is shown.
Definition at line 3204 of file qwizard.cpp.
Referenced by removePage(), and setVisible().
| 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 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 2799 of file qwizard.cpp.
| void QWizard::setButtonLayout | ( | const QList< WizardButton > & | layout | ) |
Sets the order in which buttons are displayed to layout, where layout is a list of WizardButton.
The default layout depends on the options (e.g., whether HelpButtonOnRight) that are set. You can call this function if you need more control over the buttons' layout than what options already provides.
You can specify horizontal stretches in the layout using Stretch .
Example:
Definition at line 2762 of file qwizard.cpp.
| 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 Mac OS X, the Next button is called Continue.
To add extra buttons to the wizard (e.g., a Print button), one way is to call setButtonText() with CustomButton1, CustomButton2, or CustomButton3 to set their text, and make the buttons visible using the HaveCustomButton1, HaveCustomButton2, and/or HaveCustomButton3 options.
Button texts may also be set on a per-page basis using QWizardPage::setButtonText().
Definition at line 2704 of file qwizard.cpp.
| 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:
Definition at line 2953 of file qwizard.cpp.
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 2522 of file qwizard.cpp.
| 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 2617 of file qwizard.cpp.
| void QWizard::setOptions | ( | WizardOptions | options | ) |
Definition at line 2653 of file qwizard.cpp.
Referenced by setOption().
| void QWizard::setPage | ( | int | id, |
| QWizardPage * | page | ||
| ) |
Adds the given page to the wizard with the given id.
Definition at line 2262 of file qwizard.cpp.
Referenced by addPage().
| 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 Wizard Look and Feel{wizard style}.
Pixmaps can also be set for a specific page using QWizardPage::setPixmap().
Definition at line 2901 of file qwizard.cpp.
| void QWizard::setSideWidget | ( | QWidget * | widget | ) |
Sets the given widget to be shown on the left side of the wizard.
For styles which use the WatermarkPixmap (ClassicStyle and ModernStyle) the side widget is displayed on top of the watermark, for other styles or when the watermark is not provided the side widget is displayed on the left side of the wizard.
Passing 0 shows no side widget.
When the widget is not 0 the wizard reparents it.
Any previous side widget is hidden.
You may call setSideWidget() with the same widget at different times.
All widgets set here will be deleted by the wizard when it is destroyed unless you separately reparent the widget after setting some other side widget (or 0).
By default, no side widget is present.
Definition at line 2993 of file qwizard.cpp.
| void QWizard::setStartId | ( | int | id | ) |
Definition at line 2454 of file qwizard.cpp.
| void QWizard::setSubTitleFormat | ( | Qt::TextFormat | format | ) |
Definition at line 2876 of file qwizard.cpp.
| void QWizard::setTitleFormat | ( | Qt::TextFormat | format | ) |
Definition at line 2852 of file qwizard.cpp.
|
virtual |
| void QWizard::setWizardStyle | ( | WizardStyle | style | ) |
Definition at line 2574 of file qwizard.cpp.
Referenced by winEvent().
| QWidget * QWizard::sideWidget | ( | ) | const |
Returns the widget on the left side of the wizard or 0.
By default, no side widget is present.
Definition at line 3014 of file qwizard.cpp.
|
virtual |
Reimplemented Function
Reimplemented from QDialog.
Definition at line 3037 of file qwizard.cpp.
| int QWizard::startId | ( | ) | const |
Referenced by restart(), and setStartId().
| Qt::TextFormat QWizard::subTitleFormat | ( | ) | const |
Referenced by setSubTitleFormat().
| bool QWizard::testOption | ( | WizardOption | option | ) | const |
Returns true if the given option is enabled; otherwise, returns false.
Definition at line 2630 of file qwizard.cpp.
| Qt::TextFormat QWizard::titleFormat | ( | ) | const |
Referenced by setTitleFormat().
|
virtual |
This virtual function is called by QWizard when the user clicks Next or Finish to perform some last-minute validation.
If it returns true, the next page is shown (or the wizard finishes); otherwise, the current page stays up.
The default implementation calls QWizardPage::validatePage() on the currentPage().
When possible, it is usually better style to disable the Next or Finish button (by specifying mandatory fields or by reimplementing QWizardPage::isComplete()) than to reimplement validateCurrentPage().
Definition at line 3401 of file qwizard.cpp.
Referenced by done(), and next().
| QList< int > QWizard::visitedPages | ( | ) | const |
Returns the list of IDs of visited pages, in the order in which the pages were visited.
Pressing Back marks the current page as "unvisited" again.
Definition at line 2425 of file qwizard.cpp.
|
protectedvirtual |
Reimplemented Function
Reimplemented from QWidget.
Definition at line 3300 of file qwizard.cpp.
| WizardStyle QWizard::wizardStyle | ( | ) | const |
Referenced by setWizardStyle().
|
friend |
|
private |
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.
|
private |
the various options that affect the look and feel of the wizard
By default, the following options are set (depending on the platform):
|
private |
|
private |
the text format used by page subtitles
The default format is Qt::AutoText.
|
private |
the text format used by page titles
The default format is Qt::AutoText.
|
private |
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.
Definition at line 64 of file qwizard.h.
Referenced by QVistaHelper::handleWinEvent().