src/eric7/Documentation/Source/eric7.EricWidgets.EricTextSpinBox.html

<!DOCTYPE html>
<html><head>
<title>eric7.EricWidgets.EricTextSpinBox</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricWidgets.EricTextSpinBox</h1>
<p>
Module implementing a spinbox with textual entries.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#EricTextSpinBox">EricTextSpinBox</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="EricTextSpinBox" ID="EricTextSpinBox"></a>
<h2>EricTextSpinBox</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>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Methods</h3>
<table>
<tr>
<td><a href="#EricTextSpinBox.__init__">EricTextSpinBox</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricTextSpinBox.addItem">addItem</a></td>
<td>Public method to add an item with item data.</td>
</tr>
<tr>
<td><a href="#EricTextSpinBox.currentIndex">currentIndex</a></td>
<td>Public method to retrieve the current index.</td>
</tr>
<tr>
<td><a href="#EricTextSpinBox.itemData">itemData</a></td>
<td>Public method to retrieve the data associated with an item.</td>
</tr>
<tr>
<td><a href="#EricTextSpinBox.textFromValue">textFromValue</a></td>
<td>Public method to convert a value to text.</td>
</tr>
<tr>
<td><a href="#EricTextSpinBox.valueFromText">valueFromText</a></td>
<td>Public method to convert a text to a value.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="EricTextSpinBox.__init__" ID="EricTextSpinBox.__init__"></a>
<h4>EricTextSpinBox (Constructor)</h4>
<b>EricTextSpinBox</b>(<i>parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="EricTextSpinBox.addItem" ID="EricTextSpinBox.addItem"></a>
<h4>EricTextSpinBox.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> (str)</dt>
<dd>
text to be shown
</dd>
<dt><i>data</i> (Any)</dt>
<dd>
associated data
</dd>
</dl>
<a NAME="EricTextSpinBox.currentIndex" ID="EricTextSpinBox.currentIndex"></a>
<h4>EricTextSpinBox.currentIndex</h4>
<b>currentIndex</b>(<i></i>)
<p>
        Public method to retrieve the current index.
</p>

<dl>
<dt>Return:</dt>
<dd>
current index
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
int
</dd>
</dl>
<a NAME="EricTextSpinBox.itemData" ID="EricTextSpinBox.itemData"></a>
<h4>EricTextSpinBox.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> (int)</dt>
<dd>
index of the item
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
associated data
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
Any
</dd>
</dl>
<a NAME="EricTextSpinBox.textFromValue" ID="EricTextSpinBox.textFromValue"></a>
<h4>EricTextSpinBox.textFromValue</h4>
<b>textFromValue</b>(<i>value</i>)
<p>
        Public method to convert a value to text.
</p>

<dl>

<dt><i>value</i> (int)</dt>
<dd>
value to be converted
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
text for the given value
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="EricTextSpinBox.valueFromText" ID="EricTextSpinBox.valueFromText"></a>
<h4>EricTextSpinBox.valueFromText</h4>
<b>valueFromText</b>(<i>txt</i>)
<p>
        Public method to convert a text to a value.
</p>

<dl>

<dt><i>txt</i> (str)</dt>
<dd>
text to be converted
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
value for the given text
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
int
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>