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

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

eric ide

mercurial