Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorAPIsPage.html

eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorAPIsPage.html

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

Mercurial Repository: eric

eric ide

mercurial