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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
|
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the Qt3Support 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 either Technology Preview License Agreement or the
** Beta Release License Agreement.
**
** 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.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
** $QT_END_LICENSE$
**
****************************************************************************/
#include "q3sqlform.h"
#ifndef QT_NO_SQL_FORM
#include "qsqlfield.h"
#include "q3sqlpropertymap.h"
#include "qsqlrecord.h"
#include "qstringlist.h"
#include "qwidget.h"
#include "qhash.h"
QT_BEGIN_NAMESPACE
class Q3SqlFormPrivate
{
public:
Q3SqlFormPrivate() : propertyMap(0), buf(0), dirty(false) {}
~Q3SqlFormPrivate() { if (propertyMap) delete propertyMap; }
QStringList fld;
QHash <QString, QWidget*> wgt;
QMap <QWidget*, QSqlField *> map;
Q3SqlPropertyMap * propertyMap;
QSqlRecord* buf;
bool dirty;
};
/*!
\class Q3SqlForm
\brief The Q3SqlForm class creates and manages data entry forms
tied to SQL databases.
\compat
Typical use of a Q3SqlForm consists of the following steps:
\list
\i Create the widgets you want to appear in the form.
\i Create a cursor and navigate to the record to be edited.
\i Create the Q3SqlForm.
\i Set the form's record buffer to the cursor's update buffer.
\i Insert each widget and the field it is to edit into the form.
\i Use readFields() to update the editor widgets with values from
the database's fields.
\i Display the form and let the user edit values etc.
\i Use writeFields() to update the database's field values with
the values in the editor widgets.
\endlist
Note that a Q3SqlForm does not access the database directly, but
most often via QSqlFields which are part of a Q3SqlCursor. A
Q3SqlCursor::insert(), Q3SqlCursor::update() or Q3SqlCursor::del()
call is needed to actually write values to the database.
Some sample code to initialize a form successfully:
\snippet doc/src/snippets/code/src_qt3support_sql_q3sqlform.cpp 0
If you want to use custom editors for displaying and editing data
fields, you must install a custom Q3SqlPropertyMap. The form
uses this object to get or set the value of a widget.
\sa installPropertyMap(), Q3SqlPropertyMap
*/
/*!
Constructs a Q3SqlForm with parent \a parent.
*/
Q3SqlForm::Q3SqlForm(QObject * parent)
: QObject(parent)
{
d = new Q3SqlFormPrivate();
}
/*!
Destroys the object and frees any allocated resources.
*/
Q3SqlForm::~Q3SqlForm()
{
delete d;
}
/*!
Installs a custom Q3SqlPropertyMap. This is useful if you plan to
create your own custom editor widgets.
Q3SqlForm takes ownership of \a pmap, so \a pmap is deleted when
Q3SqlForm goes out of scope.
\sa Q3DataTable::installEditorFactory()
*/
void Q3SqlForm::installPropertyMap(Q3SqlPropertyMap * pmap)
{
if(d->propertyMap)
delete d->propertyMap;
d->propertyMap = pmap;
}
/*!
Sets \a buf as the record buffer for the form. To force the
display of the data from \a buf, use readFields().
\sa readFields() writeFields()
*/
void Q3SqlForm::setRecord(QSqlRecord* buf)
{
d->dirty = true;
d->buf = buf;
}
/*!
Inserts a \a widget, and the name of the \a field it is to be
mapped to, into the form. To actually associate inserted widgets
with an edit buffer, use setRecord().
\sa setRecord()
*/
void Q3SqlForm::insert(QWidget * widget, const QString& field)
{
d->dirty = true;
d->wgt.insert(field, widget);
d->fld += field;
}
/*!
\overload
Removes \a field from the form.
*/
void Q3SqlForm::remove(const QString& field)
{
d->dirty = true;
int i = d->fld.indexOf(field);
if (i >= 0)
d->fld.removeAt(i);
d->wgt.remove(field);
}
/*!
\overload
Inserts a \a widget, and the \a field it is to be mapped to, into
the form.
*/
void Q3SqlForm::insert(QWidget * widget, QSqlField * field)
{
d->map[widget] = field;
}
/*!
Removes a \a widget, and hence the field it's mapped to, from the
form.
*/
void Q3SqlForm::remove(QWidget * widget)
{
d->map.remove(widget);
}
/*!
Clears the values in all the widgets, and the fields they are
mapped to, in the form, and sets them to NULL.
*/
void Q3SqlForm::clearValues()
{
QMap< QWidget *, QSqlField * >::Iterator it;
for(it = d->map.begin(); it != d->map.end(); ++it){
QSqlField* f = (*it);
if (f)
f->clear();
}
readFields();
}
/*!
Removes every widget, and the fields they're mapped to, from the form.
*/
void Q3SqlForm::clear()
{
d->dirty = true;
d->fld.clear();
clearMap();
}
/*!
Returns the number of widgets in the form.
*/
int Q3SqlForm::count() const
{
return d->map.size();
}
/*!
Returns the \a{i}-th widget in the form. Useful for traversing
the widgets in the form.
*/
QWidget * Q3SqlForm::widget(int i) const
{
QMap< QWidget *, QSqlField * >::ConstIterator it;
int cnt = 0;
if(i > d->map.size())
return 0;
for(it = d->map.constBegin(); it != d->map.constEnd(); ++it){
if(cnt++ == i)
return it.key();
}
return 0;
}
/*!
Returns the widget that field \a field is mapped to.
*/
QWidget * Q3SqlForm::fieldToWidget(QSqlField * field) const
{
QMap< QWidget *, QSqlField * >::ConstIterator it;
for(it = d->map.constBegin(); it != d->map.constEnd(); ++it){
if(*it == field)
return it.key();
}
return 0;
}
/*!
Returns the SQL field that widget \a widget is mapped to.
*/
QSqlField * Q3SqlForm::widgetToField(QWidget * widget) const
{
return d->map.value(widget, 0);
}
/*!
Updates the widgets in the form with current values from the SQL
fields they are mapped to.
*/
void Q3SqlForm::readFields()
{
sync();
QSqlField * f;
QMap< QWidget *, QSqlField * >::Iterator it;
Q3SqlPropertyMap * pmap = (d->propertyMap == 0) ?
Q3SqlPropertyMap::defaultMap() : d->propertyMap;
for(it = d->map.begin() ; it != d->map.end(); ++it){
f = widgetToField(it.key());
if(!f)
continue;
pmap->setProperty(it.key(), f->value());
}
}
/*!
Updates the SQL fields with values from the widgets they are
mapped to. To actually update the database with the contents of
the record buffer, use Q3SqlCursor::insert(), Q3SqlCursor::update()
or Q3SqlCursor::del() as appropriate.
*/
void Q3SqlForm::writeFields()
{
sync();
QSqlField * f;
QMap< QWidget *, QSqlField * >::Iterator it;
Q3SqlPropertyMap * pmap = (d->propertyMap == 0) ?
Q3SqlPropertyMap::defaultMap() : d->propertyMap;
for(it = d->map.begin() ; it != d->map.end(); ++it){
f = widgetToField(it.key());
if(!f)
continue;
f->setValue(pmap->property(it.key()));
}
}
/*!
Updates the widget \a widget with the value from the SQL field it
is mapped to. Nothing happens if no SQL field is mapped to the \a
widget.
*/
void Q3SqlForm::readField(QWidget * widget)
{
sync();
QSqlField * field = 0;
Q3SqlPropertyMap * pmap = (d->propertyMap == 0) ?
Q3SqlPropertyMap::defaultMap() : d->propertyMap;
field = widgetToField(widget);
if(field)
pmap->setProperty(widget, field->value());
}
/*!
Updates the SQL field with the value from the \a widget it is
mapped to. Nothing happens if no SQL field is mapped to the \a
widget.
*/
void Q3SqlForm::writeField(QWidget * widget)
{
sync();
QSqlField * field = 0;
Q3SqlPropertyMap * pmap = (d->propertyMap == 0) ?
Q3SqlPropertyMap::defaultMap() : d->propertyMap;
field = widgetToField(widget);
if(field)
field->setValue(pmap->property(widget));
}
/*! \internal
*/
void Q3SqlForm::sync()
{
if (d->dirty) {
clearMap();
if (d->buf) {
for (int i = 0; i < d->fld.count(); ++i) {
const QSqlField *field = d->buf->fieldPtr(d->fld.at(i));
insert(d->wgt.value(d->fld.at(i)), const_cast<QSqlField *>(field));
}
}
}
d->dirty = false;
}
/*! \internal
Clears the internal map of widget/field associations
*/
void Q3SqlForm::clearMap()
{
d->map.clear();
}
QT_END_NAMESPACE
#endif // QT_NO_SQL
|