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 (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef IPLUGIN_H
  35 #define IPLUGIN_H
  36
  37 #include "extensionsystem_global.h"
  38
  39 #include <QtCore/QObject>
  40
  41 namespace ExtensionSystem {
  42
  43 namespace Internal {
  44     class IPluginPrivate;
  45     class PluginSpecPrivate;
  46 }
  47
  48 class PluginManager;
  49 class PluginSpec;
  50
  51 class EXTENSIONSYSTEM_EXPORT IPlugin : public QObject
  52 {
  53     Q_OBJECT
  54
  55 public:
  56     enum ShutdownFlag {
  57         SynchronousShutdown,
  58         AsynchronousShutdown
  59     };
  60
  61     IPlugin();
  62     virtual ~IPlugin();
  63
  64     virtual bool initialize(const QStringList &arguments, QString *errorString) = 0;
  65     virtual void extensionsInitialized() = 0;
  66     virtual ShutdownFlag aboutToShutdown() { return SynchronousShutdown; }
  67     virtual void remoteCommand(const QStringList & /* options */, const QStringList & /* arguments */) { }
  68
  69     PluginSpec *pluginSpec() const;
  70
  71     void addObject(QObject *obj);
  72     void addAutoReleasedObject(QObject *obj);
  73     void removeObject(QObject *obj);
  74
  75 signals:
  76     void asynchronousShutdownFinished();
  77
  78 private:
  79     Internal::IPluginPrivate *d;
  80
  81     friend class Internal::PluginSpecPrivate;
  82 };
  83
  84 } // namespace ExtensionSystem
  85
  86 #endif // IPLUGIN_H