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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#include "iwizard.h"
#include "icore.h"
#include <extensionsystem/pluginmanager.h>
#include <QStringList>
/*!
\class Core::IWizard
\mainclass
\brief The class IWizard is the base class for all wizards
(for example shown in \gui {File | New}).
The wizard interface is a very thin abstraction for the \gui{New...} wizards.
Basically it defines what to show to the user in the wizard selection dialogs,
and a hook that is called if the user selects the wizard.
Wizards can then perform any operations they like, including showing dialogs and
creating files. Often it is not necessary to create your own wizard from scratch,
instead use one of the predefined wizards and adapt it to your needs.
To make your wizard known to the system, add your IWizard instance to the
plugin manager's object pool in your plugin's initialize method:
\code
bool MyPlugin::initialize(const QStringList &arguments, QString *errorString)
{
// ... do setup
addAutoReleasedObject(new MyWizard);
// ... do more setup
}
\endcode
\sa Core::BaseFileWizard
\sa Core::StandardFileWizard
*/
/*!
\enum Core::IWizard::WizardKind
Used to specify what kind of objects the wizard creates. This information is used
to show e.g. only wizards that create projects when selecting a \gui{New Project}
menu item.
\value FileWizard
The wizard creates one or more files.
\value ClassWizard
The wizard creates a new class (e.g. source+header files).
\value ProjectWizard
The wizard creates a new project.
*/
/*!
\fn IWizard::IWizard(QObject *parent)
\internal
*/
/*!
\fn IWizard::~IWizard()
\internal
*/
/*!
\fn Kind IWizard::kind() const
Returns what kind of objects are created by the wizard.
\sa Kind
*/
/*!
\fn QIcon IWizard::icon() const
Returns an icon to show in the wizard selection dialog.
*/
/*!
\fn QString IWizard::description() const
Returns a translated description to show when this wizard is selected
in the dialog.
*/
/*!
\fn QString IWizard::displayName() const
Returns the translated name of the wizard, how it should appear in the
dialog.
*/
/*!
\fn QString IWizard::id() const
Returns an arbitrary id that is used for sorting within the category.
*/
/*!
\fn QString IWizard::category() const
Returns a category ID to add the wizard to.
*/
/*!
\fn QString IWizard::displayCategory() const
Returns the translated string of the category, how it should appear
in the dialog.
*/
/*!
\fn void IWizard::runWizard(const QString &path, QWidget *parent)
This method is executed when the wizard has been selected by the user
for execution. Any dialogs the wizard opens should use the given \a parent.
The \a path argument is a suggestion for the location where files should be
created. The wizard should fill this in its path selection elements as a
default path.
*/
using namespace Core;
/* A utility to find all wizards supporting a view mode and matching a predicate */
template <class Predicate>
QList<IWizard*> findWizards(Predicate predicate)
{
// Hack: Trigger delayed creation of wizards
ICore::emitNewItemsDialogRequested();
// Filter all wizards
const QList<IWizard*> allWizards = IWizard::allWizards();
QList<IWizard*> rc;
const QList<IWizard*>::const_iterator cend = allWizards.constEnd();
for (QList<IWizard*>::const_iterator it = allWizards.constBegin(); it != cend; ++it)
if (predicate(*(*it)))
rc.push_back(*it);
return rc;
}
QList<IWizard*> IWizard::allWizards()
{
// Hack: Trigger delayed creation of wizards
ICore::emitNewItemsDialogRequested();
return ExtensionSystem::PluginManager::getObjects<IWizard>();
}
// Utility to find all registered wizards of a certain kind
class WizardKindPredicate {
public:
WizardKindPredicate(IWizard::WizardKind kind) : m_kind(kind) {}
bool operator()(const IWizard &w) const { return w.kind() == m_kind; }
private:
const IWizard::WizardKind m_kind;
};
QList<IWizard*> IWizard::wizardsOfKind(WizardKind kind)
{
return findWizards(WizardKindPredicate(kind));
}
bool IWizard::isAvailable(const QString &platformName) const
{
FeatureSet availableFeatures;
const QList<Core::IFeatureProvider*> featureManagers = ExtensionSystem::PluginManager::getObjects<Core::IFeatureProvider>();
foreach (const Core::IFeatureProvider *featureManager, featureManagers)
availableFeatures |= featureManager->availableFeatures(platformName);
return availableFeatures.contains(requiredFeatures());
}
QStringList IWizard::supportedPlatforms() const
{
QStringList stringList;
foreach (const QString &platform, allAvailablePlatforms()) {
if (isAvailable(platform))
stringList.append(platform);
}
return stringList;
}
QStringList IWizard::allAvailablePlatforms()
{
QStringList platforms;
const QList<Core::IFeatureProvider*> featureManagers =
ExtensionSystem::PluginManager::getObjects<Core::IFeatureProvider>();
foreach (const Core::IFeatureProvider *featureManager, featureManagers)
platforms.append(featureManager->availablePlatforms());
return platforms;
}
QString IWizard::displayNameForPlatform(const QString &string)
{
const QList<Core::IFeatureProvider*> featureManagers =
ExtensionSystem::PluginManager::getObjects<Core::IFeatureProvider>();
foreach (const Core::IFeatureProvider *featureManager, featureManagers) {
QString displayName = featureManager->displayNameForPlatform(string);
if (!displayName.isEmpty())
return displayName;
}
return QString();
}
|
