/****************************************************************************

**

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtSql module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QSQLFIELD_H

#define QSQLFIELD_H

#include <QtCore/qvariant.h>

#include <QtCore/qstring.h>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(Sql)

class QSqlFieldPrivate;

class Q_SQL_EXPORT QSqlField

{

public:

    enum RequiredStatus { Unknown = -1, Optional = 0, Required = 1 };

    QSqlField(const QString& fieldName = QString(),

              QVariant::Type type = QVariant::Invalid);

    QSqlField(const QSqlField& other);

    QSqlField& operator=(const QSqlField& other);

    bool operator==(const QSqlField& other) const;

    inline bool operator!=(const QSqlField &other) const { return !operator==(other); }

    ~QSqlField();

    void setValue(const QVariant& value);

    inline QVariant value() const

    { return val; }

    void setName(const QString& name);

    QString name() const;

    bool isNull() const;

    void setReadOnly(bool readOnly);

    bool isReadOnly() const;

    void clear();

    QVariant::Type type() const;

    bool isAutoValue() const;

    void setType(QVariant::Type type);

    void setRequiredStatus(RequiredStatus status);

    inline void setRequired(bool required)

    { setRequiredStatus(required ? Required : Optional); }

    void setLength(int fieldLength);

    void setPrecision(int precision);

    void setDefaultValue(const QVariant &value);

    void setSqlType(int type);

    void setGenerated(bool gen);

    void setAutoValue(bool autoVal);

    RequiredStatus requiredStatus() const;

    int length() const;

    int precision() const;

    QVariant defaultValue() const;

    int typeID() const;

    bool isGenerated() const;

    bool isValid() const;

#ifdef QT3_SUPPORT

    inline QT3_SUPPORT void setNull() { clear(); }

#endif

private:

    void detach();

    QVariant val;

    QSqlFieldPrivate* d;

};

#ifndef QT_NO_DEBUG_STREAM

Q_SQL_EXPORT QDebug operator<<(QDebug, const QSqlField &);

#endif

QT_END_NAMESPACE

QT_END_HEADER

#endif // QSQLFIELD_H