src/plugins/coreplugin/icorelistener.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 ICORELISTENER_H
  35 #define ICORELISTENER_H
  36
  37 #include "core_global.h"
  38 #include <QtCore/QObject>
  39
  40 namespace Core {
  41 class IEditor;
  42 /*!
  43   \class Core::ICoreListener
  44
  45   \brief Provides a hook for plugins to veto on certain events emitted from
  46 the core plugin.
  47
  48   You implement this interface if you want to prevent certain events from
  49   occurring, e.g.  if you want to prevent the closing of the whole application
  50   or to prevent the closing of an editor window under certain conditions.
  51
  52   If e.g. the application window requests a close, then first
  53   ICoreListener::coreAboutToClose() is called (in arbitrary order) on all
  54   registered objects implementing this interface. If one if these calls returns
  55   false, the process is aborted and the event is ignored.  If all calls return
  56   true, the corresponding signal is emitted and the event is accepted/performed.
  57
  58   Guidelines for implementing:
  59   \list
  60   \o Return false from the implemented method if you want to prevent the event.
  61   \o You need to add your implementing object to the plugin managers objects:
  62      ExtensionSystem::PluginManager::instance()->addObject(yourImplementingObject);
  63   \o Don't forget to remove the object again at deconstruction (e.g. in the destructor of
  64      your plugin).
  65 */
  66 class CORE_EXPORT ICoreListener : public QObject
  67 {
  68     Q_OBJECT
  69 public:
  70     ICoreListener(QObject *parent = 0) : QObject(parent) {}
  71     virtual ~ICoreListener() {}
  72
  73     virtual bool editorAboutToClose(IEditor * /*editor*/) { return true; }
  74     virtual bool coreAboutToClose() { return true; }
  75 };
  76
  77 } // namespace Core
  78
  79 #endif // ICORELISTENER_H