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
47QT_BEGIN_HEADER
48
49QT_BEGIN_NAMESPACE
50
51QT_MODULE(Gui)
52
53#ifndef QT_NO_WIZARD
54
55class QAbstractButton;
56class QWizardPage;
57class QWizardPrivate;
58
59class Q_GUI_EXPORT QWizard : public QDialog
60{
61 Q_OBJECT
62 Q_ENUMS(WizardStyle WizardOption)
63 Q_FLAGS(WizardOptions)
64 Q_PROPERTY(WizardStyle wizardStyle READ wizardStyle WRITE setWizardStyle)
65 Q_PROPERTY(WizardOptions options READ options WRITE setOptions)
66 Q_PROPERTY(Qt::TextFormat titleFormat READ titleFormat WRITE setTitleFormat)
67 Q_PROPERTY(Qt::TextFormat subTitleFormat READ subTitleFormat WRITE setSubTitleFormat)
68 Q_PROPERTY(int startId READ startId WRITE setStartId)
69 Q_PROPERTY(int currentId READ currentId NOTIFY currentIdChanged)
70
71public:
72 enum WizardButton {
73 BackButton,
74 NextButton,
75 CommitButton,
76 FinishButton,
77 CancelButton,
78 HelpButton,
79 CustomButton1,
80 CustomButton2,
81 CustomButton3,
82 Stretch,
83
84 NoButton = -1,
85 NStandardButtons = 6,
86 NButtons = 9
87 };
88
89 enum WizardPixmap {
90 WatermarkPixmap,
91 LogoPixmap,
92 BannerPixmap,
93 BackgroundPixmap,
94 NPixmaps
95 };
96
97 enum WizardStyle {
98 ClassicStyle,
99 ModernStyle,
100 MacStyle,
101 AeroStyle,
102 NStyles
103 };
104
105 enum WizardOption {
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
177Q_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
184public Q_SLOTS:
185 void back();
186 void next();
187 void restart();
188
189protected:
190 bool event(QEvent *event);
191 void resizeEvent(QResizeEvent *event);
192 void paintEvent(QPaintEvent *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
200private:
201 Q_DISABLE_COPY(QWizard)
202 Q_DECLARE_PRIVATE(QWizard)
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
207 friend class QWizardPage;
208};
209
210Q_DECLARE_OPERATORS_FOR_FLAGS(QWizard::WizardOptions)
211
212class QWizardPagePrivate;
213
214class Q_GUI_EXPORT QWizardPage : public QWidget
215{
216 Q_OBJECT
217 Q_PROPERTY(QString title READ title WRITE setTitle)
218 Q_PROPERTY(QString subTitle READ subTitle WRITE setSubTitle)
219
220public:
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
242Q_SIGNALS:
243 void completeChanged();
244
245protected:
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
252private:
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;
259 friend class QWizardPrivate;
260};
261
262QT_END_NAMESPACE
263
264QT_END_HEADER
265
266#endif // QT_NO_WIZARD
267
268#endif // QWIZARD_H
269