QGIS API Documentation  2.99.0-Master (75367e4)
Public Member Functions | Protected Member Functions | List of all members
QgsExpressionSelectionDialog Class Reference

This class offers a dialog to change feature selections. More...

#include <qgsexpressionselectiondialog.h>

Inheritance diagram for QgsExpressionSelectionDialog:
Inheritance graph
[legend]

Public Member Functions

 QgsExpressionSelectionDialog (QgsVectorLayer *layer, const QString &startText=QString(), QWidget *parent=nullptr)
 Creates a new selection dialog. More...
 
QgsExpressionBuilderWidgetexpressionBuilder ()
 The builder widget that is used by the dialog. More...
 
QString expressionText ()
 Returns the current expression text. More...
 
void setExpressionText (const QString &text)
 Sets the current expression text. More...
 
void setGeomCalculator (const QgsDistanceArea &da)
 Sets geometry calculator used in distance/area calculations. More...
 
void setMapCanvas (QgsMapCanvas *canvas)
 Sets a map canvas associated with the dialog. More...
 
void setMessageBar (QgsMessageBar *messageBar)
 Sets the message bar to display feedback from the dialog. More...
 

Protected Member Functions

virtual void closeEvent (QCloseEvent *closeEvent) override
 Implementation for closeEvent Saves the window geometry. More...
 
virtual void done (int r) override
 Implementation for done (default behavior when pressing esc) Calls close, so the window geometry gets saved and the object deleted. More...
 

Detailed Description

This class offers a dialog to change feature selections.

To do so, a QgsExpressionBuilderWidget is shown in a dialog. It offers the possibilities to create a new selection, add to the current selection remove from the current selection or select within the current selection.

Definition at line 33 of file qgsexpressionselectiondialog.h.

Constructor & Destructor Documentation

◆ QgsExpressionSelectionDialog()

QgsExpressionSelectionDialog::QgsExpressionSelectionDialog ( QgsVectorLayer layer,
const QString &  startText = QString(),
QWidget *  parent = nullptr 
)

Creates a new selection dialog.

Parameters
layerThe layer on which the selection is to be performed.
startTextA default expression text to be applied (Defaults to empty)
parentparent object (owner)

Definition at line 26 of file qgsexpressionselectiondialog.cpp.

Member Function Documentation

◆ closeEvent()

void QgsExpressionSelectionDialog::closeEvent ( QCloseEvent *  closeEvent)
overrideprotectedvirtual

Implementation for closeEvent Saves the window geometry.

Parameters
closeEventEvent object. Unused.

Definition at line 176 of file qgsexpressionselectiondialog.cpp.

◆ done()

void QgsExpressionSelectionDialog::done ( int  r)
overrideprotectedvirtual

Implementation for done (default behavior when pressing esc) Calls close, so the window geometry gets saved and the object deleted.

Parameters
rResult value. Unused.

Definition at line 189 of file qgsexpressionselectiondialog.cpp.

◆ expressionBuilder()

QgsExpressionBuilderWidget * QgsExpressionSelectionDialog::expressionBuilder ( )

The builder widget that is used by the dialog.

Returns
The builder widget that is used by the dialog

Definition at line 62 of file qgsexpressionselectiondialog.cpp.

◆ expressionText()

QString QgsExpressionSelectionDialog::expressionText ( )

Returns the current expression text.

Returns
The expression text

Definition at line 72 of file qgsexpressionselectiondialog.cpp.

◆ setExpressionText()

void QgsExpressionSelectionDialog::setExpressionText ( const QString &  text)

Sets the current expression text.

Parameters
textthe expression text to set

Definition at line 67 of file qgsexpressionselectiondialog.cpp.

◆ setGeomCalculator()

void QgsExpressionSelectionDialog::setGeomCalculator ( const QgsDistanceArea da)

Sets geometry calculator used in distance/area calculations.

Definition at line 77 of file qgsexpressionselectiondialog.cpp.

◆ setMapCanvas()

void QgsExpressionSelectionDialog::setMapCanvas ( QgsMapCanvas canvas)

Sets a map canvas associated with the dialog.

Note
added in QGIS 3.0

Definition at line 88 of file qgsexpressionselectiondialog.cpp.

◆ setMessageBar()

void QgsExpressionSelectionDialog::setMessageBar ( QgsMessageBar messageBar)

Sets the message bar to display feedback from the dialog.

This is used when zooming to features to display the count of selected features.

Parameters
messageBartarget message bar
Note
added in QGIS 3.0

Definition at line 83 of file qgsexpressionselectiondialog.cpp.


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