Mercurial Repositories > eric / file comparison

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

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

changeset 6942
2602857055c5
parent 5352
ddcf6fd8c316
child 7164
6da6a0a5a448
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
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.__apiKey">__apiKey</a></td>
67 <td>Private method to generate a key for the apis dictionary.</td>
68 </tr><tr>
69 <td><a href="#EditorAPIsPage.__apiPreparationCancelled">__apiPreparationCancelled</a></td>
70 <td>Private slot called after the API preparation has been cancelled.</td>
71 </tr><tr>
72 <td><a href="#EditorAPIsPage.__apiPreparationFinished">__apiPreparationFinished</a></td>
73 <td>Private method called after the API preparation has finished.</td>
74 </tr><tr>
75 <td><a href="#EditorAPIsPage.__apiPreparationStarted">__apiPreparationStarted</a></td>
76 <td>Private method called after the API preparation has started.</td>
77 </tr><tr>
78 <td><a href="#EditorAPIsPage.__editorGetApisFromApiList">__editorGetApisFromApiList</a></td>
79 <td>Private slot to retrieve the api filenames from the list.</td>
80 </tr><tr>
81 <td><a href="#EditorAPIsPage.__fillApisList">__fillApisList</a></td>
82 <td>Private slot to fill the list of API files.</td>
83 </tr><tr>
84 <td><a href="#EditorAPIsPage.on_addApiFileButton_clicked">on_addApiFileButton_clicked</a></td>
85 <td>Private slot to add the api file displayed to the listbox.</td>
86 </tr><tr>
87 <td><a href="#EditorAPIsPage.on_addInstalledApiFileButton_clicked">on_addInstalledApiFileButton_clicked</a></td>
88 <td>Private slot to add an API file from the list of installed API files for the selected lexer language.</td>
89 </tr><tr>
90 <td><a href="#EditorAPIsPage.on_addPluginApiFileButton_clicked">on_addPluginApiFileButton_clicked</a></td>
91 <td>Private slot to add an API file from the list of API files installed by plugins for the selected lexer language.</td>
92 </tr><tr>
93 <td><a href="#EditorAPIsPage.on_apiFilePicker_textChanged">on_apiFilePicker_textChanged</a></td>
94 <td>Private slot to handle the entering of an API file name.</td>
95 </tr><tr>
96 <td><a href="#EditorAPIsPage.on_apiLanguageComboBox_activated">on_apiLanguageComboBox_activated</a></td>
97 <td>Private slot to fill the api listbox of the api page.</td>
98 </tr><tr>
99 <td><a href="#EditorAPIsPage.on_apiList_itemSelectionChanged">on_apiList_itemSelectionChanged</a></td>
100 <td>Private slot to react on changes of API selections.</td>
101 </tr><tr>
102 <td><a href="#EditorAPIsPage.on_deleteApiFileButton_clicked">on_deleteApiFileButton_clicked</a></td>
103 <td>Private slot to delete the currently selected file of the listbox.</td>
104 </tr><tr>
105 <td><a href="#EditorAPIsPage.on_prepareApiButton_clicked">on_prepareApiButton_clicked</a></td>
106 <td>Private slot to prepare the API file for the currently selected language.</td>
107 </tr><tr>
108 <td><a href="#EditorAPIsPage.on_projectTypeComboBox_activated">on_projectTypeComboBox_activated</a></td>
109 <td>Private slot to handle the selection of a project type.</td>
110 </tr><tr>
111 <td><a href="#EditorAPIsPage.save">save</a></td>
112 <td>Public slot to save the Editor APIs configuration.</td>
113 </tr><tr>
114 <td><a href="#EditorAPIsPage.saveState">saveState</a></td>
115 <td>Public method to save the current state of the widget.</td>
116 </tr><tr>
117 <td><a href="#EditorAPIsPage.setState">setState</a></td>
118 <td>Public method to set the state of the widget.</td>
119 </tr>
120 </table>
121 <h3>Static Methods</h3>
122 <table>
123 <tr><td>None</td></tr>
124 </table>
125 <a NAME="EditorAPIsPage.__init__" ID="EditorAPIsPage.__init__"></a>
126 <h4>EditorAPIsPage (Constructor)</h4>
127 <b>EditorAPIsPage</b>(<i></i>)
128 <p>
129 Constructor
130 </p><a NAME="EditorAPIsPage.__apiKey" ID="EditorAPIsPage.__apiKey"></a>
131 <h4>EditorAPIsPage.__apiKey</h4>
132 <b>__apiKey</b>(<i>language, projectType</i>)
133 <p>
134 Private method to generate a key for the apis dictionary.
135 </p><dl>
136 <dt><i>language</i> (str)</dt>
137 <dd>
138 programming language of the API
139 </dd><dt><i>projectType</i> (str)</dt>
140 <dd>
141 project type of the API
142 </dd>
143 </dl><dl>
144 <dt>Returns:</dt>
145 <dd>
146 key to be used
147 </dd>
148 </dl><dl>
149 <dt>Return Type:</dt>
150 <dd>
151 str
152 </dd>
153 </dl><a NAME="EditorAPIsPage.__apiPreparationCancelled" ID="EditorAPIsPage.__apiPreparationCancelled"></a>
154 <h4>EditorAPIsPage.__apiPreparationCancelled</h4>
155 <b>__apiPreparationCancelled</b>(<i></i>)
156 <p>
157 Private slot called after the API preparation has been cancelled.
158 </p><a NAME="EditorAPIsPage.__apiPreparationFinished" ID="EditorAPIsPage.__apiPreparationFinished"></a>
159 <h4>EditorAPIsPage.__apiPreparationFinished</h4>
160 <b>__apiPreparationFinished</b>(<i></i>)
161 <p>
162 Private method called after the API preparation has finished.
163 </p><a NAME="EditorAPIsPage.__apiPreparationStarted" ID="EditorAPIsPage.__apiPreparationStarted"></a>
164 <h4>EditorAPIsPage.__apiPreparationStarted</h4>
165 <b>__apiPreparationStarted</b>(<i></i>)
166 <p>
167 Private method called after the API preparation has started.
168 </p><a NAME="EditorAPIsPage.__editorGetApisFromApiList" ID="EditorAPIsPage.__editorGetApisFromApiList"></a>
169 <h4>EditorAPIsPage.__editorGetApisFromApiList</h4>
170 <b>__editorGetApisFromApiList</b>(<i></i>)
171 <p>
172 Private slot to retrieve the api filenames from the list.
173 </p><dl>
174 <dt>Returns:</dt>
175 <dd>
176 list of api filenames (list of strings)
177 </dd>
178 </dl><a NAME="EditorAPIsPage.__fillApisList" ID="EditorAPIsPage.__fillApisList"></a>
179 <h4>EditorAPIsPage.__fillApisList</h4>
180 <b>__fillApisList</b>(<i></i>)
181 <p>
182 Private slot to fill the list of API files.
183 </p><a NAME="EditorAPIsPage.on_addApiFileButton_clicked" ID="EditorAPIsPage.on_addApiFileButton_clicked"></a>
184 <h4>EditorAPIsPage.on_addApiFileButton_clicked</h4>
185 <b>on_addApiFileButton_clicked</b>(<i></i>)
186 <p>
187 Private slot to add the api file displayed to the listbox.
188 </p><a NAME="EditorAPIsPage.on_addInstalledApiFileButton_clicked" ID="EditorAPIsPage.on_addInstalledApiFileButton_clicked"></a>
189 <h4>EditorAPIsPage.on_addInstalledApiFileButton_clicked</h4>
190 <b>on_addInstalledApiFileButton_clicked</b>(<i></i>)
191 <p>
192 Private slot to add an API file from the list of installed API files
193 for the selected lexer language.
194 </p><a NAME="EditorAPIsPage.on_addPluginApiFileButton_clicked" ID="EditorAPIsPage.on_addPluginApiFileButton_clicked"></a>
195 <h4>EditorAPIsPage.on_addPluginApiFileButton_clicked</h4>
196 <b>on_addPluginApiFileButton_clicked</b>(<i></i>)
197 <p>
198 Private slot to add an API file from the list of API files installed
199 by plugins for the selected lexer language.
200 </p><a NAME="EditorAPIsPage.on_apiFilePicker_textChanged" ID="EditorAPIsPage.on_apiFilePicker_textChanged"></a>
201 <h4>EditorAPIsPage.on_apiFilePicker_textChanged</h4>
202 <b>on_apiFilePicker_textChanged</b>(<i>txt</i>)
203 <p>
204 Private slot to handle the entering of an API file name.
205 </p><dl>
206 <dt><i>txt</i></dt>
207 <dd>
208 text of the line edit (string)
209 </dd>
210 </dl><a NAME="EditorAPIsPage.on_apiLanguageComboBox_activated" ID="EditorAPIsPage.on_apiLanguageComboBox_activated"></a>
211 <h4>EditorAPIsPage.on_apiLanguageComboBox_activated</h4>
212 <b>on_apiLanguageComboBox_activated</b>(<i>language</i>)
213 <p>
214 Private slot to fill the api listbox of the api page.
215 </p><dl>
216 <dt><i>language</i></dt>
217 <dd>
218 selected API language (string)
219 </dd>
220 </dl><a NAME="EditorAPIsPage.on_apiList_itemSelectionChanged" ID="EditorAPIsPage.on_apiList_itemSelectionChanged"></a>
221 <h4>EditorAPIsPage.on_apiList_itemSelectionChanged</h4>
222 <b>on_apiList_itemSelectionChanged</b>(<i></i>)
223 <p>
224 Private slot to react on changes of API selections.
225 </p><a NAME="EditorAPIsPage.on_deleteApiFileButton_clicked" ID="EditorAPIsPage.on_deleteApiFileButton_clicked"></a>
226 <h4>EditorAPIsPage.on_deleteApiFileButton_clicked</h4>
227 <b>on_deleteApiFileButton_clicked</b>(<i></i>)
228 <p>
229 Private slot to delete the currently selected file of the listbox.
230 </p><a NAME="EditorAPIsPage.on_prepareApiButton_clicked" ID="EditorAPIsPage.on_prepareApiButton_clicked"></a>
231 <h4>EditorAPIsPage.on_prepareApiButton_clicked</h4>
232 <b>on_prepareApiButton_clicked</b>(<i></i>)
233 <p>
234 Private slot to prepare the API file for the currently selected
235 language.
236 </p><a NAME="EditorAPIsPage.on_projectTypeComboBox_activated" ID="EditorAPIsPage.on_projectTypeComboBox_activated"></a>
237 <h4>EditorAPIsPage.on_projectTypeComboBox_activated</h4>
238 <b>on_projectTypeComboBox_activated</b>(<i>index</i>)
239 <p>
240 Private slot to handle the selection of a project type.
241 </p><dl>
242 <dt><i>index</i> (str)</dt>
243 <dd>
244 index of the selected entry
245 </dd>
246 </dl><a NAME="EditorAPIsPage.save" ID="EditorAPIsPage.save"></a>
247 <h4>EditorAPIsPage.save</h4>
248 <b>save</b>(<i></i>)
249 <p>
250 Public slot to save the Editor APIs configuration.
251 </p><a NAME="EditorAPIsPage.saveState" ID="EditorAPIsPage.saveState"></a>
252 <h4>EditorAPIsPage.saveState</h4>
253 <b>saveState</b>(<i></i>)
254 <p>
255 Public method to save the current state of the widget.
256 </p><dl>
257 <dt>Returns:</dt>
258 <dd>
259 tuple containing the index of the selected lexer language
260 and the index of the selected project type
261 </dd>
262 </dl><dl>
263 <dt>Return Type:</dt>
264 <dd>
265 tuple of int and int
266 </dd>
267 </dl><a NAME="EditorAPIsPage.setState" ID="EditorAPIsPage.setState"></a>
268 <h4>EditorAPIsPage.setState</h4>
269 <b>setState</b>(<i>state</i>)
270 <p>
271 Public method to set the state of the widget.
272 </p><dl>
273 <dt><i>state</i></dt>
274 <dd>
275 state data generated by saveState
276 </dd>
277 </dl>
278 <div align="right"><a href="#top">Up</a></div>
279 <hr /><hr />
280 <a NAME="create" ID="create"></a>
281 <h2>create</h2>
282 <b>create</b>(<i>dlg</i>)
283 <p>
284 Module function to create the configuration page.
285 </p><dl>
286 <dt><i>dlg</i></dt>
287 <dd>
288 reference to the configuration dialog
289 </dd>
290 </dl><dl>
291 <dt>Returns:</dt>
292 <dd>
293 reference to the instantiated page (ConfigurationPageBase)
294 </dd>
295 </dl>
296 <div align="right"><a href="#top">Up</a></div>
297 <hr />
298 </body></html>

Mercurial Repository: eric

eric ide

mercurial