summaryrefslogtreecommitdiffstats
path: root/src/sql/qsqlselectcursor.cpp
blob: eeb318ced024fc032743676529fa4b97cfbe39c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
/****************************************************************************
**
** Definition of QSqlSelectCursor class
**
** Created : 2002-11-13
**
** Copyright (C) 2005-2008 Trolltech ASA.  All rights reserved.
**
** This file is part of the sql module of the Qt GUI Toolkit.
**
** This file may be used under the terms of the GNU General
** Public License versions 2.0 or 3.0 as published by the Free
** Software Foundation and appearing in the files LICENSE.GPL2
** and LICENSE.GPL3 included in the packaging of this file.
** Alternatively you may (at your option) use any later version
** of the GNU General Public License if such license has been
** publicly approved by Trolltech ASA (or its successors, if any)
** and the KDE Free Qt Foundation.
**
** Please review the following information to ensure GNU General
** Public Licensing requirements will be met:
** http://trolltech.com/products/qt/licenses/licensing/opensource/.
** If you are unsure which license is appropriate for your use, please
** review the following information:
** http://trolltech.com/products/qt/licenses/licensing/licensingoverview
** or contact the sales department at sales@trolltech.com.
**
** This file may be used under the terms of the Q Public License as
** defined by Trolltech ASA and appearing in the file LICENSE.QPL
** included in the packaging of this file.  Licensees holding valid Qt
** Commercial licenses may use this file in accordance with the Qt
** Commercial License Agreement provided with the Software.
**
** This file is provided "AS IS" with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE. Trolltech reserves all rights not granted
** herein.
**
**********************************************************************/

#include "qsqlselectcursor.h"
#include "qsqldriver.h"

#ifndef QT_NO_SQL

class QSqlSelectCursorPrivate
{
public:
    QSqlSelectCursorPrivate() : populated( FALSE ) {}
    QString query;
    bool populated : 1;
};

/*!
    \class QSqlSelectCursor qsqlselectcursor.h
    \brief The QSqlSelectCursor class provides browsing of general SQL
    SELECT statements.

    \ingroup database
    \module sql

    QSqlSelectCursor is a convenience class that makes it possible to
    display result sets from general SQL \c SELECT statements in
    data-aware Qt widgets. QSqlSelectCursor is read-only and does not
    support \c INSERT, \c UPDATE or \c DELETE operations.

    Pass the query in at construction time, or use the
    QSqlSelectCursor::exec() function.

    Example:
    \code
    ...
    QSqlSelectCursor* cur = new QSqlSelectCursor( "SELECT id, firstname, lastname FROM author" );
    QDataTable* table = new QDataTable( this );
    table->setSqlCursor( cur, TRUE, TRUE );
    table->refresh();
    ...
    cur->exec( "SELECT * FROM books" );
    table->refresh();
    ...
    \endcode
*/

/*!
    Constructs a read only cursor on database \a db using the query \a query.
 */
QSqlSelectCursor::QSqlSelectCursor( const QString& query, QSqlDatabase* db )
    : QSqlCursor( QString::null, FALSE, db )
{
    d = new QSqlSelectCursorPrivate;
    d->query = query;
    QSqlCursor::setMode( ReadOnly );
    if ( !query.isNull() )
	exec( query );
}

/*! Constructs a copy of \a other */
QSqlSelectCursor::QSqlSelectCursor( const QSqlSelectCursor& other )
    : QSqlCursor( other )
{
    d = new QSqlSelectCursorPrivate;
    d->query = other.d->query;
    d->populated = other.d->populated;
}

/*! Destroys the object and frees any allocated resources */
QSqlSelectCursor::~QSqlSelectCursor()
{
    delete d;
}

/*! \reimp */
bool QSqlSelectCursor::exec( const QString& query )
{
    d->query = query;
    bool ret = QSqlCursor::exec( query );
    if ( ret ) {
	QSqlCursor::clear();
	populateCursor();
    }
    return ret;
}

/*! \fn bool QSqlSelectCursor::select()
    \reimp
*/

/*! \reimp */
bool QSqlSelectCursor::select( const QString&, const QSqlIndex& )
{
    bool ret = QSqlCursor::exec( d->query );
    if ( ret && !d->populated )
	populateCursor();
    return ret;
}

/*! \internal */
void QSqlSelectCursor::populateCursor()
{
    QSqlRecordInfo inf = driver()->recordInfo( *(QSqlQuery*)this );
    for ( QSqlRecordInfo::const_iterator it = inf.begin(); it != inf.end(); ++it )
	QSqlCursor::append( *it );
    d->populated = TRUE;
}

/*! \fn QSqlIndex QSqlSelectCursor::primaryIndex( bool ) const
    \reimp
*/

/*! \fn QSqlIndex QSqlSelectCursor::index( const QStringList& ) const
    \reimp
*/

/*! \fn QSqlIndex QSqlSelectCursor::index( const QString& ) const
    \reimp
*/

/*! \fn QSqlIndex QSqlSelectCursor::index( const char* ) const
    \reimp
*/

/*! \fn void QSqlSelectCursor::setPrimaryIndex( const QSqlIndex& )
    \reimp
*/

/*! \fn void QSqlSelectCursor::append( const QSqlFieldInfo& )
    \reimp
*/

/*! \fn void QSqlSelectCursor::insert( int, const QSqlFieldInfo& )
    \reimp
*/

/*! \fn void QSqlSelectCursor::remove( int )
    \reimp
*/

/*! \fn void QSqlSelectCursor::clear()
    \reimp
*/

/*! \fn void QSqlSelectCursor::setGenerated( const QString&, bool )
    \reimp
*/

/*! \fn void QSqlSelectCursor::setGenerated( int, bool )
    \reimp
*/

/*! \fn QSqlRecord* QSqlSelectCursor::editBuffer( bool )
    \reimp
*/

/*! \fn QSqlRecord* QSqlSelectCursor::primeInsert()
    \reimp
*/

/*! \fn QSqlRecord* QSqlSelectCursor::primeUpdate()
    \reimp
*/

/*! \fn QSqlRecord* QSqlSelectCursor::primeDelete()
    \reimp
*/

/*! \fn int QSqlSelectCursor::insert( bool )
    \reimp
*/

/*! \fn int QSqlSelectCursor::update( bool )
    \reimp
*/

/*! \fn int QSqlSelectCursor::del( bool )
    \reimp
*/

/*! \fn void QSqlSelectCursor::setMode( int )
    \reimp
*/

/*! \fn void QSqlSelectCursor::setSort( const QSqlIndex& )
    \reimp
*/

/*! \fn QSqlIndex QSqlSelectCursor::sort() const
    \reimp
*/

/*! \fn void QSqlSelectCursor::setFilter( const QString& )
    \reimp
*/

/*! \fn QString QSqlSelectCursor::filter() const
    \reimp
*/

/*! \fn void QSqlSelectCursor::setName( const QString&, bool )
    \reimp
*/

/*! \fn QString QSqlSelectCursor::name() const
    \reimp
*/

/*! \fn QString QSqlSelectCursor::toString( const QString&, const QString& ) const
    \reimp
*/
#endif // QT_NO_SQL