/usr/share/qt5/doc/qtquickextras/qml-qtquick-extras-gauge.html is in qtquickcontrols5-doc-html 5.9.5-0ubuntu1.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- Gauge.qml -->
<title>Gauge QML Type | Qt Quick Extras 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="qtquickextras-index.html">Qt Quick Extras</a></td><td ><a href="qtquick-extras-qmlmodule.html">QML Types</a></td><td >Gauge 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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Gauge QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Gauge-brief -->
<p>A straight gauge that displays a value within a range. <a href="#details">More...</a></p>
<!-- @@@Gauge -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick.Extras 1.4</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.5</td></tr></table></div><ul>
<li><a href="qml-qtquick-extras-gauge-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-extras-gauge.html#font-prop">font</a></b></b> : font</li>
<li class="fn"><b><b><a href="qml-qtquick-extras-gauge.html#formatValue-prop">formatValue</a></b></b> : var</li>
<li class="fn"><b><b><a href="qml-qtquick-extras-gauge.html#maximumValue-prop">maximumValue</a></b></b> : alias</li>
<li class="fn"><b><b><a href="qml-qtquick-extras-gauge.html#minimumValue-prop">minimumValue</a></b></b> : alias</li>
<li class="fn"><b><b><a href="qml-qtquick-extras-gauge.html#minorTickmarkCount-prop">minorTickmarkCount</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-extras-gauge.html#orientation-prop">orientation</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-extras-gauge.html#tickmarkAlignment-prop">tickmarkAlignment</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-extras-gauge.html#tickmarkStepSize-prop">tickmarkStepSize</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-extras-gauge.html#value-prop">value</a></b></b> : alias</li>
</ul>
<!-- $$$Gauge-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p class="centerAlign"><img src="images/gauge.png" alt="Gauge" /></p><p>The Gauge control displays a value within some range along a horizontal or vertical axis. It can be thought of as an extension of ProgressBar, providing tickmarks and labels to provide a visual measurement of the progress.</p>
<p>The minimum and maximum values displayable by the gauge can be set with the <a href="qml-qtquick-extras-gauge.html#minimumValue-prop">minimumValue</a> and <a href="qml-qtquick-extras-gauge.html#maximumValue-prop">maximumValue</a> properties.</p>
<p>Example:</p>
<pre class="cpp">
Gauge {
minimumValue: <span class="number">0</span>
value: <span class="number">50</span>
maximumValue: <span class="number">100</span>
anchors<span class="operator">.</span>centerIn: parent
}
</pre>
<p>You can create a custom appearance for a Gauge by assigning a GaugeStyle.</p>
<!-- @@@Gauge -->
<h2>Property Documentation</h2>
<!-- $$$font -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="font-prop">
<td class="tblQmlPropNode"><p>
<a name="font-prop"></a><span class="name">font</span> : <span class="type"><a href="qml-qtquick-extras-gauge.html#font-prop">font</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The font to use for the tickmark text.</p>
</div></div><!-- @@@font -->
<br/>
<!-- $$$formatValue -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="formatValue-prop">
<td class="tblQmlPropNode"><p>
<a name="formatValue-prop"></a><span class="name">formatValue</span> : <span class="type"><a href="../qtqml/qml-var.html">var</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property accepts a function that formats the given <i>value</i> for display in tickmarkLabel.</p>
<p>For example, to provide a custom format that displays all values with 3 decimal places:</p>
<pre class="cpp">
formatValue: function(value) {
<span class="keyword">return</span> value<span class="operator">.</span>toFixed(<span class="number">3</span>);
}
</pre>
<p>The default function does no formatting.</p>
</div></div><!-- @@@formatValue -->
<br/>
<!-- $$$maximumValue -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="maximumValue-prop">
<td class="tblQmlPropNode"><p>
<a name="maximumValue-prop"></a><span class="name">maximumValue</span> : <span class="type">alias</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the largest value displayed by the gauge.</p>
<p>The default value is <code>100</code>.</p>
</div></div><!-- @@@maximumValue -->
<br/>
<!-- $$$minimumValue -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="minimumValue-prop">
<td class="tblQmlPropNode"><p>
<a name="minimumValue-prop"></a><span class="name">minimumValue</span> : <span class="type">alias</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the smallest value displayed by the gauge.</p>
<p>The default value is <code>0</code>.</p>
</div></div><!-- @@@minimumValue -->
<br/>
<!-- $$$minorTickmarkCount -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="minorTickmarkCount-prop">
<td class="tblQmlPropNode"><p>
<a name="minorTickmarkCount-prop"></a><span class="name">minorTickmarkCount</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property determines the amount of minor tickmarks drawn between each regular tickmark.</p>
<p>The default value is <code>4</code>.</p>
</div></div><!-- @@@minorTickmarkCount -->
<br/>
<!-- $$$orientation -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="orientation-prop">
<td class="tblQmlPropNode"><p>
<a name="orientation-prop"></a><span class="name">orientation</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property determines the orientation of the gauge.</p>
<p>The default value is <code>Qt.Vertical</code>.</p>
</div></div><!-- @@@orientation -->
<br/>
<!-- $$$tickmarkAlignment -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="tickmarkAlignment-prop">
<td class="tblQmlPropNode"><p>
<a name="tickmarkAlignment-prop"></a><span class="name">tickmarkAlignment</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property determines the alignment of each tickmark within the gauge. When <a href="qml-qtquick-extras-gauge.html#orientation-prop">orientation</a> is <code>Qt.Vertical</code>, the valid values are:</p>
<ul>
<li>Qt.AlignLeft</li>
<li>Qt.AlignRight</li>
</ul>
<p>Any other value will cause <code>Qt.AlignLeft</code> to be used, which is also the default value for this orientation.</p>
<p>When <a href="qml-qtquick-extras-gauge.html#orientation-prop">orientation</a> is <code>Qt.Horizontal</code>, the valid values are:</p>
<ul>
<li>Qt.AlignTop</li>
<li>Qt.AlignBottom</li>
</ul>
<p>Any other value will cause <code>Qt.AlignBottom</code> to be used, which is also the default value for this orientation.</p>
</div></div><!-- @@@tickmarkAlignment -->
<br/>
<!-- $$$tickmarkStepSize -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="tickmarkStepSize-prop">
<td class="tblQmlPropNode"><p>
<a name="tickmarkStepSize-prop"></a><span class="name">tickmarkStepSize</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property determines the rate at which tickmarks are drawn on the gauge. The lower the value, the more often tickmarks are drawn.</p>
<p>The default value is <code>10</code>.</p>
</div></div><!-- @@@tickmarkStepSize -->
<br/>
<!-- $$$value -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="value-prop">
<td class="tblQmlPropNode"><p>
<a name="value-prop"></a><span class="name">value</span> : <span class="type">alias</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the value displayed by the gauge.</p>
<p>The default value is <code>0</code>.</p>
</div></div><!-- @@@value -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</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>
|