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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0
#pragma once
#include <coreplugin/core_global.h>
#include <coreplugin/featureprovider.h>
#include <QIcon>
#include <QObject>
#include <QString>
#include <QUrl>
#include <functional>
QT_FORWARD_DECLARE_CLASS(QAction)
namespace Utils {
class FilePath;
class Wizard;
} // Utils
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)
Utils::Id id() const { return m_id; }
WizardKind kind() const { return m_supportedProjectTypes.isEmpty() ? FileWizard : ProjectWizard; }
QIcon icon() const { return m_icon; }
QString fontIconName() const { return m_fontIconName; }
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<Utils::Id> requiredFeatures() const { return m_requiredFeatures; }
WizardFlags flags() const { return m_flags; }
QUrl detailsPageQmlPath() const { return m_detailsPageQmlPath; }
QSet<Utils::Id> supportedProjectTypes() const { return m_supportedProjectTypes; }
void setId(const Utils::Id id) { m_id = id; }
void setSupportedProjectTypes(const QSet<Utils::Id> &projectTypes) { m_supportedProjectTypes = projectTypes; }
void setIcon(const QIcon &icon, const QString &iconText = {});
void setFontIconName(const QString &code) { m_fontIconName = code; }
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<Utils::Id> &featureSet) { m_requiredFeatures = featureSet; }
void addRequiredFeature(const Utils::Id &feature) { m_requiredFeatures |= feature; }
void setFlags(WizardFlags flags) { m_flags = flags; }
void setDetailsPageQmlPath(const QString &filePath);
Utils::FilePath runPath(const Utils::FilePath &defaultPath) const;
// Does bookkeeping and the calls runWizardImpl. Please implement that.
Utils::Wizard *runWizard(const Utils::FilePath &path, QWidget *parent, Utils::Id platform,
const QVariantMap &variables, bool showWizard = true);
virtual bool isAvailable(Utils::Id platformId) const;
QSet<Utils::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<Utils::Id> allAvailablePlatforms();
static QString displayNameForPlatform(Utils::Id i);
static void registerFeatureProvider(IFeatureProvider *provider);
static bool isWizardRunning();
static QWidget *currentWizard();
static void requestNewItemDialog(const QString &title,
const QList<IWizardFactory *> &factories,
const Utils::FilePath &defaultLocation,
const QVariantMap &extraVariables);
static QIcon themedIcon(const Utils::FilePath &iconMaskPath);
protected:
static QSet<Utils::Id> pluginFeatures();
static QSet<Utils::Id> availableFeatures(Utils::Id platformId);
virtual Utils::Wizard *runWizardImpl(const Utils::FilePath &path,
QWidget *parent,
Utils::Id platform,
const QVariantMap &variables,
bool showWizard = true) = 0;
private:
static void initialize();
static void destroyFeatureProvider();
static void clearWizardFactories();
QAction *m_action = nullptr;
QIcon m_icon;
QString m_fontIconName;
QString m_description;
QString m_displayName;
QString m_category;
QString m_displayCategory;
QString m_descriptionImage;
QUrl m_detailsPageQmlPath;
QSet<Utils::Id> m_requiredFeatures;
QSet<Utils::Id> m_supportedProjectTypes;
WizardFlags m_flags;
Utils::Id m_id;
friend class Internal::CorePlugin;
};
} // namespace Core
Q_DECLARE_OPERATORS_FOR_FLAGS(Core::IWizardFactory::WizardFlags)
|
