<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- textinput.qdoc -->
<title>Qt Quick Text Input Handling and Validators | Qt Quick 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtquick-index.html">Qt Quick</a></td><td >Qt Quick Text Input Handling and Validators</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#text-visual-types">Text Visual Types</a></li>
<li class="level1"><a href="#validating-input-text">Validating Input Text</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Qt Quick Text Input Handling and Validators</h1>
<span class="subtitle"></span>
<!-- $$$qtquick-input-textinput.html-description -->
<div class="descr"> <a name="details"></a>
<a name="text-visual-types"></a>
<h2 id="text-visual-types">Text Visual Types</h2>
<p>Qt Quick provides several types to display text onto the screen. The <a href="qml-qtquick-text.html">Text</a> type will display formatted text onto the screen, the <a href="qml-qtquick-textedit.html">TextEdit</a> type will place a multiline line edit onto the screen, and the <a href="qml-qtquick-textinput.html">TextInput</a> will place a single editable line field onto the screen.</p>
<p>To learn more about their specific features and properties, visit their respective documentation.</p>
<a name="validating-input-text"></a>
<h2 id="validating-input-text">Validating Input Text</h2>
<p>The <i>validator</i> types enforce the type and format of <a href="qml-qtquick-textinput.html">TextInput</a> objects.</p>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qtquick-text-validator.html">Qt Quick Text Validators</a></p></td><td class="tblDescr"><p>Types that validate text input</p></td></tr>
</table></div>
<pre class="qml">
<span class="type"><a href="qml-qtquick-column.html">Column</a></span> {
<span class="name">spacing</span>: <span class="number">10</span>
<span class="type"><a href="qml-qtquick-text.html">Text</a></span> {
<span class="name">text</span>: <span class="string">"Enter a value from 0 to 2000"</span>
}
<span class="type"><a href="qml-qtquick-textinput.html">TextInput</a></span> {
<span class="name">focus</span>: <span class="number">true</span>
<span class="name">validator</span>: <span class="name">IntValidator</span> { <span class="name">bottom</span>:<span class="number">0</span>; <span class="name">top</span>: <span class="number">2000</span>}
}
}
</pre>
<p>The validator types bind to <code>TextInput</code>'s <code>validator</code> property.</p>
<pre class="qml">
<span class="type"><a href="qml-qtquick-column.html">Column</a></span> {
<span class="name">spacing</span>: <span class="number">10</span>
<span class="type"><a href="qml-qtquick-text.html">Text</a></span> {
<span class="name">text</span>: <span class="string">"Which basket?"</span>
}
<span class="type"><a href="qml-qtquick-textinput.html">TextInput</a></span> {
<span class="name">focus</span>: <span class="number">true</span>
<span class="name">validator</span>: <span class="name">RegExpValidator</span> { <span class="name">regExp</span>: /fruit basket/ }
}
}
</pre>
<p>The regular expression in the snippet will only allow the inputted text to be <code>fruit basket</code>.</p>
<p>Note that QML parses JavaScript regular expressions, while Qt's QRegExp class' regular expressions are based on Perl regular expressions.</p>
</div>
<!-- @@@qtquick-input-textinput.html -->
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> 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.<br> 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. </p>
</div>
</body>
</html>
