Sophie

Sophie

distrib > Mageia > 6 > x86_64 > media > core-release > by-pkgid > 886c2ed147b4d6954d2d9fb23759f3ff > files > 197

qtquickcontrols25-doc-5.6.2-1.mga6.noarch.rpm

<?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 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 >ButtonGroup 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="#attached-properties">Attached Properties</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>An exclusive group of checkable controls. <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 Qt.labs.controls 1.0</td></tr></table></div><ul>
<li><a href="qml-qt-labs-controls-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-qt-labs-controls-buttongroup.html#buttons-prop">buttons</a></b></b> : list&lt;AbstractButton&gt;</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-buttongroup.html#current-prop">current</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-qt-labs-controls-buttongroup.html#group-attached-prop">group</a></b></b> : ButtonGroup</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qt-labs-controls-buttongroup.html#addButton-method">addButton</a></b></b>(AbstractButton <i>button</i>)</li>
<li class="fn">void <b><b><a href="qml-qt-labs-controls-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>
<p><a href="qml-qt-labs-controls-buttongroup.html">ButtonGroup</a> is a non-visual, mutually exclusive group of buttons. It is used with controls such as <a href="qml-qt-labs-controls-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-qt-labs-controls-buttongroup.html">ButtonGroup</a> is to assign a list of buttons. For example, the list of children of a positioner or a layout 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">&quot;DAB&quot;</span>)
      }

      RadioButton {
          text: qsTr(<span class="string">&quot;FM&quot;</span>)
      }

      RadioButton {
          text: qsTr(<span class="string">&quot;AM&quot;</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-qt-labs-controls-buttongroup.html#group-attached-prop">group</a> attached property.</p>
<pre class="cpp">

  ButtonGroup { id: radioGroup }

  Column {
      Label {
          text: qsTr(<span class="string">&quot;Radio:&quot;</span>)
      }

      RadioButton {
          checked: <span class="keyword">true</span>
          text: qsTr(<span class="string">&quot;DAB&quot;</span>)
          ButtonGroup<span class="operator">.</span>group: radioGroup
      }

      RadioButton {
          text: qsTr(<span class="string">&quot;FM&quot;</span>)
          ButtonGroup<span class="operator">.</span>group: radioGroup
      }

      RadioButton {
          text: qsTr(<span class="string">&quot;AM&quot;</span>)
          ButtonGroup<span class="operator">.</span>group: radioGroup
      }
  }

</pre>
<p>More advanced use cases can be handled using the <a href="qml-qt-labs-controls-buttongroup.html#addButton-method">addButton()</a> and <a href="qml-qt-labs-controls-buttongroup.html#removeButton-method">removeButton()</a> methods.</p>
<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-radiobutton.html">RadioButton</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>&lt;<span class="type"><a href="qml-qt-labs-controls-abstractbutton.html">AbstractButton</a></span>&gt;</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">&quot;Option A&quot;</span>)
      }

      RadioButton {
          text: qsTr(<span class="string">&quot;Option B&quot;</span>)
      }
  }

</pre>
<p><b>See also </b><a href="qml-qt-labs-controls-buttongroup.html#group-attached-prop">group</a>.</p>
</div></div><!-- @@@buttons -->
<br/>
<!-- $$$current -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="current-prop">
<td class="tblQmlPropNode"><p>
<a name="current-prop"></a><span class="name">current</span> : <span class="type"><a href="qml-qt-labs-controls-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><!-- @@@current -->
<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-qt-labs-controls-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">&quot;Option A&quot;</span>)
      ButtonGroup<span class="operator">.</span>group: group
  }

  RadioButton {
      text: qsTr(<span class="string">&quot;Option B&quot;</span>)
      ButtonGroup<span class="operator">.</span>group: group
  }

</pre>
<p><b>See also </b><a href="qml-qt-labs-controls-buttongroup.html#buttons-prop">buttons</a>.</p>
</div></div><!-- @@@group -->
<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-qt-labs-controls-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-qt-labs-controls-buttongroup.html#buttons-prop">buttons</a> property and the <a href="qml-qt-labs-controls-buttongroup.html#group-attached-prop">group</a> attached property provide a convenient and declarative syntax.</p><p><b>See also </b><a href="qml-qt-labs-controls-buttongroup.html#buttons-prop">buttons</a> and <a href="qml-qt-labs-controls-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-qt-labs-controls-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-qt-labs-controls-buttongroup.html#buttons-prop">buttons</a> property and the <a href="qml-qt-labs-controls-buttongroup.html#group-attached-prop">group</a> attached property provide a convenient and declarative syntax.</p><p><b>See also </b><a href="qml-qt-labs-controls-buttongroup.html#buttons-prop">buttons</a> and <a href="qml-qt-labs-controls-buttongroup.html#group-attached-prop">group</a>.</p>
</div></div><!-- @@@removeButton -->
<br/>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</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>