Qt 4.8
Signals | Public Functions | Protected Functions | Properties | Friends | List of all members
QWizardPage Class Reference

The QWizardPage class is the base class for wizard pages. More...

#include <qwizard.h>

Inheritance diagram for QWizardPage:
QWidget QObject QPaintDevice

Signals

void completeChanged ()
 This signal is emitted whenever the complete state of the page (i. 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

QString buttonText (QWizard::WizardButton which) const
 Returns the text on button which on this page. More...
 
virtual void cleanupPage ()
 This virtual function is called by QWizard::cleanupPage() when the user leaves the page by clicking Back (unless the QWizard::IndependentPages option is set). More...
 
virtual void initializePage ()
 This virtual function is called by QWizard::initializePage() to prepare the page just before it is shown either as a result of QWizard::restart() being called, or as a result of the user clicking Next. More...
 
bool isCommitPage () const
 Returns true if this page is a commit page; otherwise returns false. More...
 
virtual bool isComplete () const
 This virtual function is called by QWizard to determine whether the Next or Finish button should be enabled or disabled. More...
 
bool isFinalPage () const
 This function is called by QWizard to determine whether the Finish button should be shown for this page or not. More...
 
virtual int nextId () const
 This virtual function is called by QWizard::nextId() to find out which page to show when the user clicks the Next button. More...
 
QPixmap pixmap (QWizard::WizardPixmap which) const
 Returns the pixmap set for role which. More...
 
 QWizardPage (QWidget *parent=0)
 Constructs a wizard page with the given parent. More...
 
void setButtonText (QWizard::WizardButton which, const QString &text)
 Sets the text on button which to be text on this page. More...
 
void setCommitPage (bool commitPage)
 Sets this page to be a commit page if commitPage is true; otherwise, sets it to be a normal page. More...
 
void setFinalPage (bool finalPage)
 Explicitly sets this page to be final if finalPage is true. More...
 
void setPixmap (QWizard::WizardPixmap which, const QPixmap &pixmap)
 Sets the pixmap for role which to pixmap. More...
 
void setSubTitle (const QString &subTitle)
 
void setTitle (const QString &title)
 
QString subTitle () const
 
QString title () const
 
virtual bool validatePage ()
 This virtual function is called by QWizard::validateCurrentPage() when the user clicks Next or Finish to perform some last-minute validation. 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
 
QWidgetchildAt (int x, int y) const
 Returns the visible child widget at the position ({x}, {y}) in the widget's coordinate system. More...
 
QWidgetchildAt (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
 
QWidgetfocusProxy () const
 Returns the focus proxy, or 0 if there is no focus proxy. More...
 
QWidgetfocusWidget () const
 Returns the last child of this widget that setFocus had been called on. More...
 
const QFontfont () 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 QRectgeometry () 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...
 
QGraphicsEffectgraphicsEffect () const
 The graphicsEffect function returns a pointer to the widget's graphics effect. More...
 
QGraphicsProxyWidgetgraphicsProxyWidget () 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...
 
QInputContextinputContext ()
 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
 
QLayoutlayout () 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
 
virtual QSize minimumSizeHint () const
 
int minimumWidth () const
 
void move (int x, int y)
 This corresponds to move(QPoint(x, y)). More...
 
void move (const QPoint &)
 
QWidgetnativeParentWidget () const
 Returns the native parent for this widget, i. More...
 
QWidgetnextInFocusChain () 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)
 
QPaintEnginepaintEngine () const
 Returns the widget's paint engine. More...
 
const QPalettepalette () const
 
QWidgetparentWidget () const
 Returns the parent of this widget, or 0 if it does not have any parent widget. More...
 
QPoint pos () const
 
QWidgetpreviousInFocusChain () 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
 
virtual QSize sizeHint () 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
 
QStylestyle () 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
 
QWidgettopLevelWidget () 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
 
QWidgetwindow () 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...
 
QWindowSurfacewindowSurface () 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 QX11Infox11Info () 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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 Returns the names of all properties that were dynamically added to the object using setProperty(). More...
 
virtual bool eventFilter (QObject *, QEvent *)
 Filters events if this object has been installed as an event filter for the watched object. More...
 
template<typename 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 QMetaObjectmetaObject () 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
 
QObjectparent () 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...
 
QThreadthread () const
 Returns the thread in which the object lives. More...
 
QObjectUserDatauserData (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

QVariant field (const QString &name) const
 Returns the value of the field called name. More...
 
void registerField (const QString &name, QWidget *widget, const char *property=0, const char *changedSignal=0)
 Creates a field called name associated with the given property of the given widget. More...
 
void setField (const QString &name, const QVariant &value)
 Sets the value of the field called name to value. More...
 
QWizardwizard () const
 Returns the wizard associated with this page, or 0 if this page hasn't been inserted into a QWizard yet. 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...
 
virtual void closeEvent (QCloseEvent *)
 This event handler is called with the given event when Qt receives a window close request for a top-level widget from the window system. More...
 
virtual void contextMenuEvent (QContextMenuEvent *)
 This event handler, for event event, can be reimplemented in a subclass to receive widget context menu events. 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 keyPressEvent (QKeyEvent *)
 This event handler, for event event, can be reimplemented in a subclass to receive key press events for the widget. 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 paintEvent (QPaintEvent *)
 This event handler can be reimplemented in a subclass to receive paint events passed in event. 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 resizeEvent (QResizeEvent *)
 This event handler can be reimplemented in a subclass to receive widget resize events which are passed in the event parameter. More...
 
virtual 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...
 
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 winEvent (MSG *message, long *result)
 This special event handler can be reimplemented in a subclass to receive native Windows events which are passed in the message parameter. More...
 
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...
 
QObjectsender () 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

QString subTitle
 the subtitle of the page More...
 
QString title
 the title of the page More...
 

Friends

class QWizard
 
class QWizardPrivate
 

Additional Inherited Members

- Public Types inherited from QWidget
enum  RenderFlag { DrawWindowBackground = 0x1, DrawChildren = 0x2, IgnoreMask = 0x4 }
 This enum describes how to render the widget when calling QWidget::render(). More...
 
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric {
  PdmWidth = 1, PdmHeight, PdmWidthMM, PdmHeightMM,
  PdmNumColors, PdmDepth, PdmDpiX, PdmDpiY,
  PdmPhysicalDpiX, PdmPhysicalDpiY
}
 
- 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)
 
virtual void setVisible (bool visible)
 
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...
 
- Static Public Functions inherited from QWidget
static QWidgetfind (WId)
 Returns a pointer to the widget with window identifer/handle id. More...
 
static QWidgetkeyboardGrabber ()
 Returns the widget that is currently grabbing the keyboard input. More...
 
static QWidgetmouseGrabber ()
 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 QWSDisplayqwsDisplay ()
 
- 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< QObjectDatad_ptr
 
- Protected Variables inherited from QPaintDevice
ushort painters
 
- Static Protected Variables inherited from QObject
static const QMetaObject staticQtMetaObject
 

Detailed Description

The QWizardPage class is the base class for wizard pages.

Since
4.3

QWizard represents a wizard. Each page is a QWizardPage. When you create your own wizards, you can use QWizardPage directly, or you can subclass it for more control.

A page has the following attributes, which are rendered by QWizard: a title , a subTitle , and a set of pixmaps. See Elements of a Wizard Page for details. Once a page is added to the wizard (using QWizard::addPage() or QWizard::setPage()), wizard() returns a pointer to the associated QWizard object.

Page provides five virtual functions that can be reimplemented to provide custom behavior:

Normally, the Next button and the Finish button of a wizard are mutually exclusive. If isFinalPage() returns true, Finish is available; otherwise, Next is available. By default, isFinalPage() is true only when nextId() returns -1. If you want to show Next and Final simultaneously for a page (letting the user perform an "early finish"), call setFinalPage(true) on that page. For wizards that support early finishes, you might also want to set the QWizard::HaveNextButtonOnLastPage and QWizard::HaveFinishButtonOnEarlyPages options on the wizard.

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 Registering and Using Fields{"field" mechanism} that allows you to register a field (e.g., a QLineEdit) on a page and to access its value from any page. Fields are global to the entire wizard and make it easy for any single page to access information stored by another page, without having to put all the logic in QWizard or having the pages know explicitly about each other. Fields are registered using registerField() and can be accessed at any time using field() and setField().

See also
QWizard, {Class Wizard Example}, {License Wizard Example}

Definition at line 214 of file qwizard.h.

Constructors and Destructors

◆ QWizardPage()

QWizardPage::QWizardPage ( QWidget parent = 0)

Constructs a wizard page with the given parent.

When the page is inserted into a wizard using QWizard::addPage() or QWizard::setPage(), the parent is automatically set to be the wizard.

See also
wizard()

Definition at line 3510 of file qwizard.cpp.

3511  : QWidget(*new QWizardPagePrivate, parent, 0)
3512 {
3513  connect(this, SIGNAL(completeChanged()), this, SLOT(_q_updateCachedCompleteState()));
3514 }
void completeChanged()
This signal is emitted whenever the complete state of the page (i.
#define SLOT(a)
Definition: qobjectdefs.h:226
#define SIGNAL(a)
Definition: qobjectdefs.h:227
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 rece...
Definition: qobject.cpp:2580
QWidget(QWidget *parent=0, Qt::WindowFlags f=0)
Constructs a widget which is a child of parent, with widget flags set to f.
Definition: qwidget.cpp:1189

Functions

◆ buttonText()

QString QWizardPage::buttonText ( QWizard::WizardButton  which) const

Returns the text on button which on this page.

If a text has ben set using setButtonText(), this text is returned. Otherwise, if a text has been set using QWizard::setButtonText(), this text is returned.

By default, the text on buttons depends on the QWizard::wizardStyle. For example, on Mac OS X, the Next button is called Continue.

See also
setButtonText(), QWizard::buttonText(), QWizard::setButtonText()

Definition at line 3852 of file qwizard.cpp.

3853 {
3854  Q_D(const QWizardPage);
3855 
3856  if (d->buttonCustomTexts.contains(which))
3857  return d->buttonCustomTexts.value(which);
3858 
3859  if (wizard())
3860  return wizard()->buttonText(which);
3861 
3862  return QString();
3863 }
double d
Definition: qnumeric_p.h:62
The QWizardPage class is the base class for wizard pages.
Definition: qwizard.h:214
The QString class provides a Unicode character string.
Definition: qstring.h:83
#define Q_D(Class)
Definition: qglobal.h:2482
QString buttonText(WizardButton which) const
Returns the text on button which.
Definition: qwizard.cpp:2729
QWizard * wizard() const
Returns the wizard associated with this page, or 0 if this page hasn&#39;t been inserted into a QWizard y...
Definition: qwizard.cpp:4023

◆ cleanupPage()

void QWizardPage::cleanupPage ( )
virtual

This virtual function is called by QWizard::cleanupPage() when the user leaves the page by clicking Back (unless the QWizard::IndependentPages option is set).

The default implementation resets the page's fields to their original values (the values they had before initializePage() was called).

See also
QWizard::cleanupPage(), initializePage(), QWizard::IndependentPages

Definition at line 3661 of file qwizard.cpp.

Referenced by QWizard::cleanupPage().

3662 {
3663  Q_D(QWizardPage);
3664  if (d->wizard) {
3665  QVector<QWizardField> &fields = d->wizard->d_func()->fields;
3666  for (int i = 0; i < fields.count(); ++i) {
3667  const QWizardField &field = fields.at(i);
3668  if (field.page == this)
3669  field.object->setProperty(field.property, field.initialValue);
3670  }
3671  }
3672 }
double d
Definition: qnumeric_p.h:62
int count(const T &t) const
Returns the number of occurrences of value in the vector.
Definition: qvector.h:742
QWizardPage * page
Definition: qwizard.cpp:174
The QWizardPage class is the base class for wizard pages.
Definition: qwizard.h:214
bool setProperty(const char *name, const QVariant &value)
Sets the value of the object&#39;s name property to value.
Definition: qobject.cpp:3755
QByteArray property
Definition: qwizard.cpp:178
QVariant initialValue
Definition: qwizard.cpp:180
#define Q_D(Class)
Definition: qglobal.h:2482
const T & at(int i) const
Returns the item at index position i in the vector.
Definition: qvector.h:350
QObject * object
Definition: qwizard.cpp:177
QVariant field(const QString &name) const
Returns the value of the field called name.
Definition: qwizard.cpp:3951

◆ completeChanged

void QWizardPage::completeChanged ( )
signal

This signal is emitted whenever the complete state of the page (i.

e., the value of isComplete()) changes.

If you reimplement isComplete(), make sure to emit
completeChanged() whenever the value of isComplete() changes, to
ensure that QWizard updates the enabled or disabled state of its
buttons.

\sa isComplete()

Referenced by QWizardPage().

◆ field()

QVariant QWizardPage::field ( const QString name) const
protected

Returns the value of the field called name.

This function can be used to access fields on any page of the wizard. It is equivalent to calling wizard()->field(name).

Example:

void OutputFilesPage::initializePage()
{
QString className = field("className").toString();
headerLineEdit->setText(className.toLower() + ".h");
implementationLineEdit->setText(className.toLower() + ".cpp");
outputDirLineEdit->setText(QDir::convertSeparators(QDir::tempPath()));
}
See also
QWizard::field(), setField(), registerField()

Definition at line 3951 of file qwizard.cpp.

Referenced by cleanupPage(), isComplete(), and registerField().

3952 {
3953  Q_D(const QWizardPage);
3954  if (!d->wizard)
3955  return QVariant();
3956  return d->wizard->field(name);
3957 }
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
double d
Definition: qnumeric_p.h:62
The QWizardPage class is the base class for wizard pages.
Definition: qwizard.h:214
#define Q_D(Class)
Definition: qglobal.h:2482

◆ initializePage()

void QWizardPage::initializePage ( )
virtual

This virtual function is called by QWizard::initializePage() to prepare the page 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. For example:

void OutputFilesPage::initializePage()
{
QString className = field("className").toString();
headerLineEdit->setText(className.toLower() + ".h");
implementationLineEdit->setText(className.toLower() + ".cpp");
outputDirLineEdit->setText(QDir::convertSeparators(QDir::tempPath()));
}

The default implementation does nothing.

See also
QWizard::initializePage(), cleanupPage(), QWizard::IndependentPages

Definition at line 3646 of file qwizard.cpp.

Referenced by QWizard::initializePage(), and QWizardPrivate::switchToPage().

3647 {
3648 }

◆ isCommitPage()

bool QWizardPage::isCommitPage ( ) const

Returns true if this page is a commit page; otherwise returns false.

See also
setCommitPage()

Definition at line 3817 of file qwizard.cpp.

Referenced by QWizardPrivate::_q_updateButtonStates(), and QWizardPrivate::switchToPage().

3818 {
3819  Q_D(const QWizardPage);
3820  return d->commit;
3821 }
double d
Definition: qnumeric_p.h:62
The QWizardPage class is the base class for wizard pages.
Definition: qwizard.h:214
#define Q_D(Class)
Definition: qglobal.h:2482

◆ isComplete()

bool QWizardPage::isComplete ( ) const
virtual

This virtual function is called by QWizard to determine whether the Next or Finish button should be enabled or disabled.

The default implementation returns true if all mandatory fields are filled; otherwise, it returns false.

If you reimplement this function, make sure to emit completeChanged(), from the rest of your implementation, whenever the value of isComplete() changes. This ensures that QWizard updates the enabled or disabled state of its buttons. An example of the reimplementation is available here.

See also
completeChanged(), isFinalPage()

Definition at line 3709 of file qwizard.cpp.

Referenced by QWizardPrivate::_q_updateButtonStates().

3710 {
3711  Q_D(const QWizardPage);
3712 
3713  if (!d->wizard)
3714  return true;
3715 
3716  const QVector<QWizardField> &wizardFields = d->wizard->d_func()->fields;
3717  for (int i = wizardFields.count() - 1; i >= 0; --i) {
3718  const QWizardField &field = wizardFields.at(i);
3719  if (field.page == this && field.mandatory) {
3720  QVariant value = field.object->property(field.property);
3721  if (value == field.initialValue)
3722  return false;
3723 
3724 #ifndef QT_NO_LINEEDIT
3725  if (QLineEdit *lineEdit = qobject_cast<QLineEdit *>(field.object)) {
3726  if (!lineEdit->hasAcceptableInput())
3727  return false;
3728  }
3729 #endif
3730 #ifndef QT_NO_SPINBOX
3731  if (QAbstractSpinBox *spinBox = qobject_cast<QAbstractSpinBox *>(field.object)) {
3732  if (!spinBox->hasAcceptableInput())
3733  return false;
3734  }
3735 #endif
3736  }
3737  }
3738  return true;
3739 }
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
double d
Definition: qnumeric_p.h:62
int count(const T &t) const
Returns the number of occurrences of value in the vector.
Definition: qvector.h:742
QWizardPage * page
Definition: qwizard.cpp:174
The QWizardPage class is the base class for wizard pages.
Definition: qwizard.h:214
QByteArray property
Definition: qwizard.cpp:178
QVariant initialValue
Definition: qwizard.cpp:180
#define Q_D(Class)
Definition: qglobal.h:2482
The QAbstractSpinBox class provides a spinbox and a line edit to display values.
const T & at(int i) const
Returns the item at index position i in the vector.
Definition: qvector.h:350
bool mandatory
Definition: qwizard.cpp:176
QObject * object
Definition: qwizard.cpp:177
QVariant field(const QString &name) const
Returns the value of the field called name.
Definition: qwizard.cpp:3951
The QLineEdit widget is a one-line text editor.
Definition: qlineedit.h:66
QVariant property(const char *name) const
Returns the value of the object&#39;s name property.
Definition: qobject.cpp:3807

◆ isFinalPage()

bool QWizardPage::isFinalPage ( ) const

This function is called by QWizard to determine whether the Finish button should be shown for this page or not.

By default, it returns true if there is no next page (i.e., nextId() returns -1); otherwise, it returns false.

By explicitly calling setFinalPage(true), you can let the user perform an "early finish".

See also
isComplete(), QWizard::HaveFinishButtonOnEarlyPages

Definition at line 3774 of file qwizard.cpp.

Referenced by QWizardPrivate::switchToPage().

3775 {
3776  Q_D(const QWizardPage);
3777  if (d->explicitlyFinal)
3778  return true;
3779 
3780  QWizard *wizard = this->wizard();
3781  if (wizard && wizard->currentPage() == this) {
3782  // try to use the QWizard implementation if possible
3783  return wizard->nextId() == -1;
3784  } else {
3785  return nextId() == -1;
3786  }
3787 }
double d
Definition: qnumeric_p.h:62
virtual int nextId() const
This virtual function is called by QWizard::nextId() to find out which page to show when the user cli...
Definition: qwizard.cpp:3881
The QWizardPage class is the base class for wizard pages.
Definition: qwizard.h:214
#define Q_D(Class)
Definition: qglobal.h:2482
QWizardPage * currentPage() const
Returns a pointer to the current page, or 0 if there is no current page (e.g., before the wizard is s...
Definition: qwizard.cpp:2488
virtual int nextId() const
This virtual function is called by QWizard to find out which page to show when the user clicks the Ne...
Definition: qwizard.cpp:3424
QWizard * wizard() const
Returns the wizard associated with this page, or 0 if this page hasn&#39;t been inserted into a QWizard y...
Definition: qwizard.cpp:4023
The QWizard class provides a framework for wizards.
Definition: qwizard.h:59

◆ nextId()

int QWizardPage::nextId ( ) const
virtual

This virtual function is called by QWizard::nextId() 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.

By default, this function returns the lowest ID greater than the ID of the current page, or -1 if there is no such ID.

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

int IntroPage::nextId() const
{
if (evaluateRadioButton->isChecked()) {
return LicenseWizard::Page_Evaluate;
} else {
return LicenseWizard::Page_Register;
}
}
See also
QWizard::nextId()

Definition at line 3881 of file qwizard.cpp.

Referenced by isFinalPage(), and QWizard::nextId().

3882 {
3883  Q_D(const QWizardPage);
3884 
3885  if (!d->wizard)
3886  return -1;
3887 
3888  bool foundCurrentPage = false;
3889 
3890  const QWizardPrivate::PageMap &pageMap = d->wizard->d_func()->pageMap;
3893 
3894  for (; i != end; ++i) {
3895  if (i.value() == this) {
3896  foundCurrentPage = true;
3897  } else if (foundCurrentPage) {
3898  return i.key();
3899  }
3900  }
3901  return -1;
3902 }
double d
Definition: qnumeric_p.h:62
The QWizardPage class is the base class for wizard pages.
Definition: qwizard.h:214
const Key & key() const
Returns the current item&#39;s key.
Definition: qmap.h:324
#define Q_D(Class)
Definition: qglobal.h:2482
const_iterator constBegin() const
Returns a const STL-style iterator pointing to the first item in the map.
Definition: qmap.h:374
The QMap::const_iterator class provides an STL-style const iterator for QMap and QMultiMap.
Definition: qmap.h:301
const_iterator constEnd() const
Returns a const STL-style iterator pointing to the imaginary item after the last item in the map...
Definition: qmap.h:380
const T & value() const
Returns the current item&#39;s value.
Definition: qmap.h:325
static const KeyPair *const end
The QMap class is a template class that provides a skip-list-based dictionary.
Definition: qdatastream.h:67

◆ pixmap()

QPixmap QWizardPage::pixmap ( QWizard::WizardPixmap  which) const

Returns the pixmap set for role which.

Pixmaps can also be set for the entire wizard using QWizard::setPixmap(), in which case they apply for all pages that don't specify a pixmap.

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

Definition at line 3614 of file qwizard.cpp.

Referenced by QWizard::paintEvent(), setPixmap(), and QWizardPrivate::updateLayout().

3615 {
3616  Q_D(const QWizardPage);
3617  Q_ASSERT(uint(which) < QWizard::NPixmaps);
3618 
3619  const QPixmap &pixmap = d->pixmaps[which];
3620  if (!pixmap.isNull())
3621  return pixmap;
3622 
3623  if (wizard())
3624  return wizard()->pixmap(which);
3625 
3626  return pixmap;
3627 }
double d
Definition: qnumeric_p.h:62
The QWizardPage class is the base class for wizard pages.
Definition: qwizard.h:214
QPixmap pixmap(QWizard::WizardPixmap which) const
Returns the pixmap set for role which.
Definition: qwizard.cpp:3614
#define Q_ASSERT(cond)
Definition: qglobal.h:1823
#define Q_D(Class)
Definition: qglobal.h:2482
unsigned int uint
Definition: qglobal.h:996
QPixmap pixmap(WizardPixmap which) const
Returns the pixmap set for role which.
Definition: qwizard.cpp:2917
The QPixmap class is an off-screen image representation that can be used as a paint device...
Definition: qpixmap.h:71
QWizard * wizard() const
Returns the wizard associated with this page, or 0 if this page hasn&#39;t been inserted into a QWizard y...
Definition: qwizard.cpp:4023
bool isNull() const
Returns true if this is a null pixmap; otherwise returns false.
Definition: qpixmap.cpp:615

◆ registerField()

void QWizardPage::registerField ( const QString name,
QWidget widget,
const char *  property = 0,
const char *  changedSignal = 0 
)
protected

Creates a field called name associated with the given property of the given widget.

From then on, that property becomes accessible using field() and setField().

Fields are global to the entire wizard and make it easy for any single page to access information stored by another page, without having to put all the logic in QWizard or having the pages know explicitly about each other.

If name ends with an asterisk (*), 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. This requires a changedSignal to be specified, to tell QWizard to recheck the value stored by the mandatory field.

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

Widget Property Change Notification Signal
QAbstractButton bool QAbstractButton::checked QAbstractButton::toggled()
QAbstractSlider int QAbstractSlider::value QAbstractSlider::valueChanged()
QComboBox int QComboBox::currentIndex QComboBox::currentIndexChanged()
QDateTimeEdit QDateTime QDateTimeEdit::dateTime QDateTimeEdit::dateTimeChanged()
QLineEdit QString QLineEdit::text QLineEdit::textChanged()
QListWidget int QListWidget::currentRow QListWidget::currentRowChanged()
QSpinBox int QSpinBox::value QSpinBox::valueChanged()

You can use QWizard::setDefaultProperty() to add entries to this table or to override existing entries.

To consider a field "filled", QWizard simply checks that their current value doesn't equal their original value (the value they had before initializePage() was called). For QLineEdit, it also checks that hasAcceptableInput() returns true, to honor any validator or mask.

QWizard's mandatory field mechanism is provided for convenience. It can be bypassed by reimplementing QWizardPage::isComplete().

See also
field(), setField(), QWizard::setDefaultProperty()

Definition at line 4005 of file qwizard.cpp.

4007 {
4008  Q_D(QWizardPage);
4009  QWizardField field(this, name, widget, property, changedSignal);
4010  if (d->wizard) {
4011  d->wizard->d_func()->addField(field);
4012  } else {
4013  d->pendingFields += field;
4014  }
4015 }
double d
Definition: qnumeric_p.h:62
const char * changedSignal
Definition: qwizard.cpp:139
The QWizardPage class is the base class for wizard pages.
Definition: qwizard.h:214
#define Q_D(Class)
Definition: qglobal.h:2482
QVariant field(const QString &name) const
Returns the value of the field called name.
Definition: qwizard.cpp:3951
QVariant property(const char *name) const
Returns the value of the object&#39;s name property.
Definition: qobject.cpp:3807

◆ setButtonText()

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

Sets the text on button which to be text on this page.

By default, the text on buttons depends on the QWizard::wizardStyle, but may be redefined for the wizard as a whole using QWizard::setButtonText().

See also
buttonText(), QWizard::setButtonText(), QWizard::buttonText()

Definition at line 3831 of file qwizard.cpp.

3832 {
3833  Q_D(QWizardPage);
3834  d->buttonCustomTexts.insert(which, text);
3835  if (wizard() && wizard()->currentPage() == this && wizard()->d_func()->btns[which])
3836  wizard()->d_func()->btns[which]->setText(text);
3837 }
double d
Definition: qnumeric_p.h:62
The QWizardPage class is the base class for wizard pages.
Definition: qwizard.h:214
#define Q_D(Class)
Definition: qglobal.h:2482
QWizard * wizard() const
Returns the wizard associated with this page, or 0 if this page hasn&#39;t been inserted into a QWizard y...
Definition: qwizard.cpp:4023

◆ setCommitPage()

void QWizardPage::setCommitPage ( bool  commitPage)

Sets this page to be a commit page if commitPage is true; otherwise, sets it to be a normal page.

A commit page is a page that represents an action which cannot be undone by clicking Back or Cancel.

A Commit button replaces the Next button on a commit page. Clicking this button simply calls QWizard::next() just like clicking Next does.

A page entered directly from a commit page has its Back button disabled.

See also
isCommitPage()

Definition at line 3803 of file qwizard.cpp.

3804 {
3805  Q_D(QWizardPage);
3806  d->commit = commitPage;
3807  QWizard *wizard = this->wizard();
3808  if (wizard && wizard->currentPage() == this)
3809  wizard->d_func()->updateCurrentPage();
3810 }
double d
Definition: qnumeric_p.h:62
The QWizardPage class is the base class for wizard pages.
Definition: qwizard.h:214
#define Q_D(Class)
Definition: qglobal.h:2482
QWizardPage * currentPage() const
Returns a pointer to the current page, or 0 if there is no current page (e.g., before the wizard is s...
Definition: qwizard.cpp:2488
QWizard * wizard() const
Returns the wizard associated with this page, or 0 if this page hasn&#39;t been inserted into a QWizard y...
Definition: qwizard.cpp:4023
The QWizard class provides a framework for wizards.
Definition: qwizard.h:59

◆ setField()

void QWizardPage::setField ( const QString name,
const QVariant value 
)
protected

Sets the value of the field called name to value.

This function can be used to set fields on any page of the wizard. It is equivalent to calling wizard()->setField(name, value).

See also
QWizard::setField(), field(), registerField()

Definition at line 3930 of file qwizard.cpp.

3931 {
3932  Q_D(QWizardPage);
3933  if (!d->wizard)
3934  return;
3935  d->wizard->setField(name, value);
3936 }
double d
Definition: qnumeric_p.h:62
The QWizardPage class is the base class for wizard pages.
Definition: qwizard.h:214
#define Q_D(Class)
Definition: qglobal.h:2482

◆ setFinalPage()

void QWizardPage::setFinalPage ( bool  finalPage)

Explicitly sets this page to be final if finalPage is true.

After calling setFinalPage(true), isFinalPage() returns true and the Finish button is visible (and enabled if isComplete() returns true).

After calling setFinalPage(false), isFinalPage() returns true if nextId() returns -1; otherwise, it returns false.

See also
isComplete(), QWizard::HaveFinishButtonOnEarlyPages

Definition at line 3753 of file qwizard.cpp.

3754 {
3755  Q_D(QWizardPage);
3756  d->explicitlyFinal = finalPage;
3757  QWizard *wizard = this->wizard();
3758  if (wizard && wizard->currentPage() == this)
3759  wizard->d_func()->updateCurrentPage();
3760 }
double d
Definition: qnumeric_p.h:62
The QWizardPage class is the base class for wizard pages.
Definition: qwizard.h:214
#define Q_D(Class)
Definition: qglobal.h:2482
QWizardPage * currentPage() const
Returns a pointer to the current page, or 0 if there is no current page (e.g., before the wizard is s...
Definition: qwizard.cpp:2488
QWizard * wizard() const
Returns the wizard associated with this page, or 0 if this page hasn&#39;t been inserted into a QWizard y...
Definition: qwizard.cpp:4023
The QWizard class provides a framework for wizards.
Definition: qwizard.h:59

◆ setPixmap()

void QWizardPage::setPixmap ( QWizard::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 the entire wizard using QWizard::setPixmap(), in which case they apply for all pages that don't specify a pixmap.

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

Definition at line 3596 of file qwizard.cpp.

3597 {
3598  Q_D(QWizardPage);
3599  Q_ASSERT(uint(which) < QWizard::NPixmaps);
3600  d->pixmaps[which] = pixmap;
3601  if (d->wizard && d->wizard->currentPage() == this)
3602  d->wizard->d_func()->updatePixmap(which);
3603 }
double d
Definition: qnumeric_p.h:62
The QWizardPage class is the base class for wizard pages.
Definition: qwizard.h:214
QPixmap pixmap(QWizard::WizardPixmap which) const
Returns the pixmap set for role which.
Definition: qwizard.cpp:3614
#define Q_ASSERT(cond)
Definition: qglobal.h:1823
#define Q_D(Class)
Definition: qglobal.h:2482
unsigned int uint
Definition: qglobal.h:996

◆ setSubTitle()

void QWizardPage::setSubTitle ( const QString subTitle)

Definition at line 3569 of file qwizard.cpp.

3570 {
3571  Q_D(QWizardPage);
3572  d->subTitle = subTitle;
3573  if (d->wizard && d->wizard->currentPage() == this)
3574  d->wizard->d_func()->updateLayout();
3575 }
double d
Definition: qnumeric_p.h:62
The QWizardPage class is the base class for wizard pages.
Definition: qwizard.h:214
#define Q_D(Class)
Definition: qglobal.h:2482
QString subTitle() const

◆ setTitle()

void QWizardPage::setTitle ( const QString title)

Definition at line 3533 of file qwizard.cpp.

3534 {
3535  Q_D(QWizardPage);
3536  d->title = title;
3537  if (d->wizard && d->wizard->currentPage() == this)
3538  d->wizard->d_func()->updateLayout();
3539 }
double d
Definition: qnumeric_p.h:62
QString title() const
The QWizardPage class is the base class for wizard pages.
Definition: qwizard.h:214
#define Q_D(Class)
Definition: qglobal.h:2482

◆ subTitle()

QString QWizardPage::subTitle ( ) const

Referenced by setSubTitle().

◆ title()

QString QWizardPage::title ( ) const

Referenced by setTitle().

◆ validatePage()

bool QWizardPage::validatePage ( )
virtual

This virtual function is called by QWizard::validateCurrentPage() 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 returns true.

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

See also
QWizard::validateCurrentPage(), isComplete()

Definition at line 3688 of file qwizard.cpp.

Referenced by QWizard::validateCurrentPage().

3689 {
3690  return true;
3691 }

◆ wizard()

QWizard * QWizardPage::wizard ( ) const
protected

Returns the wizard associated with this page, or 0 if this page hasn't been inserted into a QWizard yet.

See also
QWizard::addPage(), QWizard::setPage()

Definition at line 4023 of file qwizard.cpp.

Referenced by buttonText(), isFinalPage(), pixmap(), setButtonText(), setCommitPage(), setFinalPage(), and QWizard::setPage().

4024 {
4025  Q_D(const QWizardPage);
4026  return d->wizard;
4027 }
double d
Definition: qnumeric_p.h:62
The QWizardPage class is the base class for wizard pages.
Definition: qwizard.h:214
#define Q_D(Class)
Definition: qglobal.h:2482

Friends and Related Functions

◆ QWizard

friend class QWizard
friend

Definition at line 258 of file qwizard.h.

◆ QWizardPrivate

friend class QWizardPrivate
friend

Definition at line 259 of file qwizard.h.

Properties

◆ subTitle

QString QWizardPage::subTitle
private

the subtitle of the page

The subtitle is shown by the QWizard, between the title and the actual page. Subtitles are optional. In ClassicStyle and ModernStyle, using subtitles is necessary to make the header appear. In MacStyle, the subtitle is shown as a text label just above the actual page.

The subtitle may be plain text or HTML, depending on the value of the QWizard::subTitleFormat property.

By default, this property contains an empty string.

See also
title, QWizard::IgnoreSubTitles, {Elements of a Wizard Page}

Definition at line 218 of file qwizard.h.

Referenced by QWizardPrivate::updateLayout().

◆ title

QString QWizardPage::title
private

the title of the page

The title is shown by the QWizard, above the actual page. All pages should have a title.

The title may be plain text or HTML, depending on the value of the QWizard::titleFormat property.

By default, this property contains an empty string.

See also
subTitle, {Elements of a Wizard Page}

Definition at line 217 of file qwizard.h.

Referenced by QWizardPrivate::updateLayout().


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