src/sql/kernel/qsqlresult.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the QtSql module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QSQLRESULT_H
  43 #define QSQLRESULT_H
  44
  45 #include <QtCore/qvariant.h>
  46 #include <QtCore/qvector.h>
  47 #include <QtSql/qsql.h>
  48
  49 QT_BEGIN_HEADER
  50
  51 QT_BEGIN_NAMESPACE
  52
  53
  54 class QString;
  55 class QSqlRecord;
  56 template <typename T> class QVector;
  57 class QVariant;
  58 class QSqlDriver;
  59 class QSqlError;
  60 class QSqlResultPrivate;
  61
  62 class Q_SQL_EXPORT QSqlResult
  63 {
  64     friend class QSqlQuery;
  65     friend class QSqlTableModelPrivate;
  66     friend class QSqlResultPrivate;
  67
  68 public:
  69     virtual ~QSqlResult();
  70     virtual QVariant handle() const;
  71
  72 protected:
  73     enum BindingSyntax {
  74         PositionalBinding,
  75         NamedBinding
  76     };
  77
  78     explicit QSqlResult(const QSqlDriver * db);
  79     int at() const;
  80     QString lastQuery() const;
  81     QSqlError lastError() const;
  82     bool isValid() const;
  83     bool isActive() const;
  84     bool isSelect() const;
  85     bool isForwardOnly() const;
  86     const QSqlDriver* driver() const;
  87     virtual void setAt(int at);
  88     virtual void setActive(bool a);
  89     virtual void setLastError(const QSqlError& e);
  90     virtual void setQuery(const QString& query);
  91     virtual void setSelect(bool s);
  92     virtual void setForwardOnly(bool forward);
  93
  94     // prepared query support
  95     virtual bool exec();
  96     virtual bool prepare(const QString& query);
  97     virtual bool savePrepare(const QString& sqlquery);
  98     virtual void bindValue(int pos, const QVariant& val, QSql::ParamType type);
  99     virtual void bindValue(const QString& placeholder, const QVariant& val,
 100                            QSql::ParamType type);
 101     void addBindValue(const QVariant& val, QSql::ParamType type);
 102     QVariant boundValue(const QString& placeholder) const;
 103     QVariant boundValue(int pos) const;
 104     QSql::ParamType bindValueType(const QString& placeholder) const;
 105     QSql::ParamType bindValueType(int pos) const;
 106     int boundValueCount() const;
 107     QVector<QVariant>& boundValues() const;
 108     QString executedQuery() const;
 109     QString boundValueName(int pos) const;
 110     void clear();
 111     bool hasOutValues() const;
 112
 113     BindingSyntax bindingSyntax() const;
 114
 115     virtual QVariant data(int i) = 0;
 116     virtual bool isNull(int i) = 0;
 117     virtual bool reset(const QString& sqlquery) = 0;
 118     virtual bool fetch(int i) = 0;
 119     virtual bool fetchNext();
 120     virtual bool fetchPrevious();
 121     virtual bool fetchFirst() = 0;
 122     virtual bool fetchLast() = 0;
 123     virtual int size() = 0;
 124     virtual int numRowsAffected() = 0;
 125     virtual QSqlRecord record() const;
 126     virtual QVariant lastInsertId() const;
 127
 128     enum VirtualHookOperation { BatchOperation, DetachFromResultSet, SetNumericalPrecision, NextResult };
 129     virtual void virtual_hook(int id, void *data);
 130     bool execBatch(bool arrayBind = false);
 131     void detachFromResultSet();
 132     void setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy policy);
 133     QSql::NumericalPrecisionPolicy numericalPrecisionPolicy() const;
 134     bool nextResult();
 135
 136 private:
 137     QSqlResultPrivate* d;
 138     void resetBindCount(); // HACK
 139
 140 private:
 141     Q_DISABLE_COPY(QSqlResult)
 142 };
 143
 144 QT_END_NAMESPACE
 145
 146 QT_END_HEADER
 147
 148 #endif // QSQLRESULT_H