Documentation/Source/eric5.UI.NumbersWidget.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.UI.NumbersWidget</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.UI.NumbersWidget</h1>
<p>
Module implementing a widget to show numbers in different formats.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#BinaryModel">BinaryModel</a></td>
<td>Class implementing a model for entering binary numbers.</td>
</tr><tr>
<td><a href="#NumbersWidget">NumbersWidget</a></td>
<td>Class implementing a widget to show numbers in different formats.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="BinaryModel" ID="BinaryModel"></a>
<h2>BinaryModel</h2>
<p>
    Class implementing a model for entering binary numbers.
</p>
<h3>Derived from</h3>
QAbstractTableModel
<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="#BinaryModel.__init__">BinaryModel</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#BinaryModel.columnCount">columnCount</a></td>
<td>Public method to get the number of columns of the model.</td>
</tr><tr>
<td><a href="#BinaryModel.data">data</a></td>
<td>Public method to get data from the model.</td>
</tr><tr>
<td><a href="#BinaryModel.flags">flags</a></td>
<td>Public method to get flags from the model.</td>
</tr><tr>
<td><a href="#BinaryModel.getValue">getValue</a></td>
<td>Public slot to get the current value.</td>
</tr><tr>
<td><a href="#BinaryModel.headerData">headerData</a></td>
<td>Public method to get header data from the model.</td>
</tr><tr>
<td><a href="#BinaryModel.rowCount">rowCount</a></td>
<td>Public method to get the number of rows of the model.</td>
</tr><tr>
<td><a href="#BinaryModel.setBits">setBits</a></td>
<td>Public slot to set the number of bits.</td>
</tr><tr>
<td><a href="#BinaryModel.setBitsAndValue">setBitsAndValue</a></td>
<td>Public slot to set the number of bits and the value to show.</td>
</tr><tr>
<td><a href="#BinaryModel.setData">setData</a></td>
<td>Public method to set the data of a node cell.</td>
</tr><tr>
<td><a href="#BinaryModel.setValue">setValue</a></td>
<td>Public slot to set the value to show.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="BinaryModel.__init__" ID="BinaryModel.__init__"></a>
<h4>BinaryModel (Constructor)</h4>
<b>BinaryModel</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="BinaryModel.columnCount" ID="BinaryModel.columnCount"></a>
<h4>BinaryModel.columnCount</h4>
<b>columnCount</b>(<i>parent</i>)
<p>
        Public method to get the number of columns of the model.
</p><dl>
<dt><i>parent</i></dt>
<dd>
parent index (QModelIndex)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
number of columns (integer)
</dd>
</dl><a NAME="BinaryModel.data" ID="BinaryModel.data"></a>
<h4>BinaryModel.data</h4>
<b>data</b>(<i>index, role=Qt.DisplayRole</i>)
<p>
        Public method to get data from the model.
</p><dl>
<dt><i>index</i></dt>
<dd>
index to get data for (QModelIndex)
</dd><dt><i>role</i></dt>
<dd>
role of the data to retrieve (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
requested data
</dd>
</dl><a NAME="BinaryModel.flags" ID="BinaryModel.flags"></a>
<h4>BinaryModel.flags</h4>
<b>flags</b>(<i>index</i>)
<p>
        Public method to get flags from the model.
</p><dl>
<dt><i>index</i></dt>
<dd>
index to get flags for (QModelIndex)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flags (Qt.ItemFlags)
</dd>
</dl><a NAME="BinaryModel.getValue" ID="BinaryModel.getValue"></a>
<h4>BinaryModel.getValue</h4>
<b>getValue</b>(<i></i>)
<p>
        Public slot to get the current value.
</p><dl>
<dt>Returns:</dt>
<dd>
current value of the model (integer)
</dd>
</dl><a NAME="BinaryModel.headerData" ID="BinaryModel.headerData"></a>
<h4>BinaryModel.headerData</h4>
<b>headerData</b>(<i>section, orientation, role=Qt.DisplayRole</i>)
<p>
        Public method to get header data from the model.
</p><dl>
<dt><i>section</i></dt>
<dd>
section number (integer)
</dd><dt><i>orientation</i></dt>
<dd>
orientation (Qt.Orientation)
</dd><dt><i>role</i></dt>
<dd>
role of the data to retrieve (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
requested data
</dd>
</dl><a NAME="BinaryModel.rowCount" ID="BinaryModel.rowCount"></a>
<h4>BinaryModel.rowCount</h4>
<b>rowCount</b>(<i>parent</i>)
<p>
        Public method to get the number of rows of the model.
</p><dl>
<dt><i>parent</i></dt>
<dd>
parent index (QModelIndex)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
number of columns (integer)
</dd>
</dl><a NAME="BinaryModel.setBits" ID="BinaryModel.setBits"></a>
<h4>BinaryModel.setBits</h4>
<b>setBits</b>(<i>bits</i>)
<p>
        Public slot to set the number of bits.
</p><dl>
<dt><i>bits</i></dt>
<dd>
number of bits to show (integer)
</dd>
</dl><a NAME="BinaryModel.setBitsAndValue" ID="BinaryModel.setBitsAndValue"></a>
<h4>BinaryModel.setBitsAndValue</h4>
<b>setBitsAndValue</b>(<i>bits, value</i>)
<p>
        Public slot to set the number of bits and the value to show.
</p><dl>
<dt><i>bits</i></dt>
<dd>
number of bits to show (integer)
</dd><dt><i>value</i></dt>
<dd>
value to show (integer)
</dd>
</dl><a NAME="BinaryModel.setData" ID="BinaryModel.setData"></a>
<h4>BinaryModel.setData</h4>
<b>setData</b>(<i>index, value, role=Qt.EditRole</i>)
<p>
        Public method to set the data of a node cell.
</p><dl>
<dt><i>index</i></dt>
<dd>
index of the node cell (QModelIndex)
</dd><dt><i>value</i></dt>
<dd>
value to be set
</dd><dt><i>role</i></dt>
<dd>
role of the data (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating success (boolean)
</dd>
</dl><a NAME="BinaryModel.setValue" ID="BinaryModel.setValue"></a>
<h4>BinaryModel.setValue</h4>
<b>setValue</b>(<i>value</i>)
<p>
        Public slot to set the value to show.
</p><dl>
<dt><i>value</i></dt>
<dd>
value to show (integer)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="NumbersWidget" ID="NumbersWidget"></a>
<h2>NumbersWidget</h2>
<p>
    Class implementing a widget to show numbers in different formats.
</p><h3>Signals</h3>
<dl>
<dt>insertNumber(str)</dt>
<dd>
emitted after the user has entered a number
            and selected the number format
</dd>
</dl>
<h3>Derived from</h3>
QWidget, Ui_NumbersWidget
<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="#NumbersWidget.__init__">NumbersWidget</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#NumbersWidget.__binModelDataChanged">__binModelDataChanged</a></td>
<td>Private slot to handle a change of the binary model value by the user.</td>
</tr><tr>
<td><a href="#NumbersWidget.__block">__block</a></td>
<td>Private slot to block some signals.</td>
</tr><tr>
<td><a href="#NumbersWidget.__formatNumbers">__formatNumbers</a></td>
<td>Private method to format the various number inputs.</td>
</tr><tr>
<td><a href="#NumbersWidget.on_binEdit_textChanged">on_binEdit_textChanged</a></td>
<td>Private slot to handle input of a binary number.</td>
</tr><tr>
<td><a href="#NumbersWidget.on_binInButton_clicked">on_binInButton_clicked</a></td>
<td>Private slot to retrieve a binary number from the current editor.</td>
</tr><tr>
<td><a href="#NumbersWidget.on_binOutButton_clicked">on_binOutButton_clicked</a></td>
<td>Private slot to send a binary number.</td>
</tr><tr>
<td><a href="#NumbersWidget.on_byteOrderButton_clicked">on_byteOrderButton_clicked</a></td>
<td>Private slot to swap the byte order.</td>
</tr><tr>
<td><a href="#NumbersWidget.on_decEdit_textChanged">on_decEdit_textChanged</a></td>
<td>Private slot to handle input of a decimal number.</td>
</tr><tr>
<td><a href="#NumbersWidget.on_decInButton_clicked">on_decInButton_clicked</a></td>
<td>Private slot to retrieve a decimal number from the current editor.</td>
</tr><tr>
<td><a href="#NumbersWidget.on_decOutButton_clicked">on_decOutButton_clicked</a></td>
<td>Private slot to send a decimal number.</td>
</tr><tr>
<td><a href="#NumbersWidget.on_hexEdit_textChanged">on_hexEdit_textChanged</a></td>
<td>Private slot to handle input of a hexadecimal number.</td>
</tr><tr>
<td><a href="#NumbersWidget.on_hexInButton_clicked">on_hexInButton_clicked</a></td>
<td>Private slot to retrieve a hexadecimal number from the current editor.</td>
</tr><tr>
<td><a href="#NumbersWidget.on_hexOutButton_clicked">on_hexOutButton_clicked</a></td>
<td>Private slot to send a hexadecimal number.</td>
</tr><tr>
<td><a href="#NumbersWidget.on_octEdit_textChanged">on_octEdit_textChanged</a></td>
<td>Private slot to handle input of an octal number.</td>
</tr><tr>
<td><a href="#NumbersWidget.on_octInButton_clicked">on_octInButton_clicked</a></td>
<td>Private slot to retrieve an octal number from the current editor.</td>
</tr><tr>
<td><a href="#NumbersWidget.on_octOutButton_clicked">on_octOutButton_clicked</a></td>
<td>Private slot to send an octal number.</td>
</tr><tr>
<td><a href="#NumbersWidget.on_sizeBox_valueChanged">on_sizeBox_valueChanged</a></td>
<td>Slot documentation goes here.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="NumbersWidget.__init__" ID="NumbersWidget.__init__"></a>
<h4>NumbersWidget (Constructor)</h4>
<b>NumbersWidget</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="NumbersWidget.__binModelDataChanged" ID="NumbersWidget.__binModelDataChanged"></a>
<h4>NumbersWidget.__binModelDataChanged</h4>
<b>__binModelDataChanged</b>(<i>start, end</i>)
<p>
        Private slot to handle a change of the binary model value by the user.
</p><dl>
<dt><i>start</i></dt>
<dd>
start index (QModelIndex)
</dd><dt><i>end</i></dt>
<dd>
end index (QModelIndex)
</dd>
</dl><a NAME="NumbersWidget.__block" ID="NumbersWidget.__block"></a>
<h4>NumbersWidget.__block</h4>
<b>__block</b>(<i>b</i>)
<p>
        Private slot to block some signals.
</p><dl>
<dt><i>b</i></dt>
<dd>
flah indicating the blocking state (boolean)
</dd>
</dl><a NAME="NumbersWidget.__formatNumbers" ID="NumbersWidget.__formatNumbers"></a>
<h4>NumbersWidget.__formatNumbers</h4>
<b>__formatNumbers</b>(<i>format</i>)
<p>
        Private method to format the various number inputs.
</p><dl>
<dt><i>format</i></dt>
<dd>
number format indicator (integer)
</dd>
</dl><a NAME="NumbersWidget.on_binEdit_textChanged" ID="NumbersWidget.on_binEdit_textChanged"></a>
<h4>NumbersWidget.on_binEdit_textChanged</h4>
<b>on_binEdit_textChanged</b>(<i>txt</i>)
<p>
        Private slot to handle input of a binary number.
</p><dl>
<dt><i>txt</i></dt>
<dd>
text entered (string)
</dd>
</dl><a NAME="NumbersWidget.on_binInButton_clicked" ID="NumbersWidget.on_binInButton_clicked"></a>
<h4>NumbersWidget.on_binInButton_clicked</h4>
<b>on_binInButton_clicked</b>(<i></i>)
<p>
        Private slot to retrieve a binary number from the current editor.
</p><a NAME="NumbersWidget.on_binOutButton_clicked" ID="NumbersWidget.on_binOutButton_clicked"></a>
<h4>NumbersWidget.on_binOutButton_clicked</h4>
<b>on_binOutButton_clicked</b>(<i></i>)
<p>
        Private slot to send a binary number.
</p><a NAME="NumbersWidget.on_byteOrderButton_clicked" ID="NumbersWidget.on_byteOrderButton_clicked"></a>
<h4>NumbersWidget.on_byteOrderButton_clicked</h4>
<b>on_byteOrderButton_clicked</b>(<i></i>)
<p>
        Private slot to swap the byte order.
</p><a NAME="NumbersWidget.on_decEdit_textChanged" ID="NumbersWidget.on_decEdit_textChanged"></a>
<h4>NumbersWidget.on_decEdit_textChanged</h4>
<b>on_decEdit_textChanged</b>(<i>txt</i>)
<p>
        Private slot to handle input of a decimal number.
</p><dl>
<dt><i>txt</i></dt>
<dd>
text entered (string)
</dd>
</dl><a NAME="NumbersWidget.on_decInButton_clicked" ID="NumbersWidget.on_decInButton_clicked"></a>
<h4>NumbersWidget.on_decInButton_clicked</h4>
<b>on_decInButton_clicked</b>(<i></i>)
<p>
        Private slot to retrieve a decimal number from the current editor.
</p><a NAME="NumbersWidget.on_decOutButton_clicked" ID="NumbersWidget.on_decOutButton_clicked"></a>
<h4>NumbersWidget.on_decOutButton_clicked</h4>
<b>on_decOutButton_clicked</b>(<i></i>)
<p>
        Private slot to send a decimal number.
</p><a NAME="NumbersWidget.on_hexEdit_textChanged" ID="NumbersWidget.on_hexEdit_textChanged"></a>
<h4>NumbersWidget.on_hexEdit_textChanged</h4>
<b>on_hexEdit_textChanged</b>(<i>txt</i>)
<p>
        Private slot to handle input of a hexadecimal number.
</p><dl>
<dt><i>txt</i></dt>
<dd>
text entered (string)
</dd>
</dl><a NAME="NumbersWidget.on_hexInButton_clicked" ID="NumbersWidget.on_hexInButton_clicked"></a>
<h4>NumbersWidget.on_hexInButton_clicked</h4>
<b>on_hexInButton_clicked</b>(<i></i>)
<p>
        Private slot to retrieve a hexadecimal number from the current editor.
</p><a NAME="NumbersWidget.on_hexOutButton_clicked" ID="NumbersWidget.on_hexOutButton_clicked"></a>
<h4>NumbersWidget.on_hexOutButton_clicked</h4>
<b>on_hexOutButton_clicked</b>(<i></i>)
<p>
        Private slot to send a hexadecimal number.
</p><a NAME="NumbersWidget.on_octEdit_textChanged" ID="NumbersWidget.on_octEdit_textChanged"></a>
<h4>NumbersWidget.on_octEdit_textChanged</h4>
<b>on_octEdit_textChanged</b>(<i>txt</i>)
<p>
        Private slot to handle input of an octal number.
</p><dl>
<dt><i>txt</i></dt>
<dd>
text entered (string)
</dd>
</dl><a NAME="NumbersWidget.on_octInButton_clicked" ID="NumbersWidget.on_octInButton_clicked"></a>
<h4>NumbersWidget.on_octInButton_clicked</h4>
<b>on_octInButton_clicked</b>(<i></i>)
<p>
        Private slot to retrieve an octal number from the current editor.
</p><a NAME="NumbersWidget.on_octOutButton_clicked" ID="NumbersWidget.on_octOutButton_clicked"></a>
<h4>NumbersWidget.on_octOutButton_clicked</h4>
<b>on_octOutButton_clicked</b>(<i></i>)
<p>
        Private slot to send an octal number.
</p><a NAME="NumbersWidget.on_sizeBox_valueChanged" ID="NumbersWidget.on_sizeBox_valueChanged"></a>
<h4>NumbersWidget.on_sizeBox_valueChanged</h4>
<b>on_sizeBox_valueChanged</b>(<i>index</i>)
<p>
        Slot documentation goes here.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>