Создание пользовательских виджетов для Qt Designer

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

Модуль QtDesigner предоставляет вам возможность создавать пользовательские виджеты в Qt Designer.

Начало работы

Для интеграции пользовательского виджета с Qt Designer, вам потребуется подходящее описание для виджета и соответствующий .pro файл.

Предоставление описания интерфейса

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

Также можно переопределить две другие виртуальные функции:

Примечания к функции domXml()

Функция domXml() возвращает фрагмент файла UI, который используется фабрикой виджетов Qt Designer для создания пользовательского виджета и его соответствующих свойств.

Начиная с Qt 4.4, поле виджетов Qt Designer позволяет описывать один пользовательский виджет в полном файле UI. Файл UI можно загрузить, используя тег <ui>. Указание тега <ui> позволяет добавить элемент <customwidget>, который содержит дополнительную информацию для пользовательских виджетов. Тег <widget> достаточно, если дополнительная информация не требуется.

Если пользовательский виджет не предоставляет разумную подсказку размера, необходимо указать стандартную геометрию в строке, возвращаемой функцией domXml() в вашем подклассе. Например, AnalogClockPlugin пример плагина пользовательских виджетов, определяет стандартную геометрию виджета следующим образом:

    ...
R"(
    <property name="geometry">
      <rect>
        <x>0</x>
        <y>0</y>
        <width>100</width>
        <height>100</height>
      </rect>
    </property>
")
    ...

Дополнительная функция функции domXml() заключается в том, что если она возвращает пустую строку, виджет не будет установлен в поле виджетов Qt Designer. Однако его по-прежнему можно использовать другими виджетами в форме. Эта функция используется для скрытия виджетов, которые не должны создаваться пользователем явно, но необходимы другим виджетам.

Полное описание пользовательского виджета выглядит следующим образом:

<ui language="c++"> displayname="MyWidget">
    <widget class="widgets::MyWidget" name="mywidget"/>
    <customwidgets>
        <customwidget>
            <class>widgets::MyWidget</class>
            <addpagemethod>addPage</addpagemethod>
            <propertyspecifications>
                <stringpropertyspecification name="fileName" notr="true" type="singleline"/>
                <stringpropertyspecification name="text" type="richtext"/>
                <tooltip name="text">Explanatory text to be shown in Property Editor</tooltip>
            </propertyspecifications>
        </customwidget>
    </customwidgets>
</ui>

Атрибуты тега <ui>:

Тег <addpagemethod> сообщает Qt Designer и uic, какой метод следует использовать для добавления страниц в контейнерный виджет. Это относится к контейнерным виджетам, которые требуют вызова определённого метода для добавления дочернего элемента вместо добавления дочернего элемента путём передачи родителя. В частности, это актуально для контейнеров, которые не являются подклассами контейнеров, предоставляемых в Qt Designer, но основаны на понятии «Текущая страница». Кроме того, вам нужно предоставить для них расширение контейнера.

Элемент <propertyspecifications> может содержать список метаданных свойств.

Тег <tooltip> может использоваться для указания всплывающей подсказки, отображаемой в редакторе свойств при наведении курсора на свойство. Имя свойства задано в атрибуте name, а текст элемента — это всплывающая подсказка. Эта функциональность была добавлена в Qt 5.6.

Для свойств типа строка используется тег <stringpropertyspecification>. Этот тег имеет следующие атрибуты:

Значения атрибута type свойства типа строка:

Требования к плагинам

Для корректной работы плагинов на всех платформах необходимо убедиться, что они экспортируют необходимые символы для Qt Designer.

Прежде всего, класс плагина должен быть экспортирован для загрузки плагина Qt Designer. Используйте макрос Q_PLUGIN_METADATA() для этого. Также макрос QDESIGNER_WIDGET_EXPORT должен использоваться для определения каждого класса пользовательского виджета внутри плагина, который Qt Designer будет инициализировать.

Создание корректных виджетов

Некоторые пользовательские виджеты имеют особые функции пользовательского интерфейса, которые могут сделать их поведение отличным от поведения многих стандартных виджетов, найденных в Qt Designer. В частности, если пользовательский виджет захватывает клавиатуру в результате вызова QWidget::grabKeyboard(), это повлияет на работу Qt Designer.

Чтобы придать пользовательским виджетам специальное поведение в Qt Designer, предоставьте реализацию функции initialize(), чтобы настроить процесс создания виджета для поведения, специфичного для Qt Designer. Эта функция будет вызываться впервые перед любыми вызовами createWidget() и, возможно, установит внутренний флаг, который можно проверить позже, когда Qt Designer вызовет функцию createWidget() плагина.

Сборка и установка плагина

Простой плагин

Пример плагина пользовательских виджетов демонстрирует простой плагин Qt Designer.

Файл .pro для плагина должен указывать заголовки и исходные файлы как для пользовательского виджета, так и для интерфейса плагина. Обычно этот файл должен только указать, что проект плагина должен быть скомпилирован как библиотека, но со специальной поддержкой плагинов для Qt Designer. Это делается с помощью следующих объявлений:

QT          += widgets uiplugin
CONFIG      += plugin
TEMPLATE    = lib

Переменная QT содержит ключевое слово uiplugin. Это указывает, что плагин использует только абстрактные интерфейсы QDesignerCustomWidgetInterface и QDesignerCustomWidgetCollectionInterface и не имеет связи с библиотеками Qt Designer. При обращении к другим интерфейсам Qt Designer, имеющим связь, следует использовать designer; это гарантирует, что плагин динамически подключается к библиотекам Qt Designer и имеет зависимость от них во время выполнения.

Если плагины созданы в режиме, несовместимом с Qt Designer, они не будут загружены и установлены. Для получения дополнительной информации о плагинах см. документ Плагины ПОМОЩЬ.

Также необходимо убедиться, что плагин установлен вместе с другими плагинами виджетов Qt Designer:

target.path = $$[QT_INSTALL_PLUGINS]/designer
INSTALLS += target

Переменная $[QT_INSTALL_PLUGINS] — это заполнитель для местоположения установленных плагинов Qt. Вы можете настроить Qt Designer на поиск плагинов в других местах, установив переменную среды QT_PLUGIN_PATH перед запуском приложения.

Примечание: Qt Designer будет искать подкаталог designer в каждом предоставленном пути.

См. QCoreApplication::libraryPaths() для получения дополнительной информации о настройке путей для библиотек и плагинов с приложениями Qt.

Разделение плагина

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

Следующие разделы описывают, как это решить.

Связывание виджета с приложением

Исходный и заголовочный файлы пользовательского виджета могут быть совместно использованы между приложением и Qt Designer, создав файл .pri для включения:

INCLUDEPATH += $$PWD
HEADERS += $$PWD/analogclock.h
SOURCES += $$PWD/analogclock.cpp

Этот файл затем будет включен в файл .pro плагина и приложения:

include(customwidget.pri)

Использование виджета с помощью библиотеки

Другой подход — поместить виджет в библиотеку, которая будет связана как с плагином Qt Designer, так и с приложением. Рекомендуется использовать статические библиотеки, чтобы избежать проблем с поиском библиотеки во время выполнения.

Для общих библиотек см. Создание общих библиотек.

Использование плагина с QUiLoader

Предпочтительный способ добавления пользовательских виджетов в QUiLoader — наследование от него с переопределением QUiLoader::createWidget().

Однако также можно использовать пользовательские плагины виджетов Qt Designer (см. QUiLoader::pluginPaths() и связанные функции). Чтобы избежать необходимости развертывания библиотек Qt Designer на целевом устройстве, эти плагины не должны иметь связи с библиотеками Qt Designer (QT = uiplugin, см. Создание пользовательских виджетов для Qt Designer#BuildingandInstallingthePlugin).

Связанные примеры

Для получения дополнительной информации об использовании пользовательских виджетов в Qt Designer, см. примеры Плагин пользовательского виджета и Плагин мирового времени для получения дополнительной информации об использовании пользовательских виджетов в Qt Designer. Также вы можете использовать класс QDesignerCustomWidgetCollectionInterface для объединения нескольких пользовательских виджетов в одну библиотеку.