<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- q3sqlpropertymap.cpp -->
<title>Qt 4.8: Q3SqlPropertyMap Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qt3support.html">Qt3Support</a></li>
<li>Q3SqlPropertyMap</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">Q3SqlPropertyMap Class Reference</h1>
<!-- $$$Q3SqlPropertyMap-brief -->
<p>The Q3SqlPropertyMap class is used to map widgets to SQL fields. <a href="#details">More...</a></p>
<!-- @@@Q3SqlPropertyMap -->
<pre class="cpp"> <span class="preprocessor">#include <Q3SqlPropertyMap></span></pre><p><b>This class is part of the Qt 3 support library.</b> It is provided to keep old source code working. We strongly advise against using it in new code. See <a href="porting4.html#qsqlpropertymap">Porting to Qt 4</a> for more information.</p>
<ul>
<li><a href="q3sqlpropertymap-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3sqlpropertymap.html#Q3SqlPropertyMap">Q3SqlPropertyMap</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="q3sqlpropertymap.html#dtor.Q3SqlPropertyMap">~Q3SqlPropertyMap</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3sqlpropertymap.html#insert">insert</a></b> ( const QString & <i>classname</i>, const QString & <i>property</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="q3sqlpropertymap.html#property">property</a></b> ( QWidget * <i>widget</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3sqlpropertymap.html#remove">remove</a></b> ( const QString & <i>classname</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3sqlpropertymap.html#setProperty">setProperty</a></b> ( QWidget * <i>widget</i>, const QVariant & <i>value</i> )</td></tr>
</table>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Q3SqlPropertyMap * </td><td class="memItemRight bottomAlign"><b><a href="q3sqlpropertymap.html#defaultMap">defaultMap</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3sqlpropertymap.html#installDefaultMap">installDefaultMap</a></b> ( Q3SqlPropertyMap * <i>map</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$Q3SqlPropertyMap-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The Q3SqlPropertyMap 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>
<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>
<p>For example, a <a href="qlineedit.html">QLineEdit</a> can be used to edit text strings and other data types in Q3DataTables or Q3SqlForms. Several properties are defined in <a href="qlineedit.html">QLineEdit</a>, but only the <i>text</i> property is used to insert and extract text from a <a href="qlineedit.html">QLineEdit</a>. Both <a href="q3datatable.html">Q3DataTable</a> and <a href="q3sqlform.html">Q3SqlForm</a> use the global Q3SqlPropertyMap 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>
<p>If you want to use custom editors with your <a href="q3datatable.html">Q3DataTable</a> or <a href="q3sqlform.html">Q3SqlForm</a>, you must install your own Q3SqlPropertyMap for that table or form. Example:</p>
<pre class="cpp"> <span class="type">Q3SqlPropertyMap</span> <span class="operator">*</span>myMap <span class="operator">=</span> <span class="keyword">new</span> <span class="type">Q3SqlPropertyMap</span>();
<span class="type"><a href="q3sqlform.html">Q3SqlForm</a></span> <span class="operator">*</span>myForm <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="q3sqlform.html">Q3SqlForm</a></span>(<span class="keyword">this</span>);
MyEditor myEditor(<span class="keyword">this</span>);
<span class="comment">// Set the Q3SqlForm's record buffer to the update buffer of</span>
<span class="comment">// a pre-existing Q3SqlCursor called 'cur'.</span>
myForm<span class="operator">-</span><span class="operator">></span>setRecord(cur<span class="operator">-</span><span class="operator">></span>primeUpdate());
<span class="comment">// Install the customized map</span>
myMap<span class="operator">-</span><span class="operator">></span><a href="q3sqlpropertymap.html#insert">insert</a>(<span class="string">"MyEditor"</span><span class="operator">,</span> <span class="string">"content"</span>);
myForm<span class="operator">-</span><span class="operator">></span>installPropertyMap(myMap); <span class="comment">// myForm now owns myMap</span>
<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
<span class="comment">// Insert a field into the form that uses a myEditor to edit the</span>
<span class="comment">// field 'somefield'</span>
myForm<span class="operator">-</span><span class="operator">></span><a href="q3sqlpropertymap.html#insert">insert</a>(<span class="operator">&</span>myEditor<span class="operator">,</span> <span class="string">"somefield"</span>);
<span class="comment">// Update myEditor with the value from the mapped database field</span>
myForm<span class="operator">-</span><span class="operator">></span>readFields();
<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
<span class="comment">// Let the user edit the form</span>
<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
<span class="comment">// Update the database fields with the values in the form</span>
myForm<span class="operator">-</span><span class="operator">></span>writeFields();
<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span></pre>
<p>You can also replace the global Q3SqlPropertyMap that is used by default. (Bear in mind that Q3SqlPropertyMap takes ownership of the new default map.)</p>
<pre class="cpp"> <span class="type">Q3SqlPropertyMap</span> <span class="operator">*</span>myMap <span class="operator">=</span> <span class="keyword">new</span> <span class="type">Q3SqlPropertyMap</span>;
myMap<span class="operator">-</span><span class="operator">></span><a href="q3sqlpropertymap.html#insert">insert</a>(<span class="string">"MyEditor"</span><span class="operator">,</span> <span class="string">"content"</span>);
<span class="type">Q3SqlPropertyMap</span><span class="operator">::</span><a href="q3sqlpropertymap.html#installDefaultMap">installDefaultMap</a>(myMap);
<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span></pre>
</div>
<p><b>See also </b><a href="q3datatable.html">Q3DataTable</a>, <a href="q3sqlform.html">Q3SqlForm</a>, and <a href="q3sqleditorfactory.html">Q3SqlEditorFactory</a>.</p>
<!-- @@@Q3SqlPropertyMap -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$Q3SqlPropertyMap[overload1]$$$Q3SqlPropertyMap -->
<h3 class="fn"><a name="Q3SqlPropertyMap"></a>Q3SqlPropertyMap::<span class="name">Q3SqlPropertyMap</span> ()</h3>
<p>Constructs a <a href="q3sqlpropertymap.html" class="compat">Q3SqlPropertyMap</a>.</p>
<p>The default property mappings used by Qt widgets are:</p>
<table class="generic">
<thead><tr class="qt-style"><th >Widgets</th><th >Property</th></tr></thead>
<tr valign="top" class="odd"><td ><a href="qcheckbox.html">QCheckBox</a>, <a href="qradiobutton.html">QRadioButton</a></td><td >checked</td></tr>
<tr valign="top" class="even"><td ><a href="qcombobox.html">QComboBox</a>, <a href="q3listbox.html" class="compat">Q3ListBox</a></td><td >currentItem</td></tr>
<tr valign="top" class="odd"><td ><a href="q3dateedit.html" class="compat">Q3DateEdit</a></td><td >date</td></tr>
<tr valign="top" class="even"><td ><a href="q3datetimeedit.html" class="compat">Q3DateTimeEdit</a> <a href="qdatetimeedit.html">QDateTimeEdit</a></td><td >dateTime</td></tr>
<tr valign="top" class="odd"><td ><a href="qtextbrowser.html">QTextBrowser</a></td><td >source</td></tr>
<tr valign="top" class="even"><td ><a href="qabstractbutton.html">QAbstractButton</a>, <a href="qdial.html">QDial</a>, <a href="qlabel.html">QLabel</a>, <a href="qlineedit.html">QLineEdit</a>, <a href="q3multilineedit.html" class="compat">Q3MultiLineEdit</a>, <a href="qpushbutton.html">QPushButton</a>, <a href="qtextedit.html">QTextEdit</a>,</td><td >text</td></tr>
<tr valign="top" class="odd"><td ><a href="q3timeedit.html" class="compat">Q3TimeEdit</a></td><td >time</td></tr>
<tr valign="top" class="even"><td ><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><td >value</td></tr>
</table>
<!-- @@@Q3SqlPropertyMap -->
<!-- $$$~Q3SqlPropertyMap[overload1]$$$~Q3SqlPropertyMap -->
<h3 class="fn"><a name="dtor.Q3SqlPropertyMap"></a>Q3SqlPropertyMap::<span class="name">~Q3SqlPropertyMap</span> ()<tt> [virtual]</tt></h3>
<p>Destroys the <a href="q3sqlpropertymap.html" class="compat">Q3SqlPropertyMap</a>.</p>
<p>Note that if the <a href="q3sqlpropertymap.html" class="compat">Q3SqlPropertyMap</a> is installed with installPropertyMap() the object it was installed into, e.g. the <a href="q3sqlform.html" class="compat">Q3SqlForm</a>, takes ownership and will delete the <a href="q3sqlpropertymap.html" class="compat">Q3SqlPropertyMap</a> when necessary.</p>
<!-- @@@~Q3SqlPropertyMap -->
<!-- $$$defaultMap[overload1]$$$defaultMap -->
<h3 class="fn"><a name="defaultMap"></a><span class="type">Q3SqlPropertyMap</span> * Q3SqlPropertyMap::<span class="name">defaultMap</span> ()<tt> [static]</tt></h3>
<p>Returns the application global <a href="q3sqlpropertymap.html" class="compat">Q3SqlPropertyMap</a>.</p>
<!-- @@@defaultMap -->
<!-- $$$insert[overload1]$$$insertconstQString&constQString& -->
<h3 class="fn"><a name="insert"></a><span class="type">void</span> Q3SqlPropertyMap::<span class="name">insert</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>classname</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>property</i> )</h3>
<p>Insert a new classname/property pair, which is used for custom SQL field editors. There <i>must</i> be a <a href="qobject.html#Q_PROPERTY">Q_PROPERTY</a>() clause in the <i>classname</i> class declaration for the <i>property</i>.</p>
<!-- @@@insert -->
<!-- $$$installDefaultMap[overload1]$$$installDefaultMapQ3SqlPropertyMap* -->
<h3 class="fn"><a name="installDefaultMap"></a><span class="type">void</span> Q3SqlPropertyMap::<span class="name">installDefaultMap</span> ( <span class="type">Q3SqlPropertyMap</span> * <i>map</i> )<tt> [static]</tt></h3>
<p>Replaces the global default property map with <i>map</i>. All <a href="q3datatable.html" class="compat">Q3DataTable</a> and <a href="q3sqlform.html" class="compat">Q3SqlForm</a> instantiations will use this new map for inserting and extracting values to and from editors. <i><a href="q3sqlpropertymap.html" class="compat">Q3SqlPropertyMap</a> takes ownership of <i>map</i>, and destroys it when it is no longer needed.</i></p>
<!-- @@@installDefaultMap -->
<!-- $$$property[overload1]$$$propertyQWidget* -->
<h3 class="fn"><a name="property"></a><span class="type"><a href="qvariant.html">QVariant</a></span> Q3SqlPropertyMap::<span class="name">property</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>widget</i> )</h3>
<p>Returns the mapped property of <i>widget</i> as a <a href="qvariant.html">QVariant</a>.</p>
<p><b>See also </b><a href="q3sqlpropertymap.html#setProperty">setProperty</a>().</p>
<!-- @@@property -->
<!-- $$$remove[overload1]$$$removeconstQString& -->
<h3 class="fn"><a name="remove"></a><span class="type">void</span> Q3SqlPropertyMap::<span class="name">remove</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>classname</i> )</h3>
<p>Removes <i>classname</i> from the map.</p>
<!-- @@@remove -->
<!-- $$$setProperty[overload1]$$$setPropertyQWidget*constQVariant& -->
<h3 class="fn"><a name="setProperty"></a><span class="type">void</span> Q3SqlPropertyMap::<span class="name">setProperty</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>widget</i>, const <span class="type"><a href="qvariant.html">QVariant</a></span> & <i>value</i> )<tt> [virtual]</tt></h3>
<p>Sets the property of <i>widget</i> to <i>value</i>.</p>
<p><b>See also </b><a href="q3sqlpropertymap.html#property">property</a>().</p>
<!-- @@@setProperty -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Qt and respective logos are trademarks of The Qt Company Ltd
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
