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

#include <qgsoptionswidgetfactory.h>

Inheritance diagram for QgsOptionsPageWidget:

Public Slots
virtual void	apply ()=0
	Called to permanently apply the settings shown in the options page (e.g.

virtual void	cancel ()
	Called to cancel settings changed in the options page (e.g.

Public Member Functions
	QgsOptionsPageWidget (QWidget *parent=nullptr)
	Constructor for QgsOptionsPageWidget.

virtual QString	helpKey () const
	Returns the optional help key for the options page.

virtual bool	isValid ()
	Validates the current state of the widget.

QHash< QWidget , QgsOptionsDialogHighlightWidget >	registeredHighlightWidgets ()
	Returns the registered highlight widgets used to search and highlight text in options dialogs.

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

Detailed Description

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

Definition at line 29 of file qgsoptionswidgetfactory.h.

Constructor & Destructor Documentation

◆ QgsOptionsPageWidget()

QgsOptionsPageWidget::QgsOptionsPageWidget ( QWidget * parent = nullptr )

inline

Constructor for QgsOptionsPageWidget.

Definition at line 37 of file qgsoptionswidgetfactory.h.

Member Function Documentation

◆ apply

virtual void QgsOptionsPageWidget::apply ( )

pure virtualslot

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.

◆ cancel

virtual void QgsOptionsPageWidget::cancel ( )

inlinevirtualslot

Called to cancel settings changed in the options page (e.g.

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

Definition at line 85 of file qgsoptionswidgetfactory.h.

◆ helpKey()

virtual QString QgsOptionsPageWidget::helpKey ( ) const

inlinevirtual

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.

Definition at line 51 of file qgsoptionswidgetfactory.h.

◆ isValid()

virtual bool QgsOptionsPageWidget::isValid ( )

inlinevirtual

Validates the current state of the widget.

Subclasses should return true if the widget state is currently valid and acceptable to apply().

The default implementation returns true.

Since: QGIS 3.24

Definition at line 71 of file qgsoptionswidgetfactory.h.

◆ registeredHighlightWidgets()

QHash< QWidget *, QgsOptionsDialogHighlightWidget * > QgsOptionsPageWidget::registeredHighlightWidgets ( )

inline

Returns the registered highlight widgets used to search and highlight text in options dialogs.

Definition at line 57 of file qgsoptionswidgetfactory.h.

◆ registerHighlightWidget()

void QgsOptionsPageWidget::registerHighlightWidget ( QgsOptionsDialogHighlightWidget * highlightWidget )

inlineprotected

Register a highlight widget to be used to search and highlight text in options dialogs.

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

Definition at line 93 of file qgsoptionswidgetfactory.h.

The documentation for this class was generated from the following file:

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/qgsoptionswidgetfactory.h

Public Slots

Public Member Functions

Protected Member Functions