QDesignerOptionsPageInterface Class

The QDesignerOptionsPageInterface provides an interface for integrating Qt Designer's options pages into IDE option dialogs. More...

Header: #include <QDesignerOptionsPageInterface>

Public Functions

virtual ~QDesignerOptionsPageInterface()
virtual void apply() = 0
virtual QWidget *createPage(QWidget *parent) = 0
virtual void finish() = 0
virtual QString name() const = 0

Detailed Description

Plugin-based IDE's typically have options dialogs for which the plugins can provide widgets to be shown for example in a tab-widget. The widgets are created on demand when the user activates a page.

In order to do this for Qt Designer, a list of QDesignerOptionsPageInterface objects can be obtained from QDesignerFormEditorInterface and registered with the option dialog. When the respective tab is activated, createPage() is invoked to create the widget. To apply the modified settings, apply() is called. finish() is called when the dialog closes.

\internal\inmodule QtDesigner \since 5.0

See also QDesignerFormEditorInterface::optionsPages() and QDesignerFormEditorInterface::setOptionsPages().

Member Function Documentation

[virtual constexpr noexcept] QDesignerOptionsPageInterface::~QDesignerOptionsPageInterface()

Destroys the QDesignerOptionsPageInterface object.

[pure virtual] void QDesignerOptionsPageInterface::apply()

This function should be called when the user clicks OK or Apply to apply the modified settings.

[pure virtual] QWidget *QDesignerOptionsPageInterface::createPage(QWidget *parent)

Creates the widget of the page parented on parent.

[pure virtual] void QDesignerOptionsPageInterface::finish()

This function should be called when the option dialog is closed.

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

Returns the name of the page, which can for example be used as a tab title.