Documentation/Source/eric5.Plugins.WizardPlugins.PyRegExpWizard.PyRegExpWizardCharactersDialog.html

Sat, 20 Aug 2011 16:30:49 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 20 Aug 2011 16:30:49 +0200
changeset 1228
7afaf2fca55b
parent 945
8cd4d08fa9f6
child 1229
a8207dc73672
permissions
-rw-r--r--

Updated source docu with new soutce documentor.

<?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.Plugins.WizardPlugins.PyRegExpWizard.PyRegExpWizardCharactersDialog</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.Plugins.WizardPlugins.PyRegExpWizard.PyRegExpWizardCharactersDialog</h1>
<p>
Module implementing a dialog for entering character classes.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#PyRegExpWizardCharactersDialog">PyRegExpWizardCharactersDialog</a></td>
<td>Class implementing a dialog for entering character classes.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="PyRegExpWizardCharactersDialog" ID="PyRegExpWizardCharactersDialog"></a>
<h2>PyRegExpWizardCharactersDialog</h2>
<p>
    Class implementing a dialog for entering character classes.
</p>
<h3>Derived from</h3>
QDialog, Ui_PyRegExpWizardCharactersDialog
<h3>Class Attributes</h3>
<table>
<tr><td>predefinedClasses</td></tr><tr><td>specialChars</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#PyRegExpWizardCharactersDialog.__addRangesLine">__addRangesLine</a></td>
<td>Private slot to add a line of entry widgets for character ranges.</td>
</tr><tr>
<td><a href="#PyRegExpWizardCharactersDialog.__addSinglesLine">__addSinglesLine</a></td>
<td>Private slot to add a line of entry widgets for single characters.</td>
</tr><tr>
<td><a href="#PyRegExpWizardCharactersDialog.__formatCharacter">__formatCharacter</a></td>
<td>Private method to format the characters entered into the dialog.</td>
</tr><tr>
<td><a href="#PyRegExpWizardCharactersDialog.__performSelectedAction">__performSelectedAction</a></td>
<td>Private method performing some actions depending on the input.</td>
</tr><tr>
<td><a href="#PyRegExpWizardCharactersDialog.__rangesCharTypeSelected">__rangesCharTypeSelected</a></td>
<td>Private slot to handle the activated(int) signal of the char ranges combo boxes.</td>
</tr><tr>
<td><a href="#PyRegExpWizardCharactersDialog.__singlesCharTypeSelected">__singlesCharTypeSelected</a></td>
<td>Private slot to handle the activated(int) signal of the single chars combo boxes.</td>
</tr><tr>
<td><a href="#PyRegExpWizardCharactersDialog.getCharacters">getCharacters</a></td>
<td>Public method to return the character string assembled via the dialog.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="PyRegExpWizardCharactersDialog.__init__" ID="PyRegExpWizardCharactersDialog.__init__"></a>
<h4>PyRegExpWizardCharactersDialog (Constructor)</h4>
<b>PyRegExpWizardCharactersDialog</b>(<i>parent=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>parent</i></dt>
<dd>
parent widget (QWidget)
</dd>
</dl><a NAME="PyRegExpWizardCharactersDialog.__addRangesLine" ID="PyRegExpWizardCharactersDialog.__addRangesLine"></a>
<h4>PyRegExpWizardCharactersDialog.__addRangesLine</h4>
<b>__addRangesLine</b>(<i></i>)
<p>
        Private slot to add a line of entry widgets for character ranges.
</p><a NAME="PyRegExpWizardCharactersDialog.__addSinglesLine" ID="PyRegExpWizardCharactersDialog.__addSinglesLine"></a>
<h4>PyRegExpWizardCharactersDialog.__addSinglesLine</h4>
<b>__addSinglesLine</b>(<i></i>)
<p>
        Private slot to add a line of entry widgets for single characters.
</p><a NAME="PyRegExpWizardCharactersDialog.__formatCharacter" ID="PyRegExpWizardCharactersDialog.__formatCharacter"></a>
<h4>PyRegExpWizardCharactersDialog.__formatCharacter</h4>
<b>__formatCharacter</b>(<i>index, char</i>)
<p>
        Private method to format the characters entered into the dialog.
</p><dl>
<dt><i>index</i></dt>
<dd>
selected list index (integer)
</dd><dt><i>char</i></dt>
<dd>
character string enetered into the dialog (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
formated character string (string)
</dd>
</dl><a NAME="PyRegExpWizardCharactersDialog.__performSelectedAction" ID="PyRegExpWizardCharactersDialog.__performSelectedAction"></a>
<h4>PyRegExpWizardCharactersDialog.__performSelectedAction</h4>
<b>__performSelectedAction</b>(<i>index, lineedit</i>)
<p>
        Private method performing some actions depending on the input.
</p><dl>
<dt><i>index</i></dt>
<dd>
selected list index (integer)
</dd><dt><i>lineedit</i></dt>
<dd>
line edit widget to act on (QLineEdit)
</dd>
</dl><a NAME="PyRegExpWizardCharactersDialog.__rangesCharTypeSelected" ID="PyRegExpWizardCharactersDialog.__rangesCharTypeSelected"></a>
<h4>PyRegExpWizardCharactersDialog.__rangesCharTypeSelected</h4>
<b>__rangesCharTypeSelected</b>(<i>index</i>)
<p>
        Private slot to handle the activated(int) signal of the char ranges combo boxes.
</p><dl>
<dt><i>index</i></dt>
<dd>
selected list index (integer)
</dd>
</dl><a NAME="PyRegExpWizardCharactersDialog.__singlesCharTypeSelected" ID="PyRegExpWizardCharactersDialog.__singlesCharTypeSelected"></a>
<h4>PyRegExpWizardCharactersDialog.__singlesCharTypeSelected</h4>
<b>__singlesCharTypeSelected</b>(<i>index</i>)
<p>
        Private slot to handle the activated(int) signal of the single chars combo boxes.
</p><dl>
<dt><i>index</i></dt>
<dd>
selected list index (integer)
</dd>
</dl><a NAME="PyRegExpWizardCharactersDialog.getCharacters" ID="PyRegExpWizardCharactersDialog.getCharacters"></a>
<h4>PyRegExpWizardCharactersDialog.getCharacters</h4>
<b>getCharacters</b>(<i></i>)
<p>
        Public method to return the character string assembled via the dialog.
</p><dl>
<dt>Returns:</dt>
<dd>
formatted string for character classes (string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial