QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Base class for widgets for pages included in the options dialog. More...
#include <qgsoptionswidgetfactory.h>
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. | |
Base class for widgets for pages included in the options dialog.
Definition at line 29 of file qgsoptionswidgetfactory.h.
|
inline |
Constructor for QgsOptionsPageWidget.
Definition at line 38 of file qgsoptionswidgetfactory.h.
|
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.
|
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 83 of file qgsoptionswidgetfactory.h.
|
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 52 of file qgsoptionswidgetfactory.h.
|
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
.
Definition at line 69 of file qgsoptionswidgetfactory.h.
|
inline |
Returns the registered highlight widgets used to search and highlight text in options dialogs.
Definition at line 58 of file qgsoptionswidgetfactory.h.
|
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 92 of file qgsoptionswidgetfactory.h.