QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
QgsSettingsTreeWidget Class Reference

QgsSettingsTreeWidget is a widget with the settings tree to visualize, search and edit settings. More...

#include <qgssettingstreewidget.h>

Inheritance diagram for QgsSettingsTreeWidget:
Inheritance graph
[legend]

Public Member Functions

 QgsSettingsTreeWidget (QWidget *parent=nullptr)
 Constructor.
 
void applyChanges () const
 Apply changes to settings value.
 
- Public Member Functions inherited from QgsOptionsDialogHighlightWidget
virtual ~QgsOptionsDialogHighlightWidget ()=default
 
bool isValid ()
 Returns if it valid: if the widget type is handled and if the widget is not still available.
 
bool searchHighlight (const QString &text)
 search for a text pattern and highlight the widget if the text is found
 
QWidget * widget ()
 Returns the widget.
 

Protected Member Functions

bool highlightText (const QString &text) override
 Highlight the text in the widget.
 
void reset () override
 reset the style of the widgets to its original state
 
bool searchText (const QString &text) override
 Search for the text in the widget and return true if it was found.
 
- Protected Member Functions inherited from QgsOptionsDialogHighlightWidget
 QgsOptionsDialogHighlightWidget (QWidget *widget=nullptr)
 Constructor.
 

Additional Inherited Members

- Static Public Member Functions inherited from QgsOptionsDialogHighlightWidget
static QgsOptionsDialogHighlightWidgetcreateWidget (QWidget *widget)
 create a highlight widget implementation for the proper widget type.
 
- Protected Attributes inherited from QgsOptionsDialogHighlightWidget
QPointer< QWidget > mWidget
 Pointer to the widget.
 

Detailed Description

QgsSettingsTreeWidget is a widget with the settings tree to visualize, search and edit settings.

Since
QGIS 3.32

Definition at line 35 of file qgssettingstreewidget.h.

Constructor & Destructor Documentation

◆ QgsSettingsTreeWidget()

QgsSettingsTreeWidget::QgsSettingsTreeWidget ( QWidget *  parent = nullptr)
explicit

Constructor.

Definition at line 26 of file qgssettingstreewidget.cpp.

Member Function Documentation

◆ applyChanges()

void QgsSettingsTreeWidget::applyChanges ( ) const

Apply changes to settings value.

Definition at line 47 of file qgssettingstreewidget.cpp.

◆ highlightText()

bool QgsSettingsTreeWidget::highlightText ( const QString &  text)
overrideprotectedvirtual

Highlight the text in the widget.

Returns
true if the text could be highlighted.

Implements QgsOptionsDialogHighlightWidget.

Definition at line 59 of file qgssettingstreewidget.cpp.

◆ reset()

void QgsSettingsTreeWidget::reset ( )
overrideprotectedvirtual

reset the style of the widgets to its original state

Implements QgsOptionsDialogHighlightWidget.

Definition at line 65 of file qgssettingstreewidget.cpp.

◆ searchText()

bool QgsSettingsTreeWidget::searchText ( const QString &  text)
overrideprotectedvirtual

Search for the text in the widget and return true if it was found.

Implements QgsOptionsDialogHighlightWidget.

Definition at line 53 of file qgssettingstreewidget.cpp.


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