src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardCharactersDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardCharactersDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardCharactersDialog</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="#QRegularExpressionWizardCharactersDialog">QRegularExpressionWizardCharactersDialog</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="QRegularExpressionWizardCharactersDialog" ID="QRegularExpressionWizardCharactersDialog"></a>
<h2>QRegularExpressionWizardCharactersDialog</h2>
<p>
    Class implementing a dialog for entering character classes.
</p>

<h3>Derived from</h3>
QDialog, Ui_QRegularExpressionWizardCharactersDialog
<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="#QRegularExpressionWizardCharactersDialog.__init__">QRegularExpressionWizardCharactersDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#QRegularExpressionWizardCharactersDialog.__addRangesLine">__addRangesLine</a></td>
<td>Private slot to add a line of entry widgets for character ranges.</td>
</tr>
<tr>
<td><a href="#QRegularExpressionWizardCharactersDialog.__addSinglesLine">__addSinglesLine</a></td>
<td>Private slot to add a line of entry widgets for single characters.</td>
</tr>
<tr>
<td><a href="#QRegularExpressionWizardCharactersDialog.__formatCharacter">__formatCharacter</a></td>
<td>Private method to format the characters entered into the dialog.</td>
</tr>
<tr>
<td><a href="#QRegularExpressionWizardCharactersDialog.__initCharacterSelectors">__initCharacterSelectors</a></td>
<td>Private method to initialize the W3C character selector entries.</td>
</tr>
<tr>
<td><a href="#QRegularExpressionWizardCharactersDialog.__performSelectedAction">__performSelectedAction</a></td>
<td>Private method performing some actions depending on the input.</td>
</tr>
<tr>
<td><a href="#QRegularExpressionWizardCharactersDialog.__populateCharTypeCombo">__populateCharTypeCombo</a></td>
<td>Private method to populate a given character type selection combo box.</td>
</tr>
<tr>
<td><a href="#QRegularExpressionWizardCharactersDialog.__populateCharacterCombo">__populateCharacterCombo</a></td>
<td>Private method to populate a character selection combo.</td>
</tr>
<tr>
<td><a href="#QRegularExpressionWizardCharactersDialog.__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="#QRegularExpressionWizardCharactersDialog.__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="#QRegularExpressionWizardCharactersDialog.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="QRegularExpressionWizardCharactersDialog.__init__" ID="QRegularExpressionWizardCharactersDialog.__init__"></a>
<h4>QRegularExpressionWizardCharactersDialog (Constructor)</h4>
<b>QRegularExpressionWizardCharactersDialog</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="QRegularExpressionWizardCharactersDialog.__addRangesLine" ID="QRegularExpressionWizardCharactersDialog.__addRangesLine"></a>
<h4>QRegularExpressionWizardCharactersDialog.__addRangesLine</h4>
<b>__addRangesLine</b>(<i></i>)
<p>
        Private slot to add a line of entry widgets for character ranges.
</p>

<a NAME="QRegularExpressionWizardCharactersDialog.__addSinglesLine" ID="QRegularExpressionWizardCharactersDialog.__addSinglesLine"></a>
<h4>QRegularExpressionWizardCharactersDialog.__addSinglesLine</h4>
<b>__addSinglesLine</b>(<i></i>)
<p>
        Private slot to add a line of entry widgets for single characters.
</p>

<a NAME="QRegularExpressionWizardCharactersDialog.__formatCharacter" ID="QRegularExpressionWizardCharactersDialog.__formatCharacter"></a>
<h4>QRegularExpressionWizardCharactersDialog.__formatCharacter</h4>
<b>__formatCharacter</b>(<i>char, formatIdentifier</i>)
<p>
        Private method to format the characters entered into the dialog.
</p>

<dl>

<dt><i>char</i> (str)</dt>
<dd>
character string entered into the dialog
</dd>
<dt><i>formatIdentifier</i> (str)</dt>
<dd>
string giving a special format (-c, -h, -i or
            -o) or the already formatted character
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
formatted character string
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="QRegularExpressionWizardCharactersDialog.__initCharacterSelectors" ID="QRegularExpressionWizardCharactersDialog.__initCharacterSelectors"></a>
<h4>QRegularExpressionWizardCharactersDialog.__initCharacterSelectors</h4>
<b>__initCharacterSelectors</b>(<i></i>)
<p>
        Private method to initialize the W3C character selector entries.
</p>

<a NAME="QRegularExpressionWizardCharactersDialog.__performSelectedAction" ID="QRegularExpressionWizardCharactersDialog.__performSelectedAction"></a>
<h4>QRegularExpressionWizardCharactersDialog.__performSelectedAction</h4>
<b>__performSelectedAction</b>(<i>formatIdentifier, lineedit, combo</i>)
<p>
        Private method performing some actions depending on the input.
</p>

<dl>

<dt><i>formatIdentifier</i> (str)</dt>
<dd>
format of the selected entry
</dd>
<dt><i>lineedit</i> (QLineEdit)</dt>
<dd>
line edit widget to act on
</dd>
<dt><i>combo</i> (QComboBox)</dt>
<dd>
combo box widget to act on
</dd>
</dl>
<a NAME="QRegularExpressionWizardCharactersDialog.__populateCharTypeCombo" ID="QRegularExpressionWizardCharactersDialog.__populateCharTypeCombo"></a>
<h4>QRegularExpressionWizardCharactersDialog.__populateCharTypeCombo</h4>
<b>__populateCharTypeCombo</b>(<i>combo, isSingle</i>)
<p>
        Private method to populate a given character type selection combo box.
</p>

<dl>

<dt><i>combo</i> (QComboBox)</dt>
<dd>
reference to the combo box to be populated
</dd>
<dt><i>isSingle</i> (bool)</dt>
<dd>
flag indicating a singles combo
</dd>
</dl>
<a NAME="QRegularExpressionWizardCharactersDialog.__populateCharacterCombo" ID="QRegularExpressionWizardCharactersDialog.__populateCharacterCombo"></a>
<h4>QRegularExpressionWizardCharactersDialog.__populateCharacterCombo</h4>
<b>__populateCharacterCombo</b>(<i>combo, formatIdentifier</i>)
<p>
        Private method to populate a character selection combo.
</p>

<dl>

<dt><i>combo</i> (QComboBox)</dt>
<dd>
combo box to be populated
</dd>
<dt><i>formatIdentifier</i> (str)</dt>
<dd>
format identifier (one of "-ccp", "-ccn",
            "-cbp", "-cbn", "-csp", "-csn", "-psp", "-psn")
</dd>
</dl>
<a NAME="QRegularExpressionWizardCharactersDialog.__rangesCharTypeSelected" ID="QRegularExpressionWizardCharactersDialog.__rangesCharTypeSelected"></a>
<h4>QRegularExpressionWizardCharactersDialog.__rangesCharTypeSelected</h4>
<b>__rangesCharTypeSelected</b>(<i>index, combo</i>)
<p>
        Private slot to handle the activated(int) signal of the char ranges
        combo boxes.
</p>

<dl>

<dt><i>index</i> (int)</dt>
<dd>
selected list index
</dd>
<dt><i>combo</i> (QComboBox)</dt>
<dd>
reference to the combo box
</dd>
</dl>
<a NAME="QRegularExpressionWizardCharactersDialog.__singlesCharTypeSelected" ID="QRegularExpressionWizardCharactersDialog.__singlesCharTypeSelected"></a>
<h4>QRegularExpressionWizardCharactersDialog.__singlesCharTypeSelected</h4>
<b>__singlesCharTypeSelected</b>(<i>index, combo</i>)
<p>
        Private slot to handle the activated(int) signal of the single chars
        combo boxes.
</p>

<dl>

<dt><i>index</i> (int)</dt>
<dd>
selected list index
</dd>
<dt><i>combo</i> (QComboBox)</dt>
<dd>
reference to the combo box
</dd>
</dl>
<a NAME="QRegularExpressionWizardCharactersDialog.getCharacters" ID="QRegularExpressionWizardCharactersDialog.getCharacters"></a>
<h4>QRegularExpressionWizardCharactersDialog.getCharacters</h4>
<b>getCharacters</b>(<i></i>)
<p>
        Public method to return the character string assembled via the dialog.
</p>

<dl>
<dt>Return:</dt>
<dd>
formatted string for character classes
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>