/usr/share/qt5/doc/qtquickcontrols/qml-qtquick-controls-textfield.html is in qtquickcontrols5-doc-html 5.3.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.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" />
<!-- TextField.qml -->
<title>TextField QML Type | QtQuickControls 5.3</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.3</li>
<li><a href="qtquickcontrols-index.html">Qt Quick Controls</a></li>
<li><a href="qtquick-controls-qmlmodule.html">QML Types</a></li>
<li>TextField QML Type</li>
<li id="buildversion">
Qt 5.3.2 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<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="#signals">Signals</a></li>
<li class="level1"><a href="#methods">Methods</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">TextField QML Type</h1>
<span class="subtitle"></span>
<!-- $$$TextField-brief -->
<p>Displays a single line of editable plain text. <a href="#details">More...</a></p>
<!-- @@@TextField -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> </b><tt>import QtQuick.Controls 1.2</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="../qtquick/qml-qtquick-focusscope.html">FocusScope</a></p>
</td></tr></table><ul>
<li><a href="qml-qtquick-controls-textfield-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#acceptableInput-prop">acceptableInput</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#activeFocusOnPress-prop">activeFocusOnPress</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#canPaste-prop">canPaste</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#canRedo-prop">canRedo</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#canUndo-prop">canUndo</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#cursorPosition-prop">cursorPosition</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#displayText-prop">displayText</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#echoMode-prop">echoMode</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#effectiveHorizontalAlignment-prop">effectiveHorizontalAlignment</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#font-prop">font</a></b></b> : font</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#horizontalAlignment-prop">horizontalAlignment</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#hovered-prop">hovered</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#inputMask-prop">inputMask</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#inputMethodHints-prop">inputMethodHints</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#length-prop">length</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#maximumLength-prop">maximumLength</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#placeholderText-prop">placeholderText</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#readOnly-prop">readOnly</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#selectedText-prop">selectedText</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#selectionEnd-prop">selectionEnd</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#selectionStart-prop">selectionStart</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#style-prop">style</a></b></b> : Component</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#text-prop">text</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#textColor-prop">textColor</a></b></b> : color</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#validator-prop">validator</a></b></b> : Validator</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#verticalAlignment-prop">verticalAlignment</a></b></b> : enumeration</li>
</ul>
<a name="signals"></a>
<h2>Signals</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#accepted-signal">accepted</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#editingFinished-signal">editingFinished</a></b></b>()</li>
</ul>
<a name="methods"></a>
<h2>Methods</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#copy-method">copy</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#cut-method">cut</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#deselect-method">deselect</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#getText-method">getText</a></b></b>(<i>start</i>, <i>end</i>)</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#insert-method">insert</a></b></b>(<i>position</i>, <i>text</i>)</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#isRightToLeft-method">isRightToLeft</a></b></b>(<i>start</i>, <i>end</i>)</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#paste-method">paste</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#redo-method">redo</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#select-method">select</a></b></b>(<i>start</i>, <i>end</i>)</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#selectAll-method">selectAll</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#selectWord-method">selectWord</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-textfield.html#undo-method">undo</a></b></b>()</li>
</ul>
<!-- $$$TextField-description -->
<a name="details"></a>
<h2>Detailed Description</h2>
<p class="centerAlign"><img src="images/textfield.png" alt="" /></p><p>TextField is used to accept a line of text input. Input constraints can be placed on a TextField item (for example, through a <a href="qml-qtquick-controls-textfield.html#validator-prop">validator</a> or <a href="qml-qtquick-controls-textfield.html#inputMask-prop">inputMask</a>). Setting <a href="qml-qtquick-controls-textfield.html#echoMode-prop">echoMode</a> to an appropriate value enables TextField to be used for a password input field.</p>
<pre class="qml"><span class="type">TextField</span> {
<span class="name">placeholderText</span>: <span class="name">qsTr</span>(<span class="string">"Enter name"</span>)
}</pre>
<p>You can create a custom appearance for a TextField by assigning a <a href="qml-qtquick-controls-styles-textfieldstyle.html">TextFieldStyle</a>.</p>
<p><b>See also </b><a href="qml-qtquick-controls-textarea.html">TextArea</a> and <a href="../qtquick/qml-qtquick-textinput.html">TextInput</a>.</p>
<!-- @@@TextField -->
<h2>Property Documentation</h2>
<!-- $$$acceptableInput -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="acceptableInput-prop"></a><span class="qmlreadonly">read-only</span><span class="name">acceptableInput</span> : <span class="type"><a href="../qtqml/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>Returns <tt>true</tt> if the text field contains acceptable text.</p>
<p>If a validator or input mask was set, this property will return <tt>true</tt> if the current text satisfies the validator or mask as a final string (not as an intermediate string).</p>
<p>The default value is <tt>true</tt>.</p>
<p><b>See also </b><a href="qml-qtquick-controls-textfield.html#validator-prop">validator</a>, <a href="qml-qtquick-controls-textfield.html#inputMask-prop">inputMask</a>, and <a href="qml-qtquick-controls-textfield.html#accepted-signal">accepted</a>.</p>
</div></div><!-- @@@acceptableInput -->
<br/>
<!-- $$$activeFocusOnPress -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="activeFocusOnPress-prop"></a><span class="name">activeFocusOnPress</span> : <span class="type"><a href="../qtqml/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property is set to <tt>true</tt> if the <a href="qml-qtquick-controls-textfield.html">TextField</a> should gain active focus on a mouse press.</p>
<p>The default value is <tt>true</tt>.</p>
</div></div><!-- @@@activeFocusOnPress -->
<br/>
<!-- $$$canPaste -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="canPaste-prop"></a><span class="qmlreadonly">read-only</span><span class="name">canPaste</span> : <span class="type"><a href="../qtqml/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>Returns <tt>true</tt> if the <a href="qml-qtquick-controls-textfield.html">TextField</a> is writable and the content of the clipboard is suitable for pasting into the <a href="qml-qtquick-controls-textfield.html">TextField</a>.</p>
</div></div><!-- @@@canPaste -->
<br/>
<!-- $$$canRedo -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="canRedo-prop"></a><span class="qmlreadonly">read-only</span><span class="name">canRedo</span> : <span class="type"><a href="../qtqml/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>Returns <tt>true</tt> if the <a href="qml-qtquick-controls-textfield.html">TextField</a> is writable and there are <a href="qml-qtquick-controls-textfield.html#undo-method">undone</a> operations that can be redone.</p>
</div></div><!-- @@@canRedo -->
<br/>
<!-- $$$canUndo -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="canUndo-prop"></a><span class="qmlreadonly">read-only</span><span class="name">canUndo</span> : <span class="type"><a href="../qtqml/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>Returns <tt>true</tt> if the <a href="qml-qtquick-controls-textfield.html">TextField</a> is writable and there are previous operations that can be undone.</p>
</div></div><!-- @@@canUndo -->
<br/>
<!-- $$$cursorPosition -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="cursorPosition-prop"></a><span class="name">cursorPosition</span> : <span class="type"><a href="../qtqml/qml-int.html">int</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the position of the cursor in the <a href="qml-qtquick-controls-textfield.html">TextField</a>.</p>
</div></div><!-- @@@cursorPosition -->
<br/>
<!-- $$$displayText -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="displayText-prop"></a><span class="qmlreadonly">read-only</span><span class="name">displayText</span> : <span class="type"><a href="../qtqml/qml-string.html">string</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the text displayed in the <a href="qml-qtquick-controls-textfield.html">TextField</a>.</p>
<p>If <a href="qml-qtquick-controls-textfield.html#echoMode-prop">echoMode</a> is set to TextInput::Normal, this holds the same value as the <a href="qml-qtquick-controls-textfield.html#text-prop">TextField::text</a> property. Otherwise, this property holds the text visible to the user, while the <a href="../qtwidgets/text.html">text</a> property holds the actual entered text.</p>
</div></div><!-- @@@displayText -->
<br/>
<!-- $$$echoMode -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="echoMode-prop"></a><span class="name">echoMode</span> : <span class="type"><a href="../qtqml/qml-enumeration.html">enumeration</a></span></p></td></tr></table></div><div class="qmldoc"><p>Specifies how the text should be displayed in the <a href="qml-qtquick-controls-textfield.html">TextField</a>.</p>
<p>The possible modes are:</p>
<ul>
<li><a href="../qtquick/qml-qtquick-textinput.html">TextInput</a>.Normal - Displays the text as it is. (Default)</li>
<li><a href="../qtquick/qml-qtquick-textinput.html">TextInput</a>.Password - Displays asterisks instead of characters.</li>
<li><a href="../qtquick/qml-qtquick-textinput.html">TextInput</a>.NoEcho - Displays nothing.</li>
<li><a href="../qtquick/qml-qtquick-textinput.html">TextInput</a>.PasswordEchoOnEdit - Displays characters as they are entered while editing, otherwise displays asterisks.</li>
</ul>
</div></div><!-- @@@echoMode -->
<br/>
<!-- $$$effectiveHorizontalAlignment -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="effectiveHorizontalAlignment-prop"></a><span class="qmlreadonly">read-only</span><span class="name">effectiveHorizontalAlignment</span> : <span class="type"><a href="../qtqml/qml-enumeration.html">enumeration</a></span></p></td></tr></table></div><div class="qmldoc"><p>Gets the effective horizontal alignment of the text within the <a href="qml-qtquick-controls-textfield.html">TextField</a> item's width.</p>
<p><a href="qml-qtquick-controls-textfield.html#horizontalAlignment-prop">horizontalAlignment</a> contains the default horizontal alignment.</p>
<p><b>See also </b><a href="qml-qtquick-controls-textfield.html#horizontalAlignment-prop">horizontalAlignment</a>.</p>
</div></div><!-- @@@effectiveHorizontalAlignment -->
<br/>
<!-- $$$font -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="font-prop"></a><span class="name">font</span> : <span class="type"><a href="../qtquick/qml-font.html">font</a></span></p></td></tr></table></div><div class="qmldoc"><p>Sets the font of the <a href="qml-qtquick-controls-textfield.html">TextField</a>.</p>
</div></div><!-- @@@font -->
<br/>
<!-- $$$horizontalAlignment -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="horizontalAlignment-prop"></a><span class="name">horizontalAlignment</span> : <span class="type"><a href="../qtqml/qml-enumeration.html">enumeration</a></span></p></td></tr></table></div><div class="qmldoc"><p>Sets the alignment of the text within the <a href="qml-qtquick-controls-textfield.html">TextField</a> item's width.</p>
<p>By default, the horizontal text alignment follows the natural alignment of the text, for example text that is read from left to right will be aligned to the left.</p>
<p>The possible alignment values are:</p>
<ul>
<li><a href="../qtquick/qml-qtquick-textinput.html">TextInput</a>.AlignLeft</li>
<li><a href="../qtquick/qml-qtquick-textinput.html">TextInput</a>.AlignRight</li>
<li><a href="../qtquick/qml-qtquick-textinput.html">TextInput</a>.AlignHCenter</li>
</ul>
<p>When using the attached property, <a href="../qtquick/qml-qtquick-layoutmirroring.html#enabled-prop">LayoutMirroring::enabled</a>, to mirror application layouts, the horizontal alignment of text will also be mirrored. However, the property <tt>horizontalAlignment</tt> will remain unchanged. To query the effective horizontal alignment of <a href="qml-qtquick-controls-textfield.html">TextField</a>, use the read-only property <tt>effectiveHorizontalAlignment</tt>.</p>
</div></div><!-- @@@horizontalAlignment -->
<br/>
<!-- $$$hovered -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="hovered-prop"></a><span class="qmlreadonly">read-only</span><span class="name">hovered</span> : <span class="type"><a href="../qtqml/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds whether the control is being hovered.</p>
</div></div><!-- @@@hovered -->
<br/>
<!-- $$$inputMask -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="inputMask-prop"></a><span class="name">inputMask</span> : <span class="type"><a href="../qtqml/qml-string.html">string</a></span></p></td></tr></table></div><div class="qmldoc"><p>Sets an input mask on the <a href="qml-qtquick-controls-textfield.html">TextField</a>, restricting the allowable text inputs. See <a href="../qtwidgets/qlineedit.html#inputMask-prop">QLineEdit::inputMask</a> for further details, as the exact same mask strings are used by <a href="qml-qtquick-controls-textfield.html">TextField</a>.</p>
<p><b>See also </b><a href="qml-qtquick-controls-textfield.html#acceptableInput-prop">acceptableInput</a> and <a href="qml-qtquick-controls-textfield.html#validator-prop">validator</a>.</p>
</div></div><!-- @@@inputMask -->
<br/>
<!-- $$$inputMethodHints -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="inputMethodHints-prop"></a><span class="name">inputMethodHints</span> : <span class="type"><a href="../qtqml/qml-enumeration.html">enumeration</a></span></p></td></tr></table></div><div class="qmldoc"><p>Provides hints to the input method about the expected content of the text field and how it should operate.</p>
<p>The value is a bit-wise combination of flags, or <tt>Qt.ImhNone</tt> if no hints are set.</p>
<p>The default value is <tt>Qt.ImhNone</tt>.</p>
<p>Flags that alter behavior are:</p>
<ul>
<li>Qt.ImhHiddenText - Characters should be hidden, as is typically used when entering passwords. This is automatically set when setting <a href="qml-qtquick-controls-textfield.html#echoMode-prop">echoMode</a> to <tt>TextInput.Password</tt>.</li>
<li>Qt.ImhSensitiveData - Typed text should not be stored by the active input method in any persistent storage like predictive user dictionary.</li>
<li>Qt.ImhNoAutoUppercase - The input method should not try to automatically switch to upper case when a sentence ends.</li>
<li>Qt.ImhPreferNumbers - Numbers are preferred (but not required).</li>
<li>Qt.ImhPreferUppercase - Uppercase letters are preferred (but not required).</li>
<li>Qt.ImhPreferLowercase - Lowercase letters are preferred (but not required).</li>
<li>Qt.ImhNoPredictiveText - Do not use predictive text (for example, dictionary lookup) while typing.</li>
<li>Qt.ImhDate - The text editor functions as a date field.</li>
<li>Qt.ImhTime - The text editor functions as a time field.</li>
</ul>
<p>Flags that restrict input (exclusive flags) are:</p>
<ul>
<li>Qt.ImhDigitsOnly - Only digits are allowed.</li>
<li>Qt.ImhFormattedNumbersOnly - Only number input is allowed. This includes decimal point and minus sign.</li>
<li>Qt.ImhUppercaseOnly - Only uppercase letter input is allowed.</li>
<li>Qt.ImhLowercaseOnly - Only lowercase letter input is allowed.</li>
<li>Qt.ImhDialableCharactersOnly - Only characters suitable for phone dialing are allowed.</li>
<li>Qt.ImhEmailCharactersOnly - Only characters suitable for email addresses are allowed.</li>
<li>Qt.ImhUrlCharactersOnly - Only characters suitable for URLs are allowed.</li>
</ul>
<p>Masks:</p>
<ul>
<li>Qt.ImhExclusiveInputMask - This mask yields nonzero if any of the exclusive flags are used.</li>
</ul>
</div></div><!-- @@@inputMethodHints -->
<br/>
<!-- $$$length -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="length-prop"></a><span class="qmlreadonly">read-only</span><span class="name">length</span> : <span class="type"><a href="../qtqml/qml-int.html">int</a></span></p></td></tr></table></div><div class="qmldoc"><p>Returns the total number of characters in the <a href="qml-qtquick-controls-textfield.html">TextField</a> item.</p>
<p>If the <a href="qml-qtquick-controls-textfield.html">TextField</a> has an input mask, the length will include mask characters and may differ from the length of the string returned by the <a href="../qtwidgets/text.html">text</a> property.</p>
<p>This property can be faster than querying the length of the <a href="../qtwidgets/text.html">text</a> property as it doesn't require any copying or conversion of the <a href="qml-qtquick-controls-textfield.html">TextField</a>'s internal string data.</p>
</div></div><!-- @@@length -->
<br/>
<!-- $$$maximumLength -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="maximumLength-prop"></a><span class="name">maximumLength</span> : <span class="type"><a href="../qtqml/qml-int.html">int</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the maximum permitted length of the text in the <a href="qml-qtquick-controls-textfield.html">TextField</a>.</p>
<p>If the text is too long, it is truncated at the limit.</p>
</div></div><!-- @@@maximumLength -->
<br/>
<!-- $$$placeholderText -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="placeholderText-prop"></a><span class="name">placeholderText</span> : <span class="type"><a href="../qtqml/qml-string.html">string</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property contains the text that is shown in the text field when the text field is empty.</p>
</div></div><!-- @@@placeholderText -->
<br/>
<!-- $$$readOnly -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="readOnly-prop"></a><span class="name">readOnly</span> : <span class="type"><a href="../qtqml/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>Sets whether user input can modify the contents of the <a href="qml-qtquick-controls-textfield.html">TextField</a>. Read- only is different from a disabled text field in that the text field will appear to be active and text can still be selected and copied.</p>
<p>If readOnly is set to <tt>true</tt>, then user input will not affect the text. Any bindings or attempts to set the text property will still work, however.</p>
</div></div><!-- @@@readOnly -->
<br/>
<!-- $$$selectedText -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="selectedText-prop"></a><span class="qmlreadonly">read-only</span><span class="name">selectedText</span> : <span class="type"><a href="../qtqml/qml-string.html">string</a></span></p></td></tr></table></div><div class="qmldoc"><p>Provides the text currently selected in the text input.</p>
<p>It is equivalent to the following snippet, but is faster and easier to use.</p>
<pre class="cpp">myTextField<span class="operator">.</span>text<span class="operator">.</span>toString()<span class="operator">.</span>substring(myTextField<span class="operator">.</span>selectionStart<span class="operator">,</span> myTextField<span class="operator">.</span>selectionEnd);</pre>
</div></div><!-- @@@selectedText -->
<br/>
<!-- $$$selectionEnd -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="selectionEnd-prop"></a><span class="qmlreadonly">read-only</span><span class="name">selectionEnd</span> : <span class="type"><a href="../qtqml/qml-int.html">int</a></span></p></td></tr></table></div><div class="qmldoc"><p>The cursor position after the last character in the current selection.</p>
<p>This property is read-only. To change the selection, use select(start,end), <a href="qml-qtquick-controls-textfield.html#selectAll-method">selectAll()</a>, or <a href="qml-qtquick-controls-textfield.html#selectWord-method">selectWord()</a>.</p>
<p><b>See also </b><a href="qml-qtquick-controls-textfield.html#selectionStart-prop">selectionStart</a>, <a href="qml-qtquick-controls-textfield.html#cursorPosition-prop">cursorPosition</a>, and <a href="qml-qtquick-controls-textfield.html#selectedText-prop">selectedText</a>.</p>
</div></div><!-- @@@selectionEnd -->
<br/>
<!-- $$$selectionStart -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="selectionStart-prop"></a><span class="qmlreadonly">read-only</span><span class="name">selectionStart</span> : <span class="type"><a href="../qtqml/qml-int.html">int</a></span></p></td></tr></table></div><div class="qmldoc"><p>The cursor position before the first character in the current selection.</p>
<p>This property is read-only. To change the selection, use select(start,end), <a href="qml-qtquick-controls-textfield.html#selectAll-method">selectAll()</a>, or <a href="qml-qtquick-controls-textfield.html#selectWord-method">selectWord()</a>.</p>
<p><b>See also </b><a href="qml-qtquick-controls-textfield.html#selectionEnd-prop">selectionEnd</a>, <a href="qml-qtquick-controls-textfield.html#cursorPosition-prop">cursorPosition</a>, and <a href="qml-qtquick-controls-textfield.html#selectedText-prop">selectedText</a>.</p>
</div></div><!-- @@@selectionStart -->
<br/>
<!-- $$$style -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="style-prop"></a><span class="name">style</span> : <span class="type"><a href="../qtqml/qml-qtqml-component.html">Component</a></span></p></td></tr></table></div><div class="qmldoc"><p>The style Component for this control.</p>
<p><b>See also </b><a href="qtquick-controls-styles-qmlmodule.html">Qt Quick Controls Styles QML Types</a>.</p>
</div></div><!-- @@@style -->
<br/>
<!-- $$$text -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="text-prop"></a><span class="name">text</span> : <span class="type"><a href="../qtqml/qml-string.html">string</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property contains the text in the <a href="qml-qtquick-controls-textfield.html">TextField</a>.</p>
</div></div><!-- @@@text -->
<br/>
<!-- $$$textColor -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="textColor-prop"></a><span class="name">textColor</span> : <span class="type"><a href="../qtquick/qml-color.html">color</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the text color.</p>
</div></div><!-- @@@textColor -->
<br/>
<!-- $$$validator -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="validator-prop"></a><span class="name">validator</span> : <span class="type">Validator</span></p></td></tr></table></div><div class="qmldoc"><p>Allows you to set a validator on the <a href="qml-qtquick-controls-textfield.html">TextField</a>. When a validator is set, the <a href="qml-qtquick-controls-textfield.html">TextField</a> will only accept input which leaves the text property in an intermediate state. The accepted signal will only be sent if the text is in an acceptable state when enter is pressed.</p>
<p>Currently supported validators are <a href="../qtquick/qml-qtquick-intvalidator.html">IntValidator</a>, <a href="../qtquick/qml-qtquick-doublevalidator.html">DoubleValidator</a>, and <a href="../qtquick/qml-qtquick-regexpvalidator.html">RegExpValidator</a>. An example of using validators is shown below, which allows input of integers between 11 and 31 into the text input:</p>
<pre class="cpp">import <span class="type"><a href="../qtquick/qtquick-module.html">QtQuick</a></span> <span class="number">2.2</span>
import <span class="type"><a href="../qtquick/qtquick-module.html">QtQuick</a></span><span class="operator">.</span>Controls <span class="number">1.2</span>
TextField {
validator: IntValidator {bottom: <span class="number">11</span>; top: <span class="number">31</span>;}
focus: <span class="keyword">true</span>
}</pre>
<p><b>See also </b><a href="qml-qtquick-controls-textfield.html#acceptableInput-prop">acceptableInput</a>, <a href="qml-qtquick-controls-textfield.html#inputMask-prop">inputMask</a>, and <a href="qml-qtquick-controls-textfield.html#accepted-signal">accepted</a>.</p>
</div></div><!-- @@@validator -->
<br/>
<!-- $$$verticalAlignment -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="verticalAlignment-prop"></a><span class="name">verticalAlignment</span> : <span class="type"><a href="../qtqml/qml-enumeration.html">enumeration</a></span></p></td></tr></table></div><div class="qmldoc"><p>Sets the alignment of the text within the <a href="qml-qtquick-controls-textfield.html">TextField</a> item's height.</p>
<p>The possible alignment values are:</p>
<ul>
<li><a href="../qtquick/qml-qtquick-textinput.html">TextInput</a>.AlignTop</li>
<li><a href="../qtquick/qml-qtquick-textinput.html">TextInput</a>.AlignBottom</li>
<li><a href="../qtquick/qml-qtquick-textinput.html">TextInput</a>.AlignVCenter (default).</li>
</ul>
</div></div><!-- @@@verticalAlignment -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$accepted -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="accepted-signal"></a><span class="name">accepted</span>()</p></td></tr></table></div><div class="qmldoc"><p>This signal is emitted when the Return or Enter key is pressed. Note that if there is a <a href="qml-qtquick-controls-textfield.html#validator-prop">validator</a> or <a href="qml-qtquick-controls-textfield.html#inputMask-prop">inputMask</a> set on the text field, the signal will only be emitted if the input is in an acceptable state.</p>
<p>The corresponding handler is <tt>onAccepted</tt>.</p>
</div></div><!-- @@@accepted -->
<br/>
<!-- $$$editingFinished -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="editingFinished-signal"></a><span class="name">editingFinished</span>()</p></td></tr></table></div><div class="qmldoc"><p>This signal is emitted when the Return or Enter key is pressed or the text field loses focus. Note that if there is a validator or <a href="qml-qtquick-controls-textfield.html#inputMask-prop">inputMask</a> set on the text field and enter/return is pressed, this signal will only be emitted if the input follows the <a href="qml-qtquick-controls-textfield.html#inputMask-prop">inputMask</a> and the validator returns an acceptable state.</p>
<p>The corresponding handler is <tt>onEditingFinished</tt>.</p>
<p>This QML signal was introduced in QtQuick.Controls 1.1.</p>
</div></div><!-- @@@editingFinished -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$copy -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="copy-method"></a><span class="name">copy</span>()</p></td></tr></table></div><div class="qmldoc"><p>Copies the currently selected text to the system clipboard.</p>
</div></div><!-- @@@copy -->
<br/>
<!-- $$$cut -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="cut-method"></a><span class="name">cut</span>()</p></td></tr></table></div><div class="qmldoc"><p>Moves the currently selected text to the system clipboard.</p>
</div></div><!-- @@@cut -->
<br/>
<!-- $$$deselect -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="deselect-method"></a><span class="name">deselect</span>()</p></td></tr></table></div><div class="qmldoc"><p>Removes active text selection.</p>
</div></div><!-- @@@deselect -->
<br/>
<!-- $$$getText -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="getText-method"></a><span class="name">getText</span>(<i> start</i>, <i> end</i>)</p></td></tr></table></div><div class="qmldoc"><p>Removes the section of text that is between the <i>start</i> and <i>end</i> positions from the <a href="qml-qtquick-controls-textfield.html">TextField</a>.</p>
</div></div><!-- @@@getText -->
<br/>
<!-- $$$insert -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="insert-method"></a><span class="name">insert</span>(<i> position</i>, <i> text</i>)</p></td></tr></table></div><div class="qmldoc"><p>Inserts <i>text</i> into the <a href="qml-qtquick-controls-textfield.html">TextField</a> at <i>position</i>.</p>
</div></div><!-- @@@insert -->
<br/>
<!-- $$$isRightToLeft -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="isRightToLeft-method"></a><span class="name">isRightToLeft</span>(<i> start</i>, <i> end</i>)</p></td></tr></table></div><div class="qmldoc"><p>Returns <tt>true</tt> if the natural reading direction of the editor text found between positions <i>start</i> and <i>end</i> is right to left.</p>
</div></div><!-- @@@isRightToLeft -->
<br/>
<!-- $$$paste -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="paste-method"></a><span class="name">paste</span>()</p></td></tr></table></div><div class="qmldoc"><p>Replaces the currently selected text by the contents of the system clipboard.</p>
</div></div><!-- @@@paste -->
<br/>
<!-- $$$redo -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="redo-method"></a><span class="name">redo</span>()</p></td></tr></table></div><div class="qmldoc"><p>Performs the last operation if redo is <a href="qml-qtquick-controls-textfield.html#canRedo-prop">available</a>.</p>
</div></div><!-- @@@redo -->
<br/>
<!-- $$$select -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="select-method"></a><span class="name">select</span>(<i> start</i>, <i> end</i>)</p></td></tr></table></div><div class="qmldoc"><p>Causes the text from <i>start</i> to <i>end</i> to be selected.</p>
<p>If either start or end is out of range, the selection is not changed.</p>
<p>After calling select, <a href="qml-qtquick-controls-textfield.html#selectionStart-prop">selectionStart</a> will become the lesser and <a href="qml-qtquick-controls-textfield.html#selectionEnd-prop">selectionEnd</a> will become the greater (regardless of the order passed to this method).</p>
<p><b>See also </b><a href="qml-qtquick-controls-textfield.html#selectionStart-prop">selectionStart</a> and <a href="qml-qtquick-controls-textfield.html#selectionEnd-prop">selectionEnd</a>.</p>
</div></div><!-- @@@select -->
<br/>
<!-- $$$selectAll -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="selectAll-method"></a><span class="name">selectAll</span>()</p></td></tr></table></div><div class="qmldoc"><p>Causes all text to be selected.</p>
</div></div><!-- @@@selectAll -->
<br/>
<!-- $$$selectWord -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="selectWord-method"></a><span class="name">selectWord</span>()</p></td></tr></table></div><div class="qmldoc"><p>Causes the word closest to the current cursor position to be selected.</p>
</div></div><!-- @@@selectWord -->
<br/>
<!-- $$$undo -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="undo-method"></a><span class="name">undo</span>()</p></td></tr></table></div><div class="qmldoc"><p>Reverts the last operation if undo is <a href="qml-qtquick-controls-textfield.html#canUndo-prop">available</a>. undo() deselects any current selection and updates the selection start to the current cursor position.</p>
</div></div><!-- @@@undo -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2014 Digia Plc and/or its
subsidiaries. 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> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|