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