QGIS/python/core/auto_generated/qgsdatabasetablemodel.sip.in
Nyall Dawson f7731bc28f Add model for database tables from a connection
Optionally limited to a specific schema, if desired
2020-03-09 21:04:51 +10:00

89 lines
3.1 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsdatabasetablemodel.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsDatabaseTableModel : QAbstractItemModel
{
%Docstring
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.
.. versionadded:: 3.14
%End
%TypeHeaderCode
#include "qgsdatabasetablemodel.h"
%End
public:
enum Role
{
RoleTableName,
RoleSchema,
RoleTableFlags,
RoleComment,
RoleCustomInfo,
RoleWkbType,
RoleCrs,
};
explicit QgsDatabaseTableModel( const QString &provider, const QString &connection, const QString &schema = QString(), QObject *parent /TransferThis/ = 0 );
%Docstring
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.
.. warning::
The ``provider`` must support the connection API methods in its QgsProviderMetadata implementation
in order for the model to work correctly.
%End
explicit QgsDatabaseTableModel( QgsAbstractDatabaseProviderConnection *connection /Transfer/, const QString &schema = QString(), QObject *parent /TransferThis/ = 0 );
%Docstring
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.
%End
virtual QModelIndex parent( const QModelIndex &child ) const;
virtual int rowCount( const QModelIndex &parent = QModelIndex() ) const;
virtual int columnCount( const QModelIndex &parent = QModelIndex() ) const;
virtual QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const;
virtual QModelIndex index( int row, int column, const QModelIndex &parent ) const;
public slots:
void refresh();
%Docstring
Refreshes the table list by querying the underlying connection.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsdatabasetablemodel.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/