<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qquicktextfield.cpp --> <title>TextField QML Type | Qt Labs Controls 5.6</title> <link rel="stylesheet" type="text/css" href="style/offline-simple.css" /> <script type="text/javascript"> window.onload = function(){document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");}; </script> </head> <body> <div class="header" id="qtdocheader"> <div class="main"> <div class="main-rounded"> <div class="navigationbar"> <table><tr> <td >Qt 5.6</td><td ><a href="qtlabscontrols-index.html">Qt Labs Controls</a></td><td ><a href="qt-labs-controls-qmlmodule.html">QML Types</a></td><td >TextField QML Type</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right">Qt 5.6.2 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="#properties">Properties</a></li> <li class="level1"><a href="#signals">Signals</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">TextField QML Type</h1> <span class="subtitle"></span> <!-- $$$TextField-brief --> <p>A single line text input control. <a href="#details">More...</a></p> <!-- @@@TextField --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import Qt.labs.controls 1.0</td></tr></table></div><ul> <li><a href="qml-qt-labs-controls-textfield-members.html">List of all members, including inherited members</a></li> </ul> <a name="properties"></a> <h2 id="properties">Properties</h2> <ul> <li class="fn"><b><b><a href="qml-qt-labs-controls-textfield.html#background-prop">background</a></b></b> : Item</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-textfield.html#focusReason-prop">focusReason</a></b></b> : enumeration</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-textfield.html#placeholderText-prop">placeholderText</a></b></b> : string</li> </ul> <a name="signals"></a> <h2 id="signals">Signals</h2> <ul> <li class="fn">void <b><b><a href="qml-qt-labs-controls-textfield.html#pressAndHold-signal">pressAndHold</a></b></b>(MouseEvent <i>mouse</i>)</li> </ul> <!-- $$$TextField-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> </p> <p><a href="qml-qt-labs-controls-textfield.html">TextField</a> is a single line text editor. <a href="qml-qt-labs-controls-textfield.html">TextField</a> extends TextInput with a <a href="qml-qt-labs-controls-textfield.html#placeholderText-prop">placeholder text</a> functionality, and adds decoration.</p> <div class="table"><table class="generic"> <tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/qtlabscontrols-textfield-normal.png" alt="" /></p></td><td >A text field in its normal state.</td></tr> <tr valign="top" class="even"><td ><p class="centerAlign"><img src="images/qtlabscontrols-textfield-focused.png" alt="" /></p></td><td >A text field that has active focus.</td></tr> <tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/qtlabscontrols-textfield-disabled.png" alt="" /></p></td><td >A text field that is disabled.</td></tr> </table></div> <pre class="cpp"> TextField { placeholderText: qsTr(<span class="string">"Enter name"</span>) } </pre> <p><b>Note: </b><i>Types in the Qt.labs module are not guaranteed to remain compatible in future versions.</i></p><p><b>See also </b><a href="qml-qt-labs-controls-textarea.html">TextArea</a>, <a href="qtlabscontrols-customize.html#customizing-textfield">Customizing TextField</a>, and <a href="qtlabscontrols-input.html">Input Controls</a>.</p> <!-- @@@TextField --> <h2>Property Documentation</h2> <!-- $$$background --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="background-prop"> <td class="tblQmlPropNode"><p> <a name="background-prop"></a><span class="name">background</span> : <span class="type">Item</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the background item.</p> <p><b>Note: </b>If the background item has no explicit size specified, it automatically follows the control's size. In most cases, there is no need to specify width or height for a background item.</p><p><b>See also </b><a href="qtlabscontrols-customize.html#customizing-textfield">Customizing TextField</a>.</p> </div></div><!-- @@@background --> <br/> <!-- $$$focusReason --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="focusReason-prop"> <td class="tblQmlPropNode"><p> <a name="focusReason-prop"></a><span class="name">focusReason</span> : <span class="type">enumeration</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the reason of the last focus change.</p> <p><b>Note: </b>This property does not indicate whether the control has active focus, but the reason why the control either gained or lost focus.</p><div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tbldscr">Description</th></tr> <tr><td class="topAlign"><code>Qt.MouseFocusReason</code></td><td class="topAlign">A mouse action occurred.</td></tr> <tr><td class="topAlign"><code>Qt.TabFocusReason</code></td><td class="topAlign">The Tab key was pressed.</td></tr> <tr><td class="topAlign"><code>Qt.BacktabFocusReason</code></td><td class="topAlign">A Backtab occurred. The input for this may include the Shift or Control keys; e.g. Shift+Tab.</td></tr> <tr><td class="topAlign"><code>Qt.ActiveWindowFocusReason</code></td><td class="topAlign">The window system made this window either active or inactive.</td></tr> <tr><td class="topAlign"><code>Qt.PopupFocusReason</code></td><td class="topAlign">The application opened/closed a pop-up that grabbed/released the keyboard focus.</td></tr> <tr><td class="topAlign"><code>Qt.ShortcutFocusReason</code></td><td class="topAlign">The user typed a label's buddy shortcut</td></tr> <tr><td class="topAlign"><code>Qt.MenuBarFocusReason</code></td><td class="topAlign">The menu bar took focus.</td></tr> <tr><td class="topAlign"><code>Qt.OtherFocusReason</code></td><td class="topAlign">Another reason, usually application-specific.</td></tr> </table></div> <p><b>See also </b>Item::activeFocus.</p> </div></div><!-- @@@focusReason --> <br/> <!-- $$$placeholderText --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="placeholderText-prop"> <td class="tblQmlPropNode"><p> <a name="placeholderText-prop"></a><span class="name">placeholderText</span> : <span class="type">string</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the placeholder text.</p> </div></div><!-- @@@placeholderText --> <br/> <h2>Signal Documentation</h2> <!-- $$$pressAndHold --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="pressAndHold-signal"> <td class="tblQmlFuncNode"><p> <a name="pressAndHold-signal"></a><span class="type">void</span> <span class="name">pressAndHold</span>(<span class="type">MouseEvent</span> <i>mouse</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when there is a long press (the delay depends on the platform plugin). The mouse parameter provides information about the press, including the x and y position of the press, and which button is pressed.</p> </div></div><!-- @@@pressAndHold --> <br/> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2016 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>