src/libs/extensionsystem/iplugin.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (info@qt.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 IPLUGIN_H
  34 #define IPLUGIN_H
  35
  36 #include "extensionsystem_global.h"
  37
  38 #include <QtCore/QObject>
  39
  40 namespace ExtensionSystem {
  41
  42 namespace Internal {
  43     class IPluginPrivate;
  44     class PluginSpecPrivate;
  45 }
  46
  47 class PluginManager;
  48 class PluginSpec;
  49
  50 class EXTENSIONSYSTEM_EXPORT IPlugin : public QObject
  51 {
  52     Q_OBJECT
  53
  54 public:
  55     enum ShutdownFlag {
  56         SynchronousShutdown,
  57         AsynchronousShutdown
  58     };
  59
  60     IPlugin();
  61     virtual ~IPlugin();
  62
  63     virtual bool initialize(const QStringList &arguments, QString *errorString) = 0;
  64     virtual void extensionsInitialized() = 0;
  65     virtual ShutdownFlag aboutToShutdown() { return SynchronousShutdown; }
  66     virtual void remoteCommand(const QStringList & /* options */, const QStringList & /* arguments */) { }
  67
  68     PluginSpec *pluginSpec() const;
  69
  70     void addObject(QObject *obj);
  71     void addAutoReleasedObject(QObject *obj);
  72     void removeObject(QObject *obj);
  73
  74 signals:
  75     void asynchronousShutdownFinished();
  76
  77 private:
  78     Internal::IPluginPrivate *d;
  79
  80     friend class Internal::PluginSpecPrivate;
  81 };
  82
  83 } // namespace ExtensionSystem
  84
  85 #endif // IPLUGIN_H