/usr/share/qt5/doc/qtquickcontrols/qml-qtquick-controls-checkbox.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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- CheckBox.qml -->
<title>CheckBox 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 >CheckBox 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="#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 checkbox with a text label. <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 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-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-qtquick-controls-checkbox.html#activeFocusOnPress-prop">activeFocusOnPress</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-checkbox.html#checked-prop">checked</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-checkbox.html#checkedState-prop">checkedState</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-checkbox.html#exclusiveGroup-prop">exclusiveGroup</a></b></b> : ExclusiveGroup</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-checkbox.html#hovered-prop">hovered</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-checkbox.html#partiallyCheckedEnabled-prop">partiallyCheckedEnabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-checkbox.html#pressed-prop">pressed</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-checkbox.html#style-prop">style</a></b></b> : Component</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-checkbox.html#text-prop">text</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-checkbox.html#tooltip-prop">tooltip</a></b></b> : string</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-controls-checkbox.html#clicked-signal">clicked</a></b></b>()</li>
</ul>
<!-- $$$CheckBox-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p class="centerAlign"><img src="images/checkbox.png" alt="" /></p><p>A <a href="qml-qtquick-controls-checkbox.html">CheckBox</a> is an option button that can be toggled on (checked) or off (unchecked). Checkboxes are typically used to represent features in an application that can be enabled or disabled without affecting others.</p>
<p>The state of the checkbox can be set with the <a href="qml-qtquick-controls-checkbox.html#checked-prop">checked</a> property.</p>
<p>In addition to the checked and unchecked states, there is a third state: partially checked. This state indicates that the regular checked/unchecked state can not be determined; generally because of other states that affect the checkbox. This state is useful when several child nodes are selected in a treeview, for example.</p>
<p>The partially checked state can be made available to the user by setting <a href="qml-qtquick-controls-checkbox.html#partiallyCheckedEnabled-prop">partiallyCheckedEnabled</a> to <code>true</code>, or set directly by setting <a href="qml-qtquick-controls-checkbox.html#checkedState-prop">checkedState</a> to <code>Qt.PartiallyChecked</code>. <a href="qml-qtquick-controls-checkbox.html#checkedState-prop">checkedState</a> behaves identically to <a href="qml-qtquick-controls-checkbox.html#checked-prop">checked</a> when <a href="qml-qtquick-controls-checkbox.html#partiallyCheckedEnabled-prop">partiallyCheckedEnabled</a> is <code>false</code>; setting one will appropriately set the other.</p>
<p>The label is shown next to the checkbox, and you can set the label text using its <a href="qml-qtquick-controls-checkbox.html#text-prop">text</a> property.</p>
<pre class="qml">
<span class="type"><a href="../qtquick/qml-qtquick-column.html">Column</a></span> {
<span class="type"><a href="qml-qtquick-controls-checkbox.html">CheckBox</a></span> {
<span class="name">text</span>: <span class="name">qsTr</span>(<span class="string">"Breakfast"</span>)
<span class="name">checked</span>: <span class="number">true</span>
}
<span class="type"><a href="qml-qtquick-controls-checkbox.html">CheckBox</a></span> {
<span class="name">text</span>: <span class="name">qsTr</span>(<span class="string">"Lunch"</span>)
}
<span class="type"><a href="qml-qtquick-controls-checkbox.html">CheckBox</a></span> {
<span class="name">text</span>: <span class="name">qsTr</span>(<span class="string">"Dinner"</span>)
<span class="name">checked</span>: <span class="number">true</span>
}
}
</pre>
<p>Whenever a <a href="qml-qtquick-controls-checkbox.html">CheckBox</a> is clicked, it emits the <a href="qml-qtquick-controls-checkbox.html#clicked-signal">clicked()</a> signal.</p>
<p>You can create a custom appearance for a <a href="qml-qtquick-controls-checkbox.html">CheckBox</a> by assigning a <a href="qml-qtquick-controls-styles-checkboxstyle.html">CheckBoxStyle</a>.</p>
<!-- @@@CheckBox -->
<h2>Property Documentation</h2>
<!-- $$$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 is <code>true</code> if the control takes the focus when it is pressed; <a href="../qtquick/qquickitem.html#forceActiveFocus">forceActiveFocus()</a> will be called on the control.</p>
</div></div><!-- @@@activeFocusOnPress -->
<br/>
<!-- $$$checked -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="checked-prop">
<td class="tblQmlPropNode"><p>
<a name="checked-prop"></a><span class="name">checked</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property is <code>true</code> if the control is checked.</p>
</div></div><!-- @@@checked -->
<br/>
<!-- $$$checkedState -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="checkedState-prop">
<td class="tblQmlPropNode"><p>
<a name="checkedState-prop"></a><span class="name">checkedState</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property indicates the current checked state of the checkbox.</p>
<p>Possible values: <code>Qt.UnChecked</code> - The checkbox is not checked (default). <code>Qt.Checked</code> - The checkbox is checked. <code>Qt.PartiallyChecked</code> - The checkbox is in a partially checked (or "mixed") state.</p>
<p>The <a href="qml-qtquick-controls-checkbox.html#checked-prop">checked</a> property also determines whether this property is <code>Qt.Checked</code> or <code>Qt.UnChecked</code>, and vice versa.</p>
</div></div><!-- @@@checkedState -->
<br/>
<!-- $$$exclusiveGroup -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="exclusiveGroup-prop">
<td class="tblQmlPropNode"><p>
<a name="exclusiveGroup-prop"></a><span class="name">exclusiveGroup</span> : <span class="type"><a href="qml-qtquick-controls-exclusivegroup.html">ExclusiveGroup</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property stores the <a href="qml-qtquick-controls-exclusivegroup.html">ExclusiveGroup</a> that the control belongs to.</p>
</div></div><!-- @@@exclusiveGroup -->
<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/>
<!-- $$$partiallyCheckedEnabled -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="partiallyCheckedEnabled-prop">
<td class="tblQmlPropNode"><p>
<a name="partiallyCheckedEnabled-prop"></a><span class="name">partiallyCheckedEnabled</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property determines whether the <code>Qt.PartiallyChecked</code> state is available.</p>
<p>A checkbox may be in a partially checked state when the regular checked state can not be determined.</p>
<p>Setting <a href="qml-qtquick-controls-checkbox.html#checkedState-prop">checkedState</a> to <code>Qt.PartiallyChecked</code> will implicitly set this property to <code>true</code>.</p>
<p>If this property is <code>true</code>, <a href="qml-qtquick-controls-checkbox.html#checked-prop">checked</a> will be <code>false</code>.</p>
<p>By default, this property is <code>false</code>.</p>
</div></div><!-- @@@partiallyCheckedEnabled -->
<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="name">pressed</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property is <code>true</code> if the control is being pressed. Set this property to manually invoke a mouse click.</p>
</div></div><!-- @@@pressed -->
<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/>
<!-- $$$text -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="text-prop">
<td class="tblQmlPropNode"><p>
<a name="text-prop"></a><span class="name">text</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the text that the label should display.</p>
</div></div><!-- @@@text -->
<br/>
<!-- $$$tooltip -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="tooltip-prop">
<td class="tblQmlPropNode"><p>
<a name="tooltip-prop"></a><span class="name">tooltip</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the button tooltip.</p>
<p>This QML property was introduced in QtQuick.Controls 1.7.</p>
</div></div><!-- @@@tooltip -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$clicked -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="clicked-signal">
<td class="tblQmlFuncNode"><p>
<a name="clicked-signal"></a><span class="name">clicked</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Emitted whenever the control is clicked.</p>
</div></div><!-- @@@clicked -->
<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>
|