qtquickcontrols2-5-doc-html 5.9.5-0ubuntu2 / usr / share / qt5 / doc / qtquickcontrols2 / qml-qtquick-controls2-abstractbutton.html

This file is indexed.

/usr/share/qt5/doc/qtquickcontrols2/qml-qtquick-controls2-abstractbutton.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
<?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 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 >AbstractButton 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="#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">AbstractButton QML Type</h1>
<span class="subtitle"></span>
<!-- $$$AbstractButton-brief -->
<p>Abstract base type providing functionality common to buttons. <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 QtQuick.Controls 2.2</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  Qt 5.7</td></tr></table></div><ul>
<li><a href="qml-qtquick-controls2-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-qtquick-controls2-abstractbutton.html#autoExclusive-prop">autoExclusive</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-abstractbutton.html#checkable-prop">checkable</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-abstractbutton.html#checked-prop">checked</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-abstractbutton.html#down-prop">down</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-abstractbutton.html#indicator-prop">indicator</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-abstractbutton.html#pressed-prop">pressed</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-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-qtquick-controls2-abstractbutton.html#canceled-signal">canceled</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-abstractbutton.html#clicked-signal">clicked</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-abstractbutton.html#doubleClicked-signal">doubleClicked</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-abstractbutton.html#pressAndHold-signal">pressAndHold</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-abstractbutton.html#pressed-signal">pressed</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-abstractbutton.html#released-signal">released</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-abstractbutton.html#toggled-signal">toggled</a></b></b>()</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-abstractbutton.html#toggle-method">toggle</a></b></b>()</li>
</ul>
<!-- $$$AbstractButton-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p><a href="qml-qtquick-controls2-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><b>See also </b><a href="qml-qtquick-controls2-buttongroup.html">ButtonGroup</a> and <a href="qtquickcontrols2-buttons.html">Button Controls</a>.</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-qtquick-controls2-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 a <a href="qml-qtquick-controls2-buttongroup.html">ButtonGroup</a>.</p><p><a href="qml-qtquick-controls2-radiobutton.html">RadioButton</a> and <a href="qml-qtquick-controls2-tabbutton.html">TabButton</a> are auto-exclusive by default.</p>
</div></div><!-- @@@autoExclusive -->
<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>
<p>A checkable button toggles between checked (on) and unchecked (off) when the user clicks on it or presses the space bar while the button has active focus.</p>
<p>Setting <a href="qml-qtquick-controls2-abstractbutton.html#checked-prop">checked</a> to <code>true</code> forces this property to <code>true</code>.</p>
<p>The default value is <code>false</code>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-abstractbutton.html#checked-prop">checked</a>.</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>
<p><b>See also </b><a href="qml-qtquick-controls2-abstractbutton.html#checkable-prop">checkable</a>.</p>
</div></div><!-- @@@checked -->
<br/>
<!-- $$$down -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="down-prop">
<td class="tblQmlPropNode"><p>
<a name="down-prop"></a><span class="name">down</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the button is visually down.</p>
<p>Unless explicitly set, this property follows the value of <a href="qml-qtquick-controls2-abstractbutton.html#pressed-prop">pressed</a>. To return to the default value, set this property to <code>undefined</code>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-abstractbutton.html#pressed-prop">pressed</a>.</p>
</div></div><!-- @@@down -->
<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"><a href="../qtquick/qml-qtquick-item.html">Item</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the indicator item.</p>
</div></div><!-- @@@indicator -->
<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="qmlreadonly">[read-only] </span><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 physically pressed. A button can be pressed by either touch or key events.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-abstractbutton.html#down-prop">down</a>.</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 content item is an image.</p><p><b>See also </b><a href="qml-qtquick-controls2-control.html#contentItem-prop">contentItem</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-qtquick-controls2-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 via touch, mouse, or keyboard.</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 via touch or mouse.</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 pressed and held down by the user via touch or mouse.</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 via touch, mouse, or keyboard.</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 via touch, mouse, or keyboard.</p>
</div></div><!-- @@@released -->
<br/>
<!-- $$$toggled -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="toggled-signal">
<td class="tblQmlFuncNode"><p>
<a name="toggled-signal"></a><span class="type">void</span> <span class="name">toggled</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when a checkable button is interactively toggled by the user via touch, mouse, or keyboard.</p>
<p>This QML signal was introduced in  QtQuick.Controls 2.2 (Qt 5.9).</p>
</div></div><!-- @@@toggled -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$toggle -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="toggle-method">
<td class="tblQmlFuncNode"><p>
<a name="toggle-method"></a><span class="type">void</span> <span class="name">toggle</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Toggles the checked state of the button.</p>
</div></div><!-- @@@toggle -->
<br/>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</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>

APT Browse - Built by Thomas Orozco.