Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Plugins.WizardPlugins.SetupWizard.SetupWizardDialog.html

Documentation/Source/eric6.Plugins.WizardPlugins.SetupWizard.SetupWizardDialog.html

changeset 6015
26fc8e08f4ac
equal deleted inserted replaced
6014:d3375a0a3240 6015:26fc8e08f4ac
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.WizardPlugins.SetupWizard.SetupWizardDialog</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><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.WizardPlugins.SetupWizard.SetupWizardDialog</h1>
23 <p>
24 Module implementing the setup.py wizard dialog.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#SetupWizardDialog">SetupWizardDialog</a></td>
34 <td>Class implementing the setup.py wizard dialog.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="SetupWizardDialog" ID="SetupWizardDialog"></a>
43 <h2>SetupWizardDialog</h2>
44 <p>
45 Class implementing the setup.py wizard dialog.
46 </p><p>
47 It displays a dialog for entering the parameters
48 for the E5MessageBox code generator.
49 </p>
50 <h3>Derived from</h3>
51 QDialog, Ui_SetupWizardDialog
52 <h3>Class Attributes</h3>
53 <table>
54 <tr><td>None</td></tr>
55 </table>
56 <h3>Class Methods</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Methods</h3>
61 <table>
62 <tr>
63 <td><a href="#SetupWizardDialog.__init__">SetupWizardDialog</a></td>
64 <td>Constructor</td>
65 </tr><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><tr>
69 <td><a href="#SetupWizardDialog.__addPackage">__addPackage</a></td>
70 <td>Private method to add a package to the list.</td>
71 </tr><tr>
72 <td><a href="#SetupWizardDialog.__enableOkButton">__enableOkButton</a></td>
73 <td>Private slot to set the state of the OK button.</td>
74 </tr><tr>
75 <td><a href="#SetupWizardDialog.__getLicenseText">__getLicenseText</a></td>
76 <td>Private method to get the license text.</td>
77 </tr><tr>
78 <td><a href="#SetupWizardDialog.__getStartDir">__getStartDir</a></td>
79 <td>Private method to get the start directory for selection dialogs.</td>
80 </tr><tr>
81 <td><a href="#SetupWizardDialog.__populateFromTroveLists">__populateFromTroveLists</a></td>
82 <td>Private method to populate lists from the Trove list file.</td>
83 </tr><tr>
84 <td><a href="#SetupWizardDialog.getCode">getCode</a></td>
85 <td>Public method to get the source code.</td>
86 </tr><tr>
87 <td><a href="#SetupWizardDialog.on_addExludePatternButton_clicked">on_addExludePatternButton_clicked</a></td>
88 <td>Private slot to add an exclude pattern to the list.</td>
89 </tr><tr>
90 <td><a href="#SetupWizardDialog.on_addModuleButton_clicked">on_addModuleButton_clicked</a></td>
91 <td>Private slot to add Python modules to the list.</td>
92 </tr><tr>
93 <td><a href="#SetupWizardDialog.on_addPackageButton_clicked">on_addPackageButton_clicked</a></td>
94 <td>Private slot to add a package to the list.</td>
95 </tr><tr>
96 <td><a href="#SetupWizardDialog.on_addScriptButton_clicked">on_addScriptButton_clicked</a></td>
97 <td>Private slot to add scripts to the list.</td>
98 </tr><tr>
99 <td><a href="#SetupWizardDialog.on_autodiscoverPackagesButton_clicked">on_autodiscoverPackagesButton_clicked</a></td>
100 <td>Private slot to discover packages automatically.</td>
101 </tr><tr>
102 <td><a href="#SetupWizardDialog.on_deleteExcludePatternButton_clicked">on_deleteExcludePatternButton_clicked</a></td>
103 <td>Private slot to delete the selected exclude pattern items.</td>
104 </tr><tr>
105 <td><a href="#SetupWizardDialog.on_deleteModuleButton_clicked">on_deleteModuleButton_clicked</a></td>
106 <td>Private slot to delete the selected script items.</td>
107 </tr><tr>
108 <td><a href="#SetupWizardDialog.on_deletePackageButton_clicked">on_deletePackageButton_clicked</a></td>
109 <td>Private slot to delete the selected package items.</td>
110 </tr><tr>
111 <td><a href="#SetupWizardDialog.on_deleteScriptButton_clicked">on_deleteScriptButton_clicked</a></td>
112 <td>Private slot to delete the selected script items.</td>
113 </tr><tr>
114 <td><a href="#SetupWizardDialog.on_excludePatternEdit_returnPressed">on_excludePatternEdit_returnPressed</a></td>
115 <td>Private slot handling a press of the return button of the exclude pattern edit.</td>
116 </tr><tr>
117 <td><a href="#SetupWizardDialog.on_excludePatternEdit_textChanged">on_excludePatternEdit_textChanged</a></td>
118 <td>Private slot to handle a change of the exclude pattern text.</td>
119 </tr><tr>
120 <td><a href="#SetupWizardDialog.on_excludePatternList_itemSelectionChanged">on_excludePatternList_itemSelectionChanged</a></td>
121 <td>Private slot to handle a change of selected items of the exclude pattern list.</td>
122 </tr><tr>
123 <td><a href="#SetupWizardDialog.on_modulesList_itemSelectionChanged">on_modulesList_itemSelectionChanged</a></td>
124 <td>Private slot to handle a change of selected items of the modules list.</td>
125 </tr><tr>
126 <td><a href="#SetupWizardDialog.on_packageDirButton_clicked">on_packageDirButton_clicked</a></td>
127 <td>Private slot to select a package directory via a directory selection dialog.</td>
128 </tr><tr>
129 <td><a href="#SetupWizardDialog.on_packageEdit_returnPressed">on_packageEdit_returnPressed</a></td>
130 <td>Private slot handling a press of the return button of the package edit.</td>
131 </tr><tr>
132 <td><a href="#SetupWizardDialog.on_packageEdit_textChanged">on_packageEdit_textChanged</a></td>
133 <td>Private slot to handle a change of the package text.</td>
134 </tr><tr>
135 <td><a href="#SetupWizardDialog.on_packageRootDirButton_clicked">on_packageRootDirButton_clicked</a></td>
136 <td>Private slot to select the packages root directory via a directory selection dialog.</td>
137 </tr><tr>
138 <td><a href="#SetupWizardDialog.on_packageRootEdit_textChanged">on_packageRootEdit_textChanged</a></td>
139 <td>Private slot handling the entering of a packages root.</td>
140 </tr><tr>
141 <td><a href="#SetupWizardDialog.on_packagesList_itemSelectionChanged">on_packagesList_itemSelectionChanged</a></td>
142 <td>Private slot to handle a change of selected items of the packages list.</td>
143 </tr><tr>
144 <td><a href="#SetupWizardDialog.on_projectButton_clicked">on_projectButton_clicked</a></td>
145 <td>Private slot to populate some fields with data retrieved from the current project.</td>
146 </tr><tr>
147 <td><a href="#SetupWizardDialog.on_scriptsList_itemSelectionChanged">on_scriptsList_itemSelectionChanged</a></td>
148 <td>Private slot to handle a change of selected items of the scripts list.</td>
149 </tr><tr>
150 <td><a href="#SetupWizardDialog.on_sourceDirectoryButton_clicked">on_sourceDirectoryButton_clicked</a></td>
151 <td>Private slot to select the packages root directory via a directory selection dialog.</td>
152 </tr><tr>
153 <td><a href="#SetupWizardDialog.on_variantComboBox_currentIndexChanged">on_variantComboBox_currentIndexChanged</a></td>
154 <td>Private slot handling a change of the setup variant.</td>
155 </tr>
156 </table>
157 <h3>Static Methods</h3>
158 <table>
159 <tr><td>None</td></tr>
160 </table>
161 <a NAME="SetupWizardDialog.__init__" ID="SetupWizardDialog.__init__"></a>
162 <h4>SetupWizardDialog (Constructor)</h4>
163 <b>SetupWizardDialog</b>(<i>parent=None</i>)
164 <p>
165 Constructor
166 </p><dl>
167 <dt><i>parent</i></dt>
168 <dd>
169 reference to the parent widget (QWidget)
170 </dd>
171 </dl><a NAME="SetupWizardDialog.__addClassifierEntry" ID="SetupWizardDialog.__addClassifierEntry"></a>
172 <h4>SetupWizardDialog.__addClassifierEntry</h4>
173 <b>__addClassifierEntry</b>(<i>line</i>)
174 <p>
175 Private method to add a new entry to the list of trove classifiers.
176 </p><dl>
177 <dt><i>line</i></dt>
178 <dd>
179 line containing the data for the entry (string)
180 </dd>
181 </dl><a NAME="SetupWizardDialog.__addPackage" ID="SetupWizardDialog.__addPackage"></a>
182 <h4>SetupWizardDialog.__addPackage</h4>
183 <b>__addPackage</b>(<i>pkgDir</i>)
184 <p>
185 Private method to add a package to the list.
186 </p><dl>
187 <dt><i>pkgDir</i></dt>
188 <dd>
189 name of the package directory (string)
190 </dd>
191 </dl><a NAME="SetupWizardDialog.__enableOkButton" ID="SetupWizardDialog.__enableOkButton"></a>
192 <h4>SetupWizardDialog.__enableOkButton</h4>
193 <b>__enableOkButton</b>(<i></i>)
194 <p>
195 Private slot to set the state of the OK button.
196 </p><a NAME="SetupWizardDialog.__getLicenseText" ID="SetupWizardDialog.__getLicenseText"></a>
197 <h4>SetupWizardDialog.__getLicenseText</h4>
198 <b>__getLicenseText</b>(<i></i>)
199 <p>
200 Private method to get the license text.
201 </p><dl>
202 <dt>Returns:</dt>
203 <dd>
204 license text (string)
205 </dd>
206 </dl><a NAME="SetupWizardDialog.__getStartDir" ID="SetupWizardDialog.__getStartDir"></a>
207 <h4>SetupWizardDialog.__getStartDir</h4>
208 <b>__getStartDir</b>(<i></i>)
209 <p>
210 Private method to get the start directory for selection dialogs.
211 </p><dl>
212 <dt>Returns:</dt>
213 <dd>
214 start directory (string)
215 </dd>
216 </dl><a NAME="SetupWizardDialog.__populateFromTroveLists" ID="SetupWizardDialog.__populateFromTroveLists"></a>
217 <h4>SetupWizardDialog.__populateFromTroveLists</h4>
218 <b>__populateFromTroveLists</b>(<i></i>)
219 <p>
220 Private method to populate lists from the Trove list file.
221 </p><a NAME="SetupWizardDialog.getCode" ID="SetupWizardDialog.getCode"></a>
222 <h4>SetupWizardDialog.getCode</h4>
223 <b>getCode</b>(<i>indLevel, indString</i>)
224 <p>
225 Public method to get the source code.
226 </p><dl>
227 <dt><i>indLevel</i></dt>
228 <dd>
229 indentation level (int)
230 </dd><dt><i>indString</i></dt>
231 <dd>
232 string used for indentation (space or tab) (string)
233 </dd>
234 </dl><dl>
235 <dt>Returns:</dt>
236 <dd>
237 generated code (string)
238 </dd>
239 </dl><a NAME="SetupWizardDialog.on_addExludePatternButton_clicked" ID="SetupWizardDialog.on_addExludePatternButton_clicked"></a>
240 <h4>SetupWizardDialog.on_addExludePatternButton_clicked</h4>
241 <b>on_addExludePatternButton_clicked</b>(<i></i>)
242 <p>
243 Private slot to add an exclude pattern to the list.
244 </p><a NAME="SetupWizardDialog.on_addModuleButton_clicked" ID="SetupWizardDialog.on_addModuleButton_clicked"></a>
245 <h4>SetupWizardDialog.on_addModuleButton_clicked</h4>
246 <b>on_addModuleButton_clicked</b>(<i></i>)
247 <p>
248 Private slot to add Python modules to the list.
249 </p><a NAME="SetupWizardDialog.on_addPackageButton_clicked" ID="SetupWizardDialog.on_addPackageButton_clicked"></a>
250 <h4>SetupWizardDialog.on_addPackageButton_clicked</h4>
251 <b>on_addPackageButton_clicked</b>(<i></i>)
252 <p>
253 Private slot to add a package to the list.
254 </p><a NAME="SetupWizardDialog.on_addScriptButton_clicked" ID="SetupWizardDialog.on_addScriptButton_clicked"></a>
255 <h4>SetupWizardDialog.on_addScriptButton_clicked</h4>
256 <b>on_addScriptButton_clicked</b>(<i></i>)
257 <p>
258 Private slot to add scripts to the list.
259 </p><a NAME="SetupWizardDialog.on_autodiscoverPackagesButton_clicked" ID="SetupWizardDialog.on_autodiscoverPackagesButton_clicked"></a>
260 <h4>SetupWizardDialog.on_autodiscoverPackagesButton_clicked</h4>
261 <b>on_autodiscoverPackagesButton_clicked</b>(<i></i>)
262 <p>
263 Private slot to discover packages automatically.
264 </p><a NAME="SetupWizardDialog.on_deleteExcludePatternButton_clicked" ID="SetupWizardDialog.on_deleteExcludePatternButton_clicked"></a>
265 <h4>SetupWizardDialog.on_deleteExcludePatternButton_clicked</h4>
266 <b>on_deleteExcludePatternButton_clicked</b>(<i></i>)
267 <p>
268 Private slot to delete the selected exclude pattern items.
269 </p><a NAME="SetupWizardDialog.on_deleteModuleButton_clicked" ID="SetupWizardDialog.on_deleteModuleButton_clicked"></a>
270 <h4>SetupWizardDialog.on_deleteModuleButton_clicked</h4>
271 <b>on_deleteModuleButton_clicked</b>(<i></i>)
272 <p>
273 Private slot to delete the selected script items.
274 </p><a NAME="SetupWizardDialog.on_deletePackageButton_clicked" ID="SetupWizardDialog.on_deletePackageButton_clicked"></a>
275 <h4>SetupWizardDialog.on_deletePackageButton_clicked</h4>
276 <b>on_deletePackageButton_clicked</b>(<i></i>)
277 <p>
278 Private slot to delete the selected package items.
279 </p><a NAME="SetupWizardDialog.on_deleteScriptButton_clicked" ID="SetupWizardDialog.on_deleteScriptButton_clicked"></a>
280 <h4>SetupWizardDialog.on_deleteScriptButton_clicked</h4>
281 <b>on_deleteScriptButton_clicked</b>(<i></i>)
282 <p>
283 Private slot to delete the selected script items.
284 </p><a NAME="SetupWizardDialog.on_excludePatternEdit_returnPressed" ID="SetupWizardDialog.on_excludePatternEdit_returnPressed"></a>
285 <h4>SetupWizardDialog.on_excludePatternEdit_returnPressed</h4>
286 <b>on_excludePatternEdit_returnPressed</b>(<i></i>)
287 <p>
288 Private slot handling a press of the return button of the
289 exclude pattern edit.
290 </p><a NAME="SetupWizardDialog.on_excludePatternEdit_textChanged" ID="SetupWizardDialog.on_excludePatternEdit_textChanged"></a>
291 <h4>SetupWizardDialog.on_excludePatternEdit_textChanged</h4>
292 <b>on_excludePatternEdit_textChanged</b>(<i>txt</i>)
293 <p>
294 Private slot to handle a change of the exclude pattern text.
295 </p><dl>
296 <dt><i>txt</i></dt>
297 <dd>
298 text of the line edit (string)
299 </dd>
300 </dl><a NAME="SetupWizardDialog.on_excludePatternList_itemSelectionChanged" ID="SetupWizardDialog.on_excludePatternList_itemSelectionChanged"></a>
301 <h4>SetupWizardDialog.on_excludePatternList_itemSelectionChanged</h4>
302 <b>on_excludePatternList_itemSelectionChanged</b>(<i></i>)
303 <p>
304 Private slot to handle a change of selected items of the
305 exclude pattern list.
306 </p><a NAME="SetupWizardDialog.on_modulesList_itemSelectionChanged" ID="SetupWizardDialog.on_modulesList_itemSelectionChanged"></a>
307 <h4>SetupWizardDialog.on_modulesList_itemSelectionChanged</h4>
308 <b>on_modulesList_itemSelectionChanged</b>(<i></i>)
309 <p>
310 Private slot to handle a change of selected items of the
311 modules list.
312 </p><a NAME="SetupWizardDialog.on_packageDirButton_clicked" ID="SetupWizardDialog.on_packageDirButton_clicked"></a>
313 <h4>SetupWizardDialog.on_packageDirButton_clicked</h4>
314 <b>on_packageDirButton_clicked</b>(<i></i>)
315 <p>
316 Private slot to select a package directory via a directory
317 selection dialog.
318 </p><a NAME="SetupWizardDialog.on_packageEdit_returnPressed" ID="SetupWizardDialog.on_packageEdit_returnPressed"></a>
319 <h4>SetupWizardDialog.on_packageEdit_returnPressed</h4>
320 <b>on_packageEdit_returnPressed</b>(<i></i>)
321 <p>
322 Private slot handling a press of the return button of the
323 package edit.
324 </p><a NAME="SetupWizardDialog.on_packageEdit_textChanged" ID="SetupWizardDialog.on_packageEdit_textChanged"></a>
325 <h4>SetupWizardDialog.on_packageEdit_textChanged</h4>
326 <b>on_packageEdit_textChanged</b>(<i>txt</i>)
327 <p>
328 Private slot to handle a change of the package text.
329 </p><dl>
330 <dt><i>txt</i></dt>
331 <dd>
332 text of the line edit (string)
333 </dd>
334 </dl><a NAME="SetupWizardDialog.on_packageRootDirButton_clicked" ID="SetupWizardDialog.on_packageRootDirButton_clicked"></a>
335 <h4>SetupWizardDialog.on_packageRootDirButton_clicked</h4>
336 <b>on_packageRootDirButton_clicked</b>(<i></i>)
337 <p>
338 Private slot to select the packages root directory via a
339 directory selection dialog.
340 </p><a NAME="SetupWizardDialog.on_packageRootEdit_textChanged" ID="SetupWizardDialog.on_packageRootEdit_textChanged"></a>
341 <h4>SetupWizardDialog.on_packageRootEdit_textChanged</h4>
342 <b>on_packageRootEdit_textChanged</b>(<i>txt</i>)
343 <p>
344 Private slot handling the entering of a packages root.
345 </p><dl>
346 <dt><i>txt</i></dt>
347 <dd>
348 text of the line edit (string)
349 </dd>
350 </dl><a NAME="SetupWizardDialog.on_packagesList_itemSelectionChanged" ID="SetupWizardDialog.on_packagesList_itemSelectionChanged"></a>
351 <h4>SetupWizardDialog.on_packagesList_itemSelectionChanged</h4>
352 <b>on_packagesList_itemSelectionChanged</b>(<i></i>)
353 <p>
354 Private slot to handle a change of selected items of the
355 packages list.
356 </p><a NAME="SetupWizardDialog.on_projectButton_clicked" ID="SetupWizardDialog.on_projectButton_clicked"></a>
357 <h4>SetupWizardDialog.on_projectButton_clicked</h4>
358 <b>on_projectButton_clicked</b>(<i></i>)
359 <p>
360 Private slot to populate some fields with data retrieved from the
361 current project.
362 </p><a NAME="SetupWizardDialog.on_scriptsList_itemSelectionChanged" ID="SetupWizardDialog.on_scriptsList_itemSelectionChanged"></a>
363 <h4>SetupWizardDialog.on_scriptsList_itemSelectionChanged</h4>
364 <b>on_scriptsList_itemSelectionChanged</b>(<i></i>)
365 <p>
366 Private slot to handle a change of selected items of the
367 scripts list.
368 </p><a NAME="SetupWizardDialog.on_sourceDirectoryButton_clicked" ID="SetupWizardDialog.on_sourceDirectoryButton_clicked"></a>
369 <h4>SetupWizardDialog.on_sourceDirectoryButton_clicked</h4>
370 <b>on_sourceDirectoryButton_clicked</b>(<i></i>)
371 <p>
372 Private slot to select the packages root directory via a
373 directory selection dialog.
374 </p><a NAME="SetupWizardDialog.on_variantComboBox_currentIndexChanged" ID="SetupWizardDialog.on_variantComboBox_currentIndexChanged"></a>
375 <h4>SetupWizardDialog.on_variantComboBox_currentIndexChanged</h4>
376 <b>on_variantComboBox_currentIndexChanged</b>(<i>index</i>)
377 <p>
378 Private slot handling a change of the setup variant.
379 </p><dl>
380 <dt><i>index</i></dt>
381 <dd>
382 index of the selected entry (integer)
383 </dd>
384 </dl>
385 <div align="right"><a href="#top">Up</a></div>
386 <hr />
387 </body></html>

Mercurial Repository: eric

eric ide

mercurial