/****************************************************************************

**

** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (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 Technology Preview License Agreement accompanying

** this package.

**

** 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.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@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