QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
A model containing tables from a database connection. More...
#include <qgsdatabasetablemodel.h>
Public Types | |
enum class | CustomRole : int { TableName = Qt::UserRole , Schema , TableFlags , Comment , CustomInfo , WkbType , Crs , Empty } |
Custom model roles. More... | |
Public Slots | |
void | refresh () |
Refreshes the table list by querying the underlying connection. | |
Public Member Functions | |
QgsDatabaseTableModel (const QString &provider, const QString &connection, const QString &schema=QString(), QObject *parent=nullptr) | |
Constructor for QgsDatabaseTableModel, for the specified provider and connection name. | |
QgsDatabaseTableModel (QgsAbstractDatabaseProviderConnection *connection, const QString &schema=QString(), QObject *parent=nullptr) | |
Constructor for QgsDatabaseTableModel, for the specified connection. | |
bool | allowEmptyTable () const |
Returns true if the model allows the empty table ("not set") choice. | |
int | columnCount (const QModelIndex &parent=QModelIndex()) const override |
QVariant | data (const QModelIndex &index, int role=Qt::DisplayRole) const override |
QModelIndex | index (int row, int column, const QModelIndex &parent) const override |
QModelIndex | parent (const QModelIndex &child) const override |
int | rowCount (const QModelIndex &parent=QModelIndex()) const override |
void | setAllowEmptyTable (bool allowEmpty) |
Sets whether an optional empty table ("not set") option is present in the model. | |
A model containing tables from a database connection.
This class does not automatically subscribe to database updates. Tables are queried from the database initially upon model construction. In order to update the listed tbales, QgsDatabaseTableModel::refresh() must be manually called.
Definition at line 39 of file qgsdatabasetablemodel.h.
|
strong |
Custom model roles.
Definition at line 53 of file qgsdatabasetablemodel.h.
|
explicit |
Constructor for QgsDatabaseTableModel, for the specified provider and connection name.
The optional schema argument can be used to restrict the tables to those from a specific schema.
Definition at line 22 of file qgsdatabasetablemodel.cpp.
|
explicit |
Constructor for QgsDatabaseTableModel, for the specified connection.
The optional schema argument can be used to restrict the tables to those from a specific schema.
Ownership of connection is transferred to the model.
Definition at line 34 of file qgsdatabasetablemodel.cpp.
|
inline |
Returns true
if the model allows the empty table ("not set") choice.
Definition at line 103 of file qgsdatabasetablemodel.h.
|
override |
Definition at line 64 of file qgsdatabasetablemodel.cpp.
|
override |
Definition at line 71 of file qgsdatabasetablemodel.cpp.
|
override |
Definition at line 169 of file qgsdatabasetablemodel.cpp.
|
override |
Definition at line 49 of file qgsdatabasetablemodel.cpp.
|
slot |
Refreshes the table list by querying the underlying connection.
Definition at line 198 of file qgsdatabasetablemodel.cpp.
|
override |
Definition at line 56 of file qgsdatabasetablemodel.cpp.
void QgsDatabaseTableModel::setAllowEmptyTable | ( | bool | allowEmpty | ) |
Sets whether an optional empty table ("not set") option is present in the model.
Definition at line 179 of file qgsdatabasetablemodel.cpp.