summaryrefslogtreecommitdiffstats
path: root/doc/html/qregexpvalidator.html
diff options
context:
space:
mode:
authorTimothy Pearson <kb9vqf@pearsoncomputing.net>2011-07-10 15:24:15 -0500
committerTimothy Pearson <kb9vqf@pearsoncomputing.net>2011-07-10 15:24:15 -0500
commitbd0f3345a938b35ce6a12f6150373b0955b8dd12 (patch)
tree7a520322212d48ebcb9fbe1087e7fca28b76185c /doc/html/qregexpvalidator.html
downloadqt3-bd0f3345a938b35ce6a12f6150373b0955b8dd12.tar.gz
qt3-bd0f3345a938b35ce6a12f6150373b0955b8dd12.zip
Add Qt3 development HEAD version
Diffstat (limited to 'doc/html/qregexpvalidator.html')
-rw-r--r--doc/html/qregexpvalidator.html161
1 files changed, 161 insertions, 0 deletions
diff --git a/doc/html/qregexpvalidator.html b/doc/html/qregexpvalidator.html
new file mode 100644
index 0000000..bb70075
--- /dev/null
+++ b/doc/html/qregexpvalidator.html
@@ -0,0 +1,161 @@
+<!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/widgets/qvalidator.cpp:517 -->
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>QRegExpValidator 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>QRegExpValidator Class Reference</h1>
+
+<p>The QRegExpValidator class is used to check a string
+against a regular expression.
+<a href="#details">More...</a>
+<p><tt>#include &lt;<a href="qvalidator-h.html">qvalidator.h</a>&gt;</tt>
+<p>Inherits <a href="qvalidator.html">QValidator</a>.
+<p><a href="qregexpvalidator-members.html">List of all member functions.</a>
+<h2>Public Members</h2>
+<ul>
+<li class=fn><a href="#QRegExpValidator"><b>QRegExpValidator</b></a> ( QObject&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )</li>
+<li class=fn><a href="#QRegExpValidator-2"><b>QRegExpValidator</b></a> ( const&nbsp;QRegExp&nbsp;&amp;&nbsp;rx, QObject&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )</li>
+<li class=fn><a href="#~QRegExpValidator"><b>~QRegExpValidator</b></a> ()</li>
+<li class=fn>virtual QValidator::State <a href="#validate"><b>validate</b></a> ( QString&nbsp;&amp;&nbsp;input, int&nbsp;&amp;&nbsp;pos ) const</li>
+<li class=fn>void <a href="#setRegExp"><b>setRegExp</b></a> ( const&nbsp;QRegExp&nbsp;&amp;&nbsp;rx )</li>
+<li class=fn>const QRegExp &amp; <a href="#regExp"><b>regExp</b></a> () const</li>
+</ul>
+<hr><a name="details"></a><h2>Detailed Description</h2>
+
+
+The QRegExpValidator class is used to check a string
+against a <a href="qregexp.html#regular-expression">regular expression</a>.
+<p>
+<p> QRegExpValidator contains a regular expression, "regexp", used to
+determine whether an input string is <a href="qvalidator.html#State-enum">Acceptable</a>, <a href="qvalidator.html#State-enum">Intermediate</a> or <a href="qvalidator.html#State-enum">Invalid</a>.
+<p> The regexp is treated as if it begins with the start of string
+assertion, <b>^</b>, and ends with the end of string assertion
+<b>$</b> so the match is against the entire input string, or from
+the given position if a start position greater than zero is given.
+<p> For a brief introduction to Qt's regexp engine see <a href="qregexp.html">QRegExp</a>.
+<p> Example of use:
+<pre>
+ // regexp: optional '-' followed by between 1 and 3 digits
+ <a href="qregexp.html">QRegExp</a> rx( "-?\\d{1,3}" );
+ <a href="qvalidator.html">QValidator</a>* validator = new QRegExpValidator( rx, this );
+
+ <a href="qlineedit.html">QLineEdit</a>* edit = new <a href="qlineedit.html">QLineEdit</a>( this );
+ edit-&gt;<a href="qlineedit.html#setValidator">setValidator</a>( validator );
+ </pre>
+
+<p> Below we present some examples of validators. In practice they would
+normally be associated with a widget as in the example above.
+<p> <pre>
+ // integers 1 to 9999
+ <a href="qregexp.html">QRegExp</a> rx( "[1-9]\\d{0,3}" );
+ // the validator treats the regexp as "^[1-9]\\d{0,3}$"
+ QRegExpValidator v( rx, 0 );
+ <a href="qstring.html">QString</a> s;
+ int pos = 0;
+
+ s = "0"; v.<a href="#validate">validate</a>( s, pos ); // returns Invalid
+ s = "12345"; v.<a href="#validate">validate</a>( s, pos ); // returns Invalid
+ s = "1"; v.<a href="#validate">validate</a>( s, pos ); // returns Acceptable
+
+ rx.<a href="qregexp.html#setPattern">setPattern</a>( "\\S+" ); // one or more non-whitespace characters
+ v.<a href="#setRegExp">setRegExp</a>( rx );
+ s = "myfile.txt"; v.<a href="#validate">validate</a>( s, pos ); // Returns Acceptable
+ s = "my file.txt"; v.<a href="#validate">validate</a>( s, pos ); // Returns Invalid
+
+ // A, B or C followed by exactly five digits followed by W, X, Y or Z
+ rx.<a href="qregexp.html#setPattern">setPattern</a>( "[A-C]\\d{5}[W-Z]" );
+ v.<a href="#setRegExp">setRegExp</a>( rx );
+ s = "a12345Z"; v.<a href="#validate">validate</a>( s, pos ); // Returns Invalid
+ s = "A12345Z"; v.<a href="#validate">validate</a>( s, pos ); // Returns Acceptable
+ s = "B12"; v.<a href="#validate">validate</a>( s, pos ); // Returns Intermediate
+
+ // match most 'readme' files
+ rx.<a href="qregexp.html#setPattern">setPattern</a>( "read\\S?me(\.(txt|asc|1st))?" );
+ rx.<a href="qregexp.html#setCaseSensitive">setCaseSensitive</a>( FALSE );
+ v.<a href="#setRegExp">setRegExp</a>( rx );
+ s = "readme"; v.<a href="#validate">validate</a>( s, pos ); // Returns Acceptable
+ s = "README.1ST"; v.<a href="#validate">validate</a>( s, pos ); // Returns Acceptable
+ s = "read me.txt"; v.<a href="#validate">validate</a>( s, pos ); // Returns Invalid
+ s = "readm"; v.<a href="#validate">validate</a>( s, pos ); // Returns Intermediate
+ </pre>
+
+<p> <p>See also <a href="qregexp.html">QRegExp</a>, <a href="qintvalidator.html">QIntValidator</a>, <a href="qdoublevalidator.html">QDoubleValidator</a>, and <a href="misc.html">Miscellaneous Classes</a>.
+
+<hr><h2>Member Function Documentation</h2>
+<h3 class=fn><a name="QRegExpValidator"></a>QRegExpValidator::QRegExpValidator ( <a href="qobject.html">QObject</a>&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )
+</h3>
+Constructs a validator that accepts any string (including an empty
+one) as valid. The object's parent is <em>parent</em> and its name is <em>name</em>.
+
+<h3 class=fn><a name="QRegExpValidator-2"></a>QRegExpValidator::QRegExpValidator ( const&nbsp;<a href="qregexp.html">QRegExp</a>&nbsp;&amp;&nbsp;rx, <a href="qobject.html">QObject</a>&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )
+</h3>
+Constructs a validator which accepts all strings that match the
+<a href="qregexp.html#regular-expression">regular expression</a> <em>rx</em>. The object's parent is <em>parent</em> and its
+name is <em>name</em>.
+<p> The match is made against the entire string, e.g. if the regexp is
+<b>[A-Fa-f0-9]+</b> it will be treated as <b>^[A-Fa-f0-9]+$</b>.
+
+<h3 class=fn><a name="~QRegExpValidator"></a>QRegExpValidator::~QRegExpValidator ()
+</h3>
+Destroys the validator, freeing any resources allocated.
+
+<h3 class=fn>const&nbsp;<a href="qregexp.html">QRegExp</a>&nbsp;&amp; <a name="regExp"></a>QRegExpValidator::regExp () const
+</h3>
+
+<p> Returns the <a href="qregexp.html#regular-expression">regular expression</a> used for validation.
+<p> <p>See also <a href="#setRegExp">setRegExp</a>().
+
+<h3 class=fn>void <a name="setRegExp"></a>QRegExpValidator::setRegExp ( const&nbsp;<a href="qregexp.html">QRegExp</a>&nbsp;&amp;&nbsp;rx )
+</h3>
+Sets the <a href="qregexp.html#regular-expression">regular expression</a> used for validation to <em>rx</em>.
+<p> <p>See also <a href="#regExp">regExp</a>().
+
+<h3 class=fn><a href="qvalidator.html#State-enum">QValidator::State</a> <a name="validate"></a>QRegExpValidator::validate ( <a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;input, int&nbsp;&amp;&nbsp;pos ) const<tt> [virtual]</tt>
+</h3>
+Returns <a href="qvalidator.html#State-enum">Acceptable</a> if <em>input</em> is matched by the <a href="qregexp.html#regular-expression">regular expression</a> for this validator, <a href="qvalidator.html#State-enum">Intermediate</a> if it has matched
+partially (i.e. could be a valid match if additional valid
+characters are added), and <a href="qvalidator.html#State-enum">Invalid</a> if <em>input</em> is not matched.
+<p> The <em>pos</em> parameter is set to the length of the <em>input</em> parameter.
+<p> For example, if the regular expression is <b>&#92;w&#92;d&#92;d</b> (that
+is, word-character, digit, digit) then "A57" is <a href="qvalidator.html#State-enum">Acceptable</a>,
+"E5" is <a href="qvalidator.html#State-enum">Intermediate</a> and "+9" is <a href="qvalidator.html#State-enum">Invalid</a>.
+<p> <p>See also <a href="qregexp.html#match">QRegExp::match</a>() and <a href="qregexp.html#search">QRegExp::search</a>().
+
+<p>Reimplemented from <a href="qvalidator.html#validate">QValidator</a>.
+<!-- 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>