src/plugins/coreplugin/dialogs/iwizard.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #ifndef IWIZARD_H
  34 #define IWIZARD_H
  35
  36 #include <coreplugin/core_global.h>
  37 #include <coreplugin/featureprovider.h>
  38
  39 #include <QObject>
  40
  41 QT_BEGIN_NAMESPACE
  42 class QIcon;
  43 QT_END_NAMESPACE
  44
  45 namespace Core {
  46
  47 class CORE_EXPORT IWizard
  48     : public QObject
  49 {
  50     Q_OBJECT
  51 public:
  52     enum WizardKind {
  53         FileWizard = 0x01,
  54         ClassWizard = 0x02,
  55         ProjectWizard = 0x04
  56     };
  57     Q_DECLARE_FLAGS(WizardKinds, WizardKind)
  58     enum WizardFlag {
  59         PlatformIndependent = 0x01
  60     };
  61     Q_DECLARE_FLAGS(WizardFlags, WizardFlag)
  62
  63     IWizard(QObject *parent = 0) : QObject(parent) {}
  64     virtual ~IWizard() {}
  65
  66     virtual WizardKind kind() const = 0;
  67     virtual QIcon icon() const = 0;
  68     virtual QString description() const = 0;
  69     virtual QString displayName() const = 0;
  70     virtual QString id() const = 0;
  71
  72     virtual QString category() const = 0;
  73     virtual QString displayCategory() const = 0;
  74
  75     virtual QString descriptionImage() const = 0;
  76
  77     virtual FeatureSet requiredFeatures() const = 0;
  78     virtual WizardFlags flags() const = 0;
  79
  80     virtual void runWizard(const QString &path, QWidget *parent, const QString &platform) = 0;
  81
  82     bool isAvailable(const QString &platformName) const;
  83     QStringList supportedPlatforms() const;
  84
  85     // Utility to find all registered wizards
  86     static QList<IWizard*> allWizards();
  87     // Utility to find all registered wizards of a certain kind
  88     static QList<IWizard*> wizardsOfKind(WizardKind kind);
  89     static QStringList allAvailablePlatforms();
  90     static QString displayNameForPlatform(const QString &string);
  91 };
  92
  93 } // namespace Core
  94
  95 Q_DECLARE_OPERATORS_FOR_FLAGS(Core::IWizard::WizardKinds)
  96 Q_DECLARE_OPERATORS_FOR_FLAGS(Core::IWizard::WizardFlags)
  97
  98 #endif // IWIZARD_H