ground/openpilotgcs/src/plugins/coreplugin/dialogs/iwizard.h

   1 /**
   2  ******************************************************************************
   3  *
   4  * @file       iwizard.h
   5  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
   6  *             Parts by Nokia Corporation (qt-info@nokia.com) Copyright (C) 2009.
   7  * @addtogroup GCSPlugins GCS Plugins
   8  * @{
   9  * @addtogroup CorePlugin Core Plugin
  10  * @{
  11  * @brief The Core GCS plugin
  12  *****************************************************************************/
  13 /*
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful, but
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  21  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  22  * for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License along
  25  * with this program; if not, write to the Free Software Foundation, Inc.,
  26  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  27  */
  28
  29 #ifndef IWIZARD_H
  30 #define IWIZARD_H
  31
  32 #include <coreplugin/core_global.h>
  33 #include <QtCore/QObject>
  34
  35 QT_BEGIN_NAMESPACE
  36 class QIcon;
  37 QT_END_NAMESPACE
  38
  39 namespace Core {
  40 class CORE_EXPORT IWizard
  41     : public QObject {
  42     Q_OBJECT
  43 public:
  44     enum Kind {
  45         FileWizard,
  46         ClassWizard,
  47         ProjectWizard
  48     };
  49
  50     IWizard(QObject *parent = 0) : QObject(parent) {}
  51     virtual ~IWizard() {}
  52
  53     virtual Kind kind() const           = 0;
  54     virtual QIcon icon() const          = 0;
  55     virtual QString description() const = 0;
  56     virtual QString name() const        = 0;
  57
  58     virtual QString category() const    = 0;
  59     virtual QString trCategory() const  = 0;
  60
  61     virtual QStringList runWizard(const QString &path, QWidget *parent) = 0;
  62
  63     // Utility to find all registered wizards
  64     static QList<IWizard *> allWizards();
  65     // Utility to find all registered wizards of a certain kind
  66     static QList<IWizard *> wizardsOfKind(Kind kind);
  67 };
  68 } // namespace Core
  69
  70 #endif // IWIZARD_H