A tool button that allows enabling or disabling legend filter by contents of the map. More...

#include <qgslegendfilterbutton.h>

Inheritance diagram for QgsLegendFilterButton:

Signals
void	expressionTextChanged ()
	Emitted when the expression text changes.

Public Member Functions
	QgsLegendFilterButton (QWidget *parent=nullptr)
	Construct a new filter legend button.

QString	expressionText () const
	Returns the current text used as filter expression.

void	registerExpressionContextGenerator (QgsExpressionContextGenerator *generator)
	Register an expression context generator class that will be used to retrieve an expression context for the button when required.

void	setExpressionText (const QString &expression)
	Sets the current text used as filter expression.

void	setVectorLayer (QgsVectorLayer *layer)
	Sets the associated vectorLayer May be `nullptr`.

QgsVectorLayer *	vectorLayer () const
	Returns the current associated vectorLayer May be `nullptr`.

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.

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 26 of file qgslegendfilterbutton.cpp.

Member Function Documentation

◆ expressionText()

QString QgsLegendFilterButton::expressionText ( ) const

Returns the current text used as filter expression.

Definition at line 118 of file qgslegendfilterbutton.cpp.

◆ expressionTextChanged

void QgsLegendFilterButton::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 91 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 123 of file qgslegendfilterbutton.cpp.

◆ setVectorLayer()

void QgsLegendFilterButton::setVectorLayer ( QgsVectorLayer * layer )

Sets the associated vectorLayer May be nullptr.

Definition at line 134 of file qgslegendfilterbutton.cpp.

◆ vectorLayer()

QgsVectorLayer * QgsLegendFilterButton::vectorLayer ( ) const

Returns the current associated vectorLayer May be nullptr.

Definition at line 129 of file qgslegendfilterbutton.cpp.

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

/build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/gui/qgslegendfilterbutton.h
/build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/gui/qgslegendfilterbutton.cpp

Signals

Public Member Functions