diff options
Diffstat (limited to 'tools/designer/src/lib/extension')
| -rw-r--r-- | tools/designer/src/lib/extension/default_extensionfactory.cpp | 178 | ||||
| -rw-r--r-- | tools/designer/src/lib/extension/default_extensionfactory.h | 86 | ||||
| -rw-r--r-- | tools/designer/src/lib/extension/extension.cpp | 186 | ||||
| -rw-r--r-- | tools/designer/src/lib/extension/extension.h | 109 | ||||
| -rw-r--r-- | tools/designer/src/lib/extension/extension.pri | 12 | ||||
| -rw-r--r-- | tools/designer/src/lib/extension/extension_global.h | 64 | ||||
| -rw-r--r-- | tools/designer/src/lib/extension/qextensionmanager.cpp | 174 | ||||
| -rw-r--r-- | tools/designer/src/lib/extension/qextensionmanager.h | 79 |
8 files changed, 888 insertions, 0 deletions
diff --git a/tools/designer/src/lib/extension/default_extensionfactory.cpp b/tools/designer/src/lib/extension/default_extensionfactory.cpp new file mode 100644 index 0000000..a96783a --- /dev/null +++ b/tools/designer/src/lib/extension/default_extensionfactory.cpp @@ -0,0 +1,178 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Qt Software Information (qt-info@nokia.com) +** +** This file is part of the Qt Designer of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the either Technology Preview License Agreement or the +** Beta Release License Agreement. +** +** 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, Nokia gives you certain +** additional rights. These rights are described in the Nokia Qt LGPL +** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this +** package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** If you are unsure which license is appropriate for your use, please +** contact the sales department at qt-sales@nokia.com. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include <QtDesigner/default_extensionfactory.h> +#include "qextensionmanager.h" +#include <qpointer.h> +#include <QtCore/qdebug.h> + +QT_BEGIN_NAMESPACE + +/*! + \class QExtensionFactory + + \brief The QExtensionFactory class allows you to create a factory + that is able to make instances of custom extensions in Qt + Designer. + + \inmodule QtDesigner + + In \QD the extensions are not created until they are required. For + that reason, when implementing a custom extension, you must also + create a QExtensionFactory, i.e. a class that is able to make an + instance of your extension, and register it using \QD's \l + {QExtensionManager}{extension manager}. + + The QExtensionManager class provides extension management + facilities for Qt Designer. When an extension is required, Qt + Designer's \l {QExtensionManager}{extension manager} will run + through all its registered factories calling + QExtensionFactory::createExtension() for each until the first one + that is able to create a requested extension for the selected + object, is found. This factory will then make an instance of the + extension. + + There are four available types of extensions in Qt Designer: + QDesignerContainerExtension , QDesignerMemberSheetExtension, + QDesignerPropertySheetExtension and QDesignerTaskMenuExtension. Qt + Designer's behavior is the same whether the requested extension is + associated with a multi page container, a member sheet, a property + sheet or a task menu. + + You can either create a new QExtensionFactory and reimplement the + QExtensionFactory::createExtension() function. For example: + + \snippet doc/src/snippets/code/tools_designer_src_lib_extension_default_extensionfactory.cpp 0 + + Or you can use an existing factory, expanding the + QExtensionFactory::createExtension() function to make the factory + able to create your extension as well. For example: + + \snippet doc/src/snippets/code/tools_designer_src_lib_extension_default_extensionfactory.cpp 1 + + For a complete example using the QExtensionFactory class, see the + \l {designer/taskmenuextension}{Task Menu Extension example}. The + example shows how to create a custom widget plugin for Qt + Designer, and how to to use the QDesignerTaskMenuExtension class + to add custom items to Qt Designer's task menu. + + \sa QExtensionManager, QAbstractExtensionFactory +*/ + +/*! + Constructs an extension factory with the given \a parent. +*/ +QExtensionFactory::QExtensionFactory(QExtensionManager *parent) + : QObject(parent) +{ +} + +/*! + Returns the extension specified by \a iid for the given \a object. + + \sa createExtension() +*/ + +QObject *QExtensionFactory::extension(QObject *object, const QString &iid) const +{ + if (!object) + return 0; + const IdObjectKey key = qMakePair(iid, object); + + ExtensionMap::iterator it = m_extensions.find(key); + if (it == m_extensions.end()) { + if (QObject *ext = createExtension(object, iid, const_cast<QExtensionFactory*>(this))) { + connect(ext, SIGNAL(destroyed(QObject*)), this, SLOT(objectDestroyed(QObject*))); + it = m_extensions.insert(key, ext); + } + } + + if (!m_extended.contains(object)) { + connect(object, SIGNAL(destroyed(QObject*)), this, SLOT(objectDestroyed(QObject*))); + m_extended.insert(object, true); + } + + if (it == m_extensions.end()) + return 0; + + return it.value(); +} + +void QExtensionFactory::objectDestroyed(QObject *object) +{ + QMutableMapIterator< IdObjectKey, QObject*> it(m_extensions); + while (it.hasNext()) { + it.next(); + + QObject *o = it.key().second; + if (o == object || object == it.value()) { + it.remove(); + } + } + + m_extended.remove(object); +} + +/*! + Creates an extension specified by \a iid for the given \a object. + The extension object is created as a child of the specified \a + parent. + + \sa extension() +*/ +QObject *QExtensionFactory::createExtension(QObject *object, const QString &iid, QObject *parent) const +{ + Q_UNUSED(object); + Q_UNUSED(iid); + Q_UNUSED(parent); + + return 0; +} + +/*! + Returns the extension manager for the extension factory. +*/ +QExtensionManager *QExtensionFactory::extensionManager() const +{ + return static_cast<QExtensionManager *>(parent()); +} + +QT_END_NAMESPACE diff --git a/tools/designer/src/lib/extension/default_extensionfactory.h b/tools/designer/src/lib/extension/default_extensionfactory.h new file mode 100644 index 0000000..1966c91 --- /dev/null +++ b/tools/designer/src/lib/extension/default_extensionfactory.h @@ -0,0 +1,86 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Qt Software Information (qt-info@nokia.com) +** +** This file is part of the Qt Designer of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the either Technology Preview License Agreement or the +** Beta Release License Agreement. +** +** 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, Nokia gives you certain +** additional rights. These rights are described in the Nokia Qt LGPL +** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this +** package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** If you are unsure which license is appropriate for your use, please +** contact the sales department at qt-sales@nokia.com. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef DEFAULT_EXTENSIONFACTORY_H +#define DEFAULT_EXTENSIONFACTORY_H + +#include <QtDesigner/extension_global.h> +#include <QtDesigner/extension.h> + +#include <QtCore/QMap> +#include <QtCore/QHash> +#include <QtCore/QPair> + +QT_BEGIN_HEADER + +QT_BEGIN_NAMESPACE + +class QExtensionManager; + +class QDESIGNER_EXTENSION_EXPORT QExtensionFactory : public QObject, public QAbstractExtensionFactory +{ + Q_OBJECT + Q_INTERFACES(QAbstractExtensionFactory) +public: + QExtensionFactory(QExtensionManager *parent = 0); + + virtual QObject *extension(QObject *object, const QString &iid) const; + QExtensionManager *extensionManager() const; + +private Q_SLOTS: + void objectDestroyed(QObject *object); + +protected: + virtual QObject *createExtension(QObject *object, const QString &iid, QObject *parent) const; + +private: + typedef QPair<QString,QObject*> IdObjectKey; + typedef QMap< IdObjectKey, QObject*> ExtensionMap; + mutable ExtensionMap m_extensions; + typedef QHash<QObject*, bool> ExtendedSet; + mutable ExtendedSet m_extended; +}; + +QT_END_NAMESPACE + +QT_END_HEADER + +#endif // DEFAULT_EXTENSIONFACTORY_H diff --git a/tools/designer/src/lib/extension/extension.cpp b/tools/designer/src/lib/extension/extension.cpp new file mode 100644 index 0000000..7ff13d0 --- /dev/null +++ b/tools/designer/src/lib/extension/extension.cpp @@ -0,0 +1,186 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Qt Software Information (qt-info@nokia.com) +** +** This file is part of the Qt Designer of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the either Technology Preview License Agreement or the +** Beta Release License Agreement. +** +** 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, Nokia gives you certain +** additional rights. These rights are described in the Nokia Qt LGPL +** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this +** package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** If you are unsure which license is appropriate for your use, please +** contact the sales department at qt-sales@nokia.com. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include <QtDesigner/extension.h> + +QT_BEGIN_NAMESPACE + +/*! + \class QAbstractExtensionFactory + + \brief The QAbstractExtensionFactory class provides an interface + for extension factories in Qt Designer. + + \inmodule QtDesigner + + QAbstractExtensionFactory is not intended to be instantiated + directly; use the QExtensionFactory instead. + + In \QD, extension factories are used to look up and create named + extensions as they are required. For that reason, when + implementing a custom extension, you must also create a + QExtensionFactory, i.e a class that is able to make an instance of + your extension, and register it using \QD's \l + {QExtensionManager}{extension manager}. + + When an extension is required, \QD's \l + {QExtensionManager}{extension manager} will run through all its + registered factories calling QExtensionFactory::createExtension() + for each until the first one that is able to create the requested + extension for the selected object, is found. This factory will + then make an instance of the extension. + + \sa QExtensionFactory, QExtensionManager +*/ + +/*! + \fn QAbstractExtensionFactory::~QAbstractExtensionFactory() + + Destroys the extension factory. +*/ + +/*! + \fn QObject *QAbstractExtensionFactory::extension(QObject *object, const QString &iid) const + + Returns the extension specified by \a iid for the given \a object. +*/ + + +/*! + \class QAbstractExtensionManager + + \brief The QAbstractExtensionManager class provides an interface + for extension managers in Qt Designer. + + \inmodule QtDesigner + + QAbstractExtensionManager is not intended to be instantiated + directly; use the QExtensionManager instead. + + In \QD, extension are not created until they are required. For + that reason, when implementing a custom extension, you must also + create a QExtensionFactory, i.e a class that is able to make an + instance of your extension, and register it using \QD's \l + {QExtensionManager}{extension manager}. + + When an extension is required, \QD's \l + {QExtensionManager}{extension manager} will run through all its + registered factories calling QExtensionFactory::createExtension() + for each until the first one that is able to create the requested + extension for the selected object, is found. This factory will + then make an instance of the extension. + + \sa QExtensionManager, QExtensionFactory +*/ + +/*! + \fn QAbstractExtensionManager::~QAbstractExtensionManager() + + Destroys the extension manager. +*/ + +/*! + \fn void QAbstractExtensionManager::registerExtensions(QAbstractExtensionFactory *factory, const QString &iid) + + Register the given extension \a factory with the extension + specified by \a iid. +*/ + +/*! + \fn void QAbstractExtensionManager::unregisterExtensions(QAbstractExtensionFactory *factory, const QString &iid) + + Unregister the given \a factory with the extension specified by \a + iid. +*/ + +/*! + \fn QObject *QAbstractExtensionManager::extension(QObject *object, const QString &iid) const + + Returns the extension, specified by \a iid, for the given \a + object. +*/ + +/*! + \fn T qt_extension(QAbstractExtensionManager* manager, QObject *object) + + \relates QExtensionManager + + Returns the extension of the given \a object cast to type T if the + object is of type T (or of a subclass); otherwise returns 0. The + extension is retrieved using the given extension \a manager. + + \snippet doc/src/snippets/code/tools_designer_src_lib_extension_extension.cpp 0 + + When implementing a custom widget plugin, a pointer to \QD's + current QDesignerFormEditorInterface object (\c formEditor) is + provided by the QDesignerCustomWidgetInterface::initialize() + function's parameter. + + If the widget in the example above doesn't have a defined + QDesignerPropertySheetExtension, \c propertySheet will be a null + pointer. + +*/ + +/*! + \macro Q_DECLARE_EXTENSION_INTERFACE(ExtensionName, Identifier) + + \relates QExtensionManager + + Associates the given \a Identifier (a string literal) to the + extension class called \a ExtensionName. The \a Identifier must be + unique. For example: + + \snippet doc/src/snippets/code/tools_designer_src_lib_extension_extension.cpp 1 + + Using the company and product names is a good way to ensure + uniqueness of the identifier. + + When implementing a custom extension class, you must use + Q_DECLARE_EXTENSION_INTERFACE() to enable usage of the + qt_extension() function. The macro is normally located right after the + class definition for \a ExtensionName, in the associated header + file. + + \sa Q_DECLARE_INTERFACE() +*/ + +QT_END_NAMESPACE diff --git a/tools/designer/src/lib/extension/extension.h b/tools/designer/src/lib/extension/extension.h new file mode 100644 index 0000000..1ccd4ef --- /dev/null +++ b/tools/designer/src/lib/extension/extension.h @@ -0,0 +1,109 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Qt Software Information (qt-info@nokia.com) +** +** This file is part of the Qt Designer of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the either Technology Preview License Agreement or the +** Beta Release License Agreement. +** +** 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, Nokia gives you certain +** additional rights. These rights are described in the Nokia Qt LGPL +** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this +** package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** If you are unsure which license is appropriate for your use, please +** contact the sales department at qt-sales@nokia.com. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef EXTENSION_H +#define EXTENSION_H + +#include <QtCore/QString> +#include <QtCore/QObject> + +QT_BEGIN_HEADER + +QT_BEGIN_NAMESPACE + +#define Q_TYPEID(IFace) QLatin1String(IFace##_iid) + +class QAbstractExtensionFactory +{ +public: + virtual ~QAbstractExtensionFactory() {} + + virtual QObject *extension(QObject *object, const QString &iid) const = 0; +}; +Q_DECLARE_INTERFACE(QAbstractExtensionFactory, "com.trolltech.Qt.QAbstractExtensionFactory") + +class QAbstractExtensionManager +{ +public: + virtual ~QAbstractExtensionManager() {} + + virtual void registerExtensions(QAbstractExtensionFactory *factory, const QString &iid) = 0; + virtual void unregisterExtensions(QAbstractExtensionFactory *factory, const QString &iid) = 0; + + virtual QObject *extension(QObject *object, const QString &iid) const = 0; +}; +Q_DECLARE_INTERFACE(QAbstractExtensionManager, "com.trolltech.Qt.QAbstractExtensionManager") + +#if defined(Q_CC_MSVC) && (_MSC_VER < 1300) + +template <class T> +inline T qt_extension_helper(QAbstractExtensionManager *, QObject *, T) +{ return 0; } + +template <class T> +inline T qt_extension(QAbstractExtensionManager* manager, QObject *object) +{ return qt_extension_helper(manager, object, T(0)); } + +#define Q_DECLARE_EXTENSION_INTERFACE(IFace, IId) \ +const char * const IFace##_iid = IId; \ +Q_DECLARE_INTERFACE(IFace, IId) \ +template <> inline IFace *qt_extension_helper<IFace *>(QAbstractExtensionManager *manager, QObject *object, IFace *) \ +{ QObject *extension = manager->extension(object, Q_TYPEID(IFace)); return (IFace *)(extension ? extension->qt_metacast(IFace##_iid) : 0); } + +#else + +template <class T> +inline T qt_extension(QAbstractExtensionManager* manager, QObject *object) +{ return 0; } + +#define Q_DECLARE_EXTENSION_INTERFACE(IFace, IId) \ +const char * const IFace##_iid = IId; \ +Q_DECLARE_INTERFACE(IFace, IId) \ +template <> inline IFace *qt_extension<IFace *>(QAbstractExtensionManager *manager, QObject *object) \ +{ QObject *extension = manager->extension(object, Q_TYPEID(IFace)); return extension ? static_cast<IFace *>(extension->qt_metacast(IFace##_iid)) : static_cast<IFace *>(0); } + +#endif + +QT_END_NAMESPACE + +QT_END_HEADER + +#endif // EXTENSION_H diff --git a/tools/designer/src/lib/extension/extension.pri b/tools/designer/src/lib/extension/extension.pri new file mode 100644 index 0000000..d8ef658 --- /dev/null +++ b/tools/designer/src/lib/extension/extension.pri @@ -0,0 +1,12 @@ +# Input + +INCLUDEPATH += $$PWD + +HEADERS += $$PWD/default_extensionfactory.h \ + $$PWD/extension.h \ + $$PWD/qextensionmanager.h + +SOURCES += $$PWD/default_extensionfactory.cpp \ + $$PWD/extension.cpp \ + $$PWD/qextensionmanager.cpp + diff --git a/tools/designer/src/lib/extension/extension_global.h b/tools/designer/src/lib/extension/extension_global.h new file mode 100644 index 0000000..abd18d8 --- /dev/null +++ b/tools/designer/src/lib/extension/extension_global.h @@ -0,0 +1,64 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Qt Software Information (qt-info@nokia.com) +** +** This file is part of the Qt Designer of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the either Technology Preview License Agreement or the +** Beta Release License Agreement. +** +** 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, Nokia gives you certain +** additional rights. These rights are described in the Nokia Qt LGPL +** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this +** package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** If you are unsure which license is appropriate for your use, please +** contact the sales department at qt-sales@nokia.com. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef EXTENSION_GLOBAL_H +#define EXTENSION_GLOBAL_H + +#include <QtCore/qglobal.h> + +QT_BEGIN_HEADER +QT_BEGIN_NAMESPACE + +#define QDESIGNER_EXTENSION_EXTERN Q_DECL_EXPORT +#define QDESIGNER_EXTENSION_IMPORT Q_DECL_IMPORT + +#ifdef QT_DESIGNER_STATIC +# define QDESIGNER_EXTENSION_EXPORT +#elif defined(QDESIGNER_EXTENSION_LIBRARY) +# define QDESIGNER_EXTENSION_EXPORT QDESIGNER_EXTENSION_EXTERN +#else +# define QDESIGNER_EXTENSION_EXPORT QDESIGNER_EXTENSION_IMPORT +#endif + +QT_END_NAMESPACE +QT_END_HEADER + +#endif // EXTENSION_GLOBAL_H diff --git a/tools/designer/src/lib/extension/qextensionmanager.cpp b/tools/designer/src/lib/extension/qextensionmanager.cpp new file mode 100644 index 0000000..686c091 --- /dev/null +++ b/tools/designer/src/lib/extension/qextensionmanager.cpp @@ -0,0 +1,174 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Qt Software Information (qt-info@nokia.com) +** +** This file is part of the Qt Designer of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the either Technology Preview License Agreement or the +** Beta Release License Agreement. +** +** 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, Nokia gives you certain +** additional rights. These rights are described in the Nokia Qt LGPL +** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this +** package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** If you are unsure which license is appropriate for your use, please +** contact the sales department at qt-sales@nokia.com. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "qextensionmanager.h" + +QT_BEGIN_NAMESPACE + +/*! + \class QExtensionManager + + \brief The QExtensionManager class provides extension management + facilities for Qt Designer. + + \inmodule QtDesigner + + In \QD the extensions are not created until they are required. For + that reason, when implementing an extension, you must also create + a QExtensionFactory, i.e a class that is able to make an instance + of your extension, and register it using \QD's extension manager. + + The registration of an extension factory is typically made in the + QDesignerCustomWidgetInterface::initialize() function: + + \snippet doc/src/snippets/code/tools_designer_src_lib_extension_qextensionmanager.cpp 0 + + The QExtensionManager is not intended to be instantiated + directly. You can retrieve an interface to \QD's extension manager + using the QDesignerFormEditorInterface::extensionManager() + function. A pointer to \QD's current QDesignerFormEditorInterface + object (\c formEditor in the example above) is provided by the + QDesignerCustomWidgetInterface::initialize() function's + parameter. When implementing a custom widget plugin, you must + subclass the QDesignerCustomWidgetInterface to expose your plugin + to \QD. + + Then, when an extension is required, \QD's extension manager will + run through all its registered factories calling + QExtensionFactory::createExtension() for each until the first one + that is able to create the requested extension for the selected + object, is found. This factory will then make an instance of the + extension. + + There are four available types of extensions in \QD: + QDesignerContainerExtension , QDesignerMemberSheetExtension, + QDesignerPropertySheetExtension and + QDesignerTaskMenuExtension. \QD's behavior is the same whether the + requested extension is associated with a container, a member + sheet, a property sheet or a task menu. + + For a complete example using the QExtensionManager class, see the + \l {designer/taskmenuextension}{Task Menu Extension example}. The + example shows how to create a custom widget plugin for Qt + Designer, and how to to use the QDesignerTaskMenuExtension class + to add custom items to \QD's task menu. + + \sa QExtensionFactory, QAbstractExtensionManager +*/ + +/*! + Constructs an extension manager with the given \a parent. +*/ +QExtensionManager::QExtensionManager(QObject *parent) + : QObject(parent) +{ +} + + +/*! + Destroys the extension manager +*/ +QExtensionManager::~QExtensionManager() +{ +} + +/*! + Register the extension specified by the given \a factory and + extension identifier \a iid. +*/ +void QExtensionManager::registerExtensions(QAbstractExtensionFactory *factory, const QString &iid) +{ + if (iid.isEmpty()) { + m_globalExtension.prepend(factory); + return; + } + + FactoryMap::iterator it = m_extensions.find(iid); + if (it == m_extensions.end()) + it = m_extensions.insert(iid, FactoryList()); + + it.value().prepend(factory); +} + +/*! + Unregister the extension specified by the given \a factory and + extension identifier \a iid. +*/ +void QExtensionManager::unregisterExtensions(QAbstractExtensionFactory *factory, const QString &iid) +{ + if (iid.isEmpty()) { + m_globalExtension.removeAll(factory); + return; + } + + const FactoryMap::iterator it = m_extensions.find(iid); + if (it == m_extensions.end()) + return; + + FactoryList &factories = it.value(); + factories.removeAll(factory); + + if (factories.isEmpty()) + m_extensions.erase(it); +} + +/*! + Returns the extension specified by \a iid, for the given \a + object. +*/ +QObject *QExtensionManager::extension(QObject *object, const QString &iid) const +{ + const FactoryMap::const_iterator it = m_extensions.constFind(iid); + if (it != m_extensions.constEnd()) { + const FactoryList::const_iterator fcend = it.value().constEnd(); + for (FactoryList::const_iterator fit = it.value().constBegin(); fit != fcend; ++fit) + if (QObject *ext = (*fit)->extension(object, iid)) + return ext; + } + const FactoryList::const_iterator gfcend = m_globalExtension.constEnd(); + for (FactoryList::const_iterator git = m_globalExtension.constBegin(); git != gfcend; ++git) + if (QObject *ext = (*git)->extension(object, iid)) + return ext; + + return 0; +} + +QT_END_NAMESPACE diff --git a/tools/designer/src/lib/extension/qextensionmanager.h b/tools/designer/src/lib/extension/qextensionmanager.h new file mode 100644 index 0000000..a5b727f --- /dev/null +++ b/tools/designer/src/lib/extension/qextensionmanager.h @@ -0,0 +1,79 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Qt Software Information (qt-info@nokia.com) +** +** This file is part of the Qt Designer of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the either Technology Preview License Agreement or the +** Beta Release License Agreement. +** +** 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, Nokia gives you certain +** additional rights. These rights are described in the Nokia Qt LGPL +** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this +** package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** If you are unsure which license is appropriate for your use, please +** contact the sales department at qt-sales@nokia.com. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef QEXTENSIONMANAGER_H +#define QEXTENSIONMANAGER_H + +#include <QtDesigner/extension_global.h> +#include <QtDesigner/extension.h> +#include <QtCore/QHash> + +QT_BEGIN_HEADER + +QT_BEGIN_NAMESPACE + +class QObject; // Fool syncqt + +class QDESIGNER_EXTENSION_EXPORT QExtensionManager: public QObject, public QAbstractExtensionManager +{ + Q_OBJECT + Q_INTERFACES(QAbstractExtensionManager) +public: + QExtensionManager(QObject *parent = 0); + ~QExtensionManager(); + + virtual void registerExtensions(QAbstractExtensionFactory *factory, const QString &iid = QString()); + virtual void unregisterExtensions(QAbstractExtensionFactory *factory, const QString &iid = QString()); + + virtual QObject *extension(QObject *object, const QString &iid) const; + +private: + typedef QList<QAbstractExtensionFactory*> FactoryList; + typedef QHash<QString, FactoryList> FactoryMap; + FactoryMap m_extensions; + FactoryList m_globalExtension; +}; + +QT_END_NAMESPACE + +QT_END_HEADER + +#endif // QEXTENSIONMANAGER_H |