src/eric7/Documentation/Source/eric7.Preferences.ToolConfigurationDialog.html

branch
eric7
changeset 10479
856476537696
parent 10428
a071d4065202
child 10692
9becf9ca115c
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Preferences.ToolConfigurationDialog</h1> 9 <h1>eric7.Preferences.ToolConfigurationDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a configuration dialog for the tools menu. 11 Module implementing a configuration dialog for the tools menu.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#ToolConfigurationDialog">ToolConfigurationDialog</a></td> 22 <td><a href="#ToolConfigurationDialog">ToolConfigurationDialog</a></td>
25 <td>Class implementing a configuration dialog for the tools menu.</td> 23 <td>Class implementing a configuration dialog for the tools menu.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="ToolConfigurationDialog" ID="ToolConfigurationDialog"></a> 34 <a NAME="ToolConfigurationDialog" ID="ToolConfigurationDialog"></a>
36 <h2>ToolConfigurationDialog</h2> 35 <h2>ToolConfigurationDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a configuration dialog for the tools menu. 37 Class implementing a configuration dialog for the tools menu.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QDialog, Ui_ToolConfigurationDialog 41 QDialog, Ui_ToolConfigurationDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>None</td></tr>
46 <tr><td>None</td></tr> 45 </table>
47 </table> 46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#ToolConfigurationDialog.__init__">ToolConfigurationDialog</a></td> 55 <td><a href="#ToolConfigurationDialog.__init__">ToolConfigurationDialog</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
129 <tr> 126 <tr>
130 <td><a href="#ToolConfigurationDialog.on_upButton_clicked">on_upButton_clicked</a></td> 127 <td><a href="#ToolConfigurationDialog.on_upButton_clicked">on_upButton_clicked</a></td>
131 <td>Private slot to move an entry up in the list.</td> 128 <td>Private slot to move an entry up in the list.</td>
132 </tr> 129 </tr>
133 </table> 130 </table>
131
134 <h3>Static Methods</h3> 132 <h3>Static Methods</h3>
135 133 <table>
136 <table> 134 <tr><td>None</td></tr>
137 <tr><td>None</td></tr> 135 </table>
138 </table> 136
139 137
140 <a NAME="ToolConfigurationDialog.__init__" ID="ToolConfigurationDialog.__init__"></a> 138 <a NAME="ToolConfigurationDialog.__init__" ID="ToolConfigurationDialog.__init__"></a>
141 <h4>ToolConfigurationDialog (Constructor)</h4> 139 <h4>ToolConfigurationDialog (Constructor)</h4>
142 <b>ToolConfigurationDialog</b>(<i>toollist, parent=None</i>) 140 <b>ToolConfigurationDialog</b>(<i>toollist, parent=None</i>)
143
144 <p> 141 <p>
145 Constructor 142 Constructor
146 </p> 143 </p>
144
147 <dl> 145 <dl>
148 146
149 <dt><i>toollist</i> (list)</dt> 147 <dt><i>toollist</i> (list)</dt>
150 <dd> 148 <dd>
151 list of configured tools 149 list of configured tools
156 </dd> 154 </dd>
157 </dl> 155 </dl>
158 <a NAME="ToolConfigurationDialog.__findModeIndex" ID="ToolConfigurationDialog.__findModeIndex"></a> 156 <a NAME="ToolConfigurationDialog.__findModeIndex" ID="ToolConfigurationDialog.__findModeIndex"></a>
159 <h4>ToolConfigurationDialog.__findModeIndex</h4> 157 <h4>ToolConfigurationDialog.__findModeIndex</h4>
160 <b>__findModeIndex</b>(<i>shortName</i>) 158 <b>__findModeIndex</b>(<i>shortName</i>)
161
162 <p> 159 <p>
163 Private method to find the mode index by its short name. 160 Private method to find the mode index by its short name.
164 </p> 161 </p>
162
165 <dl> 163 <dl>
166 164
167 <dt><i>shortName</i> (str)</dt> 165 <dt><i>shortName</i> (str)</dt>
168 <dd> 166 <dd>
169 short name of the mode 167 short name of the mode
182 </dd> 180 </dd>
183 </dl> 181 </dl>
184 <a NAME="ToolConfigurationDialog.__swap" ID="ToolConfigurationDialog.__swap"></a> 182 <a NAME="ToolConfigurationDialog.__swap" ID="ToolConfigurationDialog.__swap"></a>
185 <h4>ToolConfigurationDialog.__swap</h4> 183 <h4>ToolConfigurationDialog.__swap</h4>
186 <b>__swap</b>(<i>itm1, itm2</i>) 184 <b>__swap</b>(<i>itm1, itm2</i>)
187
188 <p> 185 <p>
189 Private method used two swap two list entries given by their index. 186 Private method used two swap two list entries given by their index.
190 </p> 187 </p>
188
191 <dl> 189 <dl>
192 190
193 <dt><i>itm1</i> (int)</dt> 191 <dt><i>itm1</i> (int)</dt>
194 <dd> 192 <dd>
195 index of first entry 193 index of first entry
200 </dd> 198 </dd>
201 </dl> 199 </dl>
202 <a NAME="ToolConfigurationDialog.__toolEntryChanged" ID="ToolConfigurationDialog.__toolEntryChanged"></a> 200 <a NAME="ToolConfigurationDialog.__toolEntryChanged" ID="ToolConfigurationDialog.__toolEntryChanged"></a>
203 <h4>ToolConfigurationDialog.__toolEntryChanged</h4> 201 <h4>ToolConfigurationDialog.__toolEntryChanged</h4>
204 <b>__toolEntryChanged</b>(<i></i>) 202 <b>__toolEntryChanged</b>(<i></i>)
205
206 <p> 203 <p>
207 Private slot to perform actions when a tool entry was changed. 204 Private slot to perform actions when a tool entry was changed.
208 </p> 205 </p>
206
209 <a NAME="ToolConfigurationDialog.getToollist" ID="ToolConfigurationDialog.getToollist"></a> 207 <a NAME="ToolConfigurationDialog.getToollist" ID="ToolConfigurationDialog.getToollist"></a>
210 <h4>ToolConfigurationDialog.getToollist</h4> 208 <h4>ToolConfigurationDialog.getToollist</h4>
211 <b>getToollist</b>(<i></i>) 209 <b>getToollist</b>(<i></i>)
212
213 <p> 210 <p>
214 Public method to retrieve the tools list. 211 Public method to retrieve the tools list.
215 </p> 212 </p>
213
216 <dl> 214 <dl>
217 <dt>Return:</dt> 215 <dt>Return:</dt>
218 <dd> 216 <dd>
219 a list of tuples containing the menu text, the executable, 217 a list of tuples containing the menu text, the executable,
220 the executables arguments and a redirection flag 218 the executables arguments and a redirection flag
227 </dd> 225 </dd>
228 </dl> 226 </dl>
229 <a NAME="ToolConfigurationDialog.on_addButton_clicked" ID="ToolConfigurationDialog.on_addButton_clicked"></a> 227 <a NAME="ToolConfigurationDialog.on_addButton_clicked" ID="ToolConfigurationDialog.on_addButton_clicked"></a>
230 <h4>ToolConfigurationDialog.on_addButton_clicked</h4> 228 <h4>ToolConfigurationDialog.on_addButton_clicked</h4>
231 <b>on_addButton_clicked</b>(<i></i>) 229 <b>on_addButton_clicked</b>(<i></i>)
232
233 <p> 230 <p>
234 Private slot to add a new entry. 231 Private slot to add a new entry.
235 </p> 232 </p>
233
236 <a NAME="ToolConfigurationDialog.on_argumentsEdit_textChanged" ID="ToolConfigurationDialog.on_argumentsEdit_textChanged"></a> 234 <a NAME="ToolConfigurationDialog.on_argumentsEdit_textChanged" ID="ToolConfigurationDialog.on_argumentsEdit_textChanged"></a>
237 <h4>ToolConfigurationDialog.on_argumentsEdit_textChanged</h4> 235 <h4>ToolConfigurationDialog.on_argumentsEdit_textChanged</h4>
238 <b>on_argumentsEdit_textChanged</b>(<i>text</i>) 236 <b>on_argumentsEdit_textChanged</b>(<i>text</i>)
239
240 <p> 237 <p>
241 Private slot called, when the arguments string was changed. 238 Private slot called, when the arguments string was changed.
242 </p> 239 </p>
240
243 <dl> 241 <dl>
244 242
245 <dt><i>text</i> (str)</dt> 243 <dt><i>text</i> (str)</dt>
246 <dd> 244 <dd>
247 the new text (ignored) 245 the new text (ignored)
248 </dd> 246 </dd>
249 </dl> 247 </dl>
250 <a NAME="ToolConfigurationDialog.on_changeButton_clicked" ID="ToolConfigurationDialog.on_changeButton_clicked"></a> 248 <a NAME="ToolConfigurationDialog.on_changeButton_clicked" ID="ToolConfigurationDialog.on_changeButton_clicked"></a>
251 <h4>ToolConfigurationDialog.on_changeButton_clicked</h4> 249 <h4>ToolConfigurationDialog.on_changeButton_clicked</h4>
252 <b>on_changeButton_clicked</b>(<i></i>) 250 <b>on_changeButton_clicked</b>(<i></i>)
253
254 <p> 251 <p>
255 Private slot to change an entry. 252 Private slot to change an entry.
256 </p> 253 </p>
254
257 <a NAME="ToolConfigurationDialog.on_deleteButton_clicked" ID="ToolConfigurationDialog.on_deleteButton_clicked"></a> 255 <a NAME="ToolConfigurationDialog.on_deleteButton_clicked" ID="ToolConfigurationDialog.on_deleteButton_clicked"></a>
258 <h4>ToolConfigurationDialog.on_deleteButton_clicked</h4> 256 <h4>ToolConfigurationDialog.on_deleteButton_clicked</h4>
259 <b>on_deleteButton_clicked</b>(<i></i>) 257 <b>on_deleteButton_clicked</b>(<i></i>)
260
261 <p> 258 <p>
262 Private slot to delete the selected entry. 259 Private slot to delete the selected entry.
263 </p> 260 </p>
261
264 <a NAME="ToolConfigurationDialog.on_downButton_clicked" ID="ToolConfigurationDialog.on_downButton_clicked"></a> 262 <a NAME="ToolConfigurationDialog.on_downButton_clicked" ID="ToolConfigurationDialog.on_downButton_clicked"></a>
265 <h4>ToolConfigurationDialog.on_downButton_clicked</h4> 263 <h4>ToolConfigurationDialog.on_downButton_clicked</h4>
266 <b>on_downButton_clicked</b>(<i></i>) 264 <b>on_downButton_clicked</b>(<i></i>)
267
268 <p> 265 <p>
269 Private slot to move an entry down in the list. 266 Private slot to move an entry down in the list.
270 </p> 267 </p>
268
271 <a NAME="ToolConfigurationDialog.on_executablePicker_pathSelected" ID="ToolConfigurationDialog.on_executablePicker_pathSelected"></a> 269 <a NAME="ToolConfigurationDialog.on_executablePicker_pathSelected" ID="ToolConfigurationDialog.on_executablePicker_pathSelected"></a>
272 <h4>ToolConfigurationDialog.on_executablePicker_pathSelected</h4> 270 <h4>ToolConfigurationDialog.on_executablePicker_pathSelected</h4>
273 <b>on_executablePicker_pathSelected</b>(<i>path</i>) 271 <b>on_executablePicker_pathSelected</b>(<i>path</i>)
274
275 <p> 272 <p>
276 Private slot to check the executable after it has been selected. 273 Private slot to check the executable after it has been selected.
277 </p> 274 </p>
275
278 <dl> 276 <dl>
279 277
280 <dt><i>path</i> (str)</dt> 278 <dt><i>path</i> (str)</dt>
281 <dd> 279 <dd>
282 path of the executable 280 path of the executable
283 </dd> 281 </dd>
284 </dl> 282 </dl>
285 <a NAME="ToolConfigurationDialog.on_executablePicker_textChanged" ID="ToolConfigurationDialog.on_executablePicker_textChanged"></a> 283 <a NAME="ToolConfigurationDialog.on_executablePicker_textChanged" ID="ToolConfigurationDialog.on_executablePicker_textChanged"></a>
286 <h4>ToolConfigurationDialog.on_executablePicker_textChanged</h4> 284 <h4>ToolConfigurationDialog.on_executablePicker_textChanged</h4>
287 <b>on_executablePicker_textChanged</b>(<i>text</i>) 285 <b>on_executablePicker_textChanged</b>(<i>text</i>)
288
289 <p> 286 <p>
290 Private slot called, when the executable was changed. 287 Private slot called, when the executable was changed.
291 </p> 288 </p>
289
292 <dl> 290 <dl>
293 291
294 <dt><i>text</i> (str)</dt> 292 <dt><i>text</i> (str)</dt>
295 <dd> 293 <dd>
296 the new text (ignored) 294 the new text (ignored)
297 </dd> 295 </dd>
298 </dl> 296 </dl>
299 <a NAME="ToolConfigurationDialog.on_iconPicker_textChanged" ID="ToolConfigurationDialog.on_iconPicker_textChanged"></a> 297 <a NAME="ToolConfigurationDialog.on_iconPicker_textChanged" ID="ToolConfigurationDialog.on_iconPicker_textChanged"></a>
300 <h4>ToolConfigurationDialog.on_iconPicker_textChanged</h4> 298 <h4>ToolConfigurationDialog.on_iconPicker_textChanged</h4>
301 <b>on_iconPicker_textChanged</b>(<i>text</i>) 299 <b>on_iconPicker_textChanged</b>(<i>text</i>)
302
303 <p> 300 <p>
304 Private slot called, when the icon path was changed. 301 Private slot called, when the icon path was changed.
305 </p> 302 </p>
303
306 <dl> 304 <dl>
307 305
308 <dt><i>text</i> (str)</dt> 306 <dt><i>text</i> (str)</dt>
309 <dd> 307 <dd>
310 the new text (ignored) 308 the new text (ignored)
311 </dd> 309 </dd>
312 </dl> 310 </dl>
313 <a NAME="ToolConfigurationDialog.on_menuEdit_textChanged" ID="ToolConfigurationDialog.on_menuEdit_textChanged"></a> 311 <a NAME="ToolConfigurationDialog.on_menuEdit_textChanged" ID="ToolConfigurationDialog.on_menuEdit_textChanged"></a>
314 <h4>ToolConfigurationDialog.on_menuEdit_textChanged</h4> 312 <h4>ToolConfigurationDialog.on_menuEdit_textChanged</h4>
315 <b>on_menuEdit_textChanged</b>(<i>text</i>) 313 <b>on_menuEdit_textChanged</b>(<i>text</i>)
316
317 <p> 314 <p>
318 Private slot called, when the menu text was changed. 315 Private slot called, when the menu text was changed.
319 </p> 316 </p>
317
320 <dl> 318 <dl>
321 319
322 <dt><i>text</i> (str)</dt> 320 <dt><i>text</i> (str)</dt>
323 <dd> 321 <dd>
324 the new text (ignored) 322 the new text (ignored)
325 </dd> 323 </dd>
326 </dl> 324 </dl>
327 <a NAME="ToolConfigurationDialog.on_newButton_clicked" ID="ToolConfigurationDialog.on_newButton_clicked"></a> 325 <a NAME="ToolConfigurationDialog.on_newButton_clicked" ID="ToolConfigurationDialog.on_newButton_clicked"></a>
328 <h4>ToolConfigurationDialog.on_newButton_clicked</h4> 326 <h4>ToolConfigurationDialog.on_newButton_clicked</h4>
329 <b>on_newButton_clicked</b>(<i></i>) 327 <b>on_newButton_clicked</b>(<i></i>)
330
331 <p> 328 <p>
332 Private slot to clear all entry fields. 329 Private slot to clear all entry fields.
333 </p> 330 </p>
331
334 <a NAME="ToolConfigurationDialog.on_redirectCombo_currentIndexChanged" ID="ToolConfigurationDialog.on_redirectCombo_currentIndexChanged"></a> 332 <a NAME="ToolConfigurationDialog.on_redirectCombo_currentIndexChanged" ID="ToolConfigurationDialog.on_redirectCombo_currentIndexChanged"></a>
335 <h4>ToolConfigurationDialog.on_redirectCombo_currentIndexChanged</h4> 333 <h4>ToolConfigurationDialog.on_redirectCombo_currentIndexChanged</h4>
336 <b>on_redirectCombo_currentIndexChanged</b>(<i>index</i>) 334 <b>on_redirectCombo_currentIndexChanged</b>(<i>index</i>)
337
338 <p> 335 <p>
339 Private slot called, when the redirection mode was changed. 336 Private slot called, when the redirection mode was changed.
340 </p> 337 </p>
338
341 <dl> 339 <dl>
342 340
343 <dt><i>index</i> (int)</dt> 341 <dt><i>index</i> (int)</dt>
344 <dd> 342 <dd>
345 the selected mode index (ignored) 343 the selected mode index (ignored)
346 </dd> 344 </dd>
347 </dl> 345 </dl>
348 <a NAME="ToolConfigurationDialog.on_separatorButton_clicked" ID="ToolConfigurationDialog.on_separatorButton_clicked"></a> 346 <a NAME="ToolConfigurationDialog.on_separatorButton_clicked" ID="ToolConfigurationDialog.on_separatorButton_clicked"></a>
349 <h4>ToolConfigurationDialog.on_separatorButton_clicked</h4> 347 <h4>ToolConfigurationDialog.on_separatorButton_clicked</h4>
350 <b>on_separatorButton_clicked</b>(<i></i>) 348 <b>on_separatorButton_clicked</b>(<i></i>)
351
352 <p> 349 <p>
353 Private slot to add a menu separator. 350 Private slot to add a menu separator.
354 </p> 351 </p>
352
355 <a NAME="ToolConfigurationDialog.on_toolsList_currentRowChanged" ID="ToolConfigurationDialog.on_toolsList_currentRowChanged"></a> 353 <a NAME="ToolConfigurationDialog.on_toolsList_currentRowChanged" ID="ToolConfigurationDialog.on_toolsList_currentRowChanged"></a>
356 <h4>ToolConfigurationDialog.on_toolsList_currentRowChanged</h4> 354 <h4>ToolConfigurationDialog.on_toolsList_currentRowChanged</h4>
357 <b>on_toolsList_currentRowChanged</b>(<i>row</i>) 355 <b>on_toolsList_currentRowChanged</b>(<i>row</i>)
358
359 <p> 356 <p>
360 Private slot to set the lineedits depending on the selected entry. 357 Private slot to set the lineedits depending on the selected entry.
361 </p> 358 </p>
359
362 <dl> 360 <dl>
363 361
364 <dt><i>row</i> (int)</dt> 362 <dt><i>row</i> (int)</dt>
365 <dd> 363 <dd>
366 the row of the selected entry 364 the row of the selected entry
367 </dd> 365 </dd>
368 </dl> 366 </dl>
369 <a NAME="ToolConfigurationDialog.on_upButton_clicked" ID="ToolConfigurationDialog.on_upButton_clicked"></a> 367 <a NAME="ToolConfigurationDialog.on_upButton_clicked" ID="ToolConfigurationDialog.on_upButton_clicked"></a>
370 <h4>ToolConfigurationDialog.on_upButton_clicked</h4> 368 <h4>ToolConfigurationDialog.on_upButton_clicked</h4>
371 <b>on_upButton_clicked</b>(<i></i>) 369 <b>on_upButton_clicked</b>(<i></i>)
372
373 <p> 370 <p>
374 Private slot to move an entry up in the list. 371 Private slot to move an entry up in the list.
375 </p> 372 </p>
373
376 <div align="right"><a href="#top">Up</a></div> 374 <div align="right"><a href="#top">Up</a></div>
377 <hr /> 375 <hr />
378 </body></html> 376 </body></html>

eric ide

mercurial