From ac363113a1198850a172aa24b9dc3320c7542e94 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Thu, 26 Sep 2013 12:42:07 +0200 Subject: Doc: move icorelistener docs from header to source Edit for language and style. Change-Id: I6f22ae90e95537282e4833ca90775683e76e26cf Reviewed-by: Eike Ziller --- src/plugins/coreplugin/coreplugin.pro | 3 +- src/plugins/coreplugin/coreplugin.qbs | 1 + src/plugins/coreplugin/icorelistener.cpp | 58 ++++++++++++++++++++++++++++++++ src/plugins/coreplugin/icorelistener.h | 23 ------------- 4 files changed, 61 insertions(+), 24 deletions(-) create mode 100644 src/plugins/coreplugin/icorelistener.cpp diff --git a/src/plugins/coreplugin/coreplugin.pro b/src/plugins/coreplugin/coreplugin.pro index 64b3cbc20f..192c16f4bb 100644 --- a/src/plugins/coreplugin/coreplugin.pro +++ b/src/plugins/coreplugin/coreplugin.pro @@ -100,7 +100,8 @@ SOURCES += mainwindow.cpp \ textdocument.cpp \ documentmanager.cpp \ removefiledialog.cpp \ - iversioncontrol.cpp + iversioncontrol.cpp \ + icorelistener.cpp HEADERS += mainwindow.h \ editmode.h \ diff --git a/src/plugins/coreplugin/coreplugin.qbs b/src/plugins/coreplugin/coreplugin.qbs index c7675f50f0..6ebcfb76a0 100644 --- a/src/plugins/coreplugin/coreplugin.qbs +++ b/src/plugins/coreplugin/coreplugin.qbs @@ -76,6 +76,7 @@ QtcPlugin { "icontext.h", "icore.cpp", "icore.h", + "icorelistener.cpp", "icorelistener.h", "id.cpp", "id.h", diff --git a/src/plugins/coreplugin/icorelistener.cpp b/src/plugins/coreplugin/icorelistener.cpp new file mode 100644 index 0000000000..08ee9895e2 --- /dev/null +++ b/src/plugins/coreplugin/icorelistener.cpp @@ -0,0 +1,58 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of Qt Creator. +** +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Digia gives you certain additional +** rights. These rights are described in the Digia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +****************************************************************************/ + +#include "icorelistener.h" + +/*! + \class Core::ICoreListener + + \brief The ICoreListener class provides a hook for plugins to veto on + certain events emitted from the core plugin. + + Implement this interface to prevent certain events from occurring. For + example, to prevent the closing of the whole application + or to prevent the closing of an editor window under certain conditions. + + For example, if the application window requests a close, + \c ICoreListener::coreAboutToClose() is called (in arbitrary order) on all + registered objects implementing this interface. If one if these calls + returns \c false, the process is aborted and the event is ignored. If all + calls return \c true, the corresponding signal is emitted and the event is + accepted or performed. + + Guidelines for implementing the class: + \list + \li Return \c false from the implemented method if you want to prevent + the event. + \li Add your implementing object to the plugin managers objects: + \c{ExtensionSystem::PluginManager::instance()->addObject(yourImplementingObject)} + \li Do not forget to remove the object again at deconstruction + (for example, in the destructor of your plugin). + \endlist +*/ diff --git a/src/plugins/coreplugin/icorelistener.h b/src/plugins/coreplugin/icorelistener.h index 9d29802dc6..7fb0061e2e 100644 --- a/src/plugins/coreplugin/icorelistener.h +++ b/src/plugins/coreplugin/icorelistener.h @@ -35,30 +35,7 @@ namespace Core { class IEditor; -/*! - \class Core::ICoreListener - \brief The ICoreListener class provides a hook for plugins to veto on certain - events emitted from the core plugin. - - You implement this interface if you want to prevent certain events from - occurring, e.g. if you want to prevent the closing of the whole application - or to prevent the closing of an editor window under certain conditions. - - If e.g. the application window requests a close, then first - ICoreListener::coreAboutToClose() is called (in arbitrary order) on all - registered objects implementing this interface. If one if these calls returns - false, the process is aborted and the event is ignored. If all calls return - true, the corresponding signal is emitted and the event is accepted/performed. - - Guidelines for implementing: - \list - \li Return false from the implemented method if you want to prevent the event. - \li You need to add your implementing object to the plugin managers objects: - ExtensionSystem::PluginManager::instance()->addObject(yourImplementingObject); - \li Don't forget to remove the object again at deconstruction (e.g. in the destructor of - your plugin). -*/ class CORE_EXPORT ICoreListener : public QObject { Q_OBJECT -- cgit v1.2.3