A tool button that allows enabling or disabling legend filter by contents of the map. More...
#include <qgslegendfilterbutton.h>
Signals | |
| void | expressionTextChanged () |
| Emitted when the expression text changes. More... | |
Public Member Functions | |
| QgsLegendFilterButton (QWidget *parent=nullptr) | |
| Construct a new filter legend button. More... | |
| QString | expressionText () const |
| Returns the current text used as filter expression. More... | |
| void | registerExpressionContextGenerator (QgsExpressionContextGenerator *generator) |
| Register an expression context generator class that will be used to retrieve an expression context for the button when required. More... | |
| void | setExpressionText (const QString &expression) |
| Sets the current text used as filter expression. More... | |
| void | setVectorLayer (QgsVectorLayer *layer) |
Sets the associated vectorLayer May be nullptr. More... | |
| QgsVectorLayer * | vectorLayer () const |
Returns the current associated vectorLayer May be nullptr. More... | |
Detailed Description
A tool button that allows enabling or disabling legend filter by contents of the map.
An additional pop down menu allows defining a boolean expression to refine the filtering.
- Since
- QGIS 2.14
Definition at line 33 of file qgslegendfilterbutton.h.
Constructor & Destructor Documentation
◆ QgsLegendFilterButton()
| QgsLegendFilterButton::QgsLegendFilterButton | ( | QWidget * | parent = nullptr | ) |
Construct a new filter legend button.
- Parameters
-
parent The parent QWidget
Definition at line 25 of file qgslegendfilterbutton.cpp.
Member Function Documentation
◆ expressionText()
| QString QgsLegendFilterButton::expressionText | ( | ) | const |
Returns the current text used as filter expression.
Definition at line 117 of file qgslegendfilterbutton.cpp.
◆ expressionTextChanged
|
signal |
Emitted when the expression text changes.
◆ registerExpressionContextGenerator()
| void QgsLegendFilterButton::registerExpressionContextGenerator | ( | QgsExpressionContextGenerator * | generator | ) |
Register an expression context generator class that will be used to retrieve an expression context for the button when required.
- Since
- QGIS 3.32
Definition at line 90 of file qgslegendfilterbutton.cpp.
◆ setExpressionText()
| void QgsLegendFilterButton::setExpressionText | ( | const QString & | expression | ) |
Sets the current text used as filter expression.
This will update the menu
Definition at line 122 of file qgslegendfilterbutton.cpp.
◆ setVectorLayer()
| void QgsLegendFilterButton::setVectorLayer | ( | QgsVectorLayer * | layer | ) |
Sets the associated vectorLayer May be nullptr.
Definition at line 133 of file qgslegendfilterbutton.cpp.
◆ vectorLayer()
| QgsVectorLayer * QgsLegendFilterButton::vectorLayer | ( | ) | const |
Returns the current associated vectorLayer May be nullptr.
Definition at line 128 of file qgslegendfilterbutton.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.32.0+99sid/src/gui/qgslegendfilterbutton.h
- /build/qgis-3.32.0+99sid/src/gui/qgslegendfilterbutton.cpp
