QGIS API Documentation 3.41.0-Master (cea29feecf2)
|
Query Builder for layers. More...
#include <qgsquerybuilder.h>
Public Slots | |
void | accept () override |
void | clear () |
void | loadQuery () |
Load query from the XML file. | |
void | reject () override |
void | saveQuery () |
Save query to the XML file. | |
void | setDatasourceDescription (const QString &uri) |
virtual void | test () |
The default implementation tests that the constructed sql statement to see if the vector layer data provider likes it. | |
Public Member Functions | |
QgsQueryBuilder (QgsVectorLayer *layer, QWidget *parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags) | |
This constructor is used when the query builder is called from the vector layer properties dialog. | |
QgsCodeEditor * | codeEditorWidget () const |
Returns the code editor widget for the SQL. | |
void | setSql (const QString &sqlStatement) |
Set the sql statement to display in the dialog. | |
void | setSubsetString (const QString &subsetString) override |
Sets a subset string into the dialog. | |
void | showEvent (QShowEvent *event) override |
QString | sql () const |
Returns the sql statement entered in the dialog. | |
QString | subsetString () const override |
Returns the subset string entered in the dialog. | |
Public Member Functions inherited from QgsSubsetStringEditorInterface | |
QgsSubsetStringEditorInterface (QWidget *parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags) | |
Constructor. | |
Static Public Member Functions | |
static bool | loadQueryFromFile (QString &subset) |
Load query from the XML file. | |
static bool | saveQueryToFile (const QString &subset) |
Save query to the XML file. | |
Friends | |
class | TestQgsQueryBuilder |
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 45 of file qgsquerybuilder.h.
QgsQueryBuilder::QgsQueryBuilder | ( | QgsVectorLayer * | layer, |
QWidget * | parent = nullptr , |
||
Qt::WindowFlags | fl = QgsGuiUtils::ModalDialogFlags |
||
) |
This constructor is used when the query builder is called from the vector layer properties dialog.
layer | existing vector layer |
parent | Parent widget |
fl | dialog flags |
Definition at line 39 of file qgsquerybuilder.cpp.
|
overrideslot |
Definition at line 277 of file qgsquerybuilder.cpp.
|
slot |
Definition at line 438 of file qgsquerybuilder.cpp.
|
inline |
Returns the code editor widget for the SQL.
Definition at line 92 of file qgsquerybuilder.h.
|
slot |
|
static |
|
overrideslot |
Definition at line 301 of file qgsquerybuilder.cpp.
|
slot |
|
static |
|
slot |
Definition at line 450 of file qgsquerybuilder.cpp.
void QgsQueryBuilder::setSql | ( | const QString & | sqlStatement | ) |
Set the sql statement to display in the dialog.
Definition at line 356 of file qgsquerybuilder.cpp.
|
inlineoverridevirtual |
Sets a subset string into the dialog.
Implements QgsSubsetStringEditorInterface.
Definition at line 67 of file qgsquerybuilder.h.
|
override |
Definition at line 131 of file qgsquerybuilder.cpp.
QString QgsQueryBuilder::sql | ( | ) | const |
Returns the sql statement entered in the dialog.
Definition at line 351 of file qgsquerybuilder.cpp.
|
inlineoverridevirtual |
Returns the subset string entered in the dialog.
Implements QgsSubsetStringEditorInterface.
Definition at line 66 of file qgsquerybuilder.h.
|
virtualslot |
The default implementation tests that 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 247 of file qgsquerybuilder.cpp.
|
friend |
Definition at line 197 of file qgsquerybuilder.h.