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 QSQLFIELD_H
41#define QSQLFIELD_H
42
43#include <QtSql/qtsqlglobal.h>
44#include <QtCore/qvariant.h>
45#include <QtCore/qstring.h>
46
47QT_BEGIN_NAMESPACE
48
49
50class QSqlFieldPrivate;
51
52class Q_SQL_EXPORT QSqlField
53{
54public:
55 enum RequiredStatus { Unknown = -1, Optional = 0, Required = 1 };
56
57 explicit QSqlField(const QString& fieldName = QString(),
58 QVariant::Type type = QVariant::Invalid);
59 QSqlField(const QString &fieldName, QVariant::Type type,
60 const QString &tableName);
61
62 QSqlField(const QSqlField& other);
63 QSqlField& operator=(const QSqlField& other);
64 bool operator==(const QSqlField& other) const;
65 inline bool operator!=(const QSqlField &other) const { return !operator==(other); }
66 ~QSqlField();
67
68 void setValue(const QVariant& value);
69 inline QVariant value() const
70 { return val; }
71 void setName(const QString& name);
72 QString name() const;
73 void setTableName(const QString &tableName);
74 QString tableName() const;
75 bool isNull() const;
76 void setReadOnly(bool readOnly);
77 bool isReadOnly() const;
78 void clear();
79 QVariant::Type type() const;
80 bool isAutoValue() const;
81
82 void setType(QVariant::Type type);
83 void setRequiredStatus(RequiredStatus status);
84 inline void setRequired(bool required)
85 { setRequiredStatus(required ? Required : Optional); }
86 void setLength(int fieldLength);
87 void setPrecision(int precision);
88 void setDefaultValue(const QVariant &value);
89 void setSqlType(int type);
90 void setGenerated(bool gen);
91 void setAutoValue(bool autoVal);
92
93 RequiredStatus requiredStatus() const;
94 int length() const;
95 int precision() const;
96 QVariant defaultValue() const;
97 int typeID() const;
98 bool isGenerated() const;
99 bool isValid() const;
100
101private:
102 void detach();
103 QVariant val;
104 QSqlFieldPrivate* d;
105};
106
107#ifndef QT_NO_DEBUG_STREAM
108Q_SQL_EXPORT QDebug operator<<(QDebug, const QSqlField &);
109#endif
110
111QT_END_NAMESPACE
112
113#endif // QSQLFIELD_H
114