Spec-Zone.ru › Qt 6.0

Класс QExtensionManager

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

Заголовок: #include <QExtensionManager>
CMake: find_package(Qt6 COMPONENTS Designer REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Designer)
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-6.0/qextensionmanager.html

Spec-Zone.ru

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