~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">QValidator Class Reference</h1>

<p>The QValidator class provides validation of input text. <a href="#details">More...</a></p>

<pre>#include <QValidator></pre><p>Part of the <a href="qtgui.html">QtGui</a> module.</p>

<p>Inherits <a href="qobject.html">QObject</a>.</p>

<p>Inherited by <a href="qdoublevalidator.html">QDoubleValidator</a>, <a href="qintvalidator.html">QIntValidator</a>, and <a href="qregexpvalidator.html">QRegExpValidator</a>.</p>

<ul>

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

<li><a href="qvalidator-qt3.html">Qt 3 support members</a></li>

</ul>

<h3>Public Types</h3>

<ul>

<li><div class="fn"/>enum <b><a href="qvalidator.html#State-enum">State</a></b> { Invalid, Intermediate, Acceptable }</li>

</ul>

<h3>Public Functions</h3>

<ul>

<li><div class="fn"/><b><a href="qvalidator.html#QValidator">QValidator</a></b> ( QObject * <i>parent</i> )</li>

<li><div class="fn"/><b><a href="qvalidator.html#dtor.QValidator">~QValidator</a></b> ()</li>

<li><div class="fn"/>virtual void <b><a href="qvalidator.html#fixup">fixup</a></b> ( QString & <i>input</i> ) const</li>

<li><div class="fn"/>virtual State <b><a href="qvalidator.html#validate">validate</a></b> ( QString & <i>input</i>, int & <i>pos</i> ) const = 0</li>

</ul>

<ul>

<li><div class="fn"/>28 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>

</ul>

<h3>Additional Inherited Members</h3>

<ul>

<li><div class="fn"/>1 property inherited from <a href="qobject.html#properties">QObject</a></li>

<li><div class="fn"/>1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>

<li><div class="fn"/>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>

<li><div class="fn"/>4 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>

<li><div class="fn"/>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>

</ul>

<hr />

<h2>Detailed Description</h2>

<p>The QValidator class provides validation of input text.</p>

<p>The class itself is abstract. Two subclasses, <a href="qintvalidator.html">QIntValidator</a> and <a href="qdoublevalidator.html">QDoubleValidator</a>, provide basic numeric-range checking, and <a href="qregexpvalidator.html">QRegExpValidator</a> provides general checking using a custom regular expression.</p>

<p>If the built-in validators aren't sufficient, you can subclass QValidator. The class has two virtual functions: <a href="qvalidator.html#validate">validate</a>() and <a href="qvalidator.html#fixup">fixup</a>().</p>

<p><a href="qvalidator.html#validate">validate</a>() must be implemented by every subclass. It returns <tt>Invalid</tt>, <tt>Intermediate</tt> or <tt>Acceptable</tt> depending on whether its argument is valid (for the subclass's definition of valid).</p>

<p>These three states require some explanation. An <tt>Invalid</tt> string is <i>clearly</i> invalid. <tt>Intermediate</tt> is less obvious: the concept of validity is difficult to apply when the string is incomplete (still being edited). QValidator defines <tt>Intermediate</tt> as the property of a string that is neither clearly invalid nor acceptable as a final result. <tt>Acceptable</tt> means that the string is acceptable as a final result. One might say that any string that is a plausible intermediate state during entry of an <tt>Acceptable</tt> string is <tt>Intermediate</tt>.</p>

<p>Here are some examples:</p>

<ul>

<li>For a line edit that accepts integers from 10 to 999 inclusive, 42 and 123 are <tt>Acceptable</tt>, the empty string and 5 are <tt>Intermediate</tt>, and "asdf" and 1114 is <tt>Invalid</tt>.</li>

<li>For an editable combobox that accepts URLs, any well-formed URL is <tt>Acceptable</tt>, "http://www.trolltech.com/," is <tt>Intermediate</tt> (it might be a cut and paste action that accidentally took in a comma at the end), the empty string is <tt>Intermediate</tt> (the user might select and delete all of the text in preparation for entering a new URL) and "http:///./" is <tt>Invalid</tt>.</li>

<li>For a spin box that accepts lengths, "11cm" and "1in" are <tt>Acceptable</tt>, "11" and the empty string are <tt>Intermediate</tt>, and "http://www.trolltech.com" and "hour" are <tt>Invalid</tt>.</li>

</ul>

<p><a href="qvalidator.html#fixup">fixup</a>() is provided for validators that can repair some user errors. The default implementation does nothing. <a href="qlineedit.html">QLineEdit</a>, for example, will call <a href="qvalidator.html#fixup">fixup</a>() if the user presses Enter (or Return) and the content is not currently valid. This allows the <a href="qvalidator.html#fixup">fixup</a>() function the opportunity of performing some magic to make an <tt>Invalid</tt> string <tt>Acceptable</tt>.</p>

<p>QValidator is typically used with <a href="qlineedit.html">QLineEdit</a>, <a href="qspinbox.html">QSpinBox</a> and <a href="qcombobox.html">QComboBox</a>.</p>

<hr />

<h2>Member Type Documentation</h2>

<h3 class="fn"><a name="State-enum"></a>enum QValidator::State</h3>

<p>This enum type defines the states in which a validated string can exist.</p>

<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>

<tr><td valign="top"><tt>QValidator::Invalid</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">The string is <i>clearly</i> invalid.</td></tr>

<tr><td valign="top"><tt>QValidator::Intermediate</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">The string is a plausible intermediate value during editing.</td></tr>

<tr><td valign="top"><tt>QValidator::Acceptable</tt></td><td align="center" valign="top"> </td><td valign="top">The string is acceptable as a final result; i.e. it is valid.</td></tr>

</table>

<hr />

<h2>Member Function Documentation</h2>

<h3 class="fn"><a name="QValidator"></a>QValidator::QValidator ( <a href="qobject.html">QObject</a> * <i>parent</i> )</h3>

<p>Sets up the validator. The <i>parent</i> parameter is passed on to the <a href="qobject.html">QObject</a> constructor.</p>

<h3 class="fn"><a name="dtor.QValidator"></a>QValidator::~QValidator ()</h3>

<p>Destroys the validator, freeing any storage and other resources used.</p>

<h3 class="fn"><a name="fixup"></a>void QValidator::fixup ( <a href="qstring.html">QString</a> & <i>input</i> ) const  <tt> [virtual]</tt></h3>

<p>This function attempts to change <i>input</i> to be valid according to this validator's rules. It need not result in a valid string: callers of this function must re-test afterwards; the default does nothing.</p>

<p>Reimplementations of this function can change <i>input</i> even if they do not produce a valid string. For example, an ISBN validator might want to delete every character except digits and "-", even if the result is still not a valid ISBN; a surname validator might want to remove whitespace from the start and end of the string, even if the resulting string is not in the list of accepted surnames.</p>

<h3 class="fn"><a name="validate"></a><a href="qvalidator.html#State-enum">State</a> QValidator::validate ( <a href="qstring.html">QString</a> & <i>input</i>, int & <i>pos</i> ) const  <tt> [pure virtual]</tt></h3>

<p>This virtual function returns <tt>Invalid</tt> if <i>input</i> is invalid according to this validator's rules, <tt>Intermediate</tt> if it is likely that a little more editing will make the input acceptable (e.g. the user types "4" into a widget which accepts integers between 10 and 99), and <tt>Acceptable</tt> if the input is valid.</p>

<p>The function can change both <i>input</i> and <i>pos</i> (the cursor position) if required.</p>

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

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

</html>

Older »