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

branch
eric7
changeset 9201
2f1ccadee231
parent 9175
21e2be5f0b41
child 9202
81388c6065e8
equal deleted inserted replaced
9199:831e08e94960 9201:2f1ccadee231
73 <tr> 73 <tr>
74 <td><a href="#SetupWizardDialog.__getLicenseText">__getLicenseText</a></td> 74 <td><a href="#SetupWizardDialog.__getLicenseText">__getLicenseText</a></td>
75 <td>Private method to get the license text.</td> 75 <td>Private method to get the license text.</td>
76 </tr> 76 </tr>
77 <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>
78 <td><a href="#SetupWizardDialog.__getStartDir">__getStartDir</a></td> 90 <td><a href="#SetupWizardDialog.__getStartDir">__getStartDir</a></td>
79 <td>Private method to get the start directory for selection dialogs.</td> 91 <td>Private method to get the start directory for selection dialogs.</td>
80 </tr> 92 </tr>
81 <tr> 93 <tr>
82 <td><a href="#SetupWizardDialog.__populateClassifiers">__populateClassifiers</a></td> 94 <td><a href="#SetupWizardDialog.__populateClassifiers">__populateClassifiers</a></td>
85 <tr> 97 <tr>
86 <td><a href="#SetupWizardDialog.getCode">getCode</a></td> 98 <td><a href="#SetupWizardDialog.getCode">getCode</a></td>
87 <td>Public method to get the source code.</td> 99 <td>Public method to get the source code.</td>
88 </tr> 100 </tr>
89 <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>
90 <td><a href="#SetupWizardDialog.on_addExludePatternButton_clicked">on_addExludePatternButton_clicked</a></td> 106 <td><a href="#SetupWizardDialog.on_addExludePatternButton_clicked">on_addExludePatternButton_clicked</a></td>
91 <td>Private slot to add an exclude pattern to the list.</td> 107 <td>Private slot to add an exclude pattern to the list.</td>
92 </tr> 108 </tr>
93 <tr> 109 <tr>
94 <td><a href="#SetupWizardDialog.on_addModuleButton_clicked">on_addModuleButton_clicked</a></td> 110 <td><a href="#SetupWizardDialog.on_addModuleButton_clicked">on_addModuleButton_clicked</a></td>
95 <td>Private slot to add Python modules to the list.</td> 111 <td>Private slot to add Python modules to the list.</td>
96 </tr> 112 </tr>
97 <tr> 113 <tr>
98 <td><a href="#SetupWizardDialog.on_addScriptButton_clicked">on_addScriptButton_clicked</a></td> 114 <td><a href="#SetupWizardDialog.on_deleteEntryPointButton_clicked">on_deleteEntryPointButton_clicked</a></td>
99 <td>Private slot to add scripts to the list.</td> 115 <td>Private slot to delete the selected entry point items.</td>
100 </tr> 116 </tr>
101 <tr> 117 <tr>
102 <td><a href="#SetupWizardDialog.on_deleteExcludePatternButton_clicked">on_deleteExcludePatternButton_clicked</a></td> 118 <td><a href="#SetupWizardDialog.on_deleteExcludePatternButton_clicked">on_deleteExcludePatternButton_clicked</a></td>
103 <td>Private slot to delete the selected exclude pattern items.</td> 119 <td>Private slot to delete the selected exclude pattern items.</td>
104 </tr> 120 </tr>
105 <tr> 121 <tr>
106 <td><a href="#SetupWizardDialog.on_deleteModuleButton_clicked">on_deleteModuleButton_clicked</a></td> 122 <td><a href="#SetupWizardDialog.on_deleteModuleButton_clicked">on_deleteModuleButton_clicked</a></td>
107 <td>Private slot to delete the selected script items.</td> 123 <td>Private slot to delete the selected module items.</td>
108 </tr> 124 </tr>
109 <tr> 125 <tr>
110 <td><a href="#SetupWizardDialog.on_deleteScriptButton_clicked">on_deleteScriptButton_clicked</a></td> 126 <td><a href="#SetupWizardDialog.on_editEntryPointButton_clicked">on_editEntryPointButton_clicked</a></td>
111 <td>Private slot to delete the selected script items.</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>
112 </tr> 132 </tr>
113 <tr> 133 <tr>
114 <td><a href="#SetupWizardDialog.on_excludePatternEdit_returnPressed">on_excludePatternEdit_returnPressed</a></td> 134 <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> 135 <td>Private slot handling a press of the return button of the exclude pattern edit.</td>
116 </tr> 136 </tr>
129 <tr> 149 <tr>
130 <td><a href="#SetupWizardDialog.on_projectButton_clicked">on_projectButton_clicked</a></td> 150 <td><a href="#SetupWizardDialog.on_projectButton_clicked">on_projectButton_clicked</a></td>
131 <td>Private slot to populate some fields with data retrieved from the current project.</td> 151 <td>Private slot to populate some fields with data retrieved from the current project.</td>
132 </tr> 152 </tr>
133 <tr> 153 <tr>
134 <td><a href="#SetupWizardDialog.on_scriptsList_itemSelectionChanged">on_scriptsList_itemSelectionChanged</a></td> 154 <td><a href="#SetupWizardDialog.on_projectUrlsList_itemSelectionChanged">on_projectUrlsList_itemSelectionChanged</a></td>
135 <td>Private slot to handle a change of selected items of the scripts list.</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>
136 </tr> 168 </tr>
137 </table> 169 </table>
138 <h3>Static Methods</h3> 170 <h3>Static Methods</h3>
139 171
140 <table> 172 <table>
141 <tr><td>None</td></tr> 173 <tr><td>None</td></tr>
142 </table> 174 </table>
143 175
144 <a NAME="SetupWizardDialog.__init__" ID="SetupWizardDialog.__init__"></a> 176 <a NAME="SetupWizardDialog.__init__" ID="SetupWizardDialog.__init__"></a>
145 <h4>SetupWizardDialog (Constructor)</h4> 177 <h4>SetupWizardDialog (Constructor)</h4>
146 <b>SetupWizardDialog</b>(<i>parent=None</i>) 178 <b>SetupWizardDialog</b>(<i>category, parent=None</i>)
147 179
148 <p> 180 <p>
149 Constructor 181 Constructor
150 </p> 182 </p>
151 <dl> 183 <dl>
152 184
153 <dt><i>parent</i> (QWidget)</dt> 185 <dt><i>category</i> (str)</dt>
154 <dd> 186 <dd>
155 reference to the parent widget 187 category of setup file to create
188 </dd>
189 <dt><i>parent</i> (QWidget (optional))</dt>
190 <dd>
191 reference to the parent widget (defaults to None)
192 </dd>
193 </dl>
194 <dl>
195
196 <dt>Raises <b>ValueError</b>:</dt>
197 <dd>
198 raised for an illegal setup file category
156 </dd> 199 </dd>
157 </dl> 200 </dl>
158 <a NAME="SetupWizardDialog.__addClassifierEntry" ID="SetupWizardDialog.__addClassifierEntry"></a> 201 <a NAME="SetupWizardDialog.__addClassifierEntry" ID="SetupWizardDialog.__addClassifierEntry"></a>
159 <h4>SetupWizardDialog.__addClassifierEntry</h4> 202 <h4>SetupWizardDialog.__addClassifierEntry</h4>
160 <b>__addClassifierEntry</b>(<i>classifier</i>) 203 <b>__addClassifierEntry</b>(<i>classifier</i>)
193 <dt>Return Type:</dt> 236 <dt>Return Type:</dt>
194 <dd> 237 <dd>
195 str 238 str
196 </dd> 239 </dd>
197 </dl> 240 </dl>
241 <a NAME="SetupWizardDialog.__getPyprojectCode" ID="SetupWizardDialog.__getPyprojectCode"></a>
242 <h4>SetupWizardDialog.__getPyprojectCode</h4>
243 <b>__getPyprojectCode</b>(<i></i>)
244
245 <p>
246 Private method to get the source code for a 'pyproject.toml' file.
247 </p>
248 <dl>
249 <dt>Return:</dt>
250 <dd>
251 generated code
252 </dd>
253 </dl>
254 <dl>
255 <dt>Return Type:</dt>
256 <dd>
257 str
258 </dd>
259 </dl>
260 <a NAME="SetupWizardDialog.__getSetupCfgCode" ID="SetupWizardDialog.__getSetupCfgCode"></a>
261 <h4>SetupWizardDialog.__getSetupCfgCode</h4>
262 <b>__getSetupCfgCode</b>(<i></i>)
263
264 <p>
265 Private method to get the source code for a 'setup.cfg' file.
266 </p>
267 <dl>
268 <dt>Return:</dt>
269 <dd>
270 generated code
271 </dd>
272 </dl>
273 <dl>
274 <dt>Return Type:</dt>
275 <dd>
276 str
277 </dd>
278 </dl>
279 <a NAME="SetupWizardDialog.__getSetupPyCode" ID="SetupWizardDialog.__getSetupPyCode"></a>
280 <h4>SetupWizardDialog.__getSetupPyCode</h4>
281 <b>__getSetupPyCode</b>(<i>indLevel, indString</i>)
282
283 <p>
284 Private method to get the source code for a 'setup.py' file.
285 </p>
286 <dl>
287
288 <dt><i>indLevel</i> (int)</dt>
289 <dd>
290 indentation level
291 </dd>
292 <dt><i>indString</i> (str)</dt>
293 <dd>
294 string used for indentation (space or tab)
295 </dd>
296 </dl>
297 <dl>
298 <dt>Return:</dt>
299 <dd>
300 generated code
301 </dd>
302 </dl>
303 <dl>
304 <dt>Return Type:</dt>
305 <dd>
306 str
307 </dd>
308 </dl>
198 <a NAME="SetupWizardDialog.__getStartDir" ID="SetupWizardDialog.__getStartDir"></a> 309 <a NAME="SetupWizardDialog.__getStartDir" ID="SetupWizardDialog.__getStartDir"></a>
199 <h4>SetupWizardDialog.__getStartDir</h4> 310 <h4>SetupWizardDialog.__getStartDir</h4>
200 <b>__getStartDir</b>(<i></i>) 311 <b>__getStartDir</b>(<i></i>)
201 312
202 <p> 313 <p>
249 <dt>Return Type:</dt> 360 <dt>Return Type:</dt>
250 <dd> 361 <dd>
251 str 362 str
252 </dd> 363 </dd>
253 </dl> 364 </dl>
365 <a NAME="SetupWizardDialog.on_addEntryPointButton_clicked" ID="SetupWizardDialog.on_addEntryPointButton_clicked"></a>
366 <h4>SetupWizardDialog.on_addEntryPointButton_clicked</h4>
367 <b>on_addEntryPointButton_clicked</b>(<i></i>)
368
369 <p>
370 Private slot to add an entry point to the list.
371 </p>
254 <a NAME="SetupWizardDialog.on_addExludePatternButton_clicked" ID="SetupWizardDialog.on_addExludePatternButton_clicked"></a> 372 <a NAME="SetupWizardDialog.on_addExludePatternButton_clicked" ID="SetupWizardDialog.on_addExludePatternButton_clicked"></a>
255 <h4>SetupWizardDialog.on_addExludePatternButton_clicked</h4> 373 <h4>SetupWizardDialog.on_addExludePatternButton_clicked</h4>
256 <b>on_addExludePatternButton_clicked</b>(<i></i>) 374 <b>on_addExludePatternButton_clicked</b>(<i></i>)
257 375
258 <p> 376 <p>
263 <b>on_addModuleButton_clicked</b>(<i></i>) 381 <b>on_addModuleButton_clicked</b>(<i></i>)
264 382
265 <p> 383 <p>
266 Private slot to add Python modules to the list. 384 Private slot to add Python modules to the list.
267 </p> 385 </p>
268 <a NAME="SetupWizardDialog.on_addScriptButton_clicked" ID="SetupWizardDialog.on_addScriptButton_clicked"></a> 386 <a NAME="SetupWizardDialog.on_deleteEntryPointButton_clicked" ID="SetupWizardDialog.on_deleteEntryPointButton_clicked"></a>
269 <h4>SetupWizardDialog.on_addScriptButton_clicked</h4> 387 <h4>SetupWizardDialog.on_deleteEntryPointButton_clicked</h4>
270 <b>on_addScriptButton_clicked</b>(<i></i>) 388 <b>on_deleteEntryPointButton_clicked</b>(<i></i>)
271 389
272 <p> 390 <p>
273 Private slot to add scripts to the list. 391 Private slot to delete the selected entry point items.
274 </p> 392 </p>
275 <a NAME="SetupWizardDialog.on_deleteExcludePatternButton_clicked" ID="SetupWizardDialog.on_deleteExcludePatternButton_clicked"></a> 393 <a NAME="SetupWizardDialog.on_deleteExcludePatternButton_clicked" ID="SetupWizardDialog.on_deleteExcludePatternButton_clicked"></a>
276 <h4>SetupWizardDialog.on_deleteExcludePatternButton_clicked</h4> 394 <h4>SetupWizardDialog.on_deleteExcludePatternButton_clicked</h4>
277 <b>on_deleteExcludePatternButton_clicked</b>(<i></i>) 395 <b>on_deleteExcludePatternButton_clicked</b>(<i></i>)
278 396
282 <a NAME="SetupWizardDialog.on_deleteModuleButton_clicked" ID="SetupWizardDialog.on_deleteModuleButton_clicked"></a> 400 <a NAME="SetupWizardDialog.on_deleteModuleButton_clicked" ID="SetupWizardDialog.on_deleteModuleButton_clicked"></a>
283 <h4>SetupWizardDialog.on_deleteModuleButton_clicked</h4> 401 <h4>SetupWizardDialog.on_deleteModuleButton_clicked</h4>
284 <b>on_deleteModuleButton_clicked</b>(<i></i>) 402 <b>on_deleteModuleButton_clicked</b>(<i></i>)
285 403
286 <p> 404 <p>
287 Private slot to delete the selected script items. 405 Private slot to delete the selected module items.
288 </p> 406 </p>
289 <a NAME="SetupWizardDialog.on_deleteScriptButton_clicked" ID="SetupWizardDialog.on_deleteScriptButton_clicked"></a> 407 <a NAME="SetupWizardDialog.on_editEntryPointButton_clicked" ID="SetupWizardDialog.on_editEntryPointButton_clicked"></a>
290 <h4>SetupWizardDialog.on_deleteScriptButton_clicked</h4> 408 <h4>SetupWizardDialog.on_editEntryPointButton_clicked</h4>
291 <b>on_deleteScriptButton_clicked</b>(<i></i>) 409 <b>on_editEntryPointButton_clicked</b>(<i></i>)
292 410
293 <p> 411 <p>
294 Private slot to delete the selected script items. 412 Private slot to edit the selected entry point.
413 </p>
414 <a NAME="SetupWizardDialog.on_entryPointsList_itemSelectionChanged" ID="SetupWizardDialog.on_entryPointsList_itemSelectionChanged"></a>
415 <h4>SetupWizardDialog.on_entryPointsList_itemSelectionChanged</h4>
416 <b>on_entryPointsList_itemSelectionChanged</b>(<i></i>)
417
418 <p>
419 Private slot to handle a change of selected items of the
420 entry points list.
295 </p> 421 </p>
296 <a NAME="SetupWizardDialog.on_excludePatternEdit_returnPressed" ID="SetupWizardDialog.on_excludePatternEdit_returnPressed"></a> 422 <a NAME="SetupWizardDialog.on_excludePatternEdit_returnPressed" ID="SetupWizardDialog.on_excludePatternEdit_returnPressed"></a>
297 <h4>SetupWizardDialog.on_excludePatternEdit_returnPressed</h4> 423 <h4>SetupWizardDialog.on_excludePatternEdit_returnPressed</h4>
298 <b>on_excludePatternEdit_returnPressed</b>(<i></i>) 424 <b>on_excludePatternEdit_returnPressed</b>(<i></i>)
299 425
337 463
338 <p> 464 <p>
339 Private slot to populate some fields with data retrieved from the 465 Private slot to populate some fields with data retrieved from the
340 current project. 466 current project.
341 </p> 467 </p>
342 <a NAME="SetupWizardDialog.on_scriptsList_itemSelectionChanged" ID="SetupWizardDialog.on_scriptsList_itemSelectionChanged"></a> 468 <a NAME="SetupWizardDialog.on_projectUrlsList_itemSelectionChanged" ID="SetupWizardDialog.on_projectUrlsList_itemSelectionChanged"></a>
343 <h4>SetupWizardDialog.on_scriptsList_itemSelectionChanged</h4> 469 <h4>SetupWizardDialog.on_projectUrlsList_itemSelectionChanged</h4>
344 <b>on_scriptsList_itemSelectionChanged</b>(<i></i>) 470 <b>on_projectUrlsList_itemSelectionChanged</b>(<i></i>)
345 471
346 <p> 472 <p>
347 Private slot to handle a change of selected items of the 473 Private slot to handle a change of selected items of the
348 scripts list. 474 project URLs list.
475 </p>
476 <a NAME="SetupWizardDialog.on_urlAddButton_clicked" ID="SetupWizardDialog.on_urlAddButton_clicked"></a>
477 <h4>SetupWizardDialog.on_urlAddButton_clicked</h4>
478 <b>on_urlAddButton_clicked</b>(<i></i>)
479
480 <p>
481 Private slot to add a project URL to the list.
482 </p>
483 <a NAME="SetupWizardDialog.on_urlDeleteButton_clicked" ID="SetupWizardDialog.on_urlDeleteButton_clicked"></a>
484 <h4>SetupWizardDialog.on_urlDeleteButton_clicked</h4>
485 <b>on_urlDeleteButton_clicked</b>(<i></i>)
486
487 <p>
488 Private slot to delete the selected URL items.
489 </p>
490 <a NAME="SetupWizardDialog.on_urlEditButton_clicked" ID="SetupWizardDialog.on_urlEditButton_clicked"></a>
491 <h4>SetupWizardDialog.on_urlEditButton_clicked</h4>
492 <b>on_urlEditButton_clicked</b>(<i></i>)
493
494 <p>
495 Private slot to edit the selected project URL.
349 </p> 496 </p>
350 <div align="right"><a href="#top">Up</a></div> 497 <div align="right"><a href="#top">Up</a></div>
351 <hr /> 498 <hr />
352 </body></html> 499 </body></html>

eric ide

mercurial