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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickbutton.cpp -->
<title>Button QML Type | Qt Quick Controls 2 5.11</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 ><a href="../qtdoc/index.html">Qt 5.11</a></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 >Button QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.11.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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Button QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Button-brief -->
<p>Push-button that can be clicked to perform a command or answer a question. <a href="#details">More...</a></p>
<!-- @@@Button -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick.Controls 2.4</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="qml-qtquick-controls2-abstractbutton.html">AbstractButton</a></p>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qtquick-controls2-roundbutton.html">RoundButton</a> and <a href="qml-qtquick-controls2-toolbutton.html">ToolButton</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qtquick-controls2-button-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-button.html#flat-prop">flat</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-button.html#highlighted-prop">highlighted</a></b></b> : bool</li>
</ul>
<!-- $$$Button-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p class="centerAlign"><img src="images/qtquickcontrols2-button.gif" alt="" /></p><p>Button presents a push-button control that can be pushed or clicked by the user. Buttons are normally used to perform an action, or to answer a question. Typical buttons are <i>OK</i>, <i>Apply</i>, <i>Cancel</i>, <i>Close</i>, <i>Yes</i>, <i>No</i>, and <i>Help</i>.</p>
<p>Button inherits its API from <a href="qml-qtquick-controls2-abstractbutton.html">AbstractButton</a>. For instance, you can set <a href="qml-qtquick-controls2-abstractbutton.html#text-prop">text</a>, display an <a href="qtquickcontrols2-icons.html">icon</a>, and react to <a href="qml-qtquick-controls2-abstractbutton.html#clicked-signal">clicks</a> using the <a href="qml-qtquick-controls2-abstractbutton.html">AbstractButton</a> API.</p>
<p>A button emits the signal <a href="qml-qtquick-controls2-abstractbutton.html#clicked-signal">clicked()</a> when it is activated by the user. Connect to this signal to perform the button's action. Buttons also provide the signals <a href="qml-qtquick-controls2-abstractbutton.html#canceled-signal">canceled()</a>, <a href="qml-qtquick-controls2-abstractbutton.html#doubleClicked-signal">doubleClicked()</a>, <a href="qml-qtquick-controls2-abstractbutton.html#pressed-signal">pressed()</a>, <a href="qml-qtquick-controls2-abstractbutton.html#released-signal">released()</a> and <a href="qml-qtquick-controls2-abstractbutton.html#pressAndHold-signal">pressAndHold()</a> for long presses.</p>
<p>See the snippet below on how to connect to the button's signals.</p>
<pre class="cpp">
RowLayout {
Button {
text: <span class="string">"Ok"</span>
onClicked: model<span class="operator">.</span>submit()
}
Button {
text: <span class="string">"Cancel"</span>
onClicked: model<span class="operator">.</span>revert()
}
}
</pre>
<p><b>See also </b><a href="qtquickcontrols2-customize.html#customizing-button">Customizing Button</a> and <a href="qtquickcontrols2-buttons.html">Button Controls</a>.</p>
<!-- @@@Button -->
<h2>Property Documentation</h2>
<!-- $$$flat -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="flat-prop">
<td class="tblQmlPropNode"><p>
<a name="flat-prop"></a><span class="name">flat</span> : <span class="type"><a href="../qtqml/qml-bool.html">bool</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the button is flat.</p>
<p class="centerAlign"><img src="images/qtquickcontrols2-button-flat.gif" alt="" /></p><p>A flat button typically does not draw a background unless it is pressed or checked.</p>
<p>The default value is <code>false</code>.</p>
</div></div><!-- @@@flat -->
<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"><a href="../qtqml/qml-bool.html">bool</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the button is highlighted.</p>
<p class="centerAlign"><img src="images/qtquickcontrols2-button-highlighted.gif" alt="" /></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/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2018 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>