Sophie

Sophie

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

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" />
<!-- qquickspinbox.cpp -->
  <title>SpinBox 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 >SpinBox 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="#methods">Methods</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#custom-values">Custom Values</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">SpinBox QML Type</h1>
<span class="subtitle"></span>
<!-- $$$SpinBox-brief -->
<p>A spinbox control. <a href="#details">More...</a></p>
<!-- @@@SpinBox -->
<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></table></div><ul>
<li><a href="qml-qt-labs-controls-spinbox-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-spinbox.html#down-prop">down</a></b></b><ul>
<li class="fn"><b><b><a href="qml-qt-labs-controls-spinbox.html#down.pressed-prop">down.pressed</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-spinbox.html#down.indicator-prop">down.indicator</a></b></b> : Item</li>
</ul>
</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-spinbox.html#from-prop">from</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-spinbox.html#stepSize-prop">stepSize</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-spinbox.html#textFromValue-prop">textFromValue</a></b></b> : function</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-spinbox.html#to-prop">to</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-spinbox.html#up-prop">up</a></b></b><ul>
<li class="fn"><b><b><a href="qml-qt-labs-controls-spinbox.html#up.pressed-prop">up.pressed</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-spinbox.html#up.indicator-prop">up.indicator</a></b></b> : Item</li>
</ul>
</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-spinbox.html#validator-prop">validator</a></b></b> : Validator</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-spinbox.html#value-prop">value</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-spinbox.html#valueFromText-prop">valueFromText</a></b></b> : function</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qt-labs-controls-spinbox.html#decrease-method">decrease</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qt-labs-controls-spinbox.html#increase-method">increase</a></b></b>()</li>
</ul>
<!-- $$$SpinBox-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p class="centerAlign"><img src="images/qtlabscontrols-spinbox.png" alt="" /></p><p><a href="qml-qt-labs-controls-spinbox.html">SpinBox</a> allows the user to choose an integer value by clicking the up or down indicator buttons, by pressing up or down on the keyboard, or by entering a text value in the input field.</p>
<p>By default, <a href="qml-qt-labs-controls-spinbox.html">SpinBox</a> provides discrete values in the range of <code>[0-99]</code> with a <a href="qml-qt-labs-controls-spinbox.html#stepSize-prop">stepSize</a> of <code>1</code>.</p>
<pre class="qml">

  <span class="type"><a href="qml-qt-labs-controls-spinbox.html">SpinBox</a></span> {
      <span class="name">value</span>: <span class="number">50</span>
  }

</pre>
<a name="custom-values"></a>
<h3 >Custom Values</h3>
<p class="centerAlign"><img src="images/qtlabscontrols-spinbox-textual.png" alt="" /></p><p>Even though <a href="qml-qt-labs-controls-spinbox.html">SpinBox</a> works on integer values, it can be customized to accept arbitrary input values. The following snippet demonstrates how <a href="qml-qt-labs-controls-spinbox.html#validator-prop">validator</a>, <a href="qml-qt-labs-controls-spinbox.html#textFromValue-prop">textFromValue</a> and <a href="qml-qt-labs-controls-spinbox.html#valueFromText-prop">valueFromText</a> can be used to customize the default behavior.</p>
<pre class="qml">

  <span class="type"><a href="qml-qt-labs-controls-spinbox.html">SpinBox</a></span> {
      <span class="name">from</span>: <span class="number">0</span>
      <span class="name">to</span>: <span class="name">items</span>.<span class="name">length</span> <span class="operator">-</span> <span class="number">1</span>
      <span class="name">value</span>: <span class="number">1</span> <span class="comment">// &quot;Medium&quot;</span>

      property <span class="type">var</span> <span class="name">items</span>: [<span class="string">&quot;Small&quot;</span>, <span class="string">&quot;Medium&quot;</span>, <span class="string">&quot;Large&quot;</span>]

      <span class="name">validator</span>: <span class="name">RegExpValidator</span> {
          <span class="name">regExp</span>: new <span class="name">RegExp</span>(<span class="string">&quot;(Small|Medium|Large)&quot;</span>, <span class="string">&quot;i&quot;</span>)
      }

      <span class="name">textFromValue</span>: <span class="keyword">function</span>(<span class="name">value</span>) {
          <span class="keyword">return</span> <span class="name">items</span>[<span class="name">value</span>];
      }

      <span class="name">valueFromText</span>: <span class="keyword">function</span>(<span class="name">text</span>) {
          <span class="keyword">for</span> (<span class="keyword">var</span> <span class="name">i</span> = <span class="number">0</span>; <span class="name">i</span> <span class="operator">&lt;</span> <span class="name">items</span>.<span class="name">length</span>; ++<span class="name">i</span>) {
              <span class="keyword">if</span> (<span class="name">items</span>[<span class="name">i</span>].<span class="name">toLowerCase</span>().<span class="name">indexOf</span>(<span class="name">text</span>.<span class="name">toLowerCase</span>()) <span class="operator">===</span> <span class="number">0</span>)
                  <span class="keyword">return</span> <span class="name">i</span>
          }
          <span class="keyword">return</span> <span class="name">sb</span>.<span class="name">value</span>
      }
  }

</pre>
<p><b>Note: </b><i>Types in the Qt.labs module are not guaranteed to remain compatible in future versions.</i></p><p><b>See also </b><a href="qml-qt-labs-controls-tumbler.html">Tumbler</a> and <a href="qtlabscontrols-customize.html#customizing-spinbox">Customizing SpinBox</a>.</p>
<!-- @@@SpinBox -->
<h2>Property Documentation</h2>
<!-- $$$down -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="even" id="down-prop"><th class="centerAlign"><p><a name="down-prop"></a><b>down group</b></p></th></tr><tr valign="top" class="odd" id="down.pressed-prop"><td class="tblQmlPropNode"><p><a name="down.pressed-prop"></a><span class="name">down.pressed</span> : <span class="type">bool</span></p></td></tr><tr valign="top" class="odd" id="down.indicator-prop"><td class="tblQmlPropNode"><p><a name="down.indicator-prop"></a><span class="name">down.indicator</span> : <span class="type">Item</span></p></td></tr></table></div></div><div class="qmldoc"><p>These properties hold the down indicator item and whether it is pressed.</p>
<p><b>See also </b><a href="qml-qt-labs-controls-spinbox.html#decrease-method">decrease()</a>.</p>
</div></div><!-- @@@down -->
<br/>
<!-- $$$from -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="from-prop">
<td class="tblQmlPropNode"><p>
<a name="from-prop"></a><span class="name">from</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the starting value for the range. The default value is <code>0</code>.</p>
<p><b>See also </b><a href="qml-qt-labs-controls-spinbox.html#to-prop">to</a> and <a href="qml-qt-labs-controls-spinbox.html#value-prop">value</a>.</p>
</div></div><!-- @@@from -->
<br/>
<!-- $$$stepSize -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="stepSize-prop">
<td class="tblQmlPropNode"><p>
<a name="stepSize-prop"></a><span class="name">stepSize</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the step size. The default value is <code>1</code>.</p>
<p><b>See also </b><a href="qml-qt-labs-controls-spinbox.html#increase-method">increase()</a> and <a href="qml-qt-labs-controls-spinbox.html#decrease-method">decrease()</a>.</p>
</div></div><!-- @@@stepSize -->
<br/>
<!-- $$$textFromValue -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="textFromValue-prop">
<td class="tblQmlPropNode"><p>
<a name="textFromValue-prop"></a><span class="name">textFromValue</span> : <span class="type">function</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds a callback function that is called whenever an integer value needs to be converted to display text.</p>
<p>The callback function signature is <code>string function(value, locale)</code>. The function can have one or two arguments, where the first argument is the value to be converted, and the optional second argument is the locale that should be used for the conversion, if applicable.</p>
<p>The default implementation does the conversion using Number.toLocaleString():</p>
<pre class="cpp">

  textFromValue: function(value<span class="operator">,</span> locale) { <span class="keyword">return</span> Number(value)<span class="operator">.</span>toLocaleString(locale<span class="operator">,</span> <span class="char">'f'</span><span class="operator">,</span> <span class="number">0</span>); }

</pre>
<p><b>See also </b><a href="qml-qt-labs-controls-spinbox.html#valueFromText-prop">valueFromText</a>, <a href="qml-qt-labs-controls-spinbox.html#validator-prop">validator</a>, and <a href="qml-qt-labs-controls-control.html#locale-prop">locale</a>.</p>
</div></div><!-- @@@textFromValue -->
<br/>
<!-- $$$to -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="to-prop">
<td class="tblQmlPropNode"><p>
<a name="to-prop"></a><span class="name">to</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the end value for the range. The default value is <code>99</code>.</p>
<p><b>See also </b><a href="qml-qt-labs-controls-spinbox.html#from-prop">from</a> and <a href="qml-qt-labs-controls-spinbox.html#value-prop">value</a>.</p>
</div></div><!-- @@@to -->
<br/>
<!-- $$$up -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="even" id="up-prop"><th class="centerAlign"><p><a name="up-prop"></a><b>up group</b></p></th></tr><tr valign="top" class="odd" id="up.pressed-prop"><td class="tblQmlPropNode"><p><a name="up.pressed-prop"></a><span class="name">up.pressed</span> : <span class="type">bool</span></p></td></tr><tr valign="top" class="odd" id="up.indicator-prop"><td class="tblQmlPropNode"><p><a name="up.indicator-prop"></a><span class="name">up.indicator</span> : <span class="type">Item</span></p></td></tr></table></div></div><div class="qmldoc"><p>These properties hold the up indicator item and whether it is pressed.</p>
<p><b>See also </b><a href="qml-qt-labs-controls-spinbox.html#increase-method">increase()</a>.</p>
</div></div><!-- @@@up -->
<br/>
<!-- $$$validator -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="validator-prop">
<td class="tblQmlPropNode"><p>
<a name="validator-prop"></a><span class="name">validator</span> : <span class="type">Validator</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the input text validator. By default, <a href="qml-qt-labs-controls-spinbox.html">SpinBox</a> uses IntValidator to accept input of integer numbers.</p>
<pre class="qml">

  <span class="name">validator</span>: <span class="name">IntValidator</span> {
      <span class="name">locale</span>: <span class="name">control</span>.<span class="name">locale</span>.<span class="name">name</span>
      <span class="name">bottom</span>: <span class="name">Math</span>.<span class="name">min</span>(<span class="name">control</span>.<span class="name">from</span>, <span class="name">control</span>.<span class="name">to</span>)
      <span class="name">top</span>: <span class="name">Math</span>.<span class="name">max</span>(<span class="name">control</span>.<span class="name">from</span>, <span class="name">control</span>.<span class="name">to</span>)
  }

</pre>
<p><b>See also </b><a href="qml-qt-labs-controls-spinbox.html#textFromValue-prop">textFromValue</a>, <a href="qml-qt-labs-controls-spinbox.html#valueFromText-prop">valueFromText</a>, and <a href="qml-qt-labs-controls-control.html#locale-prop">locale</a>.</p>
</div></div><!-- @@@validator -->
<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">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the value in the range <code>from</code> - <code>to</code>. The default value is <code>0</code>.</p>
</div></div><!-- @@@value -->
<br/>
<!-- $$$valueFromText -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="valueFromText-prop">
<td class="tblQmlPropNode"><p>
<a name="valueFromText-prop"></a><span class="name">valueFromText</span> : <span class="type">function</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds a callback function that is called whenever input text needs to be converted to an integer value.</p>
<p>The callback function signature is <code>int function(text, locale)</code>. The function can have one or two arguments, where the first argument is the text to be converted, and the optional second argument is the locale that should be used for the conversion, if applicable.</p>
<p>The default implementation does the conversion using Number.fromLocaleString():</p>
<pre class="cpp">

  valueFromText: function(text<span class="operator">,</span> locale) { <span class="keyword">return</span> Number<span class="operator">.</span>fromLocaleString(locale<span class="operator">,</span> text); }

</pre>
<p><b>See also </b><a href="qml-qt-labs-controls-spinbox.html#textFromValue-prop">textFromValue</a>, <a href="qml-qt-labs-controls-spinbox.html#validator-prop">validator</a>, and <a href="qml-qt-labs-controls-control.html#locale-prop">locale</a>.</p>
</div></div><!-- @@@valueFromText -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$decrease -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="decrease-method">
<td class="tblQmlFuncNode"><p>
<a name="decrease-method"></a><span class="type">void</span> <span class="name">decrease</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Decreases the value by <a href="qml-qt-labs-controls-spinbox.html#stepSize-prop">stepSize</a>.</p>
<p><b>See also </b><a href="qml-qt-labs-controls-spinbox.html#stepSize-prop">stepSize</a>.</p>
</div></div><!-- @@@decrease -->
<br/>
<!-- $$$increase -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="increase-method">
<td class="tblQmlFuncNode"><p>
<a name="increase-method"></a><span class="type">void</span> <span class="name">increase</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Increases the value by <a href="qml-qt-labs-controls-spinbox.html#stepSize-prop">stepSize</a>.</p>
<p><b>See also </b><a href="qml-qt-labs-controls-spinbox.html#stepSize-prop">stepSize</a>.</p>
</div></div><!-- @@@increase -->
<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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional