src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.EricMessageBoxWizard.EricMessageBoxWizardDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.WizardPlugins.EricMessageBoxWizard.EricMessageBoxWizardDialog</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.EricMessageBoxWizard.EricMessageBoxWizardDialog</h1>
10
11 <p>
12 Module implementing the eric message box wizard dialog.
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="#EricMessageBoxWizardDialog">EricMessageBoxWizardDialog</a></td>
25 <td>Class implementing the eric message box wizard dialog.</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="EricMessageBoxWizardDialog" ID="EricMessageBoxWizardDialog"></a>
36 <h2>EricMessageBoxWizardDialog</h2>
37
38 <p>
39 Class implementing the eric message box wizard dialog.
40 </p>
41 <p>
42 It displays a dialog for entering the parameters
43 for the EricMessageBox code generator.
44 </p>
45 <h3>Derived from</h3>
46 QDialog, Ui_EricMessageBoxWizardDialog
47 <h3>Class Attributes</h3>
48
49 <table>
50 <tr><td>None</td></tr>
51 </table>
52 <h3>Class Methods</h3>
53
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58
59 <table>
60
61 <tr>
62 <td><a href="#EricMessageBoxWizardDialog.__init__">EricMessageBoxWizardDialog</a></td>
63 <td>Constructor</td>
64 </tr>
65 <tr>
66 <td><a href="#EricMessageBoxWizardDialog.__enabledGroups">__enabledGroups</a></td>
67 <td>Private method to enable/disable some group boxes.</td>
68 </tr>
69 <tr>
70 <td><a href="#EricMessageBoxWizardDialog.__getDefaultButtonCode">__getDefaultButtonCode</a></td>
71 <td>Private method to generate the button code for the default button.</td>
72 </tr>
73 <tr>
74 <td><a href="#EricMessageBoxWizardDialog.__getStandardButtonCode">__getStandardButtonCode</a></td>
75 <td>Private method to generate the button code for the standard buttons.</td>
76 </tr>
77 <tr>
78 <td><a href="#EricMessageBoxWizardDialog.getCode">getCode</a></td>
79 <td>Public method to get the source code.</td>
80 </tr>
81 <tr>
82 <td><a href="#EricMessageBoxWizardDialog.on_bTest_clicked">on_bTest_clicked</a></td>
83 <td>Private method to test the selected options.</td>
84 </tr>
85 <tr>
86 <td><a href="#EricMessageBoxWizardDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
87 <td>Private slot called by a button of the button box clicked.</td>
88 </tr>
89 <tr>
90 <td><a href="#EricMessageBoxWizardDialog.on_rAboutQt_toggled">on_rAboutQt_toggled</a></td>
91 <td>Private slot to handle the toggled signal of the rAboutQt radio button.</td>
92 </tr>
93 <tr>
94 <td><a href="#EricMessageBoxWizardDialog.on_rAbout_toggled">on_rAbout_toggled</a></td>
95 <td>Private slot to handle the toggled signal of the rAbout radio button.</td>
96 </tr>
97 <tr>
98 <td><a href="#EricMessageBoxWizardDialog.on_rCritical_toggled">on_rCritical_toggled</a></td>
99 <td>Private slot to handle the toggled signal of the rCritical radio button.</td>
100 </tr>
101 <tr>
102 <td><a href="#EricMessageBoxWizardDialog.on_rInformation_toggled">on_rInformation_toggled</a></td>
103 <td>Private slot to handle the toggled signal of the rInformation radio button.</td>
104 </tr>
105 <tr>
106 <td><a href="#EricMessageBoxWizardDialog.on_rOkToClearData_toggled">on_rOkToClearData_toggled</a></td>
107 <td>Private slot to handle the toggled signal of the rOkToClearData radio button.</td>
108 </tr>
109 <tr>
110 <td><a href="#EricMessageBoxWizardDialog.on_rQuestion_toggled">on_rQuestion_toggled</a></td>
111 <td>Private slot to handle the toggled signal of the rQuestion radio button.</td>
112 </tr>
113 <tr>
114 <td><a href="#EricMessageBoxWizardDialog.on_rRetryAbort_toggled">on_rRetryAbort_toggled</a></td>
115 <td>Private slot to handle the toggled signal of the rRetryAbort radio button.</td>
116 </tr>
117 <tr>
118 <td><a href="#EricMessageBoxWizardDialog.on_rStandard_toggled">on_rStandard_toggled</a></td>
119 <td>Private slot to handle the toggled signal of the rStandard radio button.</td>
120 </tr>
121 <tr>
122 <td><a href="#EricMessageBoxWizardDialog.on_rWarning_toggled">on_rWarning_toggled</a></td>
123 <td>Private slot to handle the toggled signal of the rWarning radio button.</td>
124 </tr>
125 <tr>
126 <td><a href="#EricMessageBoxWizardDialog.on_rYesNo_toggled">on_rYesNo_toggled</a></td>
127 <td>Private slot to handle the toggled signal of the rYesNo radio button.</td>
128 </tr>
129 </table>
130 <h3>Static Methods</h3>
131
132 <table>
133 <tr><td>None</td></tr>
134 </table>
135
136 <a NAME="EricMessageBoxWizardDialog.__init__" ID="EricMessageBoxWizardDialog.__init__"></a>
137 <h4>EricMessageBoxWizardDialog (Constructor)</h4>
138 <b>EricMessageBoxWizardDialog</b>(<i>parent=None</i>)
139
140 <p>
141 Constructor
142 </p>
143 <dl>
144
145 <dt><i>parent</i> (QWidget)</dt>
146 <dd>
147 reference to the parent widget
148 </dd>
149 </dl>
150 <a NAME="EricMessageBoxWizardDialog.__enabledGroups" ID="EricMessageBoxWizardDialog.__enabledGroups"></a>
151 <h4>EricMessageBoxWizardDialog.__enabledGroups</h4>
152 <b>__enabledGroups</b>(<i></i>)
153
154 <p>
155 Private method to enable/disable some group boxes.
156 </p>
157 <a NAME="EricMessageBoxWizardDialog.__getDefaultButtonCode" ID="EricMessageBoxWizardDialog.__getDefaultButtonCode"></a>
158 <h4>EricMessageBoxWizardDialog.__getDefaultButtonCode</h4>
159 <b>__getDefaultButtonCode</b>(<i>istring</i>)
160
161 <p>
162 Private method to generate the button code for the default button.
163 </p>
164 <dl>
165
166 <dt><i>istring</i> (str)</dt>
167 <dd>
168 indentation string
169 </dd>
170 </dl>
171 <dl>
172 <dt>Return:</dt>
173 <dd>
174 the button code
175 </dd>
176 </dl>
177 <dl>
178 <dt>Return Type:</dt>
179 <dd>
180 str
181 </dd>
182 </dl>
183 <a NAME="EricMessageBoxWizardDialog.__getStandardButtonCode" ID="EricMessageBoxWizardDialog.__getStandardButtonCode"></a>
184 <h4>EricMessageBoxWizardDialog.__getStandardButtonCode</h4>
185 <b>__getStandardButtonCode</b>(<i>istring, withIntro=True</i>)
186
187 <p>
188 Private method to generate the button code for the standard buttons.
189 </p>
190 <dl>
191
192 <dt><i>istring</i> (str)</dt>
193 <dd>
194 indentation string
195 </dd>
196 <dt><i>withIntro</i> (bool)</dt>
197 <dd>
198 flag indicating to generate a first line
199 with introductory text
200 </dd>
201 </dl>
202 <dl>
203 <dt>Return:</dt>
204 <dd>
205 the button code
206 </dd>
207 </dl>
208 <dl>
209 <dt>Return Type:</dt>
210 <dd>
211 str
212 </dd>
213 </dl>
214 <a NAME="EricMessageBoxWizardDialog.getCode" ID="EricMessageBoxWizardDialog.getCode"></a>
215 <h4>EricMessageBoxWizardDialog.getCode</h4>
216 <b>getCode</b>(<i>indLevel, indString</i>)
217
218 <p>
219 Public method to get the source code.
220 </p>
221 <dl>
222
223 <dt><i>indLevel</i> (int)</dt>
224 <dd>
225 indentation level
226 </dd>
227 <dt><i>indString</i> (str)</dt>
228 <dd>
229 string used for indentation (space or tab)
230 </dd>
231 </dl>
232 <dl>
233 <dt>Return:</dt>
234 <dd>
235 generated code
236 </dd>
237 </dl>
238 <dl>
239 <dt>Return Type:</dt>
240 <dd>
241 str
242 </dd>
243 </dl>
244 <a NAME="EricMessageBoxWizardDialog.on_bTest_clicked" ID="EricMessageBoxWizardDialog.on_bTest_clicked"></a>
245 <h4>EricMessageBoxWizardDialog.on_bTest_clicked</h4>
246 <b>on_bTest_clicked</b>(<i></i>)
247
248 <p>
249 Private method to test the selected options.
250 </p>
251 <a NAME="EricMessageBoxWizardDialog.on_buttonBox_clicked" ID="EricMessageBoxWizardDialog.on_buttonBox_clicked"></a>
252 <h4>EricMessageBoxWizardDialog.on_buttonBox_clicked</h4>
253 <b>on_buttonBox_clicked</b>(<i>button</i>)
254
255 <p>
256 Private slot called by a button of the button box clicked.
257 </p>
258 <dl>
259
260 <dt><i>button</i> (QAbstractButton)</dt>
261 <dd>
262 button that was clicked
263 </dd>
264 </dl>
265 <a NAME="EricMessageBoxWizardDialog.on_rAboutQt_toggled" ID="EricMessageBoxWizardDialog.on_rAboutQt_toggled"></a>
266 <h4>EricMessageBoxWizardDialog.on_rAboutQt_toggled</h4>
267 <b>on_rAboutQt_toggled</b>(<i>on</i>)
268
269 <p>
270 Private slot to handle the toggled signal of the rAboutQt
271 radio button.
272 </p>
273 <dl>
274
275 <dt><i>on</i> (bool)</dt>
276 <dd>
277 toggle state (ignored)
278 </dd>
279 </dl>
280 <a NAME="EricMessageBoxWizardDialog.on_rAbout_toggled" ID="EricMessageBoxWizardDialog.on_rAbout_toggled"></a>
281 <h4>EricMessageBoxWizardDialog.on_rAbout_toggled</h4>
282 <b>on_rAbout_toggled</b>(<i>on</i>)
283
284 <p>
285 Private slot to handle the toggled signal of the rAbout
286 radio button.
287 </p>
288 <dl>
289
290 <dt><i>on</i> (bool)</dt>
291 <dd>
292 toggle state (ignored)
293 </dd>
294 </dl>
295 <a NAME="EricMessageBoxWizardDialog.on_rCritical_toggled" ID="EricMessageBoxWizardDialog.on_rCritical_toggled"></a>
296 <h4>EricMessageBoxWizardDialog.on_rCritical_toggled</h4>
297 <b>on_rCritical_toggled</b>(<i>on</i>)
298
299 <p>
300 Private slot to handle the toggled signal of the rCritical
301 radio button.
302 </p>
303 <dl>
304
305 <dt><i>on</i> (bool)</dt>
306 <dd>
307 toggle state (ignored)
308 </dd>
309 </dl>
310 <a NAME="EricMessageBoxWizardDialog.on_rInformation_toggled" ID="EricMessageBoxWizardDialog.on_rInformation_toggled"></a>
311 <h4>EricMessageBoxWizardDialog.on_rInformation_toggled</h4>
312 <b>on_rInformation_toggled</b>(<i>on</i>)
313
314 <p>
315 Private slot to handle the toggled signal of the rInformation
316 radio button.
317 </p>
318 <dl>
319
320 <dt><i>on</i> (bool)</dt>
321 <dd>
322 toggle state (ignored)
323 </dd>
324 </dl>
325 <a NAME="EricMessageBoxWizardDialog.on_rOkToClearData_toggled" ID="EricMessageBoxWizardDialog.on_rOkToClearData_toggled"></a>
326 <h4>EricMessageBoxWizardDialog.on_rOkToClearData_toggled</h4>
327 <b>on_rOkToClearData_toggled</b>(<i>on</i>)
328
329 <p>
330 Private slot to handle the toggled signal of the rOkToClearData
331 radio button.
332 </p>
333 <dl>
334
335 <dt><i>on</i> (bool)</dt>
336 <dd>
337 toggle state (ignored)
338 </dd>
339 </dl>
340 <a NAME="EricMessageBoxWizardDialog.on_rQuestion_toggled" ID="EricMessageBoxWizardDialog.on_rQuestion_toggled"></a>
341 <h4>EricMessageBoxWizardDialog.on_rQuestion_toggled</h4>
342 <b>on_rQuestion_toggled</b>(<i>on</i>)
343
344 <p>
345 Private slot to handle the toggled signal of the rQuestion
346 radio button.
347 </p>
348 <dl>
349
350 <dt><i>on</i> (bool)</dt>
351 <dd>
352 toggle state (ignored)
353 </dd>
354 </dl>
355 <a NAME="EricMessageBoxWizardDialog.on_rRetryAbort_toggled" ID="EricMessageBoxWizardDialog.on_rRetryAbort_toggled"></a>
356 <h4>EricMessageBoxWizardDialog.on_rRetryAbort_toggled</h4>
357 <b>on_rRetryAbort_toggled</b>(<i>on</i>)
358
359 <p>
360 Private slot to handle the toggled signal of the rRetryAbort
361 radio button.
362 </p>
363 <dl>
364
365 <dt><i>on</i> (bool)</dt>
366 <dd>
367 toggle state (ignored)
368 </dd>
369 </dl>
370 <a NAME="EricMessageBoxWizardDialog.on_rStandard_toggled" ID="EricMessageBoxWizardDialog.on_rStandard_toggled"></a>
371 <h4>EricMessageBoxWizardDialog.on_rStandard_toggled</h4>
372 <b>on_rStandard_toggled</b>(<i>on</i>)
373
374 <p>
375 Private slot to handle the toggled signal of the rStandard
376 radio button.
377 </p>
378 <dl>
379
380 <dt><i>on</i> (bool)</dt>
381 <dd>
382 toggle state (ignored)
383 </dd>
384 </dl>
385 <a NAME="EricMessageBoxWizardDialog.on_rWarning_toggled" ID="EricMessageBoxWizardDialog.on_rWarning_toggled"></a>
386 <h4>EricMessageBoxWizardDialog.on_rWarning_toggled</h4>
387 <b>on_rWarning_toggled</b>(<i>on</i>)
388
389 <p>
390 Private slot to handle the toggled signal of the rWarning
391 radio button.
392 </p>
393 <dl>
394
395 <dt><i>on</i> (bool)</dt>
396 <dd>
397 toggle state (ignored)
398 </dd>
399 </dl>
400 <a NAME="EricMessageBoxWizardDialog.on_rYesNo_toggled" ID="EricMessageBoxWizardDialog.on_rYesNo_toggled"></a>
401 <h4>EricMessageBoxWizardDialog.on_rYesNo_toggled</h4>
402 <b>on_rYesNo_toggled</b>(<i>on</i>)
403
404 <p>
405 Private slot to handle the toggled signal of the rYesNo
406 radio button.
407 </p>
408 <dl>
409
410 <dt><i>on</i> (bool)</dt>
411 <dd>
412 toggle state (ignored)
413 </dd>
414 </dl>
415 <div align="right"><a href="#top">Up</a></div>
416 <hr />
417 </body></html>

eric ide

mercurial