<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qquickcheckbox.cpp --> <title>CheckBox 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 >CheckBox 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="#details">Detailed Description</a></li> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">CheckBox QML Type</h1> <span class="subtitle"></span> <!-- $$$CheckBox-brief --> <p>A check box control. <a href="#details">More...</a></p> <!-- @@@CheckBox --> <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><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qt-labs-controls-abstractbutton.html">AbstractButton</a></p> </td></tr></table></div><ul> <li><a href="qml-qt-labs-controls-checkbox-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-checkbox.html#checkState-prop">checkState</a></b></b> : enumeration</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-checkbox.html#tristate-prop">tristate</a></b></b> : bool</li> </ul> <!-- $$$CheckBox-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> </p> <p><a href="qml-qt-labs-controls-checkbox.html">CheckBox</a> presents an option button that can be toggled on (checked) or off (unchecked). Check boxes are typically used to select one or more options from a set of options.</p> <div class="table"><table class="generic"> <tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/qtlabscontrols-checkbox-normal.png" alt="" /></p></td><td >A check box in its normal state.</td></tr> <tr valign="top" class="even"><td ><p class="centerAlign"><img src="images/qtlabscontrols-checkbox-checked.png" alt="" /></p></td><td >A check box that is checked.</td></tr> <tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/qtlabscontrols-checkbox-focused.png" alt="" /></p></td><td >A check box that has active focus.</td></tr> <tr valign="top" class="even"><td ><p class="centerAlign"><img src="images/qtlabscontrols-checkbox-disabled.png" alt="" /></p></td><td >A check box that is disabled.</td></tr> </table></div> <pre class="cpp"> ColumnLayout { CheckBox { checked: <span class="keyword">true</span> text: qsTr(<span class="string">"First"</span>) } CheckBox { text: qsTr(<span class="string">"Second"</span>) } CheckBox { checked: <span class="keyword">true</span> text: qsTr(<span class="string">"Third"</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="qtlabscontrols-customize.html#customizing-checkbox">Customizing CheckBox</a> and <a href="qtlabscontrols-buttons.html">Button Controls</a>.</p> <!-- @@@CheckBox --> <h2>Property Documentation</h2> <!-- $$$checkState --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="checkState-prop"> <td class="tblQmlPropNode"><p> <a name="checkState-prop"></a><span class="name">checkState</span> : <span class="type">enumeration</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the check state of the checkbox.</p> <p>Available states:</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.Unchecked</code></td><td class="topAlign">The checkbox is unchecked.</td></tr> <tr><td class="topAlign"><code>Qt.PartiallyChecked</code></td><td class="topAlign">The checkbox is partially checked. This state is only used when <a href="qml-qt-labs-controls-checkbox.html#tristate-prop">tristate</a> is enabled.</td></tr> <tr><td class="topAlign"><code>Qt.Checked</code></td><td class="topAlign">The checkbox is checked.</td></tr> </table></div> <p><b>See also </b><a href="qml-qt-labs-controls-checkbox.html#tristate-prop">tristate</a> and <a href="qml-qt-labs-controls-abstractbutton.html#checked-prop">checked</a>.</p> </div></div><!-- @@@checkState --> <br/> <!-- $$$tristate --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="tristate-prop"> <td class="tblQmlPropNode"><p> <a name="tristate-prop"></a><span class="name">tristate</span> : <span class="type">bool</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds whether the checkbox is a tri-state checkbox.</p> <p>The default is <code>false</code>, i.e., the checkbox has only two states.</p> </div></div><!-- @@@tristate --> <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>