ground/gcs/src/libs/extensionsystem/iplugin.h

   1 /**
   2  ******************************************************************************
   3  *
   4  * @file       iplugin.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  * @brief
   8  * @see        The GNU Public License (GPL) Version 3
   9  * @defgroup
  10  * @{
  11  *
  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 IPLUGIN_H
  30 #define IPLUGIN_H
  31
  32 #include "extensionsystem_global.h"
  33
  34 #include <QtCore/QObject>
  35
  36 namespace ExtensionSystem {
  37 namespace Internal {
  38 class IPluginPrivate;
  39 class PluginSpecPrivate;
  40 }
  41
  42 class PluginManager;
  43 class PluginSpec;
  44
  45 class EXTENSIONSYSTEM_EXPORT IPlugin : public QObject {
  46     Q_OBJECT
  47
  48 public:
  49     IPlugin();
  50     virtual ~IPlugin();
  51
  52     virtual bool initialize(const QStringList &arguments, QString *errorString) = 0;
  53     virtual void extensionsInitialized() = 0;
  54     virtual void shutdown() {}
  55
  56     PluginSpec *pluginSpec() const;
  57
  58     void addObject(QObject *obj);
  59     void addAutoReleasedObject(QObject *obj);
  60     void removeObject(QObject *obj);
  61
  62 private:
  63     Internal::IPluginPrivate *d;
  64
  65     friend class Internal::PluginSpecPrivate;
  66 };
  67 } // namespace ExtensionSystem
  68
  69 #endif // IPLUGIN_H