QgsOptionsWidgetFactory class

A factory class for creating custom options pages.

Contents

Constructors, destructors, conversion operators

QgsOptionsWidgetFactory() defaulted
Constructor.
QgsOptionsWidgetFactory(const QString& title, const QIcon& icon)
Constructor.

Public functions

auto createWidget(QWidget* parent = nullptr) const -> QgsOptionsPageWidget* pure virtual
Factory function to create the widget on demand as needed by the options dialog.
auto icon() const -> QIcon virtual
The icon that will be shown in the UI for the panel.
void setIcon(const QIcon& icon)
Set the icon to show in the interface for the factory object.
void setTitle(const QString& title)
Set the title for the interface.
auto title() const -> QString virtual
The title of the panel.

Function documentation

QgsOptionsPageWidget* QgsOptionsWidgetFactory::createWidget(QWidget* parent = nullptr) const pure virtual

Factory function to create the widget on demand as needed by the options dialog.

Parameters
parent The parent of the widget.
Returns A new widget to show as a page in the options dialog.

QIcon QgsOptionsWidgetFactory::icon() const virtual

The icon that will be shown in the UI for the panel.

Returns A QIcon for the panel icon.

void QgsOptionsWidgetFactory::setIcon(const QIcon& icon)

Set the icon to show in the interface for the factory object.

void QgsOptionsWidgetFactory::setTitle(const QString& title)

Set the title for the interface.

QString QgsOptionsWidgetFactory::title() const virtual

The title of the panel.