Класс QDesignerCustomWidgetInterface

Класс QDesignerCustomWidgetInterface позволяет Qt Designer получать доступ к пользовательским виджетам и создавать их. Подробнее...

• Список всех членов, включая унаследованные

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

Макросы

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

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

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

class AnalogClockPlugin : public QObject, public QDesignerCustomWidgetInterface
{
    Q_OBJECT
    Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QDesignerCustomWidgetInterface")
    Q_INTERFACES(QDesignerCustomWidgetInterface)
public:
    explicit AnalogClockPlugin(QObject *parent = nullptr);

    bool isContainer() const override;
    bool isInitialized() const override;
    QIcon icon() const override;
    QString domXml() const override;
    QString group() const override;
    QString includeFile() const override;
    QString name() const override;
    QString toolTip() const override;
    QString whatsThis() const override;
    QWidget *createWidget(QWidget *parent) override;
    void initialize(QDesignerFormEditorInterface *core) override;

private:
    bool initialized = false;
};

Обратите внимание, что единственной частью определения класса, специфичной для этого конкретного пользовательского виджета, является имя класса. Кроме того, поскольку мы реализуем интерфейс, мы должны убедиться, что он известен системе метаобъектов, используя макрос Q_INTERFACES(). Это позволяет Qt Designer использовать функцию qobject_cast() для запроса поддерживаемых интерфейсов, используя только указатель QObject.

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

Qt Designer создает экземпляры пользовательского виджета, вызывая функцию createWidget() плагина с соответствующим родительским виджетом. Плагины должны создавать и возвращать экземпляр пользовательского виджета с указанным родительским виджетом.

Экспортирование пользовательского плагина виджета в Qt Designer с помощью макроса Q_PLUGIN_METADATA(). Например, если библиотека под названием libcustomwidgetplugin.so (в Unix) или libcustomwidget.dll (в Windows) содержит класс виджета MyCustomWidget, мы можем экспортировать его, добавив следующую строку в файл, содержащий заголовок плагина:

Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QDesignerCustomWidgetInterface")

Этот макрос гарантирует, что Qt Designer может получить доступ к пользовательскому виджету и создать его. Без этого макроса Qt Designer не сможет его использовать.

При реализации плагина пользовательского виджета его следует создавать как отдельную библиотеку. Если вы хотите включить несколько плагинов пользовательских виджетов в одну библиотеку, вам дополнительно необходимо создать подкласс QDesignerCustomWidgetCollectionInterface.

Предупреждение: Если ваш плагин пользовательского виджета содержит свойства QVariant, имейте в виду, что поддерживаются только следующие типы:

• QVariant::ByteArray
• QVariant::Bool
• QVariant::Color
• QVariant::Cursor
• QVariant::Date
• QVariant::DateTime
• QVariant::Double
• QVariant::Int
• QVariant::Point
• QVariant::Rect
• QVariant::Size
• QVariant::SizePolicy
• QVariant::String
• QVariant::Time
• QVariant::UInt

Полный пример использования класса QDesignerCustomWidgetInterface см. в Примере пользовательского виджета. Пример показывает, как создать плагин пользовательского виджета для Qt Designer.

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

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

[virtual] QDesignerCustomWidgetInterface::~QDesignerCustomWidgetInterface()

Удаляет интерфейс пользовательского виджета.

[virtual] QString QDesignerCustomWidgetInterface::codeTemplate() const

Эта функция зарезервирована для будущих применений Qt Designer.

[pure virtual] QWidget *QDesignerCustomWidgetInterface::createWidget(QWidget *parent)

Возвращает новый экземпляр пользовательского виджета с заданным родительским элементом.

[virtual] QString QDesignerCustomWidgetInterface::domXml() const

Возвращает XML, используемый для описания свойств пользовательского виджета в Qt Designer.

[pure virtual] QString QDesignerCustomWidgetInterface::group() const

Возвращает имя группы, к которой принадлежит пользовательский виджет.

[pure virtual] QIcon QDesignerCustomWidgetInterface::icon() const

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

[pure virtual] QString QDesignerCustomWidgetInterface::includeFile() const

Возвращает путь к файлу включения, который uic использует при создании кода для пользовательского виджета.

[virtual] void QDesignerCustomWidgetInterface::initialize(QDesignerFormEditorInterface *formEditor)

Инициализирует виджет для использования с указанным интерфейсом formEditor.

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

[pure virtual] bool QDesignerCustomWidgetInterface::isContainer() const

Возвращает true, если пользовательский виджет предназначен для использования в качестве контейнера; в противном случае возвращает false.

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

[virtual] bool QDesignerCustomWidgetInterface::isInitialized() const

Возвращает true, если виджет был инициализирован; в противном случае возвращает false.

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

[pure virtual] QString QDesignerCustomWidgetInterface::name() const

Возвращает имя класса пользовательского виджета, предоставляемое интерфейсом.

Возвращаемое имя должно совпадать с именем класса, используемого для пользовательского виджета.

[pure virtual] QString QDesignerCustomWidgetInterface::toolTip() const

Возвращает краткое описание виджета, которое может использоваться Qt Designer в всплывающей подсказке.

[pure virtual] QString QDesignerCustomWidgetInterface::whatsThis() const

Возвращает описание виджета, которое может использоваться Qt Designer в справке "Что это?" для виджета.

class QDESIGNER_WIDGET_EXPORT WorldTimeClock : public QWidget
{
    Q_OBJECT
    ...
};