1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtSql module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QSQLTABLEMODEL_H
41#define QSQLTABLEMODEL_H
42
43#include <QtSql/qtsqlglobal.h>
44#include <QtSql/qsqldatabase.h>
45#include <QtSql/qsqlquerymodel.h>
46
47QT_REQUIRE_CONFIG(sqlmodel);
48
49QT_BEGIN_NAMESPACE
50
51
52class QSqlTableModelPrivate;
53class QSqlRecord;
54class QSqlField;
55class QSqlIndex;
56
57class Q_SQL_EXPORT QSqlTableModel: public QSqlQueryModel
58{
59 Q_OBJECT
60 Q_DECLARE_PRIVATE(QSqlTableModel)
61
62public:
63 enum EditStrategy {OnFieldChange, OnRowChange, OnManualSubmit};
64
65 explicit QSqlTableModel(QObject *parent = nullptr, QSqlDatabase db = QSqlDatabase());
66 virtual ~QSqlTableModel();
67
68 virtual void setTable(const QString &tableName);
69 QString tableName() const;
70
71 Qt::ItemFlags flags(const QModelIndex &index) const override;
72
73 QSqlRecord record() const;
74 QSqlRecord record(int row) const;
75 QVariant data(const QModelIndex &idx, int role = Qt::DisplayRole) const override;
76 bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override;
77#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
78 bool clearItemData(const QModelIndex &index) override;
79#endif
80
81 QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;
82
83 bool isDirty() const;
84 bool isDirty(const QModelIndex &index) const;
85
86 void clear() override;
87
88 virtual void setEditStrategy(EditStrategy strategy);
89 EditStrategy editStrategy() const;
90
91 QSqlIndex primaryKey() const;
92 QSqlDatabase database() const;
93 int fieldIndex(const QString &fieldName) const;
94
95 void sort(int column, Qt::SortOrder order) override;
96 virtual void setSort(int column, Qt::SortOrder order);
97
98 QString filter() const;
99 virtual void setFilter(const QString &filter);
100
101 int rowCount(const QModelIndex &parent = QModelIndex()) const override;
102
103 bool removeColumns(int column, int count, const QModelIndex &parent = QModelIndex()) override;
104 bool removeRows(int row, int count, const QModelIndex &parent = QModelIndex()) override;
105 bool insertRows(int row, int count, const QModelIndex &parent = QModelIndex()) override;
106
107 bool insertRecord(int row, const QSqlRecord &record);
108 bool setRecord(int row, const QSqlRecord &record);
109
110 virtual void revertRow(int row);
111
112public Q_SLOTS:
113 virtual bool select();
114 virtual bool selectRow(int row);
115
116 bool submit() override;
117 void revert() override;
118
119 bool submitAll();
120 void revertAll();
121
122Q_SIGNALS:
123 void primeInsert(int row, QSqlRecord &record);
124
125 void beforeInsert(QSqlRecord &record);
126 void beforeUpdate(int row, QSqlRecord &record);
127 void beforeDelete(int row);
128
129protected:
130 QSqlTableModel(QSqlTableModelPrivate &dd, QObject *parent = nullptr, QSqlDatabase db = QSqlDatabase());
131
132 virtual bool updateRowInTable(int row, const QSqlRecord &values);
133 virtual bool insertRowIntoTable(const QSqlRecord &values);
134 virtual bool deleteRowFromTable(int row);
135 virtual QString orderByClause() const;
136 virtual QString selectStatement() const;
137
138 void setPrimaryKey(const QSqlIndex &key);
139 void setQuery(const QSqlQuery &query);
140 QModelIndex indexInQuery(const QModelIndex &item) const override;
141 QSqlRecord primaryValues(int row) const;
142};
143
144QT_END_NAMESPACE
145
146#endif // QSQLTABLEMODEL_H
147

source code of qtbase/src/sql/models/qsqltablemodel.h