Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorAPIsPage.html
src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorAPIsPage.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10070
- 9f5758c0fec1
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Preferences.ConfigurationPages.EditorAPIsPage</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.ConfigurationPages.EditorAPIsPage</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the Editor APIs configuration page. | |
| 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="#EditorAPIsPage">EditorAPIsPage</a></td> | |
| 25 <td>Class implementing the Editor APIs configuration page.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 | |
| 32 <tr> | |
| 33 <td><a href="#create">create</a></td> | |
| 34 <td>Module function to create the configuration page.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="EditorAPIsPage" ID="EditorAPIsPage"></a> | |
| 40 <h2>EditorAPIsPage</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class implementing the Editor APIs configuration page. | |
| 44 </p> | |
| 45 <h3>Derived from</h3> | |
| 46 ConfigurationPageBase, Ui_EditorAPIsPage | |
| 47 <h3>Class Attributes</h3> | |
| 48 | |
| 49 <table> | |
| 50 <tr><td>None</td></tr> | |
| 51 </table> | |
| 52 <h3>Class Methods</h3> | |
| 53 | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 | |
| 59 <table> | |
| 60 | |
| 61 <tr> | |
| 62 <td><a href="#EditorAPIsPage.__init__">EditorAPIsPage</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#EditorAPIsPage.__apiKey">__apiKey</a></td> | |
| 67 <td>Private method to generate a key for the apis dictionary.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#EditorAPIsPage.__apiPreparationCancelled">__apiPreparationCancelled</a></td> | |
| 71 <td>Private slot called after the API preparation has been cancelled.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#EditorAPIsPage.__apiPreparationFinished">__apiPreparationFinished</a></td> | |
| 75 <td>Private method called after the API preparation has finished.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#EditorAPIsPage.__apiPreparationStarted">__apiPreparationStarted</a></td> | |
| 79 <td>Private method called after the API preparation has started.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#EditorAPIsPage.__editorGetApisFromApiList">__editorGetApisFromApiList</a></td> | |
| 83 <td>Private slot to retrieve the api filenames from the list.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#EditorAPIsPage.__fillApisList">__fillApisList</a></td> | |
| 87 <td>Private slot to fill the list of API files.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#EditorAPIsPage.__fillProjectTypeComboBox">__fillProjectTypeComboBox</a></td> | |
| 91 <td>Private slot to fill the selection of available project types for the given language.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#EditorAPIsPage.on_addApiFileButton_clicked">on_addApiFileButton_clicked</a></td> | |
| 95 <td>Private slot to add the api file displayed to the listbox.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#EditorAPIsPage.on_addInstalledApiFileButton_clicked">on_addInstalledApiFileButton_clicked</a></td> | |
| 99 <td>Private slot to add an API file from the list of installed API files for the selected lexer language.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#EditorAPIsPage.on_addPluginApiFileButton_clicked">on_addPluginApiFileButton_clicked</a></td> | |
| 103 <td>Private slot to add an API file from the list of API files installed by plugins for the selected lexer language.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#EditorAPIsPage.on_apiFilePicker_textChanged">on_apiFilePicker_textChanged</a></td> | |
| 107 <td>Private slot to handle the entering of an API file name.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#EditorAPIsPage.on_apiLanguageComboBox_activated">on_apiLanguageComboBox_activated</a></td> | |
| 111 <td>Private slot to fill the api listbox of the api page.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#EditorAPIsPage.on_apiList_itemSelectionChanged">on_apiList_itemSelectionChanged</a></td> | |
| 115 <td>Private slot to react on changes of API selections.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#EditorAPIsPage.on_deleteApiFileButton_clicked">on_deleteApiFileButton_clicked</a></td> | |
| 119 <td>Private slot to delete the currently selected file of the listbox.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#EditorAPIsPage.on_prepareApiButton_clicked">on_prepareApiButton_clicked</a></td> | |
| 123 <td>Private slot to prepare the API file for the currently selected language.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#EditorAPIsPage.on_projectTypeComboBox_activated">on_projectTypeComboBox_activated</a></td> | |
| 127 <td>Private slot to handle the selection of a project type.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#EditorAPIsPage.save">save</a></td> | |
| 131 <td>Public slot to save the Editor APIs configuration.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#EditorAPIsPage.saveState">saveState</a></td> | |
| 135 <td>Public method to save the current state of the widget.</td> | |
| 136 </tr> | |
| 137 <tr> | |
| 138 <td><a href="#EditorAPIsPage.setState">setState</a></td> | |
| 139 <td>Public method to set the state of the widget.</td> | |
| 140 </tr> | |
| 141 </table> | |
| 142 <h3>Static Methods</h3> | |
| 143 | |
| 144 <table> | |
| 145 <tr><td>None</td></tr> | |
| 146 </table> | |
| 147 | |
| 148 <a NAME="EditorAPIsPage.__init__" ID="EditorAPIsPage.__init__"></a> | |
| 149 <h4>EditorAPIsPage (Constructor)</h4> | |
| 150 <b>EditorAPIsPage</b>(<i></i>) | |
| 151 | |
| 152 <p> | |
| 153 Constructor | |
| 154 </p> | |
| 155 <a NAME="EditorAPIsPage.__apiKey" ID="EditorAPIsPage.__apiKey"></a> | |
| 156 <h4>EditorAPIsPage.__apiKey</h4> | |
| 157 <b>__apiKey</b>(<i>language, projectType</i>) | |
| 158 | |
| 159 <p> | |
| 160 Private method to generate a key for the apis dictionary. | |
| 161 </p> | |
| 162 <dl> | |
| 163 | |
| 164 <dt><i>language</i> (str)</dt> | |
| 165 <dd> | |
| 166 programming language of the API | |
| 167 </dd> | |
| 168 <dt><i>projectType</i> (str)</dt> | |
| 169 <dd> | |
| 170 project type of the API | |
| 171 </dd> | |
| 172 </dl> | |
| 173 <dl> | |
| 174 <dt>Return:</dt> | |
| 175 <dd> | |
| 176 key to be used | |
| 177 </dd> | |
| 178 </dl> | |
| 179 <dl> | |
| 180 <dt>Return Type:</dt> | |
| 181 <dd> | |
| 182 str | |
| 183 </dd> | |
| 184 </dl> | |
| 185 <a NAME="EditorAPIsPage.__apiPreparationCancelled" ID="EditorAPIsPage.__apiPreparationCancelled"></a> | |
| 186 <h4>EditorAPIsPage.__apiPreparationCancelled</h4> | |
| 187 <b>__apiPreparationCancelled</b>(<i></i>) | |
| 188 | |
| 189 <p> | |
| 190 Private slot called after the API preparation has been cancelled. | |
| 191 </p> | |
| 192 <a NAME="EditorAPIsPage.__apiPreparationFinished" ID="EditorAPIsPage.__apiPreparationFinished"></a> | |
| 193 <h4>EditorAPIsPage.__apiPreparationFinished</h4> | |
| 194 <b>__apiPreparationFinished</b>(<i></i>) | |
| 195 | |
| 196 <p> | |
| 197 Private method called after the API preparation has finished. | |
| 198 </p> | |
| 199 <a NAME="EditorAPIsPage.__apiPreparationStarted" ID="EditorAPIsPage.__apiPreparationStarted"></a> | |
| 200 <h4>EditorAPIsPage.__apiPreparationStarted</h4> | |
| 201 <b>__apiPreparationStarted</b>(<i></i>) | |
| 202 | |
| 203 <p> | |
| 204 Private method called after the API preparation has started. | |
| 205 </p> | |
| 206 <a NAME="EditorAPIsPage.__editorGetApisFromApiList" ID="EditorAPIsPage.__editorGetApisFromApiList"></a> | |
| 207 <h4>EditorAPIsPage.__editorGetApisFromApiList</h4> | |
| 208 <b>__editorGetApisFromApiList</b>(<i></i>) | |
| 209 | |
| 210 <p> | |
| 211 Private slot to retrieve the api filenames from the list. | |
| 212 </p> | |
| 213 <dl> | |
| 214 <dt>Return:</dt> | |
| 215 <dd> | |
| 216 list of api filenames (list of strings) | |
| 217 </dd> | |
| 218 </dl> | |
| 219 <a NAME="EditorAPIsPage.__fillApisList" ID="EditorAPIsPage.__fillApisList"></a> | |
| 220 <h4>EditorAPIsPage.__fillApisList</h4> | |
| 221 <b>__fillApisList</b>(<i></i>) | |
| 222 | |
| 223 <p> | |
| 224 Private slot to fill the list of API files. | |
| 225 </p> | |
| 226 <a NAME="EditorAPIsPage.__fillProjectTypeComboBox" ID="EditorAPIsPage.__fillProjectTypeComboBox"></a> | |
| 227 <h4>EditorAPIsPage.__fillProjectTypeComboBox</h4> | |
| 228 <b>__fillProjectTypeComboBox</b>(<i>language</i>) | |
| 229 | |
| 230 <p> | |
| 231 Private slot to fill the selection of available project types for the | |
| 232 given language. | |
| 233 </p> | |
| 234 <dl> | |
| 235 | |
| 236 <dt><i>language</i> (str)</dt> | |
| 237 <dd> | |
| 238 selected API language | |
| 239 </dd> | |
| 240 </dl> | |
| 241 <a NAME="EditorAPIsPage.on_addApiFileButton_clicked" ID="EditorAPIsPage.on_addApiFileButton_clicked"></a> | |
| 242 <h4>EditorAPIsPage.on_addApiFileButton_clicked</h4> | |
| 243 <b>on_addApiFileButton_clicked</b>(<i></i>) | |
| 244 | |
| 245 <p> | |
| 246 Private slot to add the api file displayed to the listbox. | |
| 247 </p> | |
| 248 <a NAME="EditorAPIsPage.on_addInstalledApiFileButton_clicked" ID="EditorAPIsPage.on_addInstalledApiFileButton_clicked"></a> | |
| 249 <h4>EditorAPIsPage.on_addInstalledApiFileButton_clicked</h4> | |
| 250 <b>on_addInstalledApiFileButton_clicked</b>(<i></i>) | |
| 251 | |
| 252 <p> | |
| 253 Private slot to add an API file from the list of installed API files | |
| 254 for the selected lexer language. | |
| 255 </p> | |
| 256 <a NAME="EditorAPIsPage.on_addPluginApiFileButton_clicked" ID="EditorAPIsPage.on_addPluginApiFileButton_clicked"></a> | |
| 257 <h4>EditorAPIsPage.on_addPluginApiFileButton_clicked</h4> | |
| 258 <b>on_addPluginApiFileButton_clicked</b>(<i></i>) | |
| 259 | |
| 260 <p> | |
| 261 Private slot to add an API file from the list of API files installed | |
| 262 by plugins for the selected lexer language. | |
| 263 </p> | |
| 264 <a NAME="EditorAPIsPage.on_apiFilePicker_textChanged" ID="EditorAPIsPage.on_apiFilePicker_textChanged"></a> | |
| 265 <h4>EditorAPIsPage.on_apiFilePicker_textChanged</h4> | |
| 266 <b>on_apiFilePicker_textChanged</b>(<i>txt</i>) | |
| 267 | |
| 268 <p> | |
| 269 Private slot to handle the entering of an API file name. | |
| 270 </p> | |
| 271 <dl> | |
| 272 | |
| 273 <dt><i>txt</i></dt> | |
| 274 <dd> | |
| 275 text of the line edit (string) | |
| 276 </dd> | |
| 277 </dl> | |
| 278 <a NAME="EditorAPIsPage.on_apiLanguageComboBox_activated" ID="EditorAPIsPage.on_apiLanguageComboBox_activated"></a> | |
| 279 <h4>EditorAPIsPage.on_apiLanguageComboBox_activated</h4> | |
| 280 <b>on_apiLanguageComboBox_activated</b>(<i>index</i>) | |
| 281 | |
| 282 <p> | |
| 283 Private slot to fill the api listbox of the api page. | |
| 284 </p> | |
| 285 <dl> | |
| 286 | |
| 287 <dt><i>index</i> (int)</dt> | |
| 288 <dd> | |
| 289 index of the selected entry | |
| 290 </dd> | |
| 291 </dl> | |
| 292 <a NAME="EditorAPIsPage.on_apiList_itemSelectionChanged" ID="EditorAPIsPage.on_apiList_itemSelectionChanged"></a> | |
| 293 <h4>EditorAPIsPage.on_apiList_itemSelectionChanged</h4> | |
| 294 <b>on_apiList_itemSelectionChanged</b>(<i></i>) | |
| 295 | |
| 296 <p> | |
| 297 Private slot to react on changes of API selections. | |
| 298 </p> | |
| 299 <a NAME="EditorAPIsPage.on_deleteApiFileButton_clicked" ID="EditorAPIsPage.on_deleteApiFileButton_clicked"></a> | |
| 300 <h4>EditorAPIsPage.on_deleteApiFileButton_clicked</h4> | |
| 301 <b>on_deleteApiFileButton_clicked</b>(<i></i>) | |
| 302 | |
| 303 <p> | |
| 304 Private slot to delete the currently selected file of the listbox. | |
| 305 </p> | |
| 306 <a NAME="EditorAPIsPage.on_prepareApiButton_clicked" ID="EditorAPIsPage.on_prepareApiButton_clicked"></a> | |
| 307 <h4>EditorAPIsPage.on_prepareApiButton_clicked</h4> | |
| 308 <b>on_prepareApiButton_clicked</b>(<i></i>) | |
| 309 | |
| 310 <p> | |
| 311 Private slot to prepare the API file for the currently selected | |
| 312 language. | |
| 313 </p> | |
| 314 <a NAME="EditorAPIsPage.on_projectTypeComboBox_activated" ID="EditorAPIsPage.on_projectTypeComboBox_activated"></a> | |
| 315 <h4>EditorAPIsPage.on_projectTypeComboBox_activated</h4> | |
| 316 <b>on_projectTypeComboBox_activated</b>(<i>index</i>) | |
| 317 | |
| 318 <p> | |
| 319 Private slot to handle the selection of a project type. | |
| 320 </p> | |
| 321 <dl> | |
| 322 | |
| 323 <dt><i>index</i> (str)</dt> | |
| 324 <dd> | |
| 325 index of the selected entry | |
| 326 </dd> | |
| 327 </dl> | |
| 328 <a NAME="EditorAPIsPage.save" ID="EditorAPIsPage.save"></a> | |
| 329 <h4>EditorAPIsPage.save</h4> | |
| 330 <b>save</b>(<i></i>) | |
| 331 | |
| 332 <p> | |
| 333 Public slot to save the Editor APIs configuration. | |
| 334 </p> | |
| 335 <a NAME="EditorAPIsPage.saveState" ID="EditorAPIsPage.saveState"></a> | |
| 336 <h4>EditorAPIsPage.saveState</h4> | |
| 337 <b>saveState</b>(<i></i>) | |
| 338 | |
| 339 <p> | |
| 340 Public method to save the current state of the widget. | |
| 341 </p> | |
| 342 <dl> | |
| 343 <dt>Return:</dt> | |
| 344 <dd> | |
| 345 tuple containing the index of the selected lexer language | |
| 346 and the index of the selected project type | |
| 347 </dd> | |
| 348 </dl> | |
| 349 <dl> | |
| 350 <dt>Return Type:</dt> | |
| 351 <dd> | |
| 352 tuple of int and int | |
| 353 </dd> | |
| 354 </dl> | |
| 355 <a NAME="EditorAPIsPage.setState" ID="EditorAPIsPage.setState"></a> | |
| 356 <h4>EditorAPIsPage.setState</h4> | |
| 357 <b>setState</b>(<i>state</i>) | |
| 358 | |
| 359 <p> | |
| 360 Public method to set the state of the widget. | |
| 361 </p> | |
| 362 <dl> | |
| 363 | |
| 364 <dt><i>state</i></dt> | |
| 365 <dd> | |
| 366 state data generated by saveState | |
| 367 </dd> | |
| 368 </dl> | |
| 369 <div align="right"><a href="#top">Up</a></div> | |
| 370 <hr /> | |
| 371 <hr /> | |
| 372 <a NAME="create" ID="create"></a> | |
| 373 <h2>create</h2> | |
| 374 <b>create</b>(<i>dlg</i>) | |
| 375 | |
| 376 <p> | |
| 377 Module function to create the configuration page. | |
| 378 </p> | |
| 379 <dl> | |
| 380 | |
| 381 <dt><i>dlg</i></dt> | |
| 382 <dd> | |
| 383 reference to the configuration dialog | |
| 384 </dd> | |
| 385 </dl> | |
| 386 <dl> | |
| 387 <dt>Return:</dt> | |
| 388 <dd> | |
| 389 reference to the instantiated page (ConfigurationPageBase) | |
| 390 </dd> | |
| 391 </dl> | |
| 392 <div align="right"><a href="#top">Up</a></div> | |
| 393 <hr /> | |
| 394 </body></html> |
