Sophie

Sophie

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

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" />
<!-- qquickabstractbutton.cpp -->
  <title>AbstractButton 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 >AbstractButton 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="#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">AbstractButton QML Type</h1>
<span class="subtitle"></span>
<!-- $$$AbstractButton-brief -->
<p>The base of all button controls. <a href="#details">More...</a></p>
<!-- @@@AbstractButton -->
<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-control.html">Control</a></p>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qt-labs-controls-button.html">Button</a>, <a href="qml-qt-labs-controls-checkbox.html">CheckBox</a>, <a href="qml-qt-labs-controls-itemdelegate.html">ItemDelegate</a>, <a href="qml-qt-labs-controls-radiobutton.html">RadioButton</a>, <a href="qml-qt-labs-controls-switch.html">Switch</a>, and <a href="qml-qt-labs-controls-tabbutton.html">TabButton</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qt-labs-controls-abstractbutton-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-abstractbutton.html#autoExclusive-prop">autoExclusive</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-abstractbutton.html#autoRepeat-prop">autoRepeat</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-abstractbutton.html#checkable-prop">checkable</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-abstractbutton.html#checked-prop">checked</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-abstractbutton.html#highlighted-prop">highlighted</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-abstractbutton.html#indicator-prop">indicator</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-abstractbutton.html#label-prop">label</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-abstractbutton.html#pressed-prop">pressed</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-abstractbutton.html#text-prop">text</a></b></b> : string</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qt-labs-controls-abstractbutton.html#canceled-signal">canceled</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qt-labs-controls-abstractbutton.html#clicked-signal">clicked</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qt-labs-controls-abstractbutton.html#doubleClicked-signal">doubleClicked</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qt-labs-controls-abstractbutton.html#pressAndHold-signal">pressAndHold</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qt-labs-controls-abstractbutton.html#pressed-signal">pressed</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qt-labs-controls-abstractbutton.html#released-signal">released</a></b></b>()</li>
</ul>
<!-- $$$AbstractButton-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p><a href="qml-qt-labs-controls-abstractbutton.html">AbstractButton</a> provides the interface for controls with button-like behavior; for example, push buttons and checkable controls like radio buttons and check boxes. As an abstract control, it has no delegate implementations, leaving them to the types that derive from it.</p>
<p>TODO: <a href="qml-qt-labs-controls-buttongroup.html">ButtonGroup</a> usage</p>
<p><b>Note: </b><i>Types in the Qt.labs module are not guaranteed to remain compatible in future versions.</i></p><!-- @@@AbstractButton -->
<h2>Property Documentation</h2>
<!-- $$$autoExclusive -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="autoExclusive-prop">
<td class="tblQmlPropNode"><p>
<a name="autoExclusive-prop"></a><span class="name">autoExclusive</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether auto-exclusivity is enabled.</p>
<p>If auto-exclusivity is enabled, checkable buttons that belong to the same parent item behave as if they were part of the same <a href="qml-qt-labs-controls-buttongroup.html">ButtonGroup</a>. Only one button can be checked at any time; checking another button automatically unchecks the previously checked one.</p>
<p><b>Note: </b>The property has no effect on buttons that belong to an <a href="qml-qt-labs-controls-buttongroup.html">ButtonGroup</a>.</p><p><a href="qml-qt-labs-controls-radiobutton.html">RadioButton</a> and <a href="qml-qt-labs-controls-tabbutton.html">TabButton</a> are auto-exclusive by default.</p>
</div></div><!-- @@@autoExclusive -->
<br/>
<!-- $$$autoRepeat -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="autoRepeat-prop">
<td class="tblQmlPropNode"><p>
<a name="autoRepeat-prop"></a><span class="name">autoRepeat</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the button repeats <a href="qml-qt-labs-controls-abstractbutton.html#pressed-signal">pressed()</a>, <a href="qml-qt-labs-controls-abstractbutton.html#released-signal">released()</a> and <a href="qml-qt-labs-controls-abstractbutton.html#clicked-signal">clicked()</a> signals while the button is pressed and held down.</p>
<p>The default value is <code>false</code>.</p>
</div></div><!-- @@@autoRepeat -->
<br/>
<!-- $$$checkable -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="checkable-prop">
<td class="tblQmlPropNode"><p>
<a name="checkable-prop"></a><span class="name">checkable</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the button is checkable.</p>
</div></div><!-- @@@checkable -->
<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 holds whether the button is checked.</p>
</div></div><!-- @@@checked -->
<br/>
<!-- $$$highlighted -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="highlighted-prop">
<td class="tblQmlPropNode"><p>
<a name="highlighted-prop"></a><span class="name">highlighted</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the button is highlighted.</p>
<p>A button can be highlighted in order to draw the user's attention towards it. It has no effect on keyboard interaction.</p>
<p>The default value is <code>false</code>.</p>
</div></div><!-- @@@highlighted -->
<br/>
<!-- $$$indicator -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="indicator-prop">
<td class="tblQmlPropNode"><p>
<a name="indicator-prop"></a><span class="name">indicator</span> : <span class="type">Item</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the indicator item.</p>
</div></div><!-- @@@indicator -->
<br/>
<!-- $$$label -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="label-prop">
<td class="tblQmlPropNode"><p>
<a name="label-prop"></a><span class="name">label</span> : <span class="type">Item</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the label item.</p>
<p><b>See also </b><a href="qml-qt-labs-controls-abstractbutton.html#text-prop">text</a>.</p>
</div></div><!-- @@@label -->
<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 holds whether the button is pressed.</p>
</div></div><!-- @@@pressed -->
<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 a textual description of the button.</p>
<p><b>Note: </b>The text is used for accessibility purposes, so it makes sense to set a textual description even if the label item is an image.</p><p><b>See also </b><a href="qtlabscontrols-customize.html#label">label</a>.</p>
</div></div><!-- @@@text -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$canceled -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="canceled-signal">
<td class="tblQmlFuncNode"><p>
<a name="canceled-signal"></a><span class="type">void</span> <span class="name">canceled</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the button loses mouse grab while being pressed, or when it would emit the <a href="qml-qt-labs-controls-abstractbutton.html#released-signal">released</a> signal but the mouse cursor is not inside the button.</p>
</div></div><!-- @@@canceled -->
<br/>
<!-- $$$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>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the button is interactively clicked by the user.</p>
</div></div><!-- @@@clicked -->
<br/>
<!-- $$$doubleClicked -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="doubleClicked-signal">
<td class="tblQmlFuncNode"><p>
<a name="doubleClicked-signal"></a><span class="type">void</span> <span class="name">doubleClicked</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the button is interactively double clicked by the user.</p>
</div></div><!-- @@@doubleClicked -->
<br/>
<!-- $$$pressAndHold -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="pressAndHold-signal">
<td class="tblQmlFuncNode"><p>
<a name="pressAndHold-signal"></a><span class="type">void</span> <span class="name">pressAndHold</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the button is interactively perssed and held down by the user.</p>
</div></div><!-- @@@pressAndHold -->
<br/>
<!-- $$$pressed -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="pressed-signal">
<td class="tblQmlFuncNode"><p>
<a name="pressed-signal"></a><span class="type">void</span> <span class="name">pressed</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the button is interactively pressed by the user.</p>
</div></div><!-- @@@pressed -->
<br/>
<!-- $$$released -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="released-signal">
<td class="tblQmlFuncNode"><p>
<a name="released-signal"></a><span class="type">void</span> <span class="name">released</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the button is interactively released by the user.</p>
</div></div><!-- @@@released -->
<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>