Qt 4.8
qwizard.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtGui module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef QWIZARD_H
43 #define QWIZARD_H
44 
45 #include <QtGui/qdialog.h>
46 
48 
50 
51 QT_MODULE(Gui)
52 
53 #ifndef QT_NO_WIZARD
54 
55 class QAbstractButton;
56 class QWizardPage;
57 class QWizardPrivate;
58 
60 {
61  Q_OBJECT
63  Q_FLAGS(WizardOptions)
64  WizardStyle wizardStyle;
65  WizardOptions options;
66  Qt::TextFormat titleFormat;
67  Qt::TextFormat subTitleFormat;
68  int startId;
69  int currentId;
70 
71 public:
72  enum WizardButton {
83 
84  NoButton = -1,
85  NStandardButtons = 6,
86  NButtons = 9
87  };
88 
89  enum WizardPixmap {
94  NPixmaps
95  };
96 
97  enum WizardStyle {
102  NStyles
103  };
104 
106  IndependentPages = 0x00000001,
107  IgnoreSubTitles = 0x00000002,
108  ExtendedWatermarkPixmap = 0x00000004,
109  NoDefaultButton = 0x00000008,
110  NoBackButtonOnStartPage = 0x00000010,
111  NoBackButtonOnLastPage = 0x00000020,
112  DisabledBackButtonOnLastPage = 0x00000040,
113  HaveNextButtonOnLastPage = 0x00000080,
114  HaveFinishButtonOnEarlyPages = 0x00000100,
115  NoCancelButton = 0x00000200,
116  CancelButtonOnLeft = 0x00000400,
117  HaveHelpButton = 0x00000800,
118  HelpButtonOnRight = 0x00001000,
119  HaveCustomButton1 = 0x00002000,
120  HaveCustomButton2 = 0x00004000,
121  HaveCustomButton3 = 0x00008000
122  };
123 
124  Q_DECLARE_FLAGS(WizardOptions, WizardOption)
125 
126  explicit QWizard(QWidget *parent = 0, Qt::WindowFlags flags = 0);
127  ~QWizard();
128 
129  int addPage(QWizardPage *page);
130  void setPage(int id, QWizardPage *page);
131  void removePage(int id);
132  QWizardPage *page(int id) const;
133  bool hasVisitedPage(int id) const;
134  QList<int> visitedPages() const; // ### visitedIds()?
135  QList<int> pageIds() const;
136  void setStartId(int id);
137  int startId() const;
138  QWizardPage *currentPage() const;
139  int currentId() const;
140 
141  virtual bool validateCurrentPage();
142  virtual int nextId() const;
143 
144  void setField(const QString &name, const QVariant &value);
145  QVariant field(const QString &name) const;
146 
147  void setWizardStyle(WizardStyle style);
148  WizardStyle wizardStyle() const;
149 
150  void setOption(WizardOption option, bool on = true);
151  bool testOption(WizardOption option) const;
152  void setOptions(WizardOptions options);
153  WizardOptions options() const;
154 
155  void setButtonText(WizardButton which, const QString &text);
156  QString buttonText(WizardButton which) const;
157  void setButtonLayout(const QList<WizardButton> &layout);
158  void setButton(WizardButton which, QAbstractButton *button);
159  QAbstractButton *button(WizardButton which) const;
160 
161  void setTitleFormat(Qt::TextFormat format);
162  Qt::TextFormat titleFormat() const;
163  void setSubTitleFormat(Qt::TextFormat format);
164  Qt::TextFormat subTitleFormat() const;
165  void setPixmap(WizardPixmap which, const QPixmap &pixmap);
166  QPixmap pixmap(WizardPixmap which) const;
167 
168  void setSideWidget(QWidget *widget);
169  QWidget *sideWidget() const;
170 
171  void setDefaultProperty(const char *className, const char *property,
172  const char *changedSignal);
173 
174  void setVisible(bool visible);
175  QSize sizeHint() const;
176 
177 Q_SIGNALS:
178  void currentIdChanged(int id);
179  void helpRequested();
180  void customButtonClicked(int which);
181  void pageAdded(int id);
182  void pageRemoved(int id);
183 
184 public Q_SLOTS:
185  void back();
186  void next();
187  void restart();
188 
189 protected:
190  bool event(QEvent *event);
193 #if defined(Q_WS_WIN)
194  bool winEvent(MSG * message, long * result);
195 #endif
196  void done(int result);
197  virtual void initializePage(int id);
198  virtual void cleanupPage(int id);
199 
200 private:
203  Q_PRIVATE_SLOT(d_func(), void _q_emitCustomButtonClicked())
204  Q_PRIVATE_SLOT(d_func(), void _q_updateButtonStates())
205  Q_PRIVATE_SLOT(d_func(), void _q_handleFieldObjectDestroyed(QObject *))
206 
208 };
209 
211 
213 
214 class Q_GUI_EXPORT QWizardPage : public QWidget
215 {
216  Q_OBJECT
219 
220 public:
221  QWizardPage(QWidget *parent = 0);
222 
223  void setTitle(const QString &title);
224  QString title() const;
225  void setSubTitle(const QString &subTitle);
226  QString subTitle() const;
227  void setPixmap(QWizard::WizardPixmap which, const QPixmap &pixmap);
228  QPixmap pixmap(QWizard::WizardPixmap which) const;
229  void setFinalPage(bool finalPage);
230  bool isFinalPage() const;
231  void setCommitPage(bool commitPage);
232  bool isCommitPage() const;
233  void setButtonText(QWizard::WizardButton which, const QString &text);
234  QString buttonText(QWizard::WizardButton which) const;
235 
236  virtual void initializePage();
237  virtual void cleanupPage();
238  virtual bool validatePage();
239  virtual bool isComplete() const;
240  virtual int nextId() const;
241 
242 Q_SIGNALS:
243  void completeChanged();
244 
245 protected:
246  void setField(const QString &name, const QVariant &value);
247  QVariant field(const QString &name) const;
248  void registerField(const QString &name, QWidget *widget, const char *property = 0,
249  const char *changedSignal = 0);
250  QWizard *wizard() const;
251 
252 private:
253  Q_DISABLE_COPY(QWizardPage)
254  Q_DECLARE_PRIVATE(QWizardPage)
255  Q_PRIVATE_SLOT(d_func(), void _q_maybeEmitCompleteChanged())
256  Q_PRIVATE_SLOT(d_func(), void _q_updateCachedCompleteState())
257 
258  friend class QWizard;
260 };
261 
263 
265 
266 #endif // QT_NO_WIZARD
267 
268 #endif // QWIZARD_H
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
The QAbstractButton class is the abstract base class of button widgets, providing functionality commo...
WizardButton
This enum specifies the buttons in a wizard.
Definition: qwizard.h:72
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
EventRef event
QPointer< QWidget > widget
#define QT_MODULE(x)
Definition: qglobal.h:2783
const char * changedSignal
Definition: qwizard.cpp:139
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
#define Q_DECLARE_FLAGS(Flags, Enum)
The Q_DECLARE_FLAGS() macro expands to.
Definition: qglobal.h:2348
The QDialog class is the base class of dialog windows.
Definition: qdialog.h:56
The QWizardPage class is the base class for wizard pages.
Definition: qwizard.h:214
#define Q_GUI_EXPORT
Definition: qglobal.h:1450
The QWidget class is the base class of all user interface objects.
Definition: qwidget.h:150
#define Q_DISABLE_COPY(Class)
Disables the use of copy constructors and assignment operators for the given Class.
Definition: qglobal.h:2523
#define Q_PRIVATE_SLOT(d, signature)
Definition: qobjectdefs.h:73
#define Q_SLOTS
Definition: qobjectdefs.h:71
The QString class provides a Unicode character string.
Definition: qstring.h:83
The QObject class is the base class of all Qt objects.
Definition: qobject.h:111
#define Q_SIGNALS
Definition: qobjectdefs.h:72
const char * className
Definition: qwizard.cpp:137
#define Q_ENUMS(x)
Definition: qobjectdefs.h:84
virtual void paintEvent(QPaintEvent *)
This event handler can be reimplemented in a subclass to receive paint events passed in event...
Definition: qwidget.cpp:9548
void resizeEvent(QResizeEvent *)
Reimplemented Function
Definition: qdialog.cpp:1268
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
#define Q_DECLARE_OPERATORS_FOR_FLAGS(Flags)
The Q_DECLARE_OPERATORS_FOR_FLAGS() macro declares global operator|() functions for Flags...
Definition: qglobal.h:2355
const char * name
WizardOption
This enum specifies various options that affect the look and feel of a wizard.
Definition: qwizard.h:105
const char * layout
QSize sizeHint() const
Reimplemented Function
Definition: qdialog.cpp:1160
The QResizeEvent class contains event parameters for resize events.
Definition: qevent.h:349
QString subTitle
the subtitle of the page
Definition: qwizard.h:218
#define Q_OBJECT
Definition: qobjectdefs.h:157
TextFormat
Definition: qnamespace.h:1310
virtual void done(int)
Closes the dialog and sets its result code to r.
Definition: qdialog.cpp:617
struct tagMSG MSG
virtual bool winEvent(MSG *message, long *result)
This special event handler can be reimplemented in a subclass to receive native Windows events which ...
Definition: qwidget.cpp:9941
WizardStyle
This enum specifies the different looks supported by QWizard.
Definition: qwizard.h:97
bool event(QEvent *e)
Reimplemented Function
Definition: qdialog.cpp:426
const char * property
Definition: qwizard.cpp:138
QString title
the title of the page
Definition: qwizard.h:217
Definition: qnamespace.h:54
The QPixmap class is an off-screen image representation that can be used as a paint device...
Definition: qpixmap.h:71
The QSize class defines the size of a two-dimensional object using integer point precision.
Definition: qsize.h:53
#define Q_FLAGS(x)
Definition: qobjectdefs.h:85
#define Q_DECLARE_PRIVATE(Class)
Definition: qglobal.h:2467
#define class
The QPaintEvent class contains event parameters for paint events.
Definition: qevent.h:298
The QEvent class is the base class of all event classes.
Definition: qcoreevent.h:56
#define QT_END_HEADER
Definition: qglobal.h:137
void setVisible(bool visible)
Reimplemented Function
Definition: qdialog.cpp:756
WizardPixmap
This enum specifies the pixmaps that can be associated with a page.
Definition: qwizard.h:89
#define text
Definition: qobjectdefs.h:80
The QWizard class provides a framework for wizards.
Definition: qwizard.h:59