~oif-team/ubuntu/natty/qt4-x11/xi2.1

<td width="1">  </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="mainclasses.html"><font color="#004faf">Main Classes</font></a> · <a href="annotated.html"><font color="#004faf">Annotated</font></a> · <a href="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>

<td align="right" valign="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">Q3SqlFieldInfo Class Reference</h1>

<p>The Q3SqlFieldInfo class stores meta data associated with a SQL field. <a href="#details">More...</a></p>

<pre>#include <Q3SqlFieldInfo></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 the <a href="porting4.html">Porting Guide</a> for more information.</p>

<p>Part of the <a href="qt3support.html">Qt3Support</a> module.</p>

<ul>

<li><a href="q3sqlfieldinfo-members.html">List of all members, including inherited members</a></li>

</ul>

<h3>Public Functions</h3>

<ul>

<li><div class="fn"/><b><a href="q3sqlfieldinfo.html#Q3SqlFieldInfo">Q3SqlFieldInfo</a></b> ( const QString & <i>name</i> = QString(), QVariant::Type <i>typ</i> = QVariant::Invalid, int <i>required</i> = -1, int <i>len</i> = -1, int <i>prec</i> = -1, const QVariant & <i>defValue</i> = QVariant(), int <i>typeID</i> = 0, bool <i>generated</i> = true, bool <i>trim</i> = false, bool <i>calculated</i> = false )</li>

<li><div class="fn"/><b><a href="q3sqlfieldinfo.html#Q3SqlFieldInfo-2">Q3SqlFieldInfo</a></b> ( const QSqlField & <i>other</i> )</li>

<li><div class="fn"/>virtual <b><a href="q3sqlfieldinfo.html#dtor.Q3SqlFieldInfo">~Q3SqlFieldInfo</a></b> ()</li>

<li><div class="fn"/>QVariant <b><a href="q3sqlfieldinfo.html#defaultValue">defaultValue</a></b> () const</li>

<li><div class="fn"/>bool <b><a href="q3sqlfieldinfo.html#isCalculated">isCalculated</a></b> () const</li>

<li><div class="fn"/>bool <b><a href="q3sqlfieldinfo.html#isGenerated">isGenerated</a></b> () const</li>

<li><div class="fn"/>int <b><a href="q3sqlfieldinfo.html#isRequired">isRequired</a></b> () const</li>

<li><div class="fn"/>bool <b><a href="q3sqlfieldinfo.html#isTrim">isTrim</a></b> () const</li>

<li><div class="fn"/>int <b><a href="q3sqlfieldinfo.html#length">length</a></b> () const</li>

<li><div class="fn"/>QString <b><a href="q3sqlfieldinfo.html#name">name</a></b> () const</li>

<li><div class="fn"/>int <b><a href="q3sqlfieldinfo.html#precision">precision</a></b> () const</li>

<li><div class="fn"/>virtual void <b><a href="q3sqlfieldinfo.html#setCalculated">setCalculated</a></b> ( bool <i>calculated</i> )</li>

<li><div class="fn"/>virtual void <b><a href="q3sqlfieldinfo.html#setGenerated">setGenerated</a></b> ( bool <i>generated</i> )</li>

<li><div class="fn"/>virtual void <b><a href="q3sqlfieldinfo.html#setTrim">setTrim</a></b> ( bool <i>trim</i> )</li>

<li><div class="fn"/>QSqlField <b><a href="q3sqlfieldinfo.html#toField">toField</a></b> () const</li>

<li><div class="fn"/>QVariant::Type <b><a href="q3sqlfieldinfo.html#type">type</a></b> () const</li>

<li><div class="fn"/>int <b><a href="q3sqlfieldinfo.html#typeID">typeID</a></b> () const</li>

<li><div class="fn"/>bool <b><a href="q3sqlfieldinfo.html#operator-eq-eq">operator==</a></b> ( const Q3SqlFieldInfo & <i>other</i> ) const</li>

</ul>

<hr />

<h2>Detailed Description</h2>

<p>The Q3SqlFieldInfo class stores meta data associated with a SQL field.</p>

<p>Q3SqlFieldInfo objects only store meta data; field values are stored in <a href="qsqlfield.html">QSqlField</a> objects.</p>

<p>All values must be set in the constructor, and may be retrieved using <a href="q3sqlfieldinfo.html#isRequired">isRequired</a>(), <a href="q3sqlfieldinfo.html#type">type</a>(), <a href="q3sqlfieldinfo.html#length">length</a>(), <a href="q3sqlfieldinfo.html#precision">precision</a>(), <a href="q3sqlfieldinfo.html#defaultValue">defaultValue</a>(), <a href="q3sqlfieldinfo.html#name">name</a>(), <a href="q3sqlfieldinfo.html#isGenerated">isGenerated</a>() and <a href="q3sqlfieldinfo.html#typeID">typeID</a>().</p>

<p>See also <a href="q3sqlrecordinfo.html">Q3SqlRecordInfo</a>.</p>

<hr />

<h2>Member Function Documentation</h2>

<h3 class="fn"><a name="Q3SqlFieldInfo"></a>Q3SqlFieldInfo::Q3SqlFieldInfo ( const <a href="qstring.html">QString</a> & <i>name</i> = QString(), <a href="qvariant.html#Type-enum">QVariant::Type</a> <i>typ</i> = QVariant::Invalid, int <i>required</i> = -1, int <i>len</i> = -1, int <i>prec</i> = -1, const <a href="qvariant.html">QVariant</a> & <i>defValue</i> = QVariant(), int <i>typeID</i> = 0, bool <i>generated</i> = true, bool <i>trim</i> = false, bool <i>calculated</i> = false )</h3>

<p>Constructs a <a href="q3sqlfieldinfo.html">Q3SqlFieldInfo</a> with the following parameters:</p>

<tr valign="top" bgcolor="#f0f0f0"><td><i>name</i></td><td>the name of the field.</td></tr>

<tr valign="top" bgcolor="#e0e0e0"><td><i>typ</i></td><td>the field's type in a <a href="qvariant.html">QVariant</a>.</td></tr>

<tr valign="top" bgcolor="#f0f0f0"><td><i>required</i></td><td>greater than 0 if the field is required, 0 if its value can be NULL and less than 0 if it cannot be determined whether the field is required or not.</td></tr>

<tr valign="top" bgcolor="#e0e0e0"><td><i>len</i></td><td>the length of the field. Note that for non-character types some databases return either the length in bytes or the number of digits. -1 signifies that the length cannot be determined.</td></tr>

<tr valign="top" bgcolor="#f0f0f0"><td><i>prec</i></td><td>the precision of the field, or -1 if the field has no precision or it cannot be determined.</td></tr>

<tr valign="top" bgcolor="#e0e0e0"><td><i>defValue</i></td><td>the default value that is inserted into the table if none is specified by the user. QVariant() if there is no default value or it cannot be determined.</td></tr>

<tr valign="top" bgcolor="#f0f0f0"><td><i>typeID</i></td><td>the internal typeID of the database system (only useful for low-level programming). 0 if unknown.</td></tr>

<tr valign="top" bgcolor="#e0e0e0"><td><i>generated</i></td><td>TRUE indicates that this field should be included in auto-generated SQL statments, e.g. in <a href="q3sqlcursor.html">Q3SqlCursor</a>.</td></tr>

<tr valign="top" bgcolor="#f0f0f0"><td><i>trim</i></td><td>TRUE indicates that widgets should remove trailing whitespace from character fields. This does not affect the field value but only its representation inside widgets.</td></tr>

<tr valign="top" bgcolor="#e0e0e0"><td><i>calculated</i></td><td>TRUE indicates that the value of this field is calculated. The value of calculated fields can by modified by subclassing <a href="q3sqlcursor.html">Q3SqlCursor</a> and overriding <a href="q3sqlcursor.html#calculateField">Q3SqlCursor::calculateField</a>().</td></tr>

</table>

<h3 class="fn"><a name="Q3SqlFieldInfo-2"></a>Q3SqlFieldInfo::Q3SqlFieldInfo ( const <a href="qsqlfield.html">QSqlField</a> & <i>other</i> )</h3>

<p>Creates a <a href="q3sqlfieldinfo.html">Q3SqlFieldInfo</a> object with the type and the name of the <a href="qsqlfield.html">QSqlField</a> <i>other</i>.</p>

<h3 class="fn"><a name="dtor.Q3SqlFieldInfo"></a>Q3SqlFieldInfo::~Q3SqlFieldInfo ()  <tt> [virtual]</tt></h3>

<p>Destroys the object and frees any allocated resources.</p>

<h3 class="fn"><a name="defaultValue"></a><a href="qvariant.html">QVariant</a> Q3SqlFieldInfo::defaultValue () const</h3>

<p>Returns the field's default value or an empty <a href="qvariant.html">QVariant</a> if the field has no default value or the value couldn't be determined. The default value is the value inserted in the database when it is not explicitly specified by the user.</p>

<h3 class="fn"><a name="isCalculated"></a>bool Q3SqlFieldInfo::isCalculated () const</h3>

<p>Returns TRUE if the field is calculated; otherwise returns FALSE.</p>

<p>See also <a href="q3sqlfieldinfo.html#setCalculated">setCalculated</a>().</p>

<h3 class="fn"><a name="isGenerated"></a>bool Q3SqlFieldInfo::isGenerated () const</h3>

<p>Returns TRUE if the field should be included in auto-generated SQL statments, e.g. in <a href="q3sqlcursor.html">Q3SqlCursor</a>; otherwise returns FALSE.</p>

<p>See also <a href="q3sqlfieldinfo.html#setGenerated">setGenerated</a>().</p>

<h3 class="fn"><a name="isRequired"></a>int Q3SqlFieldInfo::isRequired () const</h3>

<p>Returns a value greater than 0 if the field is required (NULL values are not allowed), 0 if it isn't required (NULL values are allowed) or less than 0 if it cannot be determined whether the field is required or not.</p>

<h3 class="fn"><a name="isTrim"></a>bool Q3SqlFieldInfo::isTrim () const</h3>

<p>Returns TRUE if trailing whitespace should be removed from character fields; otherwise returns FALSE.</p>

<p>See also <a href="q3sqlfieldinfo.html#setTrim">setTrim</a>().</p>

<h3 class="fn"><a name="length"></a>int Q3SqlFieldInfo::length () const</h3>

<p>Returns the field's length. For fields storing text the return value is the maximum number of characters the field can hold. For non-character fields some database systems return the number of bytes needed or the number of digits allowed. If the length cannot be determined -1 is returned.</p>

<h3 class="fn"><a name="name"></a><a href="qstring.html">QString</a> Q3SqlFieldInfo::name () const</h3>

<p>Returns the name of the field in the SQL table.</p>

<h3 class="fn"><a name="precision"></a>int Q3SqlFieldInfo::precision () const</h3>

<p>Returns the field's precision or -1 if the field has no precision or it cannot be determined.</p>

<h3 class="fn"><a name="setCalculated"></a>void Q3SqlFieldInfo::setCalculated ( bool <i>calculated</i> )  <tt> [virtual]</tt></h3>

<p><i>calculated</i> set to TRUE indicates that this field is a calculated field. The value of calculated fields can by modified by subclassing <a href="q3sqlcursor.html">Q3SqlCursor</a> and overriding <a href="q3sqlcursor.html#calculateField">Q3SqlCursor::calculateField</a>().</p>

<p>See also <a href="q3sqlfieldinfo.html#isCalculated">isCalculated</a>().</p>

<h3 class="fn"><a name="setGenerated"></a>void Q3SqlFieldInfo::setGenerated ( bool <i>generated</i> )  <tt> [virtual]</tt></h3>

<p><i>generated</i> set to FALSE indicates that this field should not appear in auto-generated SQL statements (for example in <a href="q3sqlcursor.html">Q3SqlCursor</a>).</p>

100

<p>See also <a href="q3sqlfieldinfo.html#isGenerated">isGenerated</a>().</p>

101

<h3 class="fn"><a name="setTrim"></a>void Q3SqlFieldInfo::setTrim ( bool <i>trim</i> )  <tt> [virtual]</tt></h3>

102

<p>If <i>trim</i> is TRUE widgets should remove trailing whitespace from character fields. This does not affect the field value but only its representation inside widgets.</p>

103

<p>See also <a href="q3sqlfieldinfo.html#isTrim">isTrim</a>().</p>

104

<h3 class="fn"><a name="toField"></a><a href="qsqlfield.html">QSqlField</a> Q3SqlFieldInfo::toField () const</h3>

105

<p>Returns an empty <a href="qsqlfield.html">QSqlField</a> based on the information in this <a href="q3sqlfieldinfo.html">Q3SqlFieldInfo</a>.</p>

106

<h3 class="fn"><a name="type"></a><a href="qvariant.html#Type-enum">QVariant::Type</a> Q3SqlFieldInfo::type () const</h3>

107

<p>Returns the field's type or <a href="qvariant.html#Type-enum">QVariant::Invalid</a> if the type is unknown.</p>

108

<h3 class="fn"><a name="typeID"></a>int Q3SqlFieldInfo::typeID () const</h3>

109

<p>Returns the internal type identifier as returned from the database system. The return value is 0 if the type is unknown.</p>

110

<h3 class="fn"><a name="operator-eq-eq"></a>bool Q3SqlFieldInfo::operator== ( const Q3SqlFieldInfo & <i>other</i> ) const</h3>

111

<p>Assigns <i>other</i> to this field info and returns a reference to it.</p>

112

113

114

115

<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>

116

117

</tr></table></div></address></body>

118

</html>

Older »