iwizardfactory.h 4.8 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
con's avatar
con committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
con's avatar
con committed
7
**
hjk's avatar
hjk committed
8
9
10
11
12
** 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
Eike Ziller's avatar
Eike Ziller committed
13
14
** conditions see http://www.qt.io/licensing.  For further information
** use the contact form at http://www.qt.io/contact-us.
15
**
16
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18
19
20
21
22
23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24
**
hjk's avatar
hjk committed
25
26
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
27
28
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
29
****************************************************************************/
hjk's avatar
hjk committed
30

Tobias Hunger's avatar
Tobias Hunger committed
31
32
#ifndef IWIZARDFACTORY_H
#define IWIZARDFACTORY_H
con's avatar
con committed
33
34

#include <coreplugin/core_global.h>
hjk's avatar
hjk committed
35
36
#include <coreplugin/id.h>
#include <coreplugin/featureprovider.h>
37

hjk's avatar
hjk committed
38
#include <QIcon>
39
#include <QObject>
40
#include <QString>
41
#include <QVariantMap>
con's avatar
con committed
42
43
44

namespace Core {

45
46
namespace Internal { class CorePlugin; }

Tobias Hunger's avatar
Tobias Hunger committed
47
class CORE_EXPORT IWizardFactory
con's avatar
con committed
48
49
50
51
    : public QObject
{
    Q_OBJECT
public:
52
53
54
55
    enum WizardKind {
        FileWizard = 0x01,
        ClassWizard = 0x02,
        ProjectWizard = 0x04
con's avatar
con committed
56
    };
57
    Q_DECLARE_FLAGS(WizardKinds, WizardKind)
58
    enum WizardFlag {
59
60
        PlatformIndependent = 0x01,
        ForceCapitalLetterForFileName = 0x02
61
62
    };
    Q_DECLARE_FLAGS(WizardFlags, WizardFlag)
con's avatar
con committed
63

64
    IWizardFactory() : m_kind(FileWizard) { }
hjk's avatar
hjk committed
65

Tobias Hunger's avatar
Tobias Hunger committed
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
    QString id() const { return m_id; }
    WizardKind kind() const { return m_kind; }
    QIcon icon() const { return m_icon; }
    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; }
    FeatureSet requiredFeatures() const { return m_requiredFeatures; }
    WizardFlags flags() const { return m_flags; }

    void setId(const QString &id) { m_id = id; }
    void setWizardKind(WizardKind kind) { m_kind = kind; }
    void setIcon(const QIcon &icon) { m_icon = icon; }
    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 FeatureSet &featureSet) { m_requiredFeatures = featureSet; }
    void addRequiredFeature(const Feature &feature) { m_requiredFeatures |= feature; }
    void setFlags(WizardFlags flags) { m_flags = flags; }
88

89
    virtual void runWizard(const QString &path, QWidget *parent, const QString &platform, const QVariantMap &variables) = 0;
90

91
92
    bool isAvailable(const QString &platformName) const;
    QStringList supportedPlatforms() const;
93

94
    // Utility to find all registered wizards
Tobias Hunger's avatar
Tobias Hunger committed
95
    static QList<IWizardFactory*> allWizardFactories();
96
    // Utility to find all registered wizards of a certain kind
Tobias Hunger's avatar
Tobias Hunger committed
97
    static QList<IWizardFactory*> wizardFactoriesOfKind(WizardKind kind);
98
99
    static QStringList allAvailablePlatforms();
    static QString displayNameForPlatform(const QString &string);
hjk's avatar
hjk committed
100

101
102
    static void registerFeatureProvider(IFeatureProvider *provider);

103
104
105
protected:
    Core::FeatureSet pluginFeatures() const;

hjk's avatar
hjk committed
106
private:
107
108
    static void destroyFeatureProvider();

Tobias Hunger's avatar
Tobias Hunger committed
109
110
111
112
113
114
115
116
117
118
    IWizardFactory::WizardKind m_kind;
    QIcon m_icon;
    QString m_description;
    QString m_displayName;
    QString m_id;
    QString m_category;
    QString m_displayCategory;
    FeatureSet m_requiredFeatures;
    WizardFlags m_flags;
    QString m_descriptionImage;
119
120

    friend class Internal::CorePlugin;
con's avatar
con committed
121
};
hjk's avatar
hjk committed
122

con's avatar
con committed
123
124
} // namespace Core

Tobias Hunger's avatar
Tobias Hunger committed
125
126
Q_DECLARE_OPERATORS_FOR_FLAGS(Core::IWizardFactory::WizardKinds)
Q_DECLARE_OPERATORS_FOR_FLAGS(Core::IWizardFactory::WizardFlags)
127

Tobias Hunger's avatar
Tobias Hunger committed
128
#endif // IWIZARDFACTORY_H