ground/openpilotgcs/src/plugins/coreplugin/iuavgadgetfactory.h

   1 /**
   2  ******************************************************************************
   3  *
   4  * @file       iuavgadgetfactory.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 IUAVGADGETFACTORY_H
  30 #define IUAVGADGETFACTORY_H
  31 #include "core_global.h"
  32
  33 #include <QtCore/QObject>
  34 #include <QIcon>
  35 #include <QSettings>
  36 #include "uavconfiginfo.h"
  37
  38 QT_BEGIN_NAMESPACE
  39 class QStringList;
  40 QT_END_NAMESPACE
  41
  42 namespace Core {
  43 class IUAVGadget;
  44 class IUAVGadgetConfiguration;
  45 class IOptionsPage;
  46
  47 class CORE_EXPORT IUAVGadgetFactory : public QObject {
  48     Q_OBJECT
  49 public:
  50     IUAVGadgetFactory(QString classId, QString name, QObject *parent = 0) :
  51         QObject(parent),
  52         m_classId(classId),
  53         m_name(name),
  54         m_icon(QIcon()),
  55         m_singleConfigurationGadget(false) {}
  56     virtual ~IUAVGadgetFactory() {}
  57
  58     virtual IUAVGadget *createGadget(QWidget *parent) = 0;
  59     virtual IUAVGadgetConfiguration *createConfiguration(QSettings * /*qSettings*/)
  60     {
  61         return 0;
  62     }
  63     virtual IUAVGadgetConfiguration *createConfiguration(QSettings *qs, UAVConfigInfo * /*configInfo*/)
  64     {
  65         return createConfiguration(qs);
  66     }
  67     virtual IOptionsPage *createOptionsPage(IUAVGadgetConfiguration * /*config*/)
  68     {
  69         return 0;
  70     }
  71     QString classId() const
  72     {
  73         return m_classId;
  74     }
  75     QString name() const
  76     {
  77         return m_name;
  78     }
  79     QIcon icon() const
  80     {
  81         return m_icon;
  82     }
  83     bool isSingleConfigurationGadget()
  84     {
  85         return m_singleConfigurationGadget;
  86     }
  87 protected:
  88     void setIcon(QIcon icon)
  89     {
  90         m_icon = icon;
  91     }
  92     void setSingleConfigurationGadgetTrue()
  93     {
  94         m_singleConfigurationGadget = true;
  95     }
  96 private:
  97     QString m_classId; // unique class id
  98     QString m_name; // display name, should also be unique
  99     QIcon m_icon;
 100     bool m_singleConfigurationGadget; // true if there is exactly one configuration for this gadget
 101 };
 102 } // namespace Core
 103
 104 #endif // IUAVGADGETFACTORY_H