/usr/share/qt5/doc/qtquickcontrols2/qml-qtquick-controls2-buttongroup.html is in qtquickcontrols2-5-doc-html 5.9.5-0ubuntu2.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickbuttongroup.cpp -->
<title>ButtonGroup QML Type | Qt Quick Controls 2 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="qtquickcontrols2-index.html">Qt Quick Controls 2</a></td><td ><a href="qtquick-controls2-qmlmodule.html">QML Types</a></td><td >ButtonGroup 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="#attached-properties">Attached 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">ButtonGroup QML Type</h1>
<span class="subtitle"></span>
<!-- $$$ButtonGroup-brief -->
<p>Mutually-exclusive group of checkable buttons. <a href="#details">More...</a></p>
<!-- @@@ButtonGroup -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick.Controls 2.2</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.7</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="../qtqml/qml-qtqml-qtobject.html">QtObject</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qtquick-controls2-buttongroup-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-controls2-buttongroup.html#buttons-prop">buttons</a></b></b> : list<AbstractButton></li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-buttongroup.html#checkedButton-prop">checkedButton</a></b></b> : AbstractButton</li>
</ul>
<a name="attached-properties"></a>
<h2 id="attached-properties">Attached Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-controls2-buttongroup.html#group-attached-prop">group</a></b></b> : ButtonGroup</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-buttongroup.html#clicked-signal">clicked</a></b></b>(AbstractButton <i>button</i>)</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-buttongroup.html#addButton-method">addButton</a></b></b>(AbstractButton <i>button</i>)</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-buttongroup.html#removeButton-method">removeButton</a></b></b>(AbstractButton <i>button</i>)</li>
</ul>
<!-- $$$ButtonGroup-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p><a href="qml-qtquick-controls2-buttongroup.html">ButtonGroup</a> is a non-visual, mutually exclusive group of buttons. It is used with controls such as <a href="qml-qtquick-controls2-radiobutton.html">RadioButton</a>, where only one of the options can be selected at a time.</p>
<p>The most straight-forward way to use <a href="qml-qtquick-controls2-buttongroup.html">ButtonGroup</a> is to assign a list of buttons. For example, the list of children of a <a href="../qtquick/qtquick-positioning-layouts.html">positioner</a> or a <a href="../qtquick/qtquicklayouts-index.html">layout</a> that manages a group of mutually exclusive buttons.</p>
<pre class="cpp">
ButtonGroup {
buttons: column<span class="operator">.</span>children
}
Column {
id: column
RadioButton {
checked: <span class="keyword">true</span>
text: qsTr(<span class="string">"DAB"</span>)
}
RadioButton {
text: qsTr(<span class="string">"FM"</span>)
}
RadioButton {
text: qsTr(<span class="string">"AM"</span>)
}
}
</pre>
<p>Mutually exclusive buttons do not always share the same parent item, or the parent layout may sometimes contain items that should not be included in the button group. Such cases are best handled using the <a href="qml-qtquick-controls2-buttongroup.html#group-attached-prop">group</a> attached property.</p>
<pre class="cpp">
ButtonGroup { id: radioGroup }
Column {
Label {
text: qsTr(<span class="string">"Radio:"</span>)
}
RadioButton {
checked: <span class="keyword">true</span>
text: qsTr(<span class="string">"DAB"</span>)
ButtonGroup<span class="operator">.</span>group: radioGroup
}
RadioButton {
text: qsTr(<span class="string">"FM"</span>)
ButtonGroup<span class="operator">.</span>group: radioGroup
}
RadioButton {
text: qsTr(<span class="string">"AM"</span>)
ButtonGroup<span class="operator">.</span>group: radioGroup
}
}
</pre>
<p>More advanced use cases can be handled using the <code>addButton()</code> and <code>removeButton()</code> methods.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-radiobutton.html">RadioButton</a> and <a href="qtquickcontrols2-buttons.html">Button Controls</a>.</p>
<!-- @@@ButtonGroup -->
<h2>Property Documentation</h2>
<!-- $$$buttons -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="buttons-prop">
<td class="tblQmlPropNode"><p>
<a name="buttons-prop"></a><span class="qmldefault">[default] </span><span class="name">buttons</span> : <span class="type">list</span><<span class="type"><a href="qml-qtquick-controls2-abstractbutton.html">AbstractButton</a></span>></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the list of buttons.</p>
<pre class="cpp">
ButtonGroup {
buttons: column<span class="operator">.</span>children
}
Column {
id: column
RadioButton {
checked: <span class="keyword">true</span>
text: qsTr(<span class="string">"Option A"</span>)
}
RadioButton {
text: qsTr(<span class="string">"Option B"</span>)
}
}
</pre>
<p><b>See also </b><a href="qml-qtquick-controls2-buttongroup.html#group-attached-prop">group</a>.</p>
</div></div><!-- @@@buttons -->
<br/>
<!-- $$$checkedButton -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="checkedButton-prop">
<td class="tblQmlPropNode"><p>
<a name="checkedButton-prop"></a><span class="name">checkedButton</span> : <span class="type"><a href="qml-qtquick-controls2-abstractbutton.html">AbstractButton</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the currently selected button, or <code>null</code> if there is none.</p>
<p>By default, it is the first checked button added to the button group.</p>
</div></div><!-- @@@checkedButton -->
<br/>
<h2>Attached Property Documentation</h2>
<!-- $$$group -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="group-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="group-attached-prop"></a><span class="name">ButtonGroup.group</span> : <span class="type"><a href="qml-qtquick-controls2-buttongroup.html">ButtonGroup</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property attaches a button to a button group.</p>
<pre class="cpp">
ButtonGroup { id: group }
RadioButton {
checked: <span class="keyword">true</span>
text: qsTr(<span class="string">"Option A"</span>)
ButtonGroup<span class="operator">.</span>group: group
}
RadioButton {
text: qsTr(<span class="string">"Option B"</span>)
ButtonGroup<span class="operator">.</span>group: group
}
</pre>
<p><b>See also </b><a href="qml-qtquick-controls2-buttongroup.html#buttons-prop">buttons</a>.</p>
</div></div><!-- @@@group -->
<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="type">void</span> <span class="name">clicked</span>(<span class="type"><a href="qml-qtquick-controls2-abstractbutton.html">AbstractButton</a></span> <i>button</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when a <i>button</i> in the group has been clicked.</p>
<p>This signal is convenient for implementing a common signal handler for all buttons in the same group.</p>
<pre class="cpp">
ButtonGroup {
buttons: column<span class="operator">.</span>children
onClicked: console<span class="operator">.</span>log(<span class="string">"clicked:"</span><span class="operator">,</span> button<span class="operator">.</span>text)
}
Column {
id: column
Button { text: <span class="string">"First"</span> }
Button { text: <span class="string">"Second"</span> }
Button { text: <span class="string">"Third"</span> }
}
</pre>
<p>This QML signal was introduced in QtQuick.Controls 2.1 (Qt 5.8).</p>
<p><b>See also </b><a href="qml-qtquick-controls2-abstractbutton.html#clicked-signal">AbstractButton::clicked()</a>.</p>
</div></div><!-- @@@clicked -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$addButton -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="addButton-method">
<td class="tblQmlFuncNode"><p>
<a name="addButton-method"></a><span class="type">void</span> <span class="name">addButton</span>(<span class="type"><a href="qml-qtquick-controls2-abstractbutton.html">AbstractButton</a></span> <i>button</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Adds a <i>button</i> to the button group.</p>
<p><b>Note: </b>Manually adding objects to a button group is typically unnecessary. The <a href="qml-qtquick-controls2-buttongroup.html#buttons-prop">buttons</a> property and the <a href="qml-qtquick-controls2-buttongroup.html#group-attached-prop">group</a> attached property provide a convenient and declarative syntax.</p><p><b>See also </b><a href="qml-qtquick-controls2-buttongroup.html#buttons-prop">buttons</a> and <a href="qml-qtquick-controls2-buttongroup.html#group-attached-prop">group</a>.</p>
</div></div><!-- @@@addButton -->
<br/>
<!-- $$$removeButton -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="removeButton-method">
<td class="tblQmlFuncNode"><p>
<a name="removeButton-method"></a><span class="type">void</span> <span class="name">removeButton</span>(<span class="type"><a href="qml-qtquick-controls2-abstractbutton.html">AbstractButton</a></span> <i>button</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Removes a <i>button</i> from the button group.</p>
<p><b>Note: </b>Manually removing objects from a button group is typically unnecessary. The <a href="qml-qtquick-controls2-buttongroup.html#buttons-prop">buttons</a> property and the <a href="qml-qtquick-controls2-buttongroup.html#group-attached-prop">group</a> attached property provide a convenient and declarative syntax.</p><p><b>See also </b><a href="qml-qtquick-controls2-buttongroup.html#buttons-prop">buttons</a> and <a href="qml-qtquick-controls2-buttongroup.html#group-attached-prop">group</a>.</p>
</div></div><!-- @@@removeButton -->
<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>
|