|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the QtGui module of the Qt Toolkit. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 #ifndef QWIZARD_H |
|
43 #define QWIZARD_H |
|
44 |
|
45 #include <QtGui/qdialog.h> |
|
46 |
|
47 QT_BEGIN_HEADER |
|
48 |
|
49 QT_BEGIN_NAMESPACE |
|
50 |
|
51 QT_MODULE(Gui) |
|
52 |
|
53 #ifndef QT_NO_WIZARD |
|
54 |
|
55 class QAbstractButton; |
|
56 class QWizardPage; |
|
57 class QWizardPrivate; |
|
58 |
|
59 class 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 |
|
71 public: |
|
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 setDefaultProperty(const char *className, const char *property, |
|
169 const char *changedSignal); |
|
170 |
|
171 void setVisible(bool visible); |
|
172 QSize sizeHint() const; |
|
173 |
|
174 Q_SIGNALS: |
|
175 void currentIdChanged(int id); |
|
176 void helpRequested(); |
|
177 void customButtonClicked(int which); |
|
178 |
|
179 public Q_SLOTS: |
|
180 void back(); |
|
181 void next(); |
|
182 void restart(); |
|
183 |
|
184 protected: |
|
185 bool event(QEvent *event); |
|
186 void resizeEvent(QResizeEvent *event); |
|
187 void paintEvent(QPaintEvent *event); |
|
188 #if defined(Q_WS_WIN) |
|
189 bool winEvent(MSG * message, long * result); |
|
190 #endif |
|
191 void done(int result); |
|
192 virtual void initializePage(int id); |
|
193 virtual void cleanupPage(int id); |
|
194 |
|
195 private: |
|
196 Q_DISABLE_COPY(QWizard) |
|
197 Q_DECLARE_PRIVATE(QWizard) |
|
198 Q_PRIVATE_SLOT(d_func(), void _q_emitCustomButtonClicked()) |
|
199 Q_PRIVATE_SLOT(d_func(), void _q_updateButtonStates()) |
|
200 Q_PRIVATE_SLOT(d_func(), void _q_handleFieldObjectDestroyed(QObject *)) |
|
201 |
|
202 friend class QWizardPage; |
|
203 }; |
|
204 |
|
205 Q_DECLARE_OPERATORS_FOR_FLAGS(QWizard::WizardOptions) |
|
206 |
|
207 class QWizardPagePrivate; |
|
208 |
|
209 class Q_GUI_EXPORT QWizardPage : public QWidget |
|
210 { |
|
211 Q_OBJECT |
|
212 Q_PROPERTY(QString title READ title WRITE setTitle) |
|
213 Q_PROPERTY(QString subTitle READ subTitle WRITE setSubTitle) |
|
214 |
|
215 public: |
|
216 QWizardPage(QWidget *parent = 0); |
|
217 |
|
218 void setTitle(const QString &title); |
|
219 QString title() const; |
|
220 void setSubTitle(const QString &subTitle); |
|
221 QString subTitle() const; |
|
222 void setPixmap(QWizard::WizardPixmap which, const QPixmap &pixmap); |
|
223 QPixmap pixmap(QWizard::WizardPixmap which) const; |
|
224 void setFinalPage(bool finalPage); |
|
225 bool isFinalPage() const; |
|
226 void setCommitPage(bool commitPage); |
|
227 bool isCommitPage() const; |
|
228 void setButtonText(QWizard::WizardButton which, const QString &text); |
|
229 QString buttonText(QWizard::WizardButton which) const; |
|
230 |
|
231 virtual void initializePage(); |
|
232 virtual void cleanupPage(); |
|
233 virtual bool validatePage(); |
|
234 virtual bool isComplete() const; |
|
235 virtual int nextId() const; |
|
236 |
|
237 Q_SIGNALS: |
|
238 void completeChanged(); |
|
239 |
|
240 protected: |
|
241 void setField(const QString &name, const QVariant &value); |
|
242 QVariant field(const QString &name) const; |
|
243 void registerField(const QString &name, QWidget *widget, const char *property = 0, |
|
244 const char *changedSignal = 0); |
|
245 QWizard *wizard() const; |
|
246 |
|
247 private: |
|
248 Q_DISABLE_COPY(QWizardPage) |
|
249 Q_DECLARE_PRIVATE(QWizardPage) |
|
250 Q_PRIVATE_SLOT(d_func(), void _q_maybeEmitCompleteChanged()) |
|
251 Q_PRIVATE_SLOT(d_func(), void _q_updateCachedCompleteState()) |
|
252 |
|
253 friend class QWizard; |
|
254 friend class QWizardPrivate; |
|
255 }; |
|
256 |
|
257 QT_END_NAMESPACE |
|
258 |
|
259 QT_END_HEADER |
|
260 |
|
261 #endif // QT_NO_WIZARD |
|
262 |
|
263 #endif // QWIZARD_H |