QExtensionManager Class | Qt Designer Manual

Qt 5.9 | Qt Designer Manual | C++ Classes | QExtensionManager

Qt 5.9.2 Reference Documentation

# QExtensionManager Class

The QExtensionManager class provides extension management facilities for Qt Designer. More...

Header: | #include <QExtensionManager>
qmake: | QT += designer
Inherits: | QObject and QAbstractExtensionManager

- List of all members, including inherited members

## Public Functions

| QExtensionManager(QObject *parent = Q_NULLPTR)
| ~QExtensionManager()

## Reimplemented Public Functions

virtual QObject * | extension(QObject *object, const QString &iid) const
virtual void | registerExtensions(QAbstractExtensionFactory *factory, const QString &iid = QString())
virtual void | unregisterExtensions(QAbstractExtensionFactory *factory, const QString &iid = QString())

- 32 public functions inherited from QObject
- 3 public functions inherited from QAbstractExtensionManager

## Related Non-Members

T | qt_extension(QAbstractExtensionManager *manager, QObject *object)

## Macros

| Q_DECLARE_EXTENSION_INTERFACE(ExtensionName, Identifier)

### Additional Inherited Members

- 1 property inherited from QObject
- 1 public slot inherited from QObject
- 2 signals inherited from QObject
- 1 public variable inherited from QObject
- 10 static public members inherited from QObject
- 9 protected functions inherited from QObject
- 2 protected variables inherited from QObject

## Detailed Description

The QExtensionManager class provides extension management facilities for Qt Designer.

In Qt Designer 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 Qt Designer's extension manager.

The registration of an extension factory is typically made in the QDesignerCustomWidgetInterface::initialize() function:

              void MyPlugin::initialize(QDesignerFormEditorInterface *formEditor)
              {
                  if (initialized)
                      return;

                  QExtensionManager *manager = formEditor->extensionManager();
                  Q_ASSERT(manager != 0);

                  manager->registerExtensions(new MyExtensionFactory(manager),
                                              Q_TYPEID(QDesignerTaskMenuExtension));

                  initialized = true;
              }

The QExtensionManager is not intended to be instantiated directly. You can retrieve an interface to Qt Designer's extension manager using the QDesignerFormEditorInterface::extensionManager() function. A pointer to Qt Designer's current QDesignerFormEditorInterface object (`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 Qt Designer.

Then, when an extension is required, Qt Designer'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 Qt Designer: QDesignerContainerExtension , QDesignerMemberSheetExtension, QDesignerPropertySheetExtension and QDesignerTaskMenuExtension. Qt Designer'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 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.

See also QExtensionFactory and QAbstractExtensionManager.

## Member Function Documentation

### QExtensionManager::QExtensionManager(QObject *parent = Q_NULLPTR)

Constructs an extension manager with the given parent.

### QExtensionManager::~QExtensionManager()

Destroys the extension manager

### `[virtual]` QObject *QExtensionManager::extension(QObject *object, const QString &iid) const

Reimplemented from QAbstractExtensionManager::extension().

Returns the extension specified by iid, for the given object.

### `[virtual]` void QExtensionManager::registerExtensions(QAbstractExtensionFactory *factory, const QString &iid = QString())

Reimplemented from QAbstractExtensionManager::registerExtensions().

Register the extension specified by the given factory and extension identifier iid.

### `[virtual]` void QExtensionManager::unregisterExtensions(QAbstractExtensionFactory *factory, const QString &iid = QString())

Reimplemented from QAbstractExtensionManager::unregisterExtensions().

Unregister the extension specified by the given factory and extension identifier iid.

## Related Non-Members

### T qt_extension(QAbstractExtensionManager *manager, QObject *object)

Returns the extension of the given 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 manager.

             QDesignerPropertySheetExtension *propertySheet;
             QExtensionManager manager = formEditor->extensionManager();

             propertySheet = qt_extension<QDesignerPropertySheetExtension*>(manager, widget);

             if(propertySheet) {...}

When implementing a custom widget plugin, a pointer to Qt Designer's current QDesignerFormEditorInterface object (`formEditor`) is provided by the QDesignerCustomWidgetInterface::initialize() function's parameter.

If the widget in the example above doesn't have a defined QDesignerPropertySheetExtension, `propertySheet` will be a null pointer.

## Macro Documentation

### Q_DECLARE_EXTENSION_INTERFACE(ExtensionName, Identifier)

Associates the given Identifier (a string literal) to the extension class called ExtensionName. The Identifier must be unique. For example:

         Q_DECLARE_EXTENSION_INTERFACE(MyExtension, "com.mycompany.myproduct.myextension")

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 ExtensionName, in the associated header file.

See also Q_DECLARE_INTERFACE().