QGIS API Documentation 3.29.0-Master (8c80f25a4f)
Public Slots | Public Member Functions | Protected Member Functions | List of all members
QgsOptionsPageWidget Class Referenceabstract

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

#include <qgsoptionswidgetfactory.h>

Inheritance diagram for QgsOptionsPageWidget:
Inheritance graph
[legend]

Public Slots

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

Public Member Functions

 QgsOptionsPageWidget (QWidget *parent=nullptr)
 Constructor for QgsOptionsPageWidget. More...
 
virtual QString helpKey () const
 Returns the optional help key for the options page. More...
 
virtual bool isValid ()
 Validates the current state of the widget. More...
 
QHash< QWidget *, QgsOptionsDialogHighlightWidget * > registeredHighlightWidgets ()
 Returns the registered highlight widgets used to search and highlight text in options dialogs. More...
 

Protected Member Functions

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

Detailed Description

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

Since
QGIS 3.0

Definition at line 30 of file qgsoptionswidgetfactory.h.

Constructor & Destructor Documentation

◆ QgsOptionsPageWidget()

QgsOptionsPageWidget::QgsOptionsPageWidget ( QWidget *  parent = nullptr)
inline

Constructor for QgsOptionsPageWidget.

Definition at line 39 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.

◆ 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 53 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 70 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 59 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 87 of file qgsoptionswidgetfactory.h.


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