diff -r 8bda0881a970 -r 0686ac00256e Documentation/Source/eric5.UI.SymbolsWidget.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.UI.SymbolsWidget.html Sat Jun 26 13:34:06 2010 +0200
@@ -0,0 +1,332 @@
+<?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.SymbolsWidget</title>
+<style>
+body {
+ background:white;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #4FA4FF; }
+h2 { color: white; background: #4FA4FF; }
+h3 { color: white; background: #00557F; }
+h4 { color: white; background: #00557F; }
+
+a { color: #AA5500; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric5.UI.SymbolsWidget</h1>
+<p>
+Module implementing a widget to select a symbol in various formats.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#SymbolsModel">SymbolsModel</a></td>
+<td>Class implementing the model for the symbols widget.</td>
+</tr><tr>
+<td><a href="#SymbolsWidget">SymbolsWidget</a></td>
+<td>Class implementing a widget to select a symbol in various formats.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="SymbolsModel" ID="SymbolsModel"></a>
+<h2>SymbolsModel</h2>
+<p>
+ Class implementing the model for the symbols widget.
+</p>
+<h3>Derived from</h3>
+QAbstractTableModel
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#SymbolsModel.__init__">SymbolsModel</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#SymbolsModel.__isDigit">__isDigit</a></td>
+<td>Private method to check, if a character is a digit.</td>
+</tr><tr>
+<td><a href="#SymbolsModel.__isLetter">__isLetter</a></td>
+<td>Private method to check, if a character is a letter.</td>
+</tr><tr>
+<td><a href="#SymbolsModel.__isMark">__isMark</a></td>
+<td>Private method to check, if a character is a mark character.</td>
+</tr><tr>
+<td><a href="#SymbolsModel.__isPunct">__isPunct</a></td>
+<td>Private method to check, if a character is a punctuation character.</td>
+</tr><tr>
+<td><a href="#SymbolsModel.__isSymbol">__isSymbol</a></td>
+<td>Private method to check, if a character is a symbol.</td>
+</tr><tr>
+<td><a href="#SymbolsModel.columnCount">columnCount</a></td>
+<td>Public method to get the number of columns of the model.</td>
+</tr><tr>
+<td><a href="#SymbolsModel.data">data</a></td>
+<td>Public method to get data from the model.</td>
+</tr><tr>
+<td><a href="#SymbolsModel.headerData">headerData</a></td>
+<td>Public method to get header data from the model.</td>
+</tr><tr>
+<td><a href="#SymbolsModel.rowCount">rowCount</a></td>
+<td>Public method to get the number of rows of the model.</td>
+</tr><tr>
+<td><a href="#SymbolsModel.setUnicode">setUnicode</a></td>
+<td>Public method to set the mode of the model.</td>
+</tr>
+</table>
+<a NAME="SymbolsModel.__init__" ID="SymbolsModel.__init__"></a>
+<h4>SymbolsModel (Constructor)</h4>
+<b>SymbolsModel</b>(<i>parent = None</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent object (QObject)
+</dd>
+</dl><a NAME="SymbolsModel.__isDigit" ID="SymbolsModel.__isDigit"></a>
+<h4>SymbolsModel.__isDigit</h4>
+<b>__isDigit</b>(<i>char</i>)
+<p>
+ Private method to check, if a character is a digit.
+</p><dl>
+<dt><i>char</i></dt>
+<dd>
+character to test (one character string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating a digit (boolean)
+</dd>
+</dl><a NAME="SymbolsModel.__isLetter" ID="SymbolsModel.__isLetter"></a>
+<h4>SymbolsModel.__isLetter</h4>
+<b>__isLetter</b>(<i>char</i>)
+<p>
+ Private method to check, if a character is a letter.
+</p><dl>
+<dt><i>char</i></dt>
+<dd>
+character to test (one character string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating a letter (boolean)
+</dd>
+</dl><a NAME="SymbolsModel.__isMark" ID="SymbolsModel.__isMark"></a>
+<h4>SymbolsModel.__isMark</h4>
+<b>__isMark</b>(<i>char</i>)
+<p>
+ Private method to check, if a character is a mark character.
+</p><dl>
+<dt><i>char</i></dt>
+<dd>
+character to test (one character string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating a mark character (boolean)
+</dd>
+</dl><a NAME="SymbolsModel.__isPunct" ID="SymbolsModel.__isPunct"></a>
+<h4>SymbolsModel.__isPunct</h4>
+<b>__isPunct</b>(<i>char</i>)
+<p>
+ Private method to check, if a character is a punctuation character.
+</p><dl>
+<dt><i>char</i></dt>
+<dd>
+character to test (one character string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating a punctuation character (boolean)
+</dd>
+</dl><a NAME="SymbolsModel.__isSymbol" ID="SymbolsModel.__isSymbol"></a>
+<h4>SymbolsModel.__isSymbol</h4>
+<b>__isSymbol</b>(<i>char</i>)
+<p>
+ Private method to check, if a character is a symbol.
+</p><dl>
+<dt><i>char</i></dt>
+<dd>
+character to test (one character string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating a symbol (boolean)
+</dd>
+</dl><a NAME="SymbolsModel.columnCount" ID="SymbolsModel.columnCount"></a>
+<h4>SymbolsModel.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="SymbolsModel.data" ID="SymbolsModel.data"></a>
+<h4>SymbolsModel.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="SymbolsModel.headerData" ID="SymbolsModel.headerData"></a>
+<h4>SymbolsModel.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="SymbolsModel.rowCount" ID="SymbolsModel.rowCount"></a>
+<h4>SymbolsModel.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="SymbolsModel.setUnicode" ID="SymbolsModel.setUnicode"></a>
+<h4>SymbolsModel.setUnicode</h4>
+<b>setUnicode</b>(<i>u</i>)
+<p>
+ Public method to set the mode of the model.
+</p><dl>
+<dt><i>u</i></dt>
+<dd>
+flag indicating unicode mode (boolean)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="SymbolsWidget" ID="SymbolsWidget"></a>
+<h2>SymbolsWidget</h2>
+<p>
+ Class implementing a widget to select a symbol in various formats.
+</p><h4>Signals</h4>
+<dl>
+<dt>insertSymbol(str)</dt>
+<dd>
+emitted after the user has selected a symbol
+</dd>
+</dl>
+<h3>Derived from</h3>
+QWidget, Ui_SymbolsWidget
+<h3>Class Attributes</h3>
+<table>
+<tr><td>insertSymbol</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#SymbolsWidget.__init__">SymbolsWidget</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#SymbolsWidget.on_symbolSpinBox_editingFinished">on_symbolSpinBox_editingFinished</a></td>
+<td>Private slot to move the table to the entered symbol id.</td>
+</tr><tr>
+<td><a href="#SymbolsWidget.on_symbolsTable_activated">on_symbolsTable_activated</a></td>
+<td>Private slot to signal the selection of a symbol.</td>
+</tr><tr>
+<td><a href="#SymbolsWidget.on_unicodeButton_toggled">on_unicodeButton_toggled</a></td>
+<td>Private slot to switch unicode mode.</td>
+</tr>
+</table>
+<a NAME="SymbolsWidget.__init__" ID="SymbolsWidget.__init__"></a>
+<h4>SymbolsWidget (Constructor)</h4>
+<b>SymbolsWidget</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="SymbolsWidget.on_symbolSpinBox_editingFinished" ID="SymbolsWidget.on_symbolSpinBox_editingFinished"></a>
+<h4>SymbolsWidget.on_symbolSpinBox_editingFinished</h4>
+<b>on_symbolSpinBox_editingFinished</b>(<i></i>)
+<p>
+ Private slot to move the table to the entered symbol id.
+</p><a NAME="SymbolsWidget.on_symbolsTable_activated" ID="SymbolsWidget.on_symbolsTable_activated"></a>
+<h4>SymbolsWidget.on_symbolsTable_activated</h4>
+<b>on_symbolsTable_activated</b>(<i>index</i>)
+<p>
+ Private slot to signal the selection of a symbol.
+</p><dl>
+<dt><i>index</i></dt>
+<dd>
+index of the selected symbol (QModelIndex)
+</dd>
+</dl><a NAME="SymbolsWidget.on_unicodeButton_toggled" ID="SymbolsWidget.on_unicodeButton_toggled"></a>
+<h4>SymbolsWidget.on_unicodeButton_toggled</h4>
+<b>on_unicodeButton_toggled</b>(<i>checked</i>)
+<p>
+ Private slot to switch unicode mode.
+</p><dl>
+<dt><i>checked</i></dt>
+<dd>
+flag indicating that the button is pressed (boolean)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
