Spec-Zone.ru › Qt 5.15

Класс QExtensionManager

Класс QExtensionManager предоставляет средства управления расширениями для Qt Designer. Подробнее...

Заголовок: #include <QExtensionManager>
qmake: QT += designer
Наследует: QObject и QAbstractExtensionManager
  • Список всех членов, включая унаследованные

Открытые функции

QExtensionManager(QObject *parent = nullptr)
virtual ~QExtensionManager()

Переопределённые открытые функции

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

Связанные нечлены

T qt_extension(QAbstractExtensionManager *manager, QObject *object)

Макросы

Q_DECLARE_EXTENSION_INTERFACE(ExtensionName, Identifier)

Подробное описание

В Qt Designer расширения не создаются до тех пор, пока они не потребуются. По этой причине при реализации расширения необходимо также создать QExtensionFactory, то есть класс, способный создать экземпляр вашего расширения, и зарегистрировать его с помощью менеджера расширений Qt Designer.

Регистрация фабрики расширения обычно выполняется в функции QDesignerCustomWidgetInterface::initialize():

        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;
        }

Класс QExtensionManager не предназначен для непосредственного создания экземпляров. Вы можете получить интерфейс к менеджеру расширений Qt Designer, используя функцию QDesignerFormEditorInterface::extensionManager(). Указатель на текущий объект QDesignerFormEditorInterface Qt Designer (formEditor в приведённом выше примере) предоставляется в качестве параметра функции QDesignerCustomWidgetInterface::initialize(). При реализации плагина пользовательского виджета необходимо унаследовать класс QDesignerCustomWidgetInterface, чтобы предоставить свой плагин Qt Designer.

Затем, когда требуется расширение, менеджер расширений Qt Designer перебирает все зарегистрированные фабрики, вызывая QExtensionFactory::createExtension() для каждой из них, пока не найдёт первую, которая способна создать требуемое расширение для выбранного объекта. Эта фабрика создаст экземпляр расширения.

Существует четыре типа расширений в Qt Designer: QDesignerContainerExtension , QDesignerMemberSheetExtension, QDesignerPropertySheetExtension и QDesignerTaskMenuExtension. Поведение Qt Designer одинаково, независимо от того, связано ли запрашиваемое расширение с контейнером, листом свойств, панелью свойств или меню задач.

Полный пример использования класса QExtensionManager см. в примере расширения меню задач. Пример показывает, как создать плагин пользовательского виджета для Qt Designer и как использовать класс QDesignerTaskMenuExtension для добавления пользовательских элементов в меню задач Qt Designer.

См. также QExtensionFactory и QAbstractExtensionManager.

Документация по функциям-членам

QExtensionManager::QExtensionManager(QObject *parent = nullptr)

Конструктор менеджера расширений с указанным parent.

[virtual] QExtensionManager::~QExtensionManager()

Удаляет менеджер расширений

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

Переопределяет: QAbstractExtensionManager::extension(QObject *object, const QString &iid) const.

Возвращает расширение, заданное iid, для заданного object.

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

Переопределяет: QAbstractExtensionManager::registerExtensions(QAbstractExtensionFactory *factory, const QString &iid).

Регистрирует расширение, заданное данной factory и идентификатором расширения iid.

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

Переопределяет: QAbstractExtensionManager::unregisterExtensions(QAbstractExtensionFactory *factory, const QString &iid).

Дерегистрирует расширение, заданное данной factory и идентификатором расширения iid.

Связанные нечлены

template <typename T> T qt_extension(QAbstractExtensionManager *manager, QObject *object)

Возвращает расширение данного object, приведённое к типу T, если объект имеет тип T (или подтип); в противном случае возвращает 0. Расширение извлекается с помощью указанного manager.

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

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

       if(propertySheet) {...}

При реализации плагина пользовательского виджета указатель на текущий объект QDesignerFormEditorInterface Qt Designer (formEditor) предоставляется в качестве параметра функции QDesignerCustomWidgetInterface::initialize().

Если у виджета в примере выше нет определённого QDesignerPropertySheetExtension, propertySheet будет указателем на null.

Документация по макросам

Q_DECLARE_EXTENSION_INTERFACE(ExtensionName, Identifier)

Связывает данный Identifier (строковая константа) с классом расширения ExtensionName. Identifier должен быть уникальным. Например:

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

Использование имени компании и продукта — хороший способ обеспечения уникальности идентификатора.

При реализации пользовательского класса расширения необходимо использовать Q_DECLARE_EXTENSION_INTERFACE(), чтобы включить использование функции qt_extension(). Макрос обычно размещается сразу после определения класса ExtensionName в соответствующем файле заголовков.

См. также Q_DECLARE_INTERFACE().

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.15/qextensionmanager.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API