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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10437
2f70ca07f0af
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardCharactersDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardCharactersDialog</h1>
10
11 <p>
12 Module implementing a dialog for entering character classes.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#QRegularExpressionWizardCharactersDialog">QRegularExpressionWizardCharactersDialog</a></td>
25 <td>Class implementing a dialog for entering character classes.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="QRegularExpressionWizardCharactersDialog" ID="QRegularExpressionWizardCharactersDialog"></a>
36 <h2>QRegularExpressionWizardCharactersDialog</h2>
37
38 <p>
39 Class implementing a dialog for entering character classes.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_QRegularExpressionWizardCharactersDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#QRegularExpressionWizardCharactersDialog.__init__">QRegularExpressionWizardCharactersDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#QRegularExpressionWizardCharactersDialog.__addRangesLine">__addRangesLine</a></td>
63 <td>Private slot to add a line of entry widgets for character ranges.</td>
64 </tr>
65 <tr>
66 <td><a href="#QRegularExpressionWizardCharactersDialog.__addSinglesLine">__addSinglesLine</a></td>
67 <td>Private slot to add a line of entry widgets for single characters.</td>
68 </tr>
69 <tr>
70 <td><a href="#QRegularExpressionWizardCharactersDialog.__formatCharacter">__formatCharacter</a></td>
71 <td>Private method to format the characters entered into the dialog.</td>
72 </tr>
73 <tr>
74 <td><a href="#QRegularExpressionWizardCharactersDialog.__initCharacterSelectors">__initCharacterSelectors</a></td>
75 <td>Private method to initialize the W3C character selector entries.</td>
76 </tr>
77 <tr>
78 <td><a href="#QRegularExpressionWizardCharactersDialog.__performSelectedAction">__performSelectedAction</a></td>
79 <td>Private method performing some actions depending on the input.</td>
80 </tr>
81 <tr>
82 <td><a href="#QRegularExpressionWizardCharactersDialog.__populateCharTypeCombo">__populateCharTypeCombo</a></td>
83 <td>Private method to populate a given character type selection combo box.</td>
84 </tr>
85 <tr>
86 <td><a href="#QRegularExpressionWizardCharactersDialog.__populateCharacterCombo">__populateCharacterCombo</a></td>
87 <td>Private method to populate a character selection combo.</td>
88 </tr>
89 <tr>
90 <td><a href="#QRegularExpressionWizardCharactersDialog.__rangesCharTypeSelected">__rangesCharTypeSelected</a></td>
91 <td>Private slot to handle the activated(int) signal of the char ranges combo boxes.</td>
92 </tr>
93 <tr>
94 <td><a href="#QRegularExpressionWizardCharactersDialog.__singlesCharTypeSelected">__singlesCharTypeSelected</a></td>
95 <td>Private slot to handle the activated(int) signal of the single chars combo boxes.</td>
96 </tr>
97 <tr>
98 <td><a href="#QRegularExpressionWizardCharactersDialog.getCharacters">getCharacters</a></td>
99 <td>Public method to return the character string assembled via the dialog.</td>
100 </tr>
101 </table>
102 <h3>Static Methods</h3>
103
104 <table>
105 <tr><td>None</td></tr>
106 </table>
107
108 <a NAME="QRegularExpressionWizardCharactersDialog.__init__" ID="QRegularExpressionWizardCharactersDialog.__init__"></a>
109 <h4>QRegularExpressionWizardCharactersDialog (Constructor)</h4>
110 <b>QRegularExpressionWizardCharactersDialog</b>(<i>parent=None</i>)
111
112 <p>
113 Constructor
114 </p>
115 <dl>
116
117 <dt><i>parent</i></dt>
118 <dd>
119 reference to the parent widget (QWidget)
120 </dd>
121 </dl>
122 <a NAME="QRegularExpressionWizardCharactersDialog.__addRangesLine" ID="QRegularExpressionWizardCharactersDialog.__addRangesLine"></a>
123 <h4>QRegularExpressionWizardCharactersDialog.__addRangesLine</h4>
124 <b>__addRangesLine</b>(<i></i>)
125
126 <p>
127 Private slot to add a line of entry widgets for character ranges.
128 </p>
129 <a NAME="QRegularExpressionWizardCharactersDialog.__addSinglesLine" ID="QRegularExpressionWizardCharactersDialog.__addSinglesLine"></a>
130 <h4>QRegularExpressionWizardCharactersDialog.__addSinglesLine</h4>
131 <b>__addSinglesLine</b>(<i></i>)
132
133 <p>
134 Private slot to add a line of entry widgets for single characters.
135 </p>
136 <a NAME="QRegularExpressionWizardCharactersDialog.__formatCharacter" ID="QRegularExpressionWizardCharactersDialog.__formatCharacter"></a>
137 <h4>QRegularExpressionWizardCharactersDialog.__formatCharacter</h4>
138 <b>__formatCharacter</b>(<i>char, formatIdentifier</i>)
139
140 <p>
141 Private method to format the characters entered into the dialog.
142 </p>
143 <dl>
144
145 <dt><i>char</i></dt>
146 <dd>
147 character string entered into the dialog (string)
148 </dd>
149 <dt><i>formatIdentifier</i></dt>
150 <dd>
151 string giving a special format (-c, -h, -i or
152 -o) or the already formatted character (string)
153 </dd>
154 </dl>
155 <dl>
156 <dt>Return:</dt>
157 <dd>
158 formatted character string (string)
159 </dd>
160 </dl>
161 <a NAME="QRegularExpressionWizardCharactersDialog.__initCharacterSelectors" ID="QRegularExpressionWizardCharactersDialog.__initCharacterSelectors"></a>
162 <h4>QRegularExpressionWizardCharactersDialog.__initCharacterSelectors</h4>
163 <b>__initCharacterSelectors</b>(<i></i>)
164
165 <p>
166 Private method to initialize the W3C character selector entries.
167 </p>
168 <a NAME="QRegularExpressionWizardCharactersDialog.__performSelectedAction" ID="QRegularExpressionWizardCharactersDialog.__performSelectedAction"></a>
169 <h4>QRegularExpressionWizardCharactersDialog.__performSelectedAction</h4>
170 <b>__performSelectedAction</b>(<i>formatIdentifier, lineedit, combo</i>)
171
172 <p>
173 Private method performing some actions depending on the input.
174 </p>
175 <dl>
176
177 <dt><i>formatIdentifier</i></dt>
178 <dd>
179 format of the selected entry (string)
180 </dd>
181 <dt><i>lineedit</i></dt>
182 <dd>
183 line edit widget to act on (QLineEdit)
184 </dd>
185 <dt><i>combo</i></dt>
186 <dd>
187 combo box widget to act on (QComboBox)
188 </dd>
189 </dl>
190 <a NAME="QRegularExpressionWizardCharactersDialog.__populateCharTypeCombo" ID="QRegularExpressionWizardCharactersDialog.__populateCharTypeCombo"></a>
191 <h4>QRegularExpressionWizardCharactersDialog.__populateCharTypeCombo</h4>
192 <b>__populateCharTypeCombo</b>(<i>combo, isSingle</i>)
193
194 <p>
195 Private method to populate a given character type selection combo box.
196 </p>
197 <dl>
198
199 <dt><i>combo</i></dt>
200 <dd>
201 reference to the combo box to be populated (QComboBox)
202 </dd>
203 <dt><i>isSingle</i></dt>
204 <dd>
205 flag indicating a singles combo (boolean)
206 </dd>
207 </dl>
208 <a NAME="QRegularExpressionWizardCharactersDialog.__populateCharacterCombo" ID="QRegularExpressionWizardCharactersDialog.__populateCharacterCombo"></a>
209 <h4>QRegularExpressionWizardCharactersDialog.__populateCharacterCombo</h4>
210 <b>__populateCharacterCombo</b>(<i>combo, formatIdentifier</i>)
211
212 <p>
213 Private method to populate a character selection combo.
214 </p>
215 <dl>
216
217 <dt><i>combo</i></dt>
218 <dd>
219 combo box to be populated (QComboBox)
220 </dd>
221 <dt><i>formatIdentifier</i></dt>
222 <dd>
223 format identifier (one of "-ccp", "-ccn",
224 "-cbp", "-cbn", "-csp", "-csn", "-psp", "-psn")
225 </dd>
226 </dl>
227 <a NAME="QRegularExpressionWizardCharactersDialog.__rangesCharTypeSelected" ID="QRegularExpressionWizardCharactersDialog.__rangesCharTypeSelected"></a>
228 <h4>QRegularExpressionWizardCharactersDialog.__rangesCharTypeSelected</h4>
229 <b>__rangesCharTypeSelected</b>(<i>index, combo</i>)
230
231 <p>
232 Private slot to handle the activated(int) signal of the char ranges
233 combo boxes.
234 </p>
235 <dl>
236
237 <dt><i>index</i> (int)</dt>
238 <dd>
239 selected list index
240 </dd>
241 <dt><i>combo</i> (QComboBox)</dt>
242 <dd>
243 reference to the combo box
244 </dd>
245 </dl>
246 <a NAME="QRegularExpressionWizardCharactersDialog.__singlesCharTypeSelected" ID="QRegularExpressionWizardCharactersDialog.__singlesCharTypeSelected"></a>
247 <h4>QRegularExpressionWizardCharactersDialog.__singlesCharTypeSelected</h4>
248 <b>__singlesCharTypeSelected</b>(<i>index, combo</i>)
249
250 <p>
251 Private slot to handle the activated(int) signal of the single chars
252 combo boxes.
253 </p>
254 <dl>
255
256 <dt><i>index</i> (int)</dt>
257 <dd>
258 selected list index
259 </dd>
260 <dt><i>combo</i> (QComboBox)</dt>
261 <dd>
262 reference to the combo box
263 </dd>
264 </dl>
265 <a NAME="QRegularExpressionWizardCharactersDialog.getCharacters" ID="QRegularExpressionWizardCharactersDialog.getCharacters"></a>
266 <h4>QRegularExpressionWizardCharactersDialog.getCharacters</h4>
267 <b>getCharacters</b>(<i></i>)
268
269 <p>
270 Public method to return the character string assembled via the dialog.
271 </p>
272 <dl>
273 <dt>Return:</dt>
274 <dd>
275 formatted string for character classes (string)
276 </dd>
277 </dl>
278 <div align="right"><a href="#top">Up</a></div>
279 <hr />
280 </body></html>

eric ide

mercurial