Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Preferences.ToolConfigurationDialog.html
src/eric7/Documentation/Source/eric7.Preferences.ToolConfigurationDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10428
- a071d4065202
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Preferences.ToolConfigurationDialog</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.Preferences.ToolConfigurationDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a configuration dialog for the tools menu. | |
| 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="#ToolConfigurationDialog">ToolConfigurationDialog</a></td> | |
| 25 <td>Class implementing a configuration dialog for the tools menu.</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="ToolConfigurationDialog" ID="ToolConfigurationDialog"></a> | |
| 36 <h2>ToolConfigurationDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a configuration dialog for the tools menu. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QDialog, Ui_ToolConfigurationDialog | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#ToolConfigurationDialog.__init__">ToolConfigurationDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#ToolConfigurationDialog.__findModeIndex">__findModeIndex</a></td> | |
| 63 <td>Private method to find the mode index by its short name.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#ToolConfigurationDialog.__swap">__swap</a></td> | |
| 67 <td>Private method used two swap two list entries given by their index.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#ToolConfigurationDialog.__toolEntryChanged">__toolEntryChanged</a></td> | |
| 71 <td>Private slot to perform actions when a tool entry was changed.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#ToolConfigurationDialog.getToollist">getToollist</a></td> | |
| 75 <td>Public method to retrieve the tools list.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#ToolConfigurationDialog.on_addButton_clicked">on_addButton_clicked</a></td> | |
| 79 <td>Private slot to add a new entry.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#ToolConfigurationDialog.on_argumentsEdit_textChanged">on_argumentsEdit_textChanged</a></td> | |
| 83 <td>Private slot called, when the arguments string was changed.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#ToolConfigurationDialog.on_changeButton_clicked">on_changeButton_clicked</a></td> | |
| 87 <td>Private slot to change an entry.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#ToolConfigurationDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td> | |
| 91 <td>Private slot to delete the selected entry.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#ToolConfigurationDialog.on_downButton_clicked">on_downButton_clicked</a></td> | |
| 95 <td>Private slot to move an entry down in the list.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#ToolConfigurationDialog.on_executablePicker_pathSelected">on_executablePicker_pathSelected</a></td> | |
| 99 <td>Private slot to check the executable after it has been selected.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#ToolConfigurationDialog.on_executablePicker_textChanged">on_executablePicker_textChanged</a></td> | |
| 103 <td>Private slot called, when the executable was changed.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#ToolConfigurationDialog.on_iconPicker_textChanged">on_iconPicker_textChanged</a></td> | |
| 107 <td>Private slot called, when the icon path was changed.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#ToolConfigurationDialog.on_menuEdit_textChanged">on_menuEdit_textChanged</a></td> | |
| 111 <td>Private slot called, when the menu text was changed.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#ToolConfigurationDialog.on_newButton_clicked">on_newButton_clicked</a></td> | |
| 115 <td>Private slot to clear all entry fields.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#ToolConfigurationDialog.on_redirectCombo_currentIndexChanged">on_redirectCombo_currentIndexChanged</a></td> | |
| 119 <td>Private slot called, when the redirection mode was changed.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#ToolConfigurationDialog.on_separatorButton_clicked">on_separatorButton_clicked</a></td> | |
| 123 <td>Private slot to add a menu separator.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#ToolConfigurationDialog.on_toolsList_currentRowChanged">on_toolsList_currentRowChanged</a></td> | |
| 127 <td>Private slot to set the lineedits depending on the selected entry.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <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> | |
| 132 </tr> | |
| 133 </table> | |
| 134 <h3>Static Methods</h3> | |
| 135 | |
| 136 <table> | |
| 137 <tr><td>None</td></tr> | |
| 138 </table> | |
| 139 | |
| 140 <a NAME="ToolConfigurationDialog.__init__" ID="ToolConfigurationDialog.__init__"></a> | |
| 141 <h4>ToolConfigurationDialog (Constructor)</h4> | |
| 142 <b>ToolConfigurationDialog</b>(<i>toollist, parent=None</i>) | |
| 143 | |
| 144 <p> | |
| 145 Constructor | |
| 146 </p> | |
| 147 <dl> | |
| 148 | |
| 149 <dt><i>toollist</i></dt> | |
| 150 <dd> | |
| 151 list of configured tools | |
| 152 </dd> | |
| 153 <dt><i>parent</i></dt> | |
| 154 <dd> | |
| 155 parent widget (QWidget) | |
| 156 </dd> | |
| 157 </dl> | |
| 158 <a NAME="ToolConfigurationDialog.__findModeIndex" ID="ToolConfigurationDialog.__findModeIndex"></a> | |
| 159 <h4>ToolConfigurationDialog.__findModeIndex</h4> | |
| 160 <b>__findModeIndex</b>(<i>shortName</i>) | |
| 161 | |
| 162 <p> | |
| 163 Private method to find the mode index by its short name. | |
| 164 </p> | |
| 165 <dl> | |
| 166 | |
| 167 <dt><i>shortName</i></dt> | |
| 168 <dd> | |
| 169 short name of the mode (string) | |
| 170 </dd> | |
| 171 </dl> | |
| 172 <dl> | |
| 173 <dt>Return:</dt> | |
| 174 <dd> | |
| 175 index of the mode (integer) | |
| 176 </dd> | |
| 177 </dl> | |
| 178 <a NAME="ToolConfigurationDialog.__swap" ID="ToolConfigurationDialog.__swap"></a> | |
| 179 <h4>ToolConfigurationDialog.__swap</h4> | |
| 180 <b>__swap</b>(<i>itm1, itm2</i>) | |
| 181 | |
| 182 <p> | |
| 183 Private method used two swap two list entries given by their index. | |
| 184 </p> | |
| 185 <dl> | |
| 186 | |
| 187 <dt><i>itm1</i></dt> | |
| 188 <dd> | |
| 189 index of first entry (int) | |
| 190 </dd> | |
| 191 <dt><i>itm2</i></dt> | |
| 192 <dd> | |
| 193 index of second entry (int) | |
| 194 </dd> | |
| 195 </dl> | |
| 196 <a NAME="ToolConfigurationDialog.__toolEntryChanged" ID="ToolConfigurationDialog.__toolEntryChanged"></a> | |
| 197 <h4>ToolConfigurationDialog.__toolEntryChanged</h4> | |
| 198 <b>__toolEntryChanged</b>(<i></i>) | |
| 199 | |
| 200 <p> | |
| 201 Private slot to perform actions when a tool entry was changed. | |
| 202 </p> | |
| 203 <a NAME="ToolConfigurationDialog.getToollist" ID="ToolConfigurationDialog.getToollist"></a> | |
| 204 <h4>ToolConfigurationDialog.getToollist</h4> | |
| 205 <b>getToollist</b>(<i></i>) | |
| 206 | |
| 207 <p> | |
| 208 Public method to retrieve the tools list. | |
| 209 </p> | |
| 210 <dl> | |
| 211 <dt>Return:</dt> | |
| 212 <dd> | |
| 213 a list of tuples containing the menu text, the executable, | |
| 214 the executables arguments and a redirection flag | |
| 215 </dd> | |
| 216 </dl> | |
| 217 <a NAME="ToolConfigurationDialog.on_addButton_clicked" ID="ToolConfigurationDialog.on_addButton_clicked"></a> | |
| 218 <h4>ToolConfigurationDialog.on_addButton_clicked</h4> | |
| 219 <b>on_addButton_clicked</b>(<i></i>) | |
| 220 | |
| 221 <p> | |
| 222 Private slot to add a new entry. | |
| 223 </p> | |
| 224 <a NAME="ToolConfigurationDialog.on_argumentsEdit_textChanged" ID="ToolConfigurationDialog.on_argumentsEdit_textChanged"></a> | |
| 225 <h4>ToolConfigurationDialog.on_argumentsEdit_textChanged</h4> | |
| 226 <b>on_argumentsEdit_textChanged</b>(<i>text</i>) | |
| 227 | |
| 228 <p> | |
| 229 Private slot called, when the arguments string was changed. | |
| 230 </p> | |
| 231 <dl> | |
| 232 | |
| 233 <dt><i>text</i></dt> | |
| 234 <dd> | |
| 235 the new text (string) (ignored) | |
| 236 </dd> | |
| 237 </dl> | |
| 238 <a NAME="ToolConfigurationDialog.on_changeButton_clicked" ID="ToolConfigurationDialog.on_changeButton_clicked"></a> | |
| 239 <h4>ToolConfigurationDialog.on_changeButton_clicked</h4> | |
| 240 <b>on_changeButton_clicked</b>(<i></i>) | |
| 241 | |
| 242 <p> | |
| 243 Private slot to change an entry. | |
| 244 </p> | |
| 245 <a NAME="ToolConfigurationDialog.on_deleteButton_clicked" ID="ToolConfigurationDialog.on_deleteButton_clicked"></a> | |
| 246 <h4>ToolConfigurationDialog.on_deleteButton_clicked</h4> | |
| 247 <b>on_deleteButton_clicked</b>(<i></i>) | |
| 248 | |
| 249 <p> | |
| 250 Private slot to delete the selected entry. | |
| 251 </p> | |
| 252 <a NAME="ToolConfigurationDialog.on_downButton_clicked" ID="ToolConfigurationDialog.on_downButton_clicked"></a> | |
| 253 <h4>ToolConfigurationDialog.on_downButton_clicked</h4> | |
| 254 <b>on_downButton_clicked</b>(<i></i>) | |
| 255 | |
| 256 <p> | |
| 257 Private slot to move an entry down in the list. | |
| 258 </p> | |
| 259 <a NAME="ToolConfigurationDialog.on_executablePicker_pathSelected" ID="ToolConfigurationDialog.on_executablePicker_pathSelected"></a> | |
| 260 <h4>ToolConfigurationDialog.on_executablePicker_pathSelected</h4> | |
| 261 <b>on_executablePicker_pathSelected</b>(<i>path</i>) | |
| 262 | |
| 263 <p> | |
| 264 Private slot to check the executable after it has been selected. | |
| 265 </p> | |
| 266 <dl> | |
| 267 | |
| 268 <dt><i>path</i> (str)</dt> | |
| 269 <dd> | |
| 270 path of the executable | |
| 271 </dd> | |
| 272 </dl> | |
| 273 <a NAME="ToolConfigurationDialog.on_executablePicker_textChanged" ID="ToolConfigurationDialog.on_executablePicker_textChanged"></a> | |
| 274 <h4>ToolConfigurationDialog.on_executablePicker_textChanged</h4> | |
| 275 <b>on_executablePicker_textChanged</b>(<i>text</i>) | |
| 276 | |
| 277 <p> | |
| 278 Private slot called, when the executable was changed. | |
| 279 </p> | |
| 280 <dl> | |
| 281 | |
| 282 <dt><i>text</i></dt> | |
| 283 <dd> | |
| 284 the new text (string) (ignored) | |
| 285 </dd> | |
| 286 </dl> | |
| 287 <a NAME="ToolConfigurationDialog.on_iconPicker_textChanged" ID="ToolConfigurationDialog.on_iconPicker_textChanged"></a> | |
| 288 <h4>ToolConfigurationDialog.on_iconPicker_textChanged</h4> | |
| 289 <b>on_iconPicker_textChanged</b>(<i>text</i>) | |
| 290 | |
| 291 <p> | |
| 292 Private slot called, when the icon path was changed. | |
| 293 </p> | |
| 294 <dl> | |
| 295 | |
| 296 <dt><i>text</i></dt> | |
| 297 <dd> | |
| 298 the new text (string) (ignored) | |
| 299 </dd> | |
| 300 </dl> | |
| 301 <a NAME="ToolConfigurationDialog.on_menuEdit_textChanged" ID="ToolConfigurationDialog.on_menuEdit_textChanged"></a> | |
| 302 <h4>ToolConfigurationDialog.on_menuEdit_textChanged</h4> | |
| 303 <b>on_menuEdit_textChanged</b>(<i>text</i>) | |
| 304 | |
| 305 <p> | |
| 306 Private slot called, when the menu text was changed. | |
| 307 </p> | |
| 308 <dl> | |
| 309 | |
| 310 <dt><i>text</i></dt> | |
| 311 <dd> | |
| 312 the new text (string) (ignored) | |
| 313 </dd> | |
| 314 </dl> | |
| 315 <a NAME="ToolConfigurationDialog.on_newButton_clicked" ID="ToolConfigurationDialog.on_newButton_clicked"></a> | |
| 316 <h4>ToolConfigurationDialog.on_newButton_clicked</h4> | |
| 317 <b>on_newButton_clicked</b>(<i></i>) | |
| 318 | |
| 319 <p> | |
| 320 Private slot to clear all entry fields. | |
| 321 </p> | |
| 322 <a NAME="ToolConfigurationDialog.on_redirectCombo_currentIndexChanged" ID="ToolConfigurationDialog.on_redirectCombo_currentIndexChanged"></a> | |
| 323 <h4>ToolConfigurationDialog.on_redirectCombo_currentIndexChanged</h4> | |
| 324 <b>on_redirectCombo_currentIndexChanged</b>(<i>index</i>) | |
| 325 | |
| 326 <p> | |
| 327 Private slot called, when the redirection mode was changed. | |
| 328 </p> | |
| 329 <dl> | |
| 330 | |
| 331 <dt><i>index</i></dt> | |
| 332 <dd> | |
| 333 the selected mode index (integer) (ignored) | |
| 334 </dd> | |
| 335 </dl> | |
| 336 <a NAME="ToolConfigurationDialog.on_separatorButton_clicked" ID="ToolConfigurationDialog.on_separatorButton_clicked"></a> | |
| 337 <h4>ToolConfigurationDialog.on_separatorButton_clicked</h4> | |
| 338 <b>on_separatorButton_clicked</b>(<i></i>) | |
| 339 | |
| 340 <p> | |
| 341 Private slot to add a menu separator. | |
| 342 </p> | |
| 343 <a NAME="ToolConfigurationDialog.on_toolsList_currentRowChanged" ID="ToolConfigurationDialog.on_toolsList_currentRowChanged"></a> | |
| 344 <h4>ToolConfigurationDialog.on_toolsList_currentRowChanged</h4> | |
| 345 <b>on_toolsList_currentRowChanged</b>(<i>row</i>) | |
| 346 | |
| 347 <p> | |
| 348 Private slot to set the lineedits depending on the selected entry. | |
| 349 </p> | |
| 350 <dl> | |
| 351 | |
| 352 <dt><i>row</i></dt> | |
| 353 <dd> | |
| 354 the row of the selected entry (integer) | |
| 355 </dd> | |
| 356 </dl> | |
| 357 <a NAME="ToolConfigurationDialog.on_upButton_clicked" ID="ToolConfigurationDialog.on_upButton_clicked"></a> | |
| 358 <h4>ToolConfigurationDialog.on_upButton_clicked</h4> | |
| 359 <b>on_upButton_clicked</b>(<i></i>) | |
| 360 | |
| 361 <p> | |
| 362 Private slot to move an entry up in the list. | |
| 363 </p> | |
| 364 <div align="right"><a href="#top">Up</a></div> | |
| 365 <hr /> | |
| 366 </body></html> |
