QGIS API Documentation  2.99.0-Master (13a3f2f)
Public Slots | Public Member Functions | List of all members
QgsQueryBuilder Class Reference

Query Builder for layers. More...

#include <qgsquerybuilder.h>

Inheritance diagram for QgsQueryBuilder:
Inheritance graph
[legend]

Public Slots

void accept () override
 
void clear ()
 
void on_btnAnd_clicked ()
 
void on_btnEqual_clicked ()
 
void on_btnGetAllValues_clicked ()
 Get all distinct values for the field. More...
 
void on_btnGreaterEqual_clicked ()
 
void on_btnGreaterThan_clicked ()
 
void on_btnILike_clicked ()
 
void on_btnIn_clicked ()
 
void on_btnLessEqual_clicked ()
 
void on_btnLessThan_clicked ()
 
void on_btnLike_clicked ()
 
void on_btnNot_clicked ()
 
void on_btnNotEqual_clicked ()
 
void on_btnNotIn_clicked ()
 
void on_btnOr_clicked ()
 
void on_btnPct_clicked ()
 
void on_btnSampleValues_clicked ()
 Get sample distinct values for the selected field. More...
 
void on_buttonBox_helpRequested ()
 
void on_lstFields_clicked (const QModelIndex &index)
 
void on_lstFields_doubleClicked (const QModelIndex &index)
 
void on_lstValues_doubleClicked (const QModelIndex &index)
 
void reject () override
 
void setDatasourceDescription (const QString &uri)
 
void setSql (const QString &sqlStatement)
 
QString sql ()
 
void test ()
 Test the constructed sql statement to see if the vector layer data provider likes it. More...
 

Public Member Functions

 QgsQueryBuilder (QgsVectorLayer *layer, QWidget *parent=0, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags)
 This constructor is used when the query builder is called from the vector layer properties dialog. More...
 
 ~QgsQueryBuilder ()
 
void showEvent (QShowEvent *event) override
 

Detailed Description

Query Builder for layers.

The query builder allows interactive creation of a SQL for limiting the features displayed in a vector layer. The fields in the table are displayed and sample values (or all values) can be viewed to aid in constructing the query. A test function returns the number of features that will be returned.

Definition at line 41 of file qgsquerybuilder.h.

Constructor & Destructor Documentation

◆ QgsQueryBuilder()

QgsQueryBuilder::QgsQueryBuilder ( QgsVectorLayer layer,
QWidget *  parent = 0,
Qt::WindowFlags  fl = QgsGuiUtils::ModalDialogFlags 
)

This constructor is used when the query builder is called from the vector layer properties dialog.

Parameters
layerexisting vector layer
parentParent widget
fldialog flags

Definition at line 28 of file qgsquerybuilder.cpp.

◆ ~QgsQueryBuilder()

QgsQueryBuilder::~QgsQueryBuilder ( )

Definition at line 59 of file qgsquerybuilder.cpp.

Member Function Documentation

◆ accept

void QgsQueryBuilder::accept ( )
overrideslot

Definition at line 230 of file qgsquerybuilder.cpp.

◆ clear

void QgsQueryBuilder::clear ( )
slot

Definition at line 384 of file qgsquerybuilder.cpp.

◆ on_btnAnd_clicked

void QgsQueryBuilder::on_btnAnd_clicked ( )
slot

Definition at line 366 of file qgsquerybuilder.cpp.

◆ on_btnEqual_clicked

void QgsQueryBuilder::on_btnEqual_clicked ( )
slot

Definition at line 262 of file qgsquerybuilder.cpp.

◆ on_btnGetAllValues_clicked

void QgsQueryBuilder::on_btnGetAllValues_clicked ( )
slot

Get all distinct values for the field.

Values are inserted into the value list box

Definition at line 173 of file qgsquerybuilder.cpp.

◆ on_btnGreaterEqual_clicked

void QgsQueryBuilder::on_btnGreaterEqual_clicked ( )
slot

Definition at line 354 of file qgsquerybuilder.cpp.

◆ on_btnGreaterThan_clicked

void QgsQueryBuilder::on_btnGreaterThan_clicked ( )
slot

Definition at line 274 of file qgsquerybuilder.cpp.

◆ on_btnILike_clicked

void QgsQueryBuilder::on_btnILike_clicked ( )
slot

Definition at line 391 of file qgsquerybuilder.cpp.

◆ on_btnIn_clicked

void QgsQueryBuilder::on_btnIn_clicked ( )
slot

Definition at line 286 of file qgsquerybuilder.cpp.

◆ on_btnLessEqual_clicked

void QgsQueryBuilder::on_btnLessEqual_clicked ( )
slot

Definition at line 348 of file qgsquerybuilder.cpp.

◆ on_btnLessThan_clicked

void QgsQueryBuilder::on_btnLessThan_clicked ( )
slot

Definition at line 268 of file qgsquerybuilder.cpp.

◆ on_btnLike_clicked

void QgsQueryBuilder::on_btnLike_clicked ( )
slot

Definition at line 298 of file qgsquerybuilder.cpp.

◆ on_btnNot_clicked

void QgsQueryBuilder::on_btnNot_clicked ( )
slot

Definition at line 372 of file qgsquerybuilder.cpp.

◆ on_btnNotEqual_clicked

void QgsQueryBuilder::on_btnNotEqual_clicked ( )
slot

Definition at line 360 of file qgsquerybuilder.cpp.

◆ on_btnNotIn_clicked

void QgsQueryBuilder::on_btnNotIn_clicked ( )
slot

Definition at line 292 of file qgsquerybuilder.cpp.

◆ on_btnOr_clicked

void QgsQueryBuilder::on_btnOr_clicked ( )
slot

Definition at line 378 of file qgsquerybuilder.cpp.

◆ on_btnPct_clicked

void QgsQueryBuilder::on_btnPct_clicked ( )
slot

Definition at line 280 of file qgsquerybuilder.cpp.

◆ on_btnSampleValues_clicked

void QgsQueryBuilder::on_btnSampleValues_clicked ( )
slot

Get sample distinct values for the selected field.

The sample size is limited to an arbitrary value (currently set to 25). The values are inserted into the values list box.

Definition at line 146 of file qgsquerybuilder.cpp.

◆ on_buttonBox_helpRequested

void QgsQueryBuilder::on_buttonBox_helpRequested ( )
inlineslot

Definition at line 83 of file qgsquerybuilder.h.

◆ on_lstFields_clicked

void QgsQueryBuilder::on_lstFields_clicked ( const QModelIndex &  index)
slot

Definition at line 314 of file qgsquerybuilder.cpp.

◆ on_lstFields_doubleClicked

void QgsQueryBuilder::on_lstFields_doubleClicked ( const QModelIndex &  index)
slot

Definition at line 327 of file qgsquerybuilder.cpp.

◆ on_lstValues_doubleClicked

void QgsQueryBuilder::on_lstValues_doubleClicked ( const QModelIndex &  index)
slot

Definition at line 333 of file qgsquerybuilder.cpp.

◆ reject

void QgsQueryBuilder::reject ( )
overrideslot

Definition at line 254 of file qgsquerybuilder.cpp.

◆ setDatasourceDescription

void QgsQueryBuilder::setDatasourceDescription ( const QString &  uri)
slot

Definition at line 397 of file qgsquerybuilder.cpp.

◆ setSql

void QgsQueryBuilder::setSql ( const QString &  sqlStatement)
slot

Definition at line 309 of file qgsquerybuilder.cpp.

◆ showEvent()

void QgsQueryBuilder::showEvent ( QShowEvent *  event)
override

Definition at line 65 of file qgsquerybuilder.cpp.

◆ sql

QString QgsQueryBuilder::sql ( )
slot

Definition at line 304 of file qgsquerybuilder.cpp.

◆ test

void QgsQueryBuilder::test ( )
slot

Test the constructed sql statement to see if the vector layer data provider likes it.

The number of rows that would be returned is displayed in a message box. The test uses a "select count(*) from ..." query to test the SQL statement.

Definition at line 200 of file qgsquerybuilder.cpp.


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