/usr/share/qt5/doc/qtquickcontrols/qml-qtquick-controls-button.html is in qtquickcontrols5-doc-html 5.3.2-2.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- Button.qml -->
<title>Button QML Type | QtQuickControls 5.3</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.3</li>
<li><a href="qtquickcontrols-index.html">Qt Quick Controls</a></li>
<li><a href="qtquick-controls-qmlmodule.html">QML Types</a></li>
<li>Button QML Type</li>
<li id="buildversion">
Qt 5.3.2 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<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>
<h1 class="title">Button QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Button-brief -->
<p>A push button with a text label. <a href="#details">More...</a></p>
<!-- @@@Button -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> </b><tt>import QtQuick.Controls 1.2</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="../qtquick/qml-qtquick-focusscope.html">FocusScope</a></p>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qtquick-controls-toolbutton.html">ToolButton</a>.</p>
</td></tr></table><ul>
<li><a href="qml-qtquick-controls-button-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-controls-button.html#action-prop">action</a></b></b> : Action</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-button.html#activeFocusOnPress-prop">activeFocusOnPress</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-button.html#checkable-prop">checkable</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-button.html#checked-prop">checked</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-button.html#exclusiveGroup-prop">exclusiveGroup</a></b></b> : ExclusiveGroup</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-button.html#hovered-prop">hovered</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-button.html#iconName-prop">iconName</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-button.html#iconSource-prop">iconSource</a></b></b> : url</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-button.html#isDefault-prop">isDefault</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-button.html#menu-prop">menu</a></b></b> : Menu</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-button.html#pressed-prop">pressed</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-button.html#style-prop">style</a></b></b> : Component</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-button.html#text-prop">text</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-controls-button.html#tooltip-prop">tooltip</a></b></b> : string</li>
</ul>
<a name="signals"></a>
<h2>Signals</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-controls-button.html#clicked-signal">clicked</a></b></b>()</li>
</ul>
<!-- $$$Button-description -->
<a name="details"></a>
<h2>Detailed Description</h2>
<p class="centerAlign"><img src="images/button.png" alt="" /></p><p>The push button is perhaps the most commonly used widget in any graphical user interface. Pushing (or clicking) a button commands the computer to perform some action or answer a question. Common examples of buttons are OK, Apply, Cancel, Close, Yes, No, and Help buttons.</p>
<pre class="qml"><span class="type">Button</span> {
<span class="name">text</span>: <span class="string">"Button"</span>
}</pre>
<p>Button is similar to the <a href="../qtwidgets/qpushbutton.html">QPushButton</a> widget.</p>
<p>You can create a custom appearance for a Button by assigning a <a href="qml-qtquick-controls-styles-buttonstyle.html">ButtonStyle</a>.</p>
<!-- @@@Button -->
<h2>Property Documentation</h2>
<!-- $$$action -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="action-prop"></a><span class="name">action</span> : <span class="type"><a href="qml-qtquick-controls-action.html">Action</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the associated button action.</p>
<p>If a button has an action associated, the action defines the button's properties like checked, text, tooltip etc.</p>
<p>When an action is set, it's still possible to override the <a href="../qtwidgets/text.html">text</a>, <a href="qml-qtquick-controls-private-basicbutton.html#tooltip-prop">tooltip</a>, <a href="qml-qtquick-controls-private-basicbutton.html#iconSource-prop">iconSource</a>, and <a href="qml-qtquick-controls-private-basicbutton.html#iconName-prop">iconName</a> properties.</p>
<p>The default value is <tt>null</tt>.</p>
</div></div><!-- @@@action -->
<br/>
<!-- $$$activeFocusOnPress -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="activeFocusOnPress-prop"></a><span class="name">activeFocusOnPress</span> : <span class="type"><a href="../qtqml/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property specifies whether the button should gain active focus when pressed.</p>
<p>The default value is <tt>false</tt>.</p>
</div></div><!-- @@@activeFocusOnPress -->
<br/>
<!-- $$$checkable -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="checkable-prop"></a><span class="name">checkable</span> : <span class="type"><a href="../qtqml/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds whether the button is checkable.</p>
<p>The default value is <tt>false</tt>.</p>
</div></div><!-- @@@checkable -->
<br/>
<!-- $$$checked -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="checked-prop"></a><span class="name">checked</span> : <span class="type"><a href="../qtqml/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds whether the button is checked.</p>
<p>Only checkable buttons can be checked.</p>
<p>The default value is <tt>false</tt>.</p>
</div></div><!-- @@@checked -->
<br/>
<!-- $$$exclusiveGroup -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="exclusiveGroup-prop"></a><span class="name">exclusiveGroup</span> : <span class="type"><a href="qml-qtquick-controls-exclusivegroup.html">ExclusiveGroup</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the <a href="qml-qtquick-controls-exclusivegroup.html">ExclusiveGroup</a> that the button belongs to.</p>
<p>The default value is <tt>null</tt>.</p>
</div></div><!-- @@@exclusiveGroup -->
<br/>
<!-- $$$hovered -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="hovered-prop"></a><span class="qmlreadonly">read-only</span><span class="name">hovered</span> : <span class="type"><a href="../qtqml/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property indicates whether the control is being hovered.</p>
</div></div><!-- @@@hovered -->
<br/>
<!-- $$$iconName -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="iconName-prop"></a><span class="name">iconName</span> : <span class="type"><a href="../qtqml/qml-string.html">string</a></span></p></td></tr></table></div><div class="qmldoc"><p>The image label source as theme name. When an icon from the platform icon theme is found, this takes precedence over <a href="qml-qtquick-controls-private-basicbutton.html#iconSource-prop">iconSource</a>.</p>
</div></div><!-- @@@iconName -->
<br/>
<!-- $$$iconSource -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="iconSource-prop"></a><span class="name">iconSource</span> : <span class="type"><a href="../qtqml/qml-url.html">url</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the icon shown on the button. If the button has no icon, the iconSource property will be an empty string.</p>
<p>The default value is the empty string.</p>
</div></div><!-- @@@iconSource -->
<br/>
<!-- $$$isDefault -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="isDefault-prop"></a><span class="name">isDefault</span> : <span class="type"><a href="../qtqml/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds whether the push button is the default button. Default buttons decide what happens when the user presses enter in a dialog without giving a button explicit focus.</p>
<p><b>Note: </b>This property only changes the appearance of the button. The expected behavior needs to be implemented by the user.</p><p>The default value is <tt>false</tt>.</p>
</div></div><!-- @@@isDefault -->
<br/>
<!-- $$$menu -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="menu-prop"></a><span class="name">menu</span> : <span class="type"><a href="qml-qtquick-controls-menu.html">Menu</a></span></p></td></tr></table></div><div class="qmldoc"><p>Assign a <a href="qml-qtquick-controls-menu.html">Menu</a> to this property to get a pull-down menu button.</p>
<p>The default value is <tt>null</tt>.</p>
</div></div><!-- @@@menu -->
<br/>
<!-- $$$pressed -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="pressed-prop"></a><span class="qmlreadonly">read-only</span><span class="name">pressed</span> : <span class="type"><a href="../qtqml/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds whether the button is being pressed.</p>
</div></div><!-- @@@pressed -->
<br/>
<!-- $$$style -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="style-prop"></a><span class="name">style</span> : <span class="type"><a href="../qtqml/qml-qtqml-component.html">Component</a></span></p></td></tr></table></div><div class="qmldoc"><p>The style Component for this control.</p>
<p><b>See also </b><a href="qtquick-controls-styles-qmlmodule.html">Qt Quick Controls Styles QML Types</a>.</p>
</div></div><!-- @@@style -->
<br/>
<!-- $$$text -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="text-prop"></a><span class="name">text</span> : <span class="type"><a href="../qtqml/qml-string.html">string</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the text shown on the button. If the button has no text, the <a href="../qtwidgets/text.html">text</a> property will be an empty string.</p>
<p>The default value is the empty string.</p>
</div></div><!-- @@@text -->
<br/>
<!-- $$$tooltip -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="tooltip-prop"></a><span class="name">tooltip</span> : <span class="type"><a href="../qtqml/qml-string.html">string</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the button tooltip.</p>
</div></div><!-- @@@tooltip -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$clicked -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="clicked-signal"></a><span class="name">clicked</span>()</p></td></tr></table></div><div class="qmldoc"><p>This signal is emitted when the button is clicked.</p>
</div></div><!-- @@@clicked -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2014 Digia Plc and/or its
subsidiaries. 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> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|