Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Preferences.ToolConfigurationDialog.html
Documentation/Source/eric5.Preferences.ToolConfigurationDialog.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Preferences.ToolConfigurationDialog</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.Preferences.ToolConfigurationDialog</h1> | |
| 12 <p> | |
| 13 Module implementing a configuration dialog for the tools menu. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#ToolConfigurationDialog">ToolConfigurationDialog</a></td> | |
| 23 <td>Class implementing a configuration dialog for the tools menu.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <hr /><hr /> | |
| 31 <a NAME="ToolConfigurationDialog" ID="ToolConfigurationDialog"></a> | |
| 32 <h2>ToolConfigurationDialog</h2> | |
| 33 <p> | |
| 34 Class implementing a configuration dialog for the tools menu. | |
| 35 </p> | |
| 36 <h3>Derived from</h3> | |
| 37 QDialog, Ui_ToolConfigurationDialog | |
| 38 <h3>Class Attributes</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <h3>Methods</h3> | |
| 43 <table> | |
| 44 <tr> | |
| 45 <td><a href="#ToolConfigurationDialog.__init__">ToolConfigurationDialog</a></td> | |
| 46 <td>Constructor</td> | |
| 47 </tr><tr> | |
| 48 <td><a href="#ToolConfigurationDialog.__findModeIndex">__findModeIndex</a></td> | |
| 49 <td>Private method to find the mode index by its short name.</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#ToolConfigurationDialog.__swap">__swap</a></td> | |
| 52 <td>Private method used two swap two list entries given by their index.</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#ToolConfigurationDialog.__toolEntryChanged">__toolEntryChanged</a></td> | |
| 55 <td>Private slot to perform actions when a tool entry was changed.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#ToolConfigurationDialog.getToollist">getToollist</a></td> | |
| 58 <td>Public method to retrieve the tools list.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#ToolConfigurationDialog.on_addButton_clicked">on_addButton_clicked</a></td> | |
| 61 <td>Private slot to add a new entry.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#ToolConfigurationDialog.on_argumentsEdit_textChanged">on_argumentsEdit_textChanged</a></td> | |
| 64 <td>Private slot called, when the arguments string was changed.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#ToolConfigurationDialog.on_changeButton_clicked">on_changeButton_clicked</a></td> | |
| 67 <td>Private slot to change an entry.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#ToolConfigurationDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td> | |
| 70 <td>Private slot to delete the selected entry.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#ToolConfigurationDialog.on_downButton_clicked">on_downButton_clicked</a></td> | |
| 73 <td>Private slot to move an entry down in the list.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#ToolConfigurationDialog.on_executableButton_clicked">on_executableButton_clicked</a></td> | |
| 76 <td>Private slot to handle the executable selection via a file selection dialog.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#ToolConfigurationDialog.on_executableEdit_textChanged">on_executableEdit_textChanged</a></td> | |
| 79 <td>Private slot called, when the executable was changed.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#ToolConfigurationDialog.on_iconButton_clicked">on_iconButton_clicked</a></td> | |
| 82 <td>Private slot to handle the icon selection via a file selection dialog.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#ToolConfigurationDialog.on_iconEdit_textChanged">on_iconEdit_textChanged</a></td> | |
| 85 <td>Private slot called, when the icon path was changed.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#ToolConfigurationDialog.on_menuEdit_textChanged">on_menuEdit_textChanged</a></td> | |
| 88 <td>Private slot called, when the menu text was changed.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#ToolConfigurationDialog.on_newButton_clicked">on_newButton_clicked</a></td> | |
| 91 <td>Private slot to clear all entry fields.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#ToolConfigurationDialog.on_redirectCombo_currentIndexChanged">on_redirectCombo_currentIndexChanged</a></td> | |
| 94 <td>Private slot called, when the redirection mode was changed.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#ToolConfigurationDialog.on_separatorButton_clicked">on_separatorButton_clicked</a></td> | |
| 97 <td>Private slot to add a menu separator.</td> | |
| 98 </tr><tr> | |
| 99 <td><a href="#ToolConfigurationDialog.on_toolsList_currentRowChanged">on_toolsList_currentRowChanged</a></td> | |
| 100 <td>Private slot to set the lineedits depending on the selected entry.</td> | |
| 101 </tr><tr> | |
| 102 <td><a href="#ToolConfigurationDialog.on_upButton_clicked">on_upButton_clicked</a></td> | |
| 103 <td>Private slot to move an entry up in the list.</td> | |
| 104 </tr> | |
| 105 </table> | |
| 106 <a NAME="ToolConfigurationDialog.__init__" ID="ToolConfigurationDialog.__init__"></a> | |
| 107 <h4>ToolConfigurationDialog (Constructor)</h4> | |
| 108 <b>ToolConfigurationDialog</b>(<i>toollist, parent=None</i>) | |
| 109 <p> | |
| 110 Constructor | |
| 111 </p><dl> | |
| 112 <dt><i>toollist</i></dt> | |
| 113 <dd> | |
| 114 list of configured tools | |
| 115 </dd><dt><i>parent</i></dt> | |
| 116 <dd> | |
| 117 parent widget (QWidget) | |
| 118 </dd> | |
| 119 </dl><a NAME="ToolConfigurationDialog.__findModeIndex" ID="ToolConfigurationDialog.__findModeIndex"></a> | |
| 120 <h4>ToolConfigurationDialog.__findModeIndex</h4> | |
| 121 <b>__findModeIndex</b>(<i>shortName</i>) | |
| 122 <p> | |
| 123 Private method to find the mode index by its short name. | |
| 124 </p><dl> | |
| 125 <dt><i>shortName</i></dt> | |
| 126 <dd> | |
| 127 short name of the mode (string) | |
| 128 </dd> | |
| 129 </dl><dl> | |
| 130 <dt>Returns:</dt> | |
| 131 <dd> | |
| 132 index of the mode (integer) | |
| 133 </dd> | |
| 134 </dl><a NAME="ToolConfigurationDialog.__swap" ID="ToolConfigurationDialog.__swap"></a> | |
| 135 <h4>ToolConfigurationDialog.__swap</h4> | |
| 136 <b>__swap</b>(<i>itm1, itm2</i>) | |
| 137 <p> | |
| 138 Private method used two swap two list entries given by their index. | |
| 139 </p><dl> | |
| 140 <dt><i>itm1</i></dt> | |
| 141 <dd> | |
| 142 index of first entry (int) | |
| 143 </dd><dt><i>itm2</i></dt> | |
| 144 <dd> | |
| 145 index of second entry (int) | |
| 146 </dd> | |
| 147 </dl><a NAME="ToolConfigurationDialog.__toolEntryChanged" ID="ToolConfigurationDialog.__toolEntryChanged"></a> | |
| 148 <h4>ToolConfigurationDialog.__toolEntryChanged</h4> | |
| 149 <b>__toolEntryChanged</b>(<i></i>) | |
| 150 <p> | |
| 151 Private slot to perform actions when a tool entry was changed. | |
| 152 </p><a NAME="ToolConfigurationDialog.getToollist" ID="ToolConfigurationDialog.getToollist"></a> | |
| 153 <h4>ToolConfigurationDialog.getToollist</h4> | |
| 154 <b>getToollist</b>(<i></i>) | |
| 155 <p> | |
| 156 Public method to retrieve the tools list. | |
| 157 </p><dl> | |
| 158 <dt>Returns:</dt> | |
| 159 <dd> | |
| 160 a list of tuples containing the menu text, the executable, | |
| 161 the executables arguments and a redirection flag | |
| 162 </dd> | |
| 163 </dl><a NAME="ToolConfigurationDialog.on_addButton_clicked" ID="ToolConfigurationDialog.on_addButton_clicked"></a> | |
| 164 <h4>ToolConfigurationDialog.on_addButton_clicked</h4> | |
| 165 <b>on_addButton_clicked</b>(<i></i>) | |
| 166 <p> | |
| 167 Private slot to add a new entry. | |
| 168 </p><a NAME="ToolConfigurationDialog.on_argumentsEdit_textChanged" ID="ToolConfigurationDialog.on_argumentsEdit_textChanged"></a> | |
| 169 <h4>ToolConfigurationDialog.on_argumentsEdit_textChanged</h4> | |
| 170 <b>on_argumentsEdit_textChanged</b>(<i>text</i>) | |
| 171 <p> | |
| 172 Private slot called, when the arguments string was changed. | |
| 173 </p><dl> | |
| 174 <dt><i>text</i></dt> | |
| 175 <dd> | |
| 176 the new text (string) (ignored) | |
| 177 </dd> | |
| 178 </dl><a NAME="ToolConfigurationDialog.on_changeButton_clicked" ID="ToolConfigurationDialog.on_changeButton_clicked"></a> | |
| 179 <h4>ToolConfigurationDialog.on_changeButton_clicked</h4> | |
| 180 <b>on_changeButton_clicked</b>(<i></i>) | |
| 181 <p> | |
| 182 Private slot to change an entry. | |
| 183 </p><a NAME="ToolConfigurationDialog.on_deleteButton_clicked" ID="ToolConfigurationDialog.on_deleteButton_clicked"></a> | |
| 184 <h4>ToolConfigurationDialog.on_deleteButton_clicked</h4> | |
| 185 <b>on_deleteButton_clicked</b>(<i></i>) | |
| 186 <p> | |
| 187 Private slot to delete the selected entry. | |
| 188 </p><a NAME="ToolConfigurationDialog.on_downButton_clicked" ID="ToolConfigurationDialog.on_downButton_clicked"></a> | |
| 189 <h4>ToolConfigurationDialog.on_downButton_clicked</h4> | |
| 190 <b>on_downButton_clicked</b>(<i></i>) | |
| 191 <p> | |
| 192 Private slot to move an entry down in the list. | |
| 193 </p><a NAME="ToolConfigurationDialog.on_executableButton_clicked" ID="ToolConfigurationDialog.on_executableButton_clicked"></a> | |
| 194 <h4>ToolConfigurationDialog.on_executableButton_clicked</h4> | |
| 195 <b>on_executableButton_clicked</b>(<i></i>) | |
| 196 <p> | |
| 197 Private slot to handle the executable selection via a file selection dialog. | |
| 198 </p><a NAME="ToolConfigurationDialog.on_executableEdit_textChanged" ID="ToolConfigurationDialog.on_executableEdit_textChanged"></a> | |
| 199 <h4>ToolConfigurationDialog.on_executableEdit_textChanged</h4> | |
| 200 <b>on_executableEdit_textChanged</b>(<i>text</i>) | |
| 201 <p> | |
| 202 Private slot called, when the executable was changed. | |
| 203 </p><dl> | |
| 204 <dt><i>text</i></dt> | |
| 205 <dd> | |
| 206 the new text (string) (ignored) | |
| 207 </dd> | |
| 208 </dl><a NAME="ToolConfigurationDialog.on_iconButton_clicked" ID="ToolConfigurationDialog.on_iconButton_clicked"></a> | |
| 209 <h4>ToolConfigurationDialog.on_iconButton_clicked</h4> | |
| 210 <b>on_iconButton_clicked</b>(<i></i>) | |
| 211 <p> | |
| 212 Private slot to handle the icon selection via a file selection dialog. | |
| 213 </p><a NAME="ToolConfigurationDialog.on_iconEdit_textChanged" ID="ToolConfigurationDialog.on_iconEdit_textChanged"></a> | |
| 214 <h4>ToolConfigurationDialog.on_iconEdit_textChanged</h4> | |
| 215 <b>on_iconEdit_textChanged</b>(<i>text</i>) | |
| 216 <p> | |
| 217 Private slot called, when the icon path was changed. | |
| 218 </p><dl> | |
| 219 <dt><i>text</i></dt> | |
| 220 <dd> | |
| 221 the new text (string) (ignored) | |
| 222 </dd> | |
| 223 </dl><a NAME="ToolConfigurationDialog.on_menuEdit_textChanged" ID="ToolConfigurationDialog.on_menuEdit_textChanged"></a> | |
| 224 <h4>ToolConfigurationDialog.on_menuEdit_textChanged</h4> | |
| 225 <b>on_menuEdit_textChanged</b>(<i>text</i>) | |
| 226 <p> | |
| 227 Private slot called, when the menu text was changed. | |
| 228 </p><dl> | |
| 229 <dt><i>text</i></dt> | |
| 230 <dd> | |
| 231 the new text (string) (ignored) | |
| 232 </dd> | |
| 233 </dl><a NAME="ToolConfigurationDialog.on_newButton_clicked" ID="ToolConfigurationDialog.on_newButton_clicked"></a> | |
| 234 <h4>ToolConfigurationDialog.on_newButton_clicked</h4> | |
| 235 <b>on_newButton_clicked</b>(<i></i>) | |
| 236 <p> | |
| 237 Private slot to clear all entry fields. | |
| 238 </p><a NAME="ToolConfigurationDialog.on_redirectCombo_currentIndexChanged" ID="ToolConfigurationDialog.on_redirectCombo_currentIndexChanged"></a> | |
| 239 <h4>ToolConfigurationDialog.on_redirectCombo_currentIndexChanged</h4> | |
| 240 <b>on_redirectCombo_currentIndexChanged</b>(<i>index</i>) | |
| 241 <p> | |
| 242 Private slot called, when the redirection mode was changed. | |
| 243 </p><dl> | |
| 244 <dt><i>index</i></dt> | |
| 245 <dd> | |
| 246 the selected mode index (integer) (ignored) | |
| 247 </dd> | |
| 248 </dl><a NAME="ToolConfigurationDialog.on_separatorButton_clicked" ID="ToolConfigurationDialog.on_separatorButton_clicked"></a> | |
| 249 <h4>ToolConfigurationDialog.on_separatorButton_clicked</h4> | |
| 250 <b>on_separatorButton_clicked</b>(<i></i>) | |
| 251 <p> | |
| 252 Private slot to add a menu separator. | |
| 253 </p><a NAME="ToolConfigurationDialog.on_toolsList_currentRowChanged" ID="ToolConfigurationDialog.on_toolsList_currentRowChanged"></a> | |
| 254 <h4>ToolConfigurationDialog.on_toolsList_currentRowChanged</h4> | |
| 255 <b>on_toolsList_currentRowChanged</b>(<i>row</i>) | |
| 256 <p> | |
| 257 Private slot to set the lineedits depending on the selected entry. | |
| 258 </p><dl> | |
| 259 <dt><i>row</i></dt> | |
| 260 <dd> | |
| 261 the row of the selected entry (integer) | |
| 262 </dd> | |
| 263 </dl><a NAME="ToolConfigurationDialog.on_upButton_clicked" ID="ToolConfigurationDialog.on_upButton_clicked"></a> | |
| 264 <h4>ToolConfigurationDialog.on_upButton_clicked</h4> | |
| 265 <b>on_upButton_clicked</b>(<i></i>) | |
| 266 <p> | |
| 267 Private slot to move an entry up in the list. | |
| 268 </p> | |
| 269 <div align="right"><a href="#top">Up</a></div> | |
| 270 <hr /> | |
| 271 </body></html> |
