File: qgsdatabasetablemodel.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 154
file content (108 lines) | stat: -rw-r--r-- 3,554 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgsdatabasetablemodel.h                                     *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsDatabaseTableModel : QAbstractItemModel
{
%Docstring(signature="appended")
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,
:py:func:`QgsDatabaseTableModel.refresh()` must be manually called.

.. versionadded:: 3.14
%End

%TypeHeaderCode
#include "qgsdatabasetablemodel.h"
%End
  public:


    enum class CustomRole /BaseType=IntEnum/
    {
      TableName,
      Schema,
      TableFlags,
      Comment,
      CustomInfo,
      WkbType,
      Crs,
      Empty,
    };

    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 :py:class:`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;


    void setAllowEmptyTable( bool allowEmpty );
%Docstring
Sets whether an optional empty table ("not set") option is present in
the model.

.. seealso:: :py:func:`allowEmptyTable`
%End

    bool allowEmptyTable() const;
%Docstring
Returns ``True`` if the model allows the empty table ("not set") choice.

.. seealso:: :py:func:`setAllowEmptyTable`
%End

  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.py again   *
 ************************************************************************/