summaryrefslogtreecommitdiffstats
path: root/doc/html/qsqlpropertymap.html
blob: a65cdc6023ca5f0546d9d1e22e64fa8d9ca4d5b3 (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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/sql/qsqlpropertymap.cpp:53 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QSqlPropertyMap Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
 <a href="index.html">
<font color="#004faf">Home</font></a>
 | <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
 | <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QSqlPropertyMap Class Reference<br><small>[<a href="sql.html">sql module</a>]</small></h1>

<p>The QSqlPropertyMap class is used to map widgets to SQL fields.
<a href="#details">More...</a>
<p><tt>#include &lt;<a href="qsqlpropertymap-h.html">qsqlpropertymap.h</a>&gt;</tt>
<p><a href="qsqlpropertymap-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#QSqlPropertyMap"><b>QSqlPropertyMap</b></a> ()</li>
<li class=fn>virtual <a href="#~QSqlPropertyMap"><b>~QSqlPropertyMap</b></a> ()</li>
<li class=fn>QVariant <a href="#property"><b>property</b></a> ( QWidget&nbsp;*&nbsp;widget )</li>
<li class=fn>virtual void <a href="#setProperty"><b>setProperty</b></a> ( QWidget&nbsp;*&nbsp;widget, const&nbsp;QVariant&nbsp;&amp;&nbsp;value )</li>
<li class=fn>void <a href="#insert"><b>insert</b></a> ( const&nbsp;QString&nbsp;&amp;&nbsp;classname, const&nbsp;QString&nbsp;&amp;&nbsp;property )</li>
<li class=fn>void <a href="#remove"><b>remove</b></a> ( const&nbsp;QString&nbsp;&amp;&nbsp;classname )</li>
</ul>
<h2>Static Public Members</h2>
<ul>
<li class=fn>QSqlPropertyMap * <a href="#defaultMap"><b>defaultMap</b></a> ()</li>
<li class=fn>void <a href="#installDefaultMap"><b>installDefaultMap</b></a> ( QSqlPropertyMap&nbsp;*&nbsp;map )</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>


The QSqlPropertyMap class is used to map widgets to SQL fields.
<p> 

<p> The SQL module uses Qt <a href="properties.html">object
    properties</a> to insert and extract values from editor
widgets.
<p> This class is used to map editors to SQL fields. This works by
associating SQL editor class names to the properties used to
insert and extract values to/from the editor.
<p> For example, a <a href="qlineedit.html">QLineEdit</a> can be used to edit text strings and
other data types in QDataTables or QSqlForms. Several properties
are defined in QLineEdit, but only the <em>text</em> property is used to
insert and extract text from a QLineEdit. Both <a href="qdatatable.html">QDataTable</a> and
<a href="qsqlform.html">QSqlForm</a> use the global QSqlPropertyMap for inserting and
extracting values to and from an editor widget. The global
property map defines several common widgets and properties that
are suitable for many applications. You can add and remove widget
properties to suit your specific needs.
<p> If you want to use custom editors with your QDataTable or
QSqlForm, you must install your own QSqlPropertyMap for that table
or form. Example:
<p> <pre>
    QSqlPropertyMap *myMap  = new QSqlPropertyMap();
    <a href="qsqlform.html">QSqlForm</a>        *myForm = new <a href="qsqlform.html">QSqlForm</a>( this );
    MyEditor myEditor( this );

    // Set the QSqlForm's record buffer to the update buffer of
    // a pre-existing QSqlCursor called 'cur'.
    myForm-&gt;<a href="qsqlform.html#setRecord">setRecord</a>( cur-&gt;primeUpdate() );

    // Install the customized map
    myMap-&gt;<a href="#insert">insert</a>( "MyEditor", "content" );
    myForm-&gt;<a href="qsqlform.html#installPropertyMap">installPropertyMap</a>( myMap ); // myForm now owns myMap
    ...
    // Insert a field into the form that uses a myEditor to edit the
    // field 'somefield'
    myForm-&gt;<a href="qsqlform.html#insert">insert</a>( &amp;myEditor, "somefield" );

    // Update myEditor with the value from the mapped database field
    myForm-&gt;<a href="qsqlform.html#readFields">readFields</a>();
    ...
    // Let the user edit the form
    ...
    // Update the database fields with the values in the form
    myForm-&gt;<a href="qsqlform.html#writeFields">writeFields</a>();
    ...
    </pre>
 
<p> You can also replace the global QSqlPropertyMap that is used by
default. (Bear in mind that QSqlPropertyMap takes ownership of the
new default map.)
<p> <pre>
    QSqlPropertyMap *myMap = new QSqlPropertyMap;

    myMap-&gt;<a href="#insert">insert</a>( "MyEditor", "content" );
    QSqlPropertyMap::<a href="#installDefaultMap">installDefaultMap</a>( myMap );
    ...
    </pre>
 
<p> <p>See also <a href="qdatatable.html">QDataTable</a>, <a href="qsqlform.html">QSqlForm</a>, <a href="qsqleditorfactory.html">QSqlEditorFactory</a>, and <a href="database.html">Database Classes</a>.

<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="QSqlPropertyMap"></a>QSqlPropertyMap::QSqlPropertyMap ()
</h3>
<p> Constructs a QSqlPropertyMap.
<p> The default property mappings used by Qt widgets are:
<center><table cellpadding="4" cellspacing="2" border="0">
<tr bgcolor="#a2c511"> <th valign="top">Widgets <th valign="top">Property
<tr bgcolor="#f0f0f0"> <td valign="top"><a href="qcheckbox.html">QCheckBox</a>,
<a href="qradiobutton.html">QRadioButton</a>
<td valign="top">checked
<tr bgcolor="#d0d0d0"> <td valign="top"><a href="qcombobox.html">QComboBox</a>,
<a href="qlistbox.html">QListBox</a>
<td valign="top">currentItem
<tr bgcolor="#f0f0f0"> <td valign="top"><a href="qdateedit.html">QDateEdit</a>
<td valign="top">date
<tr bgcolor="#d0d0d0"> <td valign="top"><a href="qdatetimeedit.html">QDateTimeEdit</a>
<td valign="top">dateTime
<tr bgcolor="#f0f0f0"> <td valign="top"><a href="qtextbrowser.html">QTextBrowser</a>
<td valign="top">source
<tr bgcolor="#d0d0d0"> <td valign="top"><a href="qbutton.html">QButton</a>,
<a href="qdial.html">QDial</a>,
<a href="qlabel.html">QLabel</a>,
<a href="qlineedit.html">QLineEdit</a>,
<a href="qmultilineedit.html">QMultiLineEdit</a>,
<a href="qpushbutton.html">QPushButton</a>,
<a href="qtextedit.html">QTextEdit</a>,
<td valign="top">text
<tr bgcolor="#f0f0f0"> <td valign="top"><a href="qtimeedit.html">QTimeEdit</a>
<td valign="top">time
<tr bgcolor="#d0d0d0"> <td valign="top"><a href="qlcdnumber.html">QLCDNumber</a>,
<a href="qscrollbar.html">QScrollBar</a>
<a href="qslider.html">QSlider</a>,
<a href="qspinbox.html">QSpinBox</a>
<td valign="top">value
</table></center>

<h3 class=fn><a name="~QSqlPropertyMap"></a>QSqlPropertyMap::~QSqlPropertyMap ()<tt> [virtual]</tt>
</h3>
Destroys the QSqlPropertyMap.
<p> Note that if the QSqlPropertyMap is installed with
installPropertyMap() the object it was installed into, e.g. the
<a href="qsqlform.html">QSqlForm</a>, takes ownership and will delete the QSqlPropertyMap when
necessary.

<h3 class=fn><a href="qsqlpropertymap.html">QSqlPropertyMap</a>&nbsp;* <a name="defaultMap"></a>QSqlPropertyMap::defaultMap ()<tt> [static]</tt>
</h3>
Returns the application global QSqlPropertyMap.

<h3 class=fn>void <a name="insert"></a>QSqlPropertyMap::insert ( const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;classname, const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;property )
</h3>
Insert a new classname/property pair, which is used for custom SQL
field editors. There <em>must</em> be a <tt>Q_PROPERTY</tt> clause in the <em>classname</em> class declaration for the <em>property</em>.

<p>Example: <a href="sql.html#x2239">sql/overview/custom1/main.cpp</a>.
<h3 class=fn>void <a name="installDefaultMap"></a>QSqlPropertyMap::installDefaultMap ( <a href="qsqlpropertymap.html">QSqlPropertyMap</a>&nbsp;*&nbsp;map )<tt> [static]</tt>
</h3>
Replaces the global default property map with <em>map</em>. All
<a href="qdatatable.html">QDataTable</a> and <a href="qsqlform.html">QSqlForm</a> instantiations will use this new map for
inserting and extracting values to and from editors.
<em>QSqlPropertyMap takes ownership of &#92;a map, and destroys it when it is no longer needed.</em>

<h3 class=fn><a href="qvariant.html">QVariant</a> <a name="property"></a>QSqlPropertyMap::property ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;widget )
</h3>
Returns the mapped property of <em>widget</em> as a <a href="qvariant.html">QVariant</a>.

<h3 class=fn>void <a name="remove"></a>QSqlPropertyMap::remove ( const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;classname )
</h3>
Removes <em>classname</em> from the map.

<h3 class=fn>void <a name="setProperty"></a>QSqlPropertyMap::setProperty ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;widget, const&nbsp;<a href="qvariant.html">QVariant</a>&nbsp;&amp;&nbsp;value )<tt> [virtual]</tt>
</h3>
Sets the property of <em>widget</em> to <em>value</em>.

<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright &copy; 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>