QgsOptionsPageWidget class

Base class for widgets for pages included in the options dialog.

Reference

Constructors, destructors, conversion operators

QgsOptionsPageWidget(QWidget* parent = nullptr): Constructor for QgsOptionsPageWidget.

Public functions

auto helpKey() const -> QString virtual: Returns the optional help key for the options page.
auto registeredHighlightWidgets() -> QMap<QWidget*, QgsOptionsDialogHighlightWidget*>: Returns the registered highlight widgets used to search and highlight text in options dialogs.

Public slots

void apply() pure virtual: Called to permanently apply the settings shown in the options page (e.g.

Protected functions

void registerHighlightWidget(QgsOptionsDialogHighlightWidget* highlightWidget): Register a highlight widget to be used to search and highlight text in options dialogs.

Function documentation

QString QgsOptionsPageWidget::helpKey() const virtual

Returns the optional help key for the options page.

The default implementation returns an empty string.

If a non-empty string is returned by this method, it will be used as the help key retrieved when the "help" button is clicked while this options page is active.

If an empty string is returned by this method the default QGIS options help will be retrieved.

void QgsOptionsPageWidget::apply() pure virtual public slot

Called to permanently apply the settings shown in the options page (e.g.

save them to QgsSettings objects). This is usually called when the options dialog is accepted.

void QgsOptionsPageWidget::registerHighlightWidget(QgsOptionsDialogHighlightWidget* highlightWidget) protected

This can be used to provide a custom implementation of QgsOptionsDialogHighlightWidget.