<?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" />
<!-- qvalidator.cpp -->
<title>Qt 4.8: QRegExpValidator 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="qtgui.html">QtGui</a></li>
<li>QRegExpValidator</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="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QRegExpValidator Class Reference</h1>
<!-- $$$QRegExpValidator-brief -->
<p>The QRegExpValidator class is used to check a string against a regular expression. <a href="#details">More...</a></p>
<!-- @@@QRegExpValidator -->
<pre class="cpp"> <span class="preprocessor">#include <QRegExpValidator></span></pre><p><b>Inherits: </b><a href="qvalidator.html">QValidator</a>.</p>
<ul>
<li><a href="qregexpvalidator-members.html">List of all members, including inherited members</a></li>
<li><a href="qregexpvalidator-qt3.html">Qt 3 support members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><a href="qregexpvalidator.html#regExp-prop">regExp</a></b> : QRegExp</li>
</ul>
<ul>
<li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</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="qregexpvalidator.html#QRegExpValidator">QRegExpValidator</a></b> ( QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qregexpvalidator.html#QRegExpValidator-2">QRegExpValidator</a></b> ( const QRegExp & <i>rx</i>, QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qregexpvalidator.html#dtor.QRegExpValidator">~QRegExpValidator</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QRegExp & </td><td class="memItemRight bottomAlign"><b><a href="qregexpvalidator.html#regExp-prop">regExp</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qregexpvalidator.html#regExp-prop">setRegExp</a></b> ( const QRegExp & <i>rx</i> )</td></tr>
</table>
<a name="reimplemented-public-functions"></a>
<h2>Reimplemented Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual QValidator::State </td><td class="memItemRight bottomAlign"><b><a href="qregexpvalidator.html#validate">validate</a></b> ( QString & <i>input</i>, int & <i>pos</i> ) const</td></tr>
</table>
<ul>
<li class="fn">4 public functions inherited from <a href="qvalidator.html#public-functions">QValidator</a></li>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
<li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
<li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
<li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QRegExpValidator-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QRegExpValidator class is used to check a string against a regular expression.</p>
<p>QRegExpValidator uses a regular expression (regexp) 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>. The regexp can either be supplied when the QRegExpValidator is constructed, or at a later time.</p>
<p>When QRegExpValidator determines whether a string is <a href="qvalidator.html#State-enum">Acceptable</a> or not, 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>); the match is against the entire input string, or from the given position if a start position greater than zero is given.</p>
<p>If a string is a prefix of an <a href="qvalidator.html#State-enum">Acceptable</a> string, it is considered <a href="qvalidator.html#State-enum">Intermediate</a>. For example, "" and "A" are <a href="qvalidator.html#State-enum">Intermediate</a> for the regexp <b>[A-Z][0-9]</b> (whereas "<a href="index.html">_</a>" would be <a href="qvalidator.html#State-enum">Invalid</a>).</p>
<p>For a brief introduction to Qt's regexp engine, see <a href="qregexp.html">QRegExp</a>.</p>
<p>Example of use:</p>
<pre class="cpp"> <span class="comment">// regexp: optional '-' followed by between 1 and 3 digits</span>
<span class="type"><a href="qregexp.html">QRegExp</a></span> rx(<span class="string">"-?\\d{1,3}"</span>);
<span class="type"><a href="qvalidator.html">QValidator</a></span> <span class="operator">*</span>validator <span class="operator">=</span> <span class="keyword">new</span> <span class="type">QRegExpValidator</span>(rx<span class="operator">,</span> <span class="keyword">this</span>);
<span class="type"><a href="qlineedit.html">QLineEdit</a></span> <span class="operator">*</span>edit <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qlineedit.html">QLineEdit</a></span>(<span class="keyword">this</span>);
edit<span class="operator">-</span><span class="operator">></span>setValidator(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 class="cpp"> <span class="comment">// integers 1 to 9999</span>
<span class="type"><a href="qregexp.html">QRegExp</a></span> rx(<span class="string">"[1-9]\\d{0,3}"</span>);
<span class="comment">// the validator treats the regexp as "^[1-9]\\d{0,3}$"</span>
<span class="type">QRegExpValidator</span> v(rx<span class="operator">,</span> <span class="number">0</span>);
<span class="type"><a href="qstring.html">QString</a></span> s;
<span class="type">int</span> pos <span class="operator">=</span> <span class="number">0</span>;
s <span class="operator">=</span> <span class="string">"0"</span>; v<span class="operator">.</span><a href="qregexpvalidator.html#validate">validate</a>(s<span class="operator">,</span> pos); <span class="comment">// returns Invalid</span>
s <span class="operator">=</span> <span class="string">"12345"</span>; v<span class="operator">.</span><a href="qregexpvalidator.html#validate">validate</a>(s<span class="operator">,</span> pos); <span class="comment">// returns Invalid</span>
s <span class="operator">=</span> <span class="string">"1"</span>; v<span class="operator">.</span><a href="qregexpvalidator.html#validate">validate</a>(s<span class="operator">,</span> pos); <span class="comment">// returns Acceptable</span>
rx<span class="operator">.</span>setPattern(<span class="string">"\\S+"</span>); <span class="comment">// one or more non-whitespace characters</span>
v<span class="operator">.</span><a href="qregexpvalidator.html#regExp-prop">setRegExp</a>(rx);
s <span class="operator">=</span> <span class="string">"myfile.txt"</span>; v<span class="operator">.</span><a href="qregexpvalidator.html#validate">validate</a>(s<span class="operator">,</span> pos); <span class="comment">// Returns Acceptable</span>
s <span class="operator">=</span> <span class="string">"my file.txt"</span>; v<span class="operator">.</span><a href="qregexpvalidator.html#validate">validate</a>(s<span class="operator">,</span> pos); <span class="comment">// Returns Invalid</span>
<span class="comment">// A, B or C followed by exactly five digits followed by W, X, Y or Z</span>
rx<span class="operator">.</span>setPattern(<span class="string">"[A-C]\\d{5}[W-Z]"</span>);
v<span class="operator">.</span><a href="qregexpvalidator.html#regExp-prop">setRegExp</a>(rx);
s <span class="operator">=</span> <span class="string">"a12345Z"</span>; v<span class="operator">.</span><a href="qregexpvalidator.html#validate">validate</a>(s<span class="operator">,</span> pos); <span class="comment">// Returns Invalid</span>
s <span class="operator">=</span> <span class="string">"A12345Z"</span>; v<span class="operator">.</span><a href="qregexpvalidator.html#validate">validate</a>(s<span class="operator">,</span> pos); <span class="comment">// Returns Acceptable</span>
s <span class="operator">=</span> <span class="string">"B12"</span>; v<span class="operator">.</span><a href="qregexpvalidator.html#validate">validate</a>(s<span class="operator">,</span> pos); <span class="comment">// Returns Intermediate</span>
<span class="comment">// match most 'readme' files</span>
rx<span class="operator">.</span>setPattern(<span class="string">"read\\S?me(\.(txt|asc|1st))?"</span>);
rx<span class="operator">.</span>setCaseSensitive(<span class="keyword">false</span>);
v<span class="operator">.</span><a href="qregexpvalidator.html#regExp-prop">setRegExp</a>(rx);
s <span class="operator">=</span> <span class="string">"readme"</span>; v<span class="operator">.</span><a href="qregexpvalidator.html#validate">validate</a>(s<span class="operator">,</span> pos); <span class="comment">// Returns Acceptable</span>
s <span class="operator">=</span> <span class="string">"README.1ST"</span>; v<span class="operator">.</span><a href="qregexpvalidator.html#validate">validate</a>(s<span class="operator">,</span> pos); <span class="comment">// Returns Acceptable</span>
s <span class="operator">=</span> <span class="string">"read me.txt"</span>; v<span class="operator">.</span><a href="qregexpvalidator.html#validate">validate</a>(s<span class="operator">,</span> pos); <span class="comment">// Returns Invalid</span>
s <span class="operator">=</span> <span class="string">"readm"</span>; v<span class="operator">.</span><a href="qregexpvalidator.html#validate">validate</a>(s<span class="operator">,</span> pos); <span class="comment">// Returns Intermediate</span></pre>
</div>
<p><b>See also </b><a href="qregexp.html">QRegExp</a>, <a href="qintvalidator.html">QIntValidator</a>, <a href="qdoublevalidator.html">QDoubleValidator</a>, and <a href="tools-settingseditor.html">Settings Editor Example</a>.</p>
<!-- @@@QRegExpValidator -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$regExp-prop$$$regExp$$$setRegExpconstQRegExp& -->
<h3 class="fn"><a name="regExp-prop"></a><span class="name">regExp</span> : <span class="type"><a href="qregexp.html">QRegExp</a></span></h3>
<p>This property holds the regular expression used for validation.</p>
<p>By default, this property contains a regular expression with the pattern <tt>.*</tt> that matches any string.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> const QRegExp & </td><td class="memItemRight bottomAlign"><span class="name"><b>regExp</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setRegExp</b></span> ( const QRegExp & <i>rx</i> )</td></tr>
</table>
<!-- @@@regExp -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QRegExpValidator[overload1]$$$QRegExpValidatorQObject* -->
<h3 class="fn"><a name="QRegExpValidator"></a>QRegExpValidator::<span class="name">QRegExpValidator</span> ( <span class="type"><a href="qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Constructs a validator with a <i>parent</i> object that accepts any string (including an empty one) as valid.</p>
<!-- @@@QRegExpValidator -->
<!-- $$$QRegExpValidator$$$QRegExpValidatorconstQRegExp&QObject* -->
<h3 class="fn"><a name="QRegExpValidator-2"></a>QRegExpValidator::<span class="name">QRegExpValidator</span> ( const <span class="type"><a href="qregexp.html">QRegExp</a></span> & <i>rx</i>, <span class="type"><a href="qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Constructs a validator with a <i>parent</i> object that accepts all strings that match the regular expression <i>rx</i>.</p>
<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>.</p>
<!-- @@@QRegExpValidator -->
<!-- $$$~QRegExpValidator[overload1]$$$~QRegExpValidator -->
<h3 class="fn"><a name="dtor.QRegExpValidator"></a>QRegExpValidator::<span class="name">~QRegExpValidator</span> ()</h3>
<p>Destroys the validator.</p>
<!-- @@@~QRegExpValidator -->
<!-- $$$validate[overload1]$$$validateQString&int& -->
<h3 class="fn"><a name="validate"></a><span class="type"><a href="qvalidator.html#State-enum">QValidator::State</a></span> QRegExpValidator::<span class="name">validate</span> ( <span class="type"><a href="qstring.html">QString</a></span> & <i>input</i>, <span class="type">int</span> & <i>pos</i> ) const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qvalidator.html#validate">QValidator::validate</a>().</p>
<p>Returns <a href="qvalidator.html#State-enum">Acceptable</a> if <i>input</i> is matched by the regular expression 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 <i>input</i> is not matched.</p>
<p>The <i>pos</i> parameter is set to the length of the <i>input</i> parameter.</p>
<p>For example, if the regular expression is <b>\w\d\d</b> (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><b>See also </b><a href="qregexp.html#exactMatch">QRegExp::exactMatch</a>().</p>
<!-- @@@validate -->
</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>
