QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Signals | Public Member Functions | List of all members
QgsLegendFilterButton Class Reference

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

#include <qgslegendfilterbutton.h>

Inheritance diagram for QgsLegendFilterButton:
Inheritance graph
[legend]

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...
 
QgsVectorLayervectorLayer () 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.

Definition at line 32 of file qgslegendfilterbutton.h.

Constructor & Destructor Documentation

◆ QgsLegendFilterButton()

QgsLegendFilterButton::QgsLegendFilterButton ( QWidget *  parent = nullptr)

Construct a new filter legend button.

Parameters
parentThe 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

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 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: