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
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#pragma once
#include <coreplugin/core_global.h>
#include <coreplugin/featureprovider.h>
#include <QIcon>
#include <QObject>
#include <QString>
#include <functional>
QT_FORWARD_DECLARE_CLASS(QAction)
namespace Utils { class Wizard; }
namespace Core {
namespace Internal { class CorePlugin; }
class CORE_EXPORT IWizardFactory
: public QObject
{
Q_OBJECT
public:
enum WizardKind {
FileWizard = 0x01,
ProjectWizard = 0x02
};
enum WizardFlag {
PlatformIndependent = 0x01,
ForceCapitalLetterForFileName = 0x02
};
Q_DECLARE_FLAGS(WizardFlags, WizardFlag)
Id id() const { return m_id; }
WizardKind kind() const { return m_supportedProjectTypes.isEmpty() ? FileWizard : ProjectWizard; }
QIcon icon() const { return m_icon; }
QString iconText() const { return m_iconText; }
QString description() const { return m_description; }
QString displayName() const { return m_displayName; }
QString category() const { return m_category; }
QString displayCategory() const { return m_displayCategory; }
QString descriptionImage() const { return m_descriptionImage; }
QSet<Id> requiredFeatures() const { return m_requiredFeatures; }
WizardFlags flags() const { return m_flags; }
QSet<Id> supportedProjectTypes() const { return m_supportedProjectTypes; }
void setId(const Id id) { m_id = id; }
void setSupportedProjectTypes(const QSet<Id> &projectTypes) { m_supportedProjectTypes = projectTypes; }
void setIcon(const QIcon &icon) { m_icon = icon; }
void setIconText(const QString &iconText) { m_iconText = iconText; }
void setDescription(const QString &description) { m_description = description; }
void setDisplayName(const QString &displayName) { m_displayName = displayName; }
void setCategory(const QString &category) { m_category = category; }
void setDisplayCategory(const QString &displayCategory) { m_displayCategory = displayCategory; }
void setDescriptionImage(const QString &descriptionImage) { m_descriptionImage = descriptionImage; }
void setRequiredFeatures(const QSet<Id> &featureSet) { m_requiredFeatures = featureSet; }
void addRequiredFeature(const Id &feature) { m_requiredFeatures |= feature; }
void setFlags(WizardFlags flags) { m_flags = flags; }
QString runPath(const QString &defaultPath);
// Does bookkeeping and the calls runWizardImpl. Please implement that.
Utils::Wizard *runWizard(const QString &path, QWidget *parent, Id platform,
const QVariantMap &variables);
virtual bool isAvailable(Id platformId) const;
QSet<Id> supportedPlatforms() const;
using FactoryCreator = std::function<QList<IWizardFactory *>()>;
static void registerFactoryCreator(const FactoryCreator &creator);
// Utility to find all registered wizards
static QList<IWizardFactory*> allWizardFactories();
static QSet<Id> allAvailablePlatforms();
static QString displayNameForPlatform(Id i);
static void registerFeatureProvider(IFeatureProvider *provider);
static bool isWizardRunning();
static QWidget *currentWizard();
static void requestNewItemDialog(const QString &title,
const QList<IWizardFactory *> &factories,
const QString &defaultLocation,
const QVariantMap &extraVariables);
protected:
QSet<Id> pluginFeatures() const;
QSet<Id> availableFeatures(Id platformId) const;
virtual Utils::Wizard *runWizardImpl(const QString &path, QWidget *parent, Id platform,
const QVariantMap &variables) = 0;
private:
static void initialize();
static void destroyFeatureProvider();
static void clearWizardFactories();
QAction *m_action = nullptr;
QIcon m_icon;
QString m_iconText;
QString m_description;
QString m_displayName;
QString m_category;
QString m_displayCategory;
QString m_descriptionImage;
QSet<Id> m_requiredFeatures;
QSet<Id> m_supportedProjectTypes;
WizardFlags m_flags;
Id m_id;
friend class Internal::CorePlugin;
};
} // namespace Core
Q_DECLARE_OPERATORS_FOR_FLAGS(Core::IWizardFactory::WizardFlags)
|
