src/sql/kernel/qsqlfield.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtSql module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** Commercial Usage
  11 ** Licensees holding valid Qt Commercial licenses may use this file in
  12 ** accordance with the Qt Commercial License Agreement provided with the
  13 ** Software or, alternatively, in accordance with the terms contained in
  14 ** a written agreement between you and Nokia.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** GNU General Public License Usage
  29 ** Alternatively, this file may be used under the terms of the GNU
  30 ** General Public License version 3.0 as published by the Free Software
  31 ** Foundation and appearing in the file LICENSE.GPL included in the
  32 ** packaging of this file.  Please review the following information to
  33 ** ensure the GNU General Public License version 3.0 requirements will be
  34 ** met: http://www.gnu.org/copyleft/gpl.html.
  35 **
  36 ** If you have questions regarding the use of this file, please contact
  37 ** Nokia at qt-info@nokia.com.
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QSQLFIELD_H
  43 #define QSQLFIELD_H
  44
  45 #include <QtCore/qvariant.h>
  46 #include <QtCore/qstring.h>
  47
  48 QT_BEGIN_HEADER
  49
  50 QT_BEGIN_NAMESPACE
  51
  52 QT_MODULE(Sql)
  53
  54 class QSqlFieldPrivate;
  55
  56 class Q_SQL_EXPORT QSqlField
  57 {
  58 public:
  59     enum RequiredStatus { Unknown = -1, Optional = 0, Required = 1 };
  60
  61     QSqlField(const QString& fieldName = QString(),
  62               QVariant::Type type = QVariant::Invalid);
  63
  64     QSqlField(const QSqlField& other);
  65     QSqlField& operator=(const QSqlField& other);
  66     bool operator==(const QSqlField& other) const;
  67     inline bool operator!=(const QSqlField &other) const { return !operator==(other); }
  68     ~QSqlField();
  69
  70     void setValue(const QVariant& value);
  71     inline QVariant value() const
  72     { return val; }
  73     void setName(const QString& name);
  74     QString name() 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
 101 #ifdef QT3_SUPPORT
 102     inline QT3_SUPPORT void setNull() { clear(); }
 103 #endif
 104
 105 private:
 106     void detach();
 107     QVariant val;
 108     QSqlFieldPrivate* d;
 109 };
 110
 111 #ifndef QT_NO_DEBUG_STREAM
 112 Q_SQL_EXPORT QDebug operator<<(QDebug, const QSqlField &);
 113 #endif
 114
 115 QT_END_NAMESPACE
 116
 117 QT_END_HEADER
 118
 119 #endif // QSQLFIELD_H