/usr/share/qt5/doc/qtquickcontrols/qml-qtquick-controls-combobox.html is in qtquickcontrols5-doc-html 5.9.5-0ubuntu1.
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 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- ComboBox.qml -->
<title>ComboBox QML Type | Qt Quick Controls 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="qtquickcontrols-index.html">Qt Quick Controls</a></td><td ><a href="qtquick-controls-qmlmodule.html">QML Types</a></td><td >ComboBox QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.5 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="#methods">Methods</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">ComboBox QML Type</h1>
<span class="subtitle"></span>
<!-- $$$ComboBox-brief -->
<p>Provides a drop-down list functionality. <a href="#details">More...</a></p>
<!-- @@@ComboBox -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick.Controls 1.4</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></div><ul>
<li><a href="qml-qtquick-controls-combobox-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-qtquick-controls-combobox.html#acceptableInput-prop">acceptableInput</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-combobox.html#activeFocusOnPress-prop">activeFocusOnPress</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-combobox.html#count-prop">count</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-combobox.html#currentIndex-prop">currentIndex</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-combobox.html#currentText-prop">currentText</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-combobox.html#editText-prop">editText</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-combobox.html#editable-prop">editable</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-combobox.html#hovered-prop">hovered</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-combobox.html#inputMethodComposing-prop">inputMethodComposing</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-combobox.html#inputMethodHints-prop">inputMethodHints</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-combobox.html#menu-prop">menu</a></b></b> : Component</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-combobox.html#model-prop">model</a></b></b> : model</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-combobox.html#pressed-prop">pressed</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-combobox.html#selectByMouse-prop">selectByMouse</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-combobox.html#style-prop">style</a></b></b> : Component</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-combobox.html#textRole-prop">textRole</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-combobox.html#validator-prop">validator</a></b></b> : Validator</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-controls-combobox.html#accepted-signal">accepted</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-combobox.html#activated-signal">activated</a></b></b>(int <i>index</i>)</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">int <b><b><a href="qml-qtquick-controls-combobox.html#find-method">find</a></b></b>(string <i>text</i>)</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls-combobox.html#selectAll-method">selectAll</a></b></b>()</li>
<li class="fn">string <b><b><a href="qml-qtquick-controls-combobox.html#textAt-method">textAt</a></b></b>(int <i>index</i>)</li>
</ul>
<!-- $$$ComboBox-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p class="centerAlign"><img src="images/combobox.png" alt="" /></p><p>Add items to the <a href="qml-qtquick-controls-combobox.html">ComboBox</a> by assigning it a <a href="../qtqml/qml-qtqml-models-listmodel.html">ListModel</a>, or a list of strings to the <a href="qml-qtquick-controls-combobox.html#model-prop">model</a> property.</p>
<pre class="qml">
<span class="type"><a href="qml-qtquick-controls-combobox.html">ComboBox</a></span> {
<span class="name">width</span>: <span class="number">200</span>
<span class="name">model</span>: [ <span class="string">"Banana"</span>, <span class="string">"Apple"</span>, <span class="string">"Coconut"</span> ]
}
</pre>
<p>In this example we are demonstrating how to use a <a href="../qtqml/qml-qtqml-models-listmodel.html">ListModel</a> with a combo box.</p>
<pre class="qml">
<span class="type"><a href="qml-qtquick-controls-combobox.html">ComboBox</a></span> {
<span class="name">currentIndex</span>: <span class="number">2</span>
<span class="name">model</span>: <span class="name">ListModel</span> {
<span class="name">id</span>: <span class="name">cbItems</span>
<span class="type"><a href="../qtqml/qml-qtqml-models-listelement.html">ListElement</a></span> { <span class="name">text</span>: <span class="string">"Banana"</span>; <span class="name">color</span>: <span class="string">"Yellow"</span> }
<span class="type"><a href="../qtqml/qml-qtqml-models-listelement.html">ListElement</a></span> { <span class="name">text</span>: <span class="string">"Apple"</span>; <span class="name">color</span>: <span class="string">"Green"</span> }
<span class="type"><a href="../qtqml/qml-qtqml-models-listelement.html">ListElement</a></span> { <span class="name">text</span>: <span class="string">"Coconut"</span>; <span class="name">color</span>: <span class="string">"Brown"</span> }
}
<span class="name">width</span>: <span class="number">200</span>
<span class="name">onCurrentIndexChanged</span>: <span class="name">console</span>.<span class="name">debug</span>(<span class="name">cbItems</span>.<span class="name">get</span>(<span class="name">currentIndex</span>).<span class="name">text</span> <span class="operator">+</span> <span class="string">", "</span> <span class="operator">+</span> <span class="name">cbItems</span>.<span class="name">get</span>(<span class="name">currentIndex</span>).<span class="name">color</span>)
}
</pre>
<p>You can make a combo box editable by setting the <a href="qml-qtquick-controls-combobox.html#editable-prop">editable</a> property. An editable combo box will autocomplete its text based on what is available in the model.</p>
<p>In the next example we demonstrate how you can append content to an editable combo box by reacting to the <a href="qml-qtquick-controls-combobox.html#accepted-signal">accepted</a> signal. Note that you have to explicitly prevent duplicates.</p>
<pre class="qml">
<span class="type"><a href="qml-qtquick-controls-combobox.html">ComboBox</a></span> {
<span class="name">editable</span>: <span class="number">true</span>
<span class="name">model</span>: <span class="name">ListModel</span> {
<span class="name">id</span>: <span class="name">model</span>
<span class="type"><a href="../qtqml/qml-qtqml-models-listelement.html">ListElement</a></span> { <span class="name">text</span>: <span class="string">"Banana"</span>; <span class="name">color</span>: <span class="string">"Yellow"</span> }
<span class="type"><a href="../qtqml/qml-qtqml-models-listelement.html">ListElement</a></span> { <span class="name">text</span>: <span class="string">"Apple"</span>; <span class="name">color</span>: <span class="string">"Green"</span> }
<span class="type"><a href="../qtqml/qml-qtqml-models-listelement.html">ListElement</a></span> { <span class="name">text</span>: <span class="string">"Coconut"</span>; <span class="name">color</span>: <span class="string">"Brown"</span> }
}
<span class="name">onAccepted</span>: {
<span class="keyword">if</span> (<span class="name">find</span>(<span class="name">currentText</span>) <span class="operator">===</span> -<span class="number">1</span>) {
<span class="name">model</span>.<span class="name">append</span>({text: <span class="name">editText</span>})
<span class="name">currentIndex</span> <span class="operator">=</span> <span class="name">find</span>(<span class="name">editText</span>)
}
}
}
</pre>
<p>You can create a custom appearance for a <a href="qml-qtquick-controls-combobox.html">ComboBox</a> by assigning a <a href="qml-qtquick-controls-styles-comboboxstyle.html">ComboBoxStyle</a>.</p>
<!-- @@@ComboBox -->
<h2>Property Documentation</h2>
<!-- $$$acceptableInput -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="acceptableInput-prop">
<td class="tblQmlPropNode"><p>
<a name="acceptableInput-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">acceptableInput</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns <code>true</code> if the combo box contains acceptable text in the editable text field.</p>
<p>If a validator was set, this property will return <code>true</code> if the current text satisfies the validator or mask as a final string (not as an intermediate string).</p>
<p>This QML property was introduced in QtQuick.Controls 1.1.</p>
<p><b>See also </b><a href="qml-qtquick-controls-combobox.html#validator-prop">validator</a> and <a href="qml-qtquick-controls-combobox.html#accepted-signal">accepted</a>.</p>
</div></div><!-- @@@acceptableInput -->
<br/>
<!-- $$$activeFocusOnPress -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="activeFocusOnPress-prop">
<td class="tblQmlPropNode"><p>
<a name="activeFocusOnPress-prop"></a><span class="name">activeFocusOnPress</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property specifies whether the combobox should gain active focus when pressed. The default value is <code>false</code>.</p>
</div></div><!-- @@@activeFocusOnPress -->
<br/>
<!-- $$$count -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="count-prop">
<td class="tblQmlPropNode"><p>
<a name="count-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">count</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the number of items in the combo box.</p>
<p>This QML property was introduced in QtQuick.Controls 1.1.</p>
</div></div><!-- @@@count -->
<br/>
<!-- $$$currentIndex -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="currentIndex-prop">
<td class="tblQmlPropNode"><p>
<a name="currentIndex-prop"></a><span class="name">currentIndex</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The index of the currently selected item in the <a href="qml-qtquick-controls-combobox.html">ComboBox</a>.</p>
<p>Setting currentIndex to <code>-1</code> will reset the selection and clear the text label. If <a href="qml-qtquick-controls-combobox.html#editable-prop">editable</a> is <code>true</code>, you may also need to manually clear <a href="qml-qtquick-controls-combobox.html#editText-prop">editText</a>.</p>
<p><b>See also </b><a href="qml-qtquick-controls-combobox.html#model-prop">model</a>.</p>
</div></div><!-- @@@currentIndex -->
<br/>
<!-- $$$currentText -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="currentText-prop">
<td class="tblQmlPropNode"><p>
<a name="currentText-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">currentText</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The text of the currently selected item in the <a href="qml-qtquick-controls-combobox.html">ComboBox</a>.</p>
<p><b>Note: </b>Since <code>currentText</code> depends on <code>currentIndex</code>, there's no way to ensure <code>currentText</code> will be up to date whenever a <code>onCurrentIndexChanged</code> handler is called.</p></div></div><!-- @@@currentText -->
<br/>
<!-- $$$editText -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="editText-prop">
<td class="tblQmlPropNode"><p>
<a name="editText-prop"></a><span class="name">editText</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property specifies text being manipulated by the user for an editable combo box.</p>
<p>This QML property was introduced in QtQuick.Controls 1.1.</p>
</div></div><!-- @@@editText -->
<br/>
<!-- $$$editable -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="editable-prop">
<td class="tblQmlPropNode"><p>
<a name="editable-prop"></a><span class="name">editable</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the combo box can be edited by the user. The default value is <code>false</code>.</p>
<p>This QML property was introduced in QtQuick.Controls 1.1.</p>
</div></div><!-- @@@editable -->
<br/>
<!-- $$$hovered -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="hovered-prop">
<td class="tblQmlPropNode"><p>
<a name="hovered-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">hovered</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property indicates whether the control is being hovered.</p>
</div></div><!-- @@@hovered -->
<br/>
<!-- $$$inputMethodComposing -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="inputMethodComposing-prop">
<td class="tblQmlPropNode"><p>
<a name="inputMethodComposing-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">inputMethodComposing</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether an editable <a href="qml-qtquick-controls-combobox.html">ComboBox</a> has partial text input from an input method.</p>
<p>While it is composing an input method may rely on mouse or key events from the <a href="qml-qtquick-controls-combobox.html">ComboBox</a> to edit or commit the partial text. This property can be used to determine when to disable events handlers that may interfere with the correct operation of an input method.</p>
<p>This QML property was introduced in QtQuick.Controls 1.3.</p>
</div></div><!-- @@@inputMethodComposing -->
<br/>
<!-- $$$inputMethodHints -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="inputMethodHints-prop">
<td class="tblQmlPropNode"><p>
<a name="inputMethodHints-prop"></a><span class="name">inputMethodHints</span> : <span class="type">enumeration</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Provides hints to the input method about the expected content of the combo box and how it should operate.</p>
<p>The value is a bit-wise combination of flags or <code>Qt.ImhNone</code> if no hints are set.</p>
<p>Flags that alter behavior are:</p>
<ul>
<li>Qt.ImhHiddenText - Characters should be hidden, as is typically used when entering passwords.</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 - Upper case letters are preferred (but not required).</li>
<li>Qt.ImhPreferLowercase - Lower case letters are preferred (but not required).</li>
<li>Qt.ImhNoPredictiveText - Do not use predictive text (i.e. 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 upper case letter input is allowed.</li>
<li>Qt.ImhLowercaseOnly - Only lower case 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>
<p>This QML property was introduced in QtQuick.Controls 1.5.</p>
</div></div><!-- @@@inputMethodHints -->
<br/>
<!-- $$$menu -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="menu-prop">
<td class="tblQmlPropNode"><p>
<a name="menu-prop"></a><span class="name">menu</span> : <span class="type"><a href="../qtqml/qml-qtqml-component.html">Component</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property contains the edit <a href="qml-qtquick-controls-menu.html">Menu</a> for working with text selection. Set it to <code>null</code> if no menu is wanted.</p>
<p><b>Note: </b>The menu is only in use when <a href="qml-qtquick-controls-combobox.html#editable-prop">editable</a> is <code>true</code></p><p>This QML property was introduced in QtQuick.Controls 1.3.</p>
</div></div><!-- @@@menu -->
<br/>
<!-- $$$model -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="model-prop">
<td class="tblQmlPropNode"><p>
<a name="model-prop"></a><span class="name">model</span> : <span class="type"><a href="qml-qtquick-controls-combobox.html#model-prop">model</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The model to populate the <a href="qml-qtquick-controls-combobox.html">ComboBox</a> from.</p>
<p>Changing the model after initialization will reset <a href="qml-qtquick-controls-combobox.html#currentIndex-prop">currentIndex</a> to <code>0</code>.</p>
</div></div><!-- @@@model -->
<br/>
<!-- $$$pressed -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="pressed-prop">
<td class="tblQmlPropNode"><p>
<a name="pressed-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">pressed</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the button is being pressed.</p>
</div></div><!-- @@@pressed -->
<br/>
<!-- $$$selectByMouse -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="selectByMouse-prop">
<td class="tblQmlPropNode"><p>
<a name="selectByMouse-prop"></a><span class="name">selectByMouse</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property determines if the user can select the text in the editable text field with the mouse.</p>
<p>The default value is <code>true</code>.</p>
<p>This QML property was introduced in QtQuick.Controls 1.3.</p>
</div></div><!-- @@@selectByMouse -->
<br/>
<!-- $$$style -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="style-prop">
<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><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/>
<!-- $$$textRole -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="textRole-prop">
<td class="tblQmlPropNode"><p>
<a name="textRole-prop"></a><span class="name">textRole</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The model role used for populating the <a href="qml-qtquick-controls-combobox.html">ComboBox</a>.</p>
</div></div><!-- @@@textRole -->
<br/>
<!-- $$$validator -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="validator-prop">
<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><div class="qmldoc"><p>Allows you to set a text validator for an editable <a href="qml-qtquick-controls-combobox.html">ComboBox</a>. When a validator is set, the text field 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 field:</p>
<p><b>Note: </b>This property is only applied when <a href="qml-qtquick-controls-combobox.html#editable-prop">editable</a> is <code>true</code></p><pre class="qml">
import QtQuick 2.2
import QtQuick.Controls 1.2
<span class="type"><a href="qml-qtquick-controls-combobox.html">ComboBox</a></span> {
<span class="name">editable</span>: <span class="number">true</span>
<span class="name">model</span>: <span class="number">10</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">10</span>;}
<span class="name">focus</span>: <span class="number">true</span>
}
</pre>
<p>This QML property was introduced in QtQuick.Controls 1.1.</p>
<p><b>See also </b><a href="qml-qtquick-controls-combobox.html#acceptableInput-prop">acceptableInput</a>, <a href="qml-qtquick-controls-combobox.html#accepted-signal">accepted</a>, and <a href="qml-qtquick-controls-combobox.html#editable-prop">editable</a>.</p>
</div></div><!-- @@@validator -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$accepted -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="accepted-signal">
<td class="tblQmlFuncNode"><p>
<a name="accepted-signal"></a><span class="name">accepted</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the Return or Enter key is pressed on an <a href="qml-qtquick-controls-combobox.html#editable-prop">editable</a> combo box. If the confirmed string is not currently in the model, the <a href="qml-qtquick-controls-combobox.html#currentIndex-prop">currentIndex</a> will be set to -1 and the <a href="qml-qtquick-controls-combobox.html#currentText-prop">currentText</a> will be updated accordingly.</p>
<p><b>Note: </b>If there is a <a href="qml-qtquick-controls-combobox.html#validator-prop">validator</a> set on the combobox, the signal will only be emitted if the input is in an acceptable state.</p><p>The corresponding handler is <code>onAccepted</code>.</p>
<p>This QML signal was introduced in QtQuick.Controls 1.1.</p>
</div></div><!-- @@@accepted -->
<br/>
<!-- $$$activated -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="activated-signal">
<td class="tblQmlFuncNode"><p>
<a name="activated-signal"></a><span class="name">activated</span>(<span class="type">int</span> <i>index</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is similar to <a href="qml-qtquick-controls-combobox.html#currentIndex-prop">currentIndex</a> changed, but will only be emitted if the combo box index was changed by the user, not when set programmatically.</p>
<p><i>index</i> is the activated model index, or <code>-1</code> if a new string is accepted.</p>
<p>The corresponding handler is <code>onActivated</code>.</p>
<p>This QML signal was introduced in QtQuick.Controls 1.1.</p>
</div></div><!-- @@@activated -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$find -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="find-method">
<td class="tblQmlFuncNode"><p>
<a name="find-method"></a><span class="type">int</span> <span class="name">find</span>(<span class="type">string</span> <i>text</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Finds and returns the index of a given <i>text</i> If no match is found, <code>-1</code> is returned. The search is case sensitive.</p>
<p>This QML method was introduced in QtQuick.Controls 1.1.</p>
</div></div><!-- @@@find -->
<br/>
<!-- $$$selectAll -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="selectAll-method">
<td class="tblQmlFuncNode"><p>
<a name="selectAll-method"></a><span class="type">void</span> <span class="name">selectAll</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Causes all <a href="qml-qtquick-controls-combobox.html#editText-prop">editText</a> to be selected.</p>
<p>This QML method was introduced in QtQuick.Controls 1.1.</p>
</div></div><!-- @@@selectAll -->
<br/>
<!-- $$$textAt -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="textAt-method">
<td class="tblQmlFuncNode"><p>
<a name="textAt-method"></a><span class="type">string</span> <span class="name">textAt</span>(<span class="type">int</span> <i>index</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns the text for a given <i>index</i>. If an invalid index is provided, <code>null</code> is returned</p>
<p>This QML method was introduced in QtQuick.Controls 1.1.</p>
</div></div><!-- @@@textAt -->
<br/>
</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>
|