Documentation/Source/eric5.E5Gui.E5TextSpinBox.html

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric5.E5Gui.E5TextSpinBox</title>
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.E5Gui.E5TextSpinBox</h1>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#E5TextSpinBox">E5TextSpinBox</a></td>
<td>Class implementing a spinbox with textual entries.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="E5TextSpinBox" ID="E5TextSpinBox"></a>
<h2>E5TextSpinBox</h2>
<p>
    Class implementing a spinbox with textual entries.
</p>
<h3>Derived from</h3>
QSpinBox
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#E5TextSpinBox.__init__">E5TextSpinBox</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#E5TextSpinBox.addItem">addItem</a></td>
<td>Public method to add an item with item data.</td>
</tr><tr>
<td><a href="#E5TextSpinBox.currentIndex">currentIndex</a></td>
<td>Public method to retrieve the current index.</td>
</tr><tr>
<td><a href="#E5TextSpinBox.itemData">itemData</a></td>
<td>Public method to retrieve the data associated with an item.</td>
</tr><tr>
<td><a href="#E5TextSpinBox.textFromValue">textFromValue</a></td>
<td>Protected method to convert a value to text.</td>
</tr><tr>
<td><a href="#E5TextSpinBox.valueFromText">valueFromText</a></td>
<td>Protected method to convert a text to a value.</td>
</tr>
</table>
<a NAME="E5TextSpinBox.__init__" ID="E5TextSpinBox.__init__"></a>
<h4>E5TextSpinBox (Constructor)</h4>
<b>E5TextSpinBox</b>(<i>parent=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>parent</i></dt>
<dd>
reference to the parent widget (QWidget)
</dd>
</dl><a NAME="E5TextSpinBox.addItem" ID="E5TextSpinBox.addItem"></a>
<h4>E5TextSpinBox.addItem</h4>
<b>addItem</b>(<i>txt, data=None</i>)
<p>
        Public method to add an item with item data.
</p><dl>
<dt><i>txt</i></dt>
<dd>
text to be shown (string)
</dd><dt><i>data</i></dt>
<dd>
associated data
</dd>
</dl><a NAME="E5TextSpinBox.currentIndex" ID="E5TextSpinBox.currentIndex"></a>
<h4>E5TextSpinBox.currentIndex</h4>
<b>currentIndex</b>(<i></i>)
<p>
        Public method to retrieve the current index.
</p><dl>
<dt>Returns:</dt>
<dd>
current index (integer)
</dd>
</dl><a NAME="E5TextSpinBox.itemData" ID="E5TextSpinBox.itemData"></a>
<h4>E5TextSpinBox.itemData</h4>
<b>itemData</b>(<i>index</i>)
<p>
        Public method to retrieve the data associated with an item.
</p><dl>
<dt><i>index</i></dt>
<dd>
index of the item (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
associated data
</dd>
</dl><a NAME="E5TextSpinBox.textFromValue" ID="E5TextSpinBox.textFromValue"></a>
<h4>E5TextSpinBox.textFromValue</h4>
<b>textFromValue</b>(<i>value</i>)
<p>
        Protected method to convert a value to text.
</p><dl>
<dt><i>value</i></dt>
<dd>
value to be converted (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
text for the given value (string)
</dd>
</dl><a NAME="E5TextSpinBox.valueFromText" ID="E5TextSpinBox.valueFromText"></a>
<h4>E5TextSpinBox.valueFromText</h4>
<b>valueFromText</b>(<i>txt</i>)
<p>
        Protected method to convert a text to a value.
</p><dl>
<dt><i>txt</i></dt>
<dd>
text to be converted (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
value for the given text (integer)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>