QGIS API Documentation 3.41.0-Master (af5edcb665c)
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Protected Member Functions | List of all members
QgsSQLComposerDialog Class Reference

SQL composer dialog. More...

#include <qgssqlcomposerdialog.h>

Inheritance diagram for QgsSQLComposerDialog:
Inheritance graph
[legend]

Classes

struct  Argument
 argument of a function More...
 
struct  Function
 description of server functions More...
 
class  SQLValidatorCallback
 Callback to do validation check on dialog validation. More...
 
class  TableSelectedCallback
 Callback to do actions on table selection. More...
 

Public Types

typedef QPair< QString, QString > PairNameTitle
 pair (name, title)
 
typedef QPair< QString, QString > PairNameType
 pair (name, type)
 

Public Member Functions

 QgsSQLComposerDialog (QgsVectorLayer *layer, QWidget *parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags)
 This constructor is used on an existing layer.
 
 QgsSQLComposerDialog (QWidget *parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags)
 constructor
 
 ~QgsSQLComposerDialog () override
 
void addApis (const QStringList &list)
 add a list of API for autocompletion
 
void addColumnNames (const QList< PairNameType > &list, const QString &tableName)
 add a list of column names
 
void addColumnNames (const QStringList &list, const QString &tableName)
 add a list of column names
 
void addFunctions (const QList< Function > &list)
 add a list of functions
 
void addFunctions (const QStringList &list)
 add a list of functions
 
void addOperators (const QStringList &list)
 add a list of operators
 
void addSpatialPredicates (const QList< Function > &list)
 add a list of spatial predicates
 
void addSpatialPredicates (const QStringList &list)
 add a list of spatial predicates
 
void addTableNames (const QList< PairNameTitle > &listNameTitle)
 add a list of table names
 
void addTableNames (const QStringList &list)
 add a list of table names
 
void setSql (const QString &sql)
 initialize the SQL statement
 
void setSQLValidatorCallback (SQLValidatorCallback *sqlValidatorCallback)
 Set a callback that will be called when the OK button is pushed.
 
void setSubsetString (const QString &subsetString) override
 Sets a subset string into the dialog.
 
void setSupportMultipleTables (bool bMultipleTables, const QString &mainTypename=QString())
 Sets if multiple tables/joins are supported. Default is false.
 
void setTableSelectedCallback (TableSelectedCallback *tableSelectedCallback)
 Set a callback that will be called when a new table is selected, so that new column names can be added typically.
 
QString sql () const
 Gets the SQL statement.
 
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.
 

Protected Member Functions

bool eventFilter (QObject *obj, QEvent *event) override
 

Detailed Description

SQL composer dialog.

Note
not available in Python bindings

Definition at line 41 of file qgssqlcomposerdialog.h.

Member Typedef Documentation

◆ PairNameTitle

typedef QPair<QString, QString> QgsSQLComposerDialog::PairNameTitle

pair (name, title)

Definition at line 47 of file qgssqlcomposerdialog.h.

◆ PairNameType

typedef QPair<QString, QString> QgsSQLComposerDialog::PairNameType

pair (name, type)

Definition at line 50 of file qgssqlcomposerdialog.h.

Constructor & Destructor Documentation

◆ QgsSQLComposerDialog() [1/2]

QgsSQLComposerDialog::QgsSQLComposerDialog ( QWidget *  parent = nullptr,
Qt::WindowFlags  fl = QgsGuiUtils::ModalDialogFlags 
)
explicit

constructor

Definition at line 32 of file qgssqlcomposerdialog.cpp.

◆ QgsSQLComposerDialog() [2/2]

QgsSQLComposerDialog::QgsSQLComposerDialog ( QgsVectorLayer layer,
QWidget *  parent = nullptr,
Qt::WindowFlags  fl = QgsGuiUtils::ModalDialogFlags 
)

This constructor is used on an existing layer.

On successful accept, it will update the layer subset string.

Parameters
layerexisting vector layer
parentParent widget
fldialog flags

Definition at line 36 of file qgssqlcomposerdialog.cpp.

◆ ~QgsSQLComposerDialog()

QgsSQLComposerDialog::~QgsSQLComposerDialog ( )
override

Definition at line 120 of file qgssqlcomposerdialog.cpp.

Member Function Documentation

◆ addApis()

void QgsSQLComposerDialog::addApis ( const QStringList &  list)

add a list of API for autocompletion

Definition at line 749 of file qgssqlcomposerdialog.cpp.

◆ addColumnNames() [1/2]

void QgsSQLComposerDialog::addColumnNames ( const QList< PairNameType > &  list,
const QString &  tableName 
)

add a list of column names

Definition at line 394 of file qgssqlcomposerdialog.cpp.

◆ addColumnNames() [2/2]

void QgsSQLComposerDialog::addColumnNames ( const QStringList &  list,
const QString &  tableName 
)

add a list of column names

Definition at line 374 of file qgssqlcomposerdialog.cpp.

◆ addFunctions() [1/2]

void QgsSQLComposerDialog::addFunctions ( const QList< Function > &  list)

add a list of functions

Definition at line 534 of file qgssqlcomposerdialog.cpp.

◆ addFunctions() [2/2]

void QgsSQLComposerDialog::addFunctions ( const QStringList &  list)

add a list of functions

Definition at line 521 of file qgssqlcomposerdialog.cpp.

◆ addOperators()

void QgsSQLComposerDialog::addOperators ( const QStringList &  list)

add a list of operators

Definition at line 419 of file qgssqlcomposerdialog.cpp.

◆ addSpatialPredicates() [1/2]

void QgsSQLComposerDialog::addSpatialPredicates ( const QList< Function > &  list)

add a list of spatial predicates

Definition at line 511 of file qgssqlcomposerdialog.cpp.

◆ addSpatialPredicates() [2/2]

void QgsSQLComposerDialog::addSpatialPredicates ( const QStringList &  list)

add a list of spatial predicates

Definition at line 498 of file qgssqlcomposerdialog.cpp.

◆ addTableNames() [1/2]

void QgsSQLComposerDialog::addTableNames ( const QList< PairNameTitle > &  listNameTitle)

add a list of table names

Definition at line 351 of file qgssqlcomposerdialog.cpp.

◆ addTableNames() [2/2]

void QgsSQLComposerDialog::addTableNames ( const QStringList &  list)

add a list of table names

Definition at line 342 of file qgssqlcomposerdialog.cpp.

◆ eventFilter()

bool QgsSQLComposerDialog::eventFilter ( QObject *  obj,
QEvent *  event 
)
overrideprotected

Definition at line 129 of file qgssqlcomposerdialog.cpp.

◆ setSql()

void QgsSQLComposerDialog::setSql ( const QString &  sql)

initialize the SQL statement

Definition at line 192 of file qgssqlcomposerdialog.cpp.

◆ setSQLValidatorCallback()

void QgsSQLComposerDialog::setSQLValidatorCallback ( SQLValidatorCallback sqlValidatorCallback)

Set a callback that will be called when the OK button is pushed.

Ownership of the callback remains to the caller.

Definition at line 187 of file qgssqlcomposerdialog.cpp.

◆ setSubsetString()

void QgsSQLComposerDialog::setSubsetString ( const QString &  subsetString)
inlineoverridevirtual

Sets a subset string into the dialog.

Implements QgsSubsetStringEditorInterface.

Definition at line 135 of file qgssqlcomposerdialog.h.

◆ setSupportMultipleTables()

void QgsSQLComposerDialog::setSupportMultipleTables ( bool  bMultipleTables,
const QString &  mainTypename = QString() 
)

Sets if multiple tables/joins are supported. Default is false.

Definition at line 766 of file qgssqlcomposerdialog.cpp.

◆ setTableSelectedCallback()

void QgsSQLComposerDialog::setTableSelectedCallback ( TableSelectedCallback tableSelectedCallback)

Set a callback that will be called when a new table is selected, so that new column names can be added typically.

Ownership of the callback remains to the caller.

Definition at line 182 of file qgssqlcomposerdialog.cpp.

◆ sql()

QString QgsSQLComposerDialog::sql ( ) const

Gets the SQL statement.

Definition at line 198 of file qgssqlcomposerdialog.cpp.

◆ subsetString()

QString QgsSQLComposerDialog::subsetString ( ) const
inlineoverridevirtual

Returns the subset string entered in the dialog.

Implements QgsSubsetStringEditorInterface.

Definition at line 134 of file qgssqlcomposerdialog.h.


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