Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Preferences.ConfigurationPages.EditorAPIsPage.html
Documentation/Source/eric6.Preferences.ConfigurationPages.EditorAPIsPage.html
- changeset 3673
- e26d7d0c1088
- child 4575
- 464a6b049f89
equal
deleted
inserted
replaced
| 3670:f0cb7579c0b4 | 3673:e26d7d0c1088 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Preferences.ConfigurationPages.EditorAPIsPage</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Preferences.ConfigurationPages.EditorAPIsPage</h1> | |
| 23 <p> | |
| 24 Module implementing the Editor APIs configuration page. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#EditorAPIsPage">EditorAPIsPage</a></td> | |
| 34 <td>Class implementing the Editor APIs configuration page.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr> | |
| 40 <td><a href="#create">create</a></td> | |
| 41 <td>Module function to create the configuration page.</td> | |
| 42 </tr> | |
| 43 </table> | |
| 44 <hr /><hr /> | |
| 45 <a NAME="EditorAPIsPage" ID="EditorAPIsPage"></a> | |
| 46 <h2>EditorAPIsPage</h2> | |
| 47 <p> | |
| 48 Class implementing the Editor APIs configuration page. | |
| 49 </p> | |
| 50 <h3>Derived from</h3> | |
| 51 ConfigurationPageBase, Ui_EditorAPIsPage | |
| 52 <h3>Class Attributes</h3> | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 <h3>Methods</h3> | |
| 61 <table> | |
| 62 <tr> | |
| 63 <td><a href="#EditorAPIsPage.__init__">EditorAPIsPage</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#EditorAPIsPage.__apiPreparationCancelled">__apiPreparationCancelled</a></td> | |
| 67 <td>Private slot called after the API preparation has been cancelled.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#EditorAPIsPage.__apiPreparationFinished">__apiPreparationFinished</a></td> | |
| 70 <td>Private method called after the API preparation has finished.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#EditorAPIsPage.__apiPreparationStarted">__apiPreparationStarted</a></td> | |
| 73 <td>Private method called after the API preparation has started.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#EditorAPIsPage.__editorGetApisFromApiList">__editorGetApisFromApiList</a></td> | |
| 76 <td>Private slot to retrieve the api filenames from the list.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#EditorAPIsPage.on_addApiFileButton_clicked">on_addApiFileButton_clicked</a></td> | |
| 79 <td>Private slot to add the api file displayed to the listbox.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#EditorAPIsPage.on_addInstalledApiFileButton_clicked">on_addInstalledApiFileButton_clicked</a></td> | |
| 82 <td>Private slot to add an API file from the list of installed API files for the selected lexer language.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#EditorAPIsPage.on_addPluginApiFileButton_clicked">on_addPluginApiFileButton_clicked</a></td> | |
| 85 <td>Private slot to add an API file from the list of API files installed by plugins for the selected lexer language.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#EditorAPIsPage.on_apiFileButton_clicked">on_apiFileButton_clicked</a></td> | |
| 88 <td>Private method to select an api file.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#EditorAPIsPage.on_apiFileEdit_textChanged">on_apiFileEdit_textChanged</a></td> | |
| 91 <td>Private slot to handle the entering of an API file name.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#EditorAPIsPage.on_apiLanguageComboBox_activated">on_apiLanguageComboBox_activated</a></td> | |
| 94 <td>Private slot to fill the api listbox of the api page.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#EditorAPIsPage.on_apiList_itemSelectionChanged">on_apiList_itemSelectionChanged</a></td> | |
| 97 <td>Private slot to react on changes of API selections.</td> | |
| 98 </tr><tr> | |
| 99 <td><a href="#EditorAPIsPage.on_deleteApiFileButton_clicked">on_deleteApiFileButton_clicked</a></td> | |
| 100 <td>Private slot to delete the currently selected file of the listbox.</td> | |
| 101 </tr><tr> | |
| 102 <td><a href="#EditorAPIsPage.on_prepareApiButton_clicked">on_prepareApiButton_clicked</a></td> | |
| 103 <td>Private slot to prepare the API file for the currently selected language.</td> | |
| 104 </tr><tr> | |
| 105 <td><a href="#EditorAPIsPage.save">save</a></td> | |
| 106 <td>Public slot to save the Editor APIs configuration.</td> | |
| 107 </tr><tr> | |
| 108 <td><a href="#EditorAPIsPage.saveState">saveState</a></td> | |
| 109 <td>Public method to save the current state of the widget.</td> | |
| 110 </tr><tr> | |
| 111 <td><a href="#EditorAPIsPage.setState">setState</a></td> | |
| 112 <td>Public method to set the state of the widget.</td> | |
| 113 </tr> | |
| 114 </table> | |
| 115 <h3>Static Methods</h3> | |
| 116 <table> | |
| 117 <tr><td>None</td></tr> | |
| 118 </table> | |
| 119 <a NAME="EditorAPIsPage.__init__" ID="EditorAPIsPage.__init__"></a> | |
| 120 <h4>EditorAPIsPage (Constructor)</h4> | |
| 121 <b>EditorAPIsPage</b>(<i></i>) | |
| 122 <p> | |
| 123 Constructor | |
| 124 </p><a NAME="EditorAPIsPage.__apiPreparationCancelled" ID="EditorAPIsPage.__apiPreparationCancelled"></a> | |
| 125 <h4>EditorAPIsPage.__apiPreparationCancelled</h4> | |
| 126 <b>__apiPreparationCancelled</b>(<i></i>) | |
| 127 <p> | |
| 128 Private slot called after the API preparation has been cancelled. | |
| 129 </p><a NAME="EditorAPIsPage.__apiPreparationFinished" ID="EditorAPIsPage.__apiPreparationFinished"></a> | |
| 130 <h4>EditorAPIsPage.__apiPreparationFinished</h4> | |
| 131 <b>__apiPreparationFinished</b>(<i></i>) | |
| 132 <p> | |
| 133 Private method called after the API preparation has finished. | |
| 134 </p><a NAME="EditorAPIsPage.__apiPreparationStarted" ID="EditorAPIsPage.__apiPreparationStarted"></a> | |
| 135 <h4>EditorAPIsPage.__apiPreparationStarted</h4> | |
| 136 <b>__apiPreparationStarted</b>(<i></i>) | |
| 137 <p> | |
| 138 Private method called after the API preparation has started. | |
| 139 </p><a NAME="EditorAPIsPage.__editorGetApisFromApiList" ID="EditorAPIsPage.__editorGetApisFromApiList"></a> | |
| 140 <h4>EditorAPIsPage.__editorGetApisFromApiList</h4> | |
| 141 <b>__editorGetApisFromApiList</b>(<i></i>) | |
| 142 <p> | |
| 143 Private slot to retrieve the api filenames from the list. | |
| 144 </p><dl> | |
| 145 <dt>Returns:</dt> | |
| 146 <dd> | |
| 147 list of api filenames (list of strings) | |
| 148 </dd> | |
| 149 </dl><a NAME="EditorAPIsPage.on_addApiFileButton_clicked" ID="EditorAPIsPage.on_addApiFileButton_clicked"></a> | |
| 150 <h4>EditorAPIsPage.on_addApiFileButton_clicked</h4> | |
| 151 <b>on_addApiFileButton_clicked</b>(<i></i>) | |
| 152 <p> | |
| 153 Private slot to add the api file displayed to the listbox. | |
| 154 </p><a NAME="EditorAPIsPage.on_addInstalledApiFileButton_clicked" ID="EditorAPIsPage.on_addInstalledApiFileButton_clicked"></a> | |
| 155 <h4>EditorAPIsPage.on_addInstalledApiFileButton_clicked</h4> | |
| 156 <b>on_addInstalledApiFileButton_clicked</b>(<i></i>) | |
| 157 <p> | |
| 158 Private slot to add an API file from the list of installed API files | |
| 159 for the selected lexer language. | |
| 160 </p><a NAME="EditorAPIsPage.on_addPluginApiFileButton_clicked" ID="EditorAPIsPage.on_addPluginApiFileButton_clicked"></a> | |
| 161 <h4>EditorAPIsPage.on_addPluginApiFileButton_clicked</h4> | |
| 162 <b>on_addPluginApiFileButton_clicked</b>(<i></i>) | |
| 163 <p> | |
| 164 Private slot to add an API file from the list of API files installed | |
| 165 by plugins for the selected lexer language. | |
| 166 </p><a NAME="EditorAPIsPage.on_apiFileButton_clicked" ID="EditorAPIsPage.on_apiFileButton_clicked"></a> | |
| 167 <h4>EditorAPIsPage.on_apiFileButton_clicked</h4> | |
| 168 <b>on_apiFileButton_clicked</b>(<i></i>) | |
| 169 <p> | |
| 170 Private method to select an api file. | |
| 171 </p><a NAME="EditorAPIsPage.on_apiFileEdit_textChanged" ID="EditorAPIsPage.on_apiFileEdit_textChanged"></a> | |
| 172 <h4>EditorAPIsPage.on_apiFileEdit_textChanged</h4> | |
| 173 <b>on_apiFileEdit_textChanged</b>(<i>txt</i>) | |
| 174 <p> | |
| 175 Private slot to handle the entering of an API file name. | |
| 176 </p><dl> | |
| 177 <dt><i>txt</i></dt> | |
| 178 <dd> | |
| 179 text of the line edit (string) | |
| 180 </dd> | |
| 181 </dl><a NAME="EditorAPIsPage.on_apiLanguageComboBox_activated" ID="EditorAPIsPage.on_apiLanguageComboBox_activated"></a> | |
| 182 <h4>EditorAPIsPage.on_apiLanguageComboBox_activated</h4> | |
| 183 <b>on_apiLanguageComboBox_activated</b>(<i>language</i>) | |
| 184 <p> | |
| 185 Private slot to fill the api listbox of the api page. | |
| 186 </p><dl> | |
| 187 <dt><i>language</i></dt> | |
| 188 <dd> | |
| 189 selected API language (string) | |
| 190 </dd> | |
| 191 </dl><a NAME="EditorAPIsPage.on_apiList_itemSelectionChanged" ID="EditorAPIsPage.on_apiList_itemSelectionChanged"></a> | |
| 192 <h4>EditorAPIsPage.on_apiList_itemSelectionChanged</h4> | |
| 193 <b>on_apiList_itemSelectionChanged</b>(<i></i>) | |
| 194 <p> | |
| 195 Private slot to react on changes of API selections. | |
| 196 </p><a NAME="EditorAPIsPage.on_deleteApiFileButton_clicked" ID="EditorAPIsPage.on_deleteApiFileButton_clicked"></a> | |
| 197 <h4>EditorAPIsPage.on_deleteApiFileButton_clicked</h4> | |
| 198 <b>on_deleteApiFileButton_clicked</b>(<i></i>) | |
| 199 <p> | |
| 200 Private slot to delete the currently selected file of the listbox. | |
| 201 </p><a NAME="EditorAPIsPage.on_prepareApiButton_clicked" ID="EditorAPIsPage.on_prepareApiButton_clicked"></a> | |
| 202 <h4>EditorAPIsPage.on_prepareApiButton_clicked</h4> | |
| 203 <b>on_prepareApiButton_clicked</b>(<i></i>) | |
| 204 <p> | |
| 205 Private slot to prepare the API file for the currently selected | |
| 206 language. | |
| 207 </p><a NAME="EditorAPIsPage.save" ID="EditorAPIsPage.save"></a> | |
| 208 <h4>EditorAPIsPage.save</h4> | |
| 209 <b>save</b>(<i></i>) | |
| 210 <p> | |
| 211 Public slot to save the Editor APIs configuration. | |
| 212 </p><a NAME="EditorAPIsPage.saveState" ID="EditorAPIsPage.saveState"></a> | |
| 213 <h4>EditorAPIsPage.saveState</h4> | |
| 214 <b>saveState</b>(<i></i>) | |
| 215 <p> | |
| 216 Public method to save the current state of the widget. | |
| 217 </p><dl> | |
| 218 <dt>Returns:</dt> | |
| 219 <dd> | |
| 220 index of the selected lexer language (integer) | |
| 221 </dd> | |
| 222 </dl><a NAME="EditorAPIsPage.setState" ID="EditorAPIsPage.setState"></a> | |
| 223 <h4>EditorAPIsPage.setState</h4> | |
| 224 <b>setState</b>(<i>state</i>) | |
| 225 <p> | |
| 226 Public method to set the state of the widget. | |
| 227 </p><dl> | |
| 228 <dt><i>state</i></dt> | |
| 229 <dd> | |
| 230 state data generated by saveState | |
| 231 </dd> | |
| 232 </dl> | |
| 233 <div align="right"><a href="#top">Up</a></div> | |
| 234 <hr /><hr /> | |
| 235 <a NAME="create" ID="create"></a> | |
| 236 <h2>create</h2> | |
| 237 <b>create</b>(<i>dlg</i>) | |
| 238 <p> | |
| 239 Module function to create the configuration page. | |
| 240 </p><dl> | |
| 241 <dt><i>dlg</i></dt> | |
| 242 <dd> | |
| 243 reference to the configuration dialog | |
| 244 </dd> | |
| 245 </dl><dl> | |
| 246 <dt>Returns:</dt> | |
| 247 <dd> | |
| 248 reference to the instantiated page (ConfigurationPageBase) | |
| 249 </dd> | |
| 250 </dl> | |
| 251 <div align="right"><a href="#top">Up</a></div> | |
| 252 <hr /> | |
| 253 </body></html> |
