blob: 35abff2f6d794f8d10c44df49972393b3a06c001 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#pragma once
#include "utils_global.h"
#include <QWizard>
namespace Utils {
class Wizard;
class WizardProgress;
class WizardPrivate;
const char SHORT_TITLE_PROPERTY[] = "shortTitle";
class QTCREATOR_UTILS_EXPORT Wizard : public QWizard
{
Q_OBJECT
Q_PROPERTY(bool automaticProgressCreationEnabled READ isAutomaticProgressCreationEnabled WRITE setAutomaticProgressCreationEnabled)
public:
explicit Wizard(QWidget *parent = nullptr, Qt::WindowFlags flags = {});
~Wizard() override;
bool isAutomaticProgressCreationEnabled() const;
void setAutomaticProgressCreationEnabled(bool enabled);
void setStartId(int pageId);
WizardProgress *wizardProgress() const;
template<class T> T *find() const
{
const QList<int> pages = pageIds();
for (int id : pages) {
if (T *result = qobject_cast<T *>(page(id)))
return result;
}
return 0;
}
// will return true for all fields registered via Utils::WizardPage::registerFieldWithName(...)
bool hasField(const QString &name) const;
void registerFieldName(const QString &name);
QSet<QString> fieldNames() const;
virtual QHash<QString, QVariant> variables() const;
void showVariables();
protected:
virtual QString stringify(const QVariant &v) const;
virtual QString evaluate(const QVariant &v) const;
bool event(QEvent *event) override;
private:
void _q_currentPageChanged(int pageId);
void _q_pageAdded(int pageId);
void _q_pageRemoved(int pageId);
Q_DECLARE_PRIVATE(Wizard)
class WizardPrivate *d_ptr;
};
class WizardProgressItem;
class WizardProgressPrivate;
class QTCREATOR_UTILS_EXPORT WizardProgress : public QObject
{
Q_OBJECT
public:
WizardProgress(QObject *parent = nullptr);
~WizardProgress() override;
WizardProgressItem *addItem(const QString &title);
void removeItem(WizardProgressItem *item);
void removePage(int pageId);
static QList<int> pages(WizardProgressItem *item);
WizardProgressItem *item(int pageId) const;
WizardProgressItem *currentItem() const;
QSet<WizardProgressItem *> items() const;
WizardProgressItem *startItem() const;
QList<WizardProgressItem *> visitedItems() const;
QList<WizardProgressItem *> directlyReachableItems() const;
bool isFinalItemDirectlyReachable() const; // return availableItems().last()->isFinalItem();
Q_SIGNALS:
void currentItemChanged(WizardProgressItem *item);
void itemChanged(WizardProgressItem *item); // contents of the item: title or icon
void itemAdded(WizardProgressItem *item);
void itemRemoved(WizardProgressItem *item);
void nextItemsChanged(WizardProgressItem *item, const QList<WizardProgressItem *> &items);
void nextShownItemChanged(WizardProgressItem *item, WizardProgressItem *nextShownItem);
void startItemChanged(WizardProgressItem *item);
private:
void setCurrentPage(int pageId);
void setStartPage(int pageId);
private:
friend class Wizard;
friend class WizardProgressItem;
friend QTCREATOR_UTILS_EXPORT QDebug &operator<<(QDebug &debug, const WizardProgress &progress);
Q_DECLARE_PRIVATE(WizardProgress)
class WizardProgressPrivate *d_ptr;
};
class WizardProgressItemPrivate;
class QTCREATOR_UTILS_EXPORT WizardProgressItem // managed by WizardProgress
{
public:
void addPage(int pageId);
QList<int> pages() const;
void setNextItems(const QList<WizardProgressItem *> &items);
QList<WizardProgressItem *> nextItems() const;
void setNextShownItem(WizardProgressItem *item);
WizardProgressItem *nextShownItem() const;
bool isFinalItem() const; // return nextItems().isEmpty();
void setTitle(const QString &title);
QString title() const;
void setTitleWordWrap(bool wrap);
bool titleWordWrap() const;
protected:
WizardProgressItem(WizardProgress *progress, const QString &title);
virtual ~WizardProgressItem();
private:
friend class WizardProgress;
friend QTCREATOR_UTILS_EXPORT QDebug &operator<<(QDebug &d, const WizardProgressItem &item);
Q_DECLARE_PRIVATE(WizardProgressItem)
class WizardProgressItemPrivate *d_ptr;
};
QTCREATOR_UTILS_EXPORT QDebug &operator<<(QDebug &debug, const WizardProgress &progress);
QTCREATOR_UTILS_EXPORT QDebug &operator<<(QDebug &debug, const WizardProgressItem &item);
} // namespace Utils
|
