src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.SetupWizard.SetupWizardDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 9202
81388c6065e8
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.WizardPlugins.SetupWizard.SetupWizardDialog</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.SetupWizard.SetupWizardDialog</h1>
10
11 <p>
12 Module implementing the setup.py 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="#SetupWizardDialog">SetupWizardDialog</a></td>
25 <td>Class implementing the setup.py 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="SetupWizardDialog" ID="SetupWizardDialog"></a>
36 <h2>SetupWizardDialog</h2>
37
38 <p>
39 Class implementing the setup.py wizard dialog.
40 </p>
41 <p>
42 It displays a dialog for entering the parameters for the setup.py code
43 generator.
44 </p>
45 <h3>Derived from</h3>
46 QDialog, Ui_SetupWizardDialog
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="#SetupWizardDialog.__init__">SetupWizardDialog</a></td>
63 <td>Constructor</td>
64 </tr>
65 <tr>
66 <td><a href="#SetupWizardDialog.__addClassifierEntry">__addClassifierEntry</a></td>
67 <td>Private method to add a new entry to the list of trove classifiers.</td>
68 </tr>
69 <tr>
70 <td><a href="#SetupWizardDialog.__enableOkButton">__enableOkButton</a></td>
71 <td>Private slot to set the state of the OK button.</td>
72 </tr>
73 <tr>
74 <td><a href="#SetupWizardDialog.__getLicenseText">__getLicenseText</a></td>
75 <td>Private method to get the license text.</td>
76 </tr>
77 <tr>
78 <td><a href="#SetupWizardDialog.__getPyprojectCode">__getPyprojectCode</a></td>
79 <td>Private method to get the source code for a 'pyproject.toml' file.</td>
80 </tr>
81 <tr>
82 <td><a href="#SetupWizardDialog.__getSetupCfgCode">__getSetupCfgCode</a></td>
83 <td>Private method to get the source code for a 'setup.cfg' file.</td>
84 </tr>
85 <tr>
86 <td><a href="#SetupWizardDialog.__getSetupPyCode">__getSetupPyCode</a></td>
87 <td>Private method to get the source code for a 'setup.py' file.</td>
88 </tr>
89 <tr>
90 <td><a href="#SetupWizardDialog.__getStartDir">__getStartDir</a></td>
91 <td>Private method to get the start directory for selection dialogs.</td>
92 </tr>
93 <tr>
94 <td><a href="#SetupWizardDialog.__populateClassifiers">__populateClassifiers</a></td>
95 <td>Private method to populate the classifiers.</td>
96 </tr>
97 <tr>
98 <td><a href="#SetupWizardDialog.accept">accept</a></td>
99 <td>Public slot to handle pressing the OK button.</td>
100 </tr>
101 <tr>
102 <td><a href="#SetupWizardDialog.on_addEntryPointButton_clicked">on_addEntryPointButton_clicked</a></td>
103 <td>Private slot to add an entry point to the list.</td>
104 </tr>
105 <tr>
106 <td><a href="#SetupWizardDialog.on_addExludePatternButton_clicked">on_addExludePatternButton_clicked</a></td>
107 <td>Private slot to add an exclude pattern to the list.</td>
108 </tr>
109 <tr>
110 <td><a href="#SetupWizardDialog.on_addModuleButton_clicked">on_addModuleButton_clicked</a></td>
111 <td>Private slot to add Python modules to the list.</td>
112 </tr>
113 <tr>
114 <td><a href="#SetupWizardDialog.on_deleteEntryPointButton_clicked">on_deleteEntryPointButton_clicked</a></td>
115 <td>Private slot to delete the selected entry point items.</td>
116 </tr>
117 <tr>
118 <td><a href="#SetupWizardDialog.on_deleteExcludePatternButton_clicked">on_deleteExcludePatternButton_clicked</a></td>
119 <td>Private slot to delete the selected exclude pattern items.</td>
120 </tr>
121 <tr>
122 <td><a href="#SetupWizardDialog.on_deleteModuleButton_clicked">on_deleteModuleButton_clicked</a></td>
123 <td>Private slot to delete the selected module items.</td>
124 </tr>
125 <tr>
126 <td><a href="#SetupWizardDialog.on_editEntryPointButton_clicked">on_editEntryPointButton_clicked</a></td>
127 <td>Private slot to edit the selected entry point.</td>
128 </tr>
129 <tr>
130 <td><a href="#SetupWizardDialog.on_entryPointsList_itemSelectionChanged">on_entryPointsList_itemSelectionChanged</a></td>
131 <td>Private slot to handle a change of selected items of the entry points list.</td>
132 </tr>
133 <tr>
134 <td><a href="#SetupWizardDialog.on_excludePatternEdit_returnPressed">on_excludePatternEdit_returnPressed</a></td>
135 <td>Private slot handling a press of the return button of the exclude pattern edit.</td>
136 </tr>
137 <tr>
138 <td><a href="#SetupWizardDialog.on_excludePatternEdit_textChanged">on_excludePatternEdit_textChanged</a></td>
139 <td>Private slot to handle a change of the exclude pattern text.</td>
140 </tr>
141 <tr>
142 <td><a href="#SetupWizardDialog.on_excludePatternList_itemSelectionChanged">on_excludePatternList_itemSelectionChanged</a></td>
143 <td>Private slot to handle a change of selected items of the exclude pattern list.</td>
144 </tr>
145 <tr>
146 <td><a href="#SetupWizardDialog.on_modulesList_itemSelectionChanged">on_modulesList_itemSelectionChanged</a></td>
147 <td>Private slot to handle a change of selected items of the modules list.</td>
148 </tr>
149 <tr>
150 <td><a href="#SetupWizardDialog.on_projectButton_clicked">on_projectButton_clicked</a></td>
151 <td>Private slot to populate some fields with data retrieved from the current project.</td>
152 </tr>
153 <tr>
154 <td><a href="#SetupWizardDialog.on_projectUrlsList_itemSelectionChanged">on_projectUrlsList_itemSelectionChanged</a></td>
155 <td>Private slot to handle a change of selected items of the project URLs list.</td>
156 </tr>
157 <tr>
158 <td><a href="#SetupWizardDialog.on_urlAddButton_clicked">on_urlAddButton_clicked</a></td>
159 <td>Private slot to add a project URL to the list.</td>
160 </tr>
161 <tr>
162 <td><a href="#SetupWizardDialog.on_urlDeleteButton_clicked">on_urlDeleteButton_clicked</a></td>
163 <td>Private slot to delete the selected URL items.</td>
164 </tr>
165 <tr>
166 <td><a href="#SetupWizardDialog.on_urlEditButton_clicked">on_urlEditButton_clicked</a></td>
167 <td>Private slot to edit the selected project URL.</td>
168 </tr>
169 </table>
170 <h3>Static Methods</h3>
171
172 <table>
173 <tr><td>None</td></tr>
174 </table>
175
176 <a NAME="SetupWizardDialog.__init__" ID="SetupWizardDialog.__init__"></a>
177 <h4>SetupWizardDialog (Constructor)</h4>
178 <b>SetupWizardDialog</b>(<i>category, editor, parent=None</i>)
179
180 <p>
181 Constructor
182 </p>
183 <dl>
184
185 <dt><i>category</i> (str)</dt>
186 <dd>
187 category of setup file to create
188 </dd>
189 <dt><i>editor</i> (Editor)</dt>
190 <dd>
191 reference to the editor object to receive the code
192 </dd>
193 <dt><i>parent</i> (QWidget (optional))</dt>
194 <dd>
195 reference to the parent widget (defaults to None)
196 </dd>
197 </dl>
198 <dl>
199
200 <dt>Raises <b>ValueError</b>:</dt>
201 <dd>
202 raised for an illegal setup file category
203 </dd>
204 </dl>
205 <a NAME="SetupWizardDialog.__addClassifierEntry" ID="SetupWizardDialog.__addClassifierEntry"></a>
206 <h4>SetupWizardDialog.__addClassifierEntry</h4>
207 <b>__addClassifierEntry</b>(<i>classifier</i>)
208
209 <p>
210 Private method to add a new entry to the list of trove classifiers.
211 </p>
212 <dl>
213
214 <dt><i>classifier</i> (str)</dt>
215 <dd>
216 classifier containing the data for the entry
217 </dd>
218 </dl>
219 <a NAME="SetupWizardDialog.__enableOkButton" ID="SetupWizardDialog.__enableOkButton"></a>
220 <h4>SetupWizardDialog.__enableOkButton</h4>
221 <b>__enableOkButton</b>(<i></i>)
222
223 <p>
224 Private slot to set the state of the OK button.
225 </p>
226 <a NAME="SetupWizardDialog.__getLicenseText" ID="SetupWizardDialog.__getLicenseText"></a>
227 <h4>SetupWizardDialog.__getLicenseText</h4>
228 <b>__getLicenseText</b>(<i></i>)
229
230 <p>
231 Private method to get the license text.
232 </p>
233 <dl>
234 <dt>Return:</dt>
235 <dd>
236 license text
237 </dd>
238 </dl>
239 <dl>
240 <dt>Return Type:</dt>
241 <dd>
242 str
243 </dd>
244 </dl>
245 <a NAME="SetupWizardDialog.__getPyprojectCode" ID="SetupWizardDialog.__getPyprojectCode"></a>
246 <h4>SetupWizardDialog.__getPyprojectCode</h4>
247 <b>__getPyprojectCode</b>(<i></i>)
248
249 <p>
250 Private method to get the source code for a 'pyproject.toml' file.
251 </p>
252 <dl>
253 <dt>Return:</dt>
254 <dd>
255 generated code
256 </dd>
257 </dl>
258 <dl>
259 <dt>Return Type:</dt>
260 <dd>
261 str
262 </dd>
263 </dl>
264 <a NAME="SetupWizardDialog.__getSetupCfgCode" ID="SetupWizardDialog.__getSetupCfgCode"></a>
265 <h4>SetupWizardDialog.__getSetupCfgCode</h4>
266 <b>__getSetupCfgCode</b>(<i></i>)
267
268 <p>
269 Private method to get the source code for a 'setup.cfg' file.
270 </p>
271 <dl>
272 <dt>Return:</dt>
273 <dd>
274 generated code
275 </dd>
276 </dl>
277 <dl>
278 <dt>Return Type:</dt>
279 <dd>
280 str
281 </dd>
282 </dl>
283 <a NAME="SetupWizardDialog.__getSetupPyCode" ID="SetupWizardDialog.__getSetupPyCode"></a>
284 <h4>SetupWizardDialog.__getSetupPyCode</h4>
285 <b>__getSetupPyCode</b>(<i>indLevel, indString</i>)
286
287 <p>
288 Private method to get the source code for a 'setup.py' file.
289 </p>
290 <dl>
291
292 <dt><i>indLevel</i> (int)</dt>
293 <dd>
294 indentation level
295 </dd>
296 <dt><i>indString</i> (str)</dt>
297 <dd>
298 string used for indentation (space or tab)
299 </dd>
300 </dl>
301 <dl>
302 <dt>Return:</dt>
303 <dd>
304 generated code
305 </dd>
306 </dl>
307 <dl>
308 <dt>Return Type:</dt>
309 <dd>
310 str
311 </dd>
312 </dl>
313 <a NAME="SetupWizardDialog.__getStartDir" ID="SetupWizardDialog.__getStartDir"></a>
314 <h4>SetupWizardDialog.__getStartDir</h4>
315 <b>__getStartDir</b>(<i></i>)
316
317 <p>
318 Private method to get the start directory for selection dialogs.
319 </p>
320 <dl>
321 <dt>Return:</dt>
322 <dd>
323 start directory
324 </dd>
325 </dl>
326 <dl>
327 <dt>Return Type:</dt>
328 <dd>
329 str
330 </dd>
331 </dl>
332 <a NAME="SetupWizardDialog.__populateClassifiers" ID="SetupWizardDialog.__populateClassifiers"></a>
333 <h4>SetupWizardDialog.__populateClassifiers</h4>
334 <b>__populateClassifiers</b>(<i></i>)
335
336 <p>
337 Private method to populate the classifiers.
338 </p>
339 <a NAME="SetupWizardDialog.accept" ID="SetupWizardDialog.accept"></a>
340 <h4>SetupWizardDialog.accept</h4>
341 <b>accept</b>(<i></i>)
342
343 <p>
344 Public slot to handle pressing the OK button.
345 </p>
346 <a NAME="SetupWizardDialog.on_addEntryPointButton_clicked" ID="SetupWizardDialog.on_addEntryPointButton_clicked"></a>
347 <h4>SetupWizardDialog.on_addEntryPointButton_clicked</h4>
348 <b>on_addEntryPointButton_clicked</b>(<i></i>)
349
350 <p>
351 Private slot to add an entry point to the list.
352 </p>
353 <a NAME="SetupWizardDialog.on_addExludePatternButton_clicked" ID="SetupWizardDialog.on_addExludePatternButton_clicked"></a>
354 <h4>SetupWizardDialog.on_addExludePatternButton_clicked</h4>
355 <b>on_addExludePatternButton_clicked</b>(<i></i>)
356
357 <p>
358 Private slot to add an exclude pattern to the list.
359 </p>
360 <a NAME="SetupWizardDialog.on_addModuleButton_clicked" ID="SetupWizardDialog.on_addModuleButton_clicked"></a>
361 <h4>SetupWizardDialog.on_addModuleButton_clicked</h4>
362 <b>on_addModuleButton_clicked</b>(<i></i>)
363
364 <p>
365 Private slot to add Python modules to the list.
366 </p>
367 <a NAME="SetupWizardDialog.on_deleteEntryPointButton_clicked" ID="SetupWizardDialog.on_deleteEntryPointButton_clicked"></a>
368 <h4>SetupWizardDialog.on_deleteEntryPointButton_clicked</h4>
369 <b>on_deleteEntryPointButton_clicked</b>(<i></i>)
370
371 <p>
372 Private slot to delete the selected entry point items.
373 </p>
374 <a NAME="SetupWizardDialog.on_deleteExcludePatternButton_clicked" ID="SetupWizardDialog.on_deleteExcludePatternButton_clicked"></a>
375 <h4>SetupWizardDialog.on_deleteExcludePatternButton_clicked</h4>
376 <b>on_deleteExcludePatternButton_clicked</b>(<i></i>)
377
378 <p>
379 Private slot to delete the selected exclude pattern items.
380 </p>
381 <a NAME="SetupWizardDialog.on_deleteModuleButton_clicked" ID="SetupWizardDialog.on_deleteModuleButton_clicked"></a>
382 <h4>SetupWizardDialog.on_deleteModuleButton_clicked</h4>
383 <b>on_deleteModuleButton_clicked</b>(<i></i>)
384
385 <p>
386 Private slot to delete the selected module items.
387 </p>
388 <a NAME="SetupWizardDialog.on_editEntryPointButton_clicked" ID="SetupWizardDialog.on_editEntryPointButton_clicked"></a>
389 <h4>SetupWizardDialog.on_editEntryPointButton_clicked</h4>
390 <b>on_editEntryPointButton_clicked</b>(<i></i>)
391
392 <p>
393 Private slot to edit the selected entry point.
394 </p>
395 <a NAME="SetupWizardDialog.on_entryPointsList_itemSelectionChanged" ID="SetupWizardDialog.on_entryPointsList_itemSelectionChanged"></a>
396 <h4>SetupWizardDialog.on_entryPointsList_itemSelectionChanged</h4>
397 <b>on_entryPointsList_itemSelectionChanged</b>(<i></i>)
398
399 <p>
400 Private slot to handle a change of selected items of the
401 entry points list.
402 </p>
403 <a NAME="SetupWizardDialog.on_excludePatternEdit_returnPressed" ID="SetupWizardDialog.on_excludePatternEdit_returnPressed"></a>
404 <h4>SetupWizardDialog.on_excludePatternEdit_returnPressed</h4>
405 <b>on_excludePatternEdit_returnPressed</b>(<i></i>)
406
407 <p>
408 Private slot handling a press of the return button of the
409 exclude pattern edit.
410 </p>
411 <a NAME="SetupWizardDialog.on_excludePatternEdit_textChanged" ID="SetupWizardDialog.on_excludePatternEdit_textChanged"></a>
412 <h4>SetupWizardDialog.on_excludePatternEdit_textChanged</h4>
413 <b>on_excludePatternEdit_textChanged</b>(<i>txt</i>)
414
415 <p>
416 Private slot to handle a change of the exclude pattern text.
417 </p>
418 <dl>
419
420 <dt><i>txt</i> (str)</dt>
421 <dd>
422 text of the line edit
423 </dd>
424 </dl>
425 <a NAME="SetupWizardDialog.on_excludePatternList_itemSelectionChanged" ID="SetupWizardDialog.on_excludePatternList_itemSelectionChanged"></a>
426 <h4>SetupWizardDialog.on_excludePatternList_itemSelectionChanged</h4>
427 <b>on_excludePatternList_itemSelectionChanged</b>(<i></i>)
428
429 <p>
430 Private slot to handle a change of selected items of the
431 exclude pattern list.
432 </p>
433 <a NAME="SetupWizardDialog.on_modulesList_itemSelectionChanged" ID="SetupWizardDialog.on_modulesList_itemSelectionChanged"></a>
434 <h4>SetupWizardDialog.on_modulesList_itemSelectionChanged</h4>
435 <b>on_modulesList_itemSelectionChanged</b>(<i></i>)
436
437 <p>
438 Private slot to handle a change of selected items of the
439 modules list.
440 </p>
441 <a NAME="SetupWizardDialog.on_projectButton_clicked" ID="SetupWizardDialog.on_projectButton_clicked"></a>
442 <h4>SetupWizardDialog.on_projectButton_clicked</h4>
443 <b>on_projectButton_clicked</b>(<i></i>)
444
445 <p>
446 Private slot to populate some fields with data retrieved from the
447 current project.
448 </p>
449 <a NAME="SetupWizardDialog.on_projectUrlsList_itemSelectionChanged" ID="SetupWizardDialog.on_projectUrlsList_itemSelectionChanged"></a>
450 <h4>SetupWizardDialog.on_projectUrlsList_itemSelectionChanged</h4>
451 <b>on_projectUrlsList_itemSelectionChanged</b>(<i></i>)
452
453 <p>
454 Private slot to handle a change of selected items of the
455 project URLs list.
456 </p>
457 <a NAME="SetupWizardDialog.on_urlAddButton_clicked" ID="SetupWizardDialog.on_urlAddButton_clicked"></a>
458 <h4>SetupWizardDialog.on_urlAddButton_clicked</h4>
459 <b>on_urlAddButton_clicked</b>(<i></i>)
460
461 <p>
462 Private slot to add a project URL to the list.
463 </p>
464 <a NAME="SetupWizardDialog.on_urlDeleteButton_clicked" ID="SetupWizardDialog.on_urlDeleteButton_clicked"></a>
465 <h4>SetupWizardDialog.on_urlDeleteButton_clicked</h4>
466 <b>on_urlDeleteButton_clicked</b>(<i></i>)
467
468 <p>
469 Private slot to delete the selected URL items.
470 </p>
471 <a NAME="SetupWizardDialog.on_urlEditButton_clicked" ID="SetupWizardDialog.on_urlEditButton_clicked"></a>
472 <h4>SetupWizardDialog.on_urlEditButton_clicked</h4>
473 <b>on_urlEditButton_clicked</b>(<i></i>)
474
475 <p>
476 Private slot to edit the selected project URL.
477 </p>
478 <div align="right"><a href="#top">Up</a></div>
479 <hr />
480 </body></html>

eric ide

mercurial