Mercurial Repositories > eric / file comparison

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

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

branch
APIs
changeset 5352
ddcf6fd8c316
parent 4575
464a6b049f89
equal deleted inserted replaced
5351:e87b1fec71d1 5352:ddcf6fd8c316
61 <table> 61 <table>
62 <tr> 62 <tr>
63 <td><a href="#EditorAPIsPage.__init__">EditorAPIsPage</a></td> 63 <td><a href="#EditorAPIsPage.__init__">EditorAPIsPage</a></td>
64 <td>Constructor</td> 64 <td>Constructor</td>
65 </tr><tr> 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>
66 <td><a href="#EditorAPIsPage.__apiPreparationCancelled">__apiPreparationCancelled</a></td> 69 <td><a href="#EditorAPIsPage.__apiPreparationCancelled">__apiPreparationCancelled</a></td>
67 <td>Private slot called after the API preparation has been cancelled.</td> 70 <td>Private slot called after the API preparation has been cancelled.</td>
68 </tr><tr> 71 </tr><tr>
69 <td><a href="#EditorAPIsPage.__apiPreparationFinished">__apiPreparationFinished</a></td> 72 <td><a href="#EditorAPIsPage.__apiPreparationFinished">__apiPreparationFinished</a></td>
70 <td>Private method called after the API preparation has finished.</td> 73 <td>Private method called after the API preparation has finished.</td>
73 <td>Private method called after the API preparation has started.</td> 76 <td>Private method called after the API preparation has started.</td>
74 </tr><tr> 77 </tr><tr>
75 <td><a href="#EditorAPIsPage.__editorGetApisFromApiList">__editorGetApisFromApiList</a></td> 78 <td><a href="#EditorAPIsPage.__editorGetApisFromApiList">__editorGetApisFromApiList</a></td>
76 <td>Private slot to retrieve the api filenames from the list.</td> 79 <td>Private slot to retrieve the api filenames from the list.</td>
77 </tr><tr> 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>
78 <td><a href="#EditorAPIsPage.on_addApiFileButton_clicked">on_addApiFileButton_clicked</a></td> 84 <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> 85 <td>Private slot to add the api file displayed to the listbox.</td>
80 </tr><tr> 86 </tr><tr>
81 <td><a href="#EditorAPIsPage.on_addInstalledApiFileButton_clicked">on_addInstalledApiFileButton_clicked</a></td> 87 <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> 88 <td>Private slot to add an API file from the list of installed API files for the selected lexer language.</td>
96 <td><a href="#EditorAPIsPage.on_deleteApiFileButton_clicked">on_deleteApiFileButton_clicked</a></td> 102 <td><a href="#EditorAPIsPage.on_deleteApiFileButton_clicked">on_deleteApiFileButton_clicked</a></td>
97 <td>Private slot to delete the currently selected file of the listbox.</td> 103 <td>Private slot to delete the currently selected file of the listbox.</td>
98 </tr><tr> 104 </tr><tr>
99 <td><a href="#EditorAPIsPage.on_prepareApiButton_clicked">on_prepareApiButton_clicked</a></td> 105 <td><a href="#EditorAPIsPage.on_prepareApiButton_clicked">on_prepareApiButton_clicked</a></td>
100 <td>Private slot to prepare the API file for the currently selected language.</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>
101 </tr><tr> 110 </tr><tr>
102 <td><a href="#EditorAPIsPage.save">save</a></td> 111 <td><a href="#EditorAPIsPage.save">save</a></td>
103 <td>Public slot to save the Editor APIs configuration.</td> 112 <td>Public slot to save the Editor APIs configuration.</td>
104 </tr><tr> 113 </tr><tr>
105 <td><a href="#EditorAPIsPage.saveState">saveState</a></td> 114 <td><a href="#EditorAPIsPage.saveState">saveState</a></td>
116 <a NAME="EditorAPIsPage.__init__" ID="EditorAPIsPage.__init__"></a> 125 <a NAME="EditorAPIsPage.__init__" ID="EditorAPIsPage.__init__"></a>
117 <h4>EditorAPIsPage (Constructor)</h4> 126 <h4>EditorAPIsPage (Constructor)</h4>
118 <b>EditorAPIsPage</b>(<i></i>) 127 <b>EditorAPIsPage</b>(<i></i>)
119 <p> 128 <p>
120 Constructor 129 Constructor
121 </p><a NAME="EditorAPIsPage.__apiPreparationCancelled" ID="EditorAPIsPage.__apiPreparationCancelled"></a> 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>
122 <h4>EditorAPIsPage.__apiPreparationCancelled</h4> 154 <h4>EditorAPIsPage.__apiPreparationCancelled</h4>
123 <b>__apiPreparationCancelled</b>(<i></i>) 155 <b>__apiPreparationCancelled</b>(<i></i>)
124 <p> 156 <p>
125 Private slot called after the API preparation has been cancelled. 157 Private slot called after the API preparation has been cancelled.
126 </p><a NAME="EditorAPIsPage.__apiPreparationFinished" ID="EditorAPIsPage.__apiPreparationFinished"></a> 158 </p><a NAME="EditorAPIsPage.__apiPreparationFinished" ID="EditorAPIsPage.__apiPreparationFinished"></a>
141 </p><dl> 173 </p><dl>
142 <dt>Returns:</dt> 174 <dt>Returns:</dt>
143 <dd> 175 <dd>
144 list of api filenames (list of strings) 176 list of api filenames (list of strings)
145 </dd> 177 </dd>
146 </dl><a NAME="EditorAPIsPage.on_addApiFileButton_clicked" ID="EditorAPIsPage.on_addApiFileButton_clicked"></a> 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>
147 <h4>EditorAPIsPage.on_addApiFileButton_clicked</h4> 184 <h4>EditorAPIsPage.on_addApiFileButton_clicked</h4>
148 <b>on_addApiFileButton_clicked</b>(<i></i>) 185 <b>on_addApiFileButton_clicked</b>(<i></i>)
149 <p> 186 <p>
150 Private slot to add the api file displayed to the listbox. 187 Private slot to add the api file displayed to the listbox.
151 </p><a NAME="EditorAPIsPage.on_addInstalledApiFileButton_clicked" ID="EditorAPIsPage.on_addInstalledApiFileButton_clicked"></a> 188 </p><a NAME="EditorAPIsPage.on_addInstalledApiFileButton_clicked" ID="EditorAPIsPage.on_addInstalledApiFileButton_clicked"></a>
194 <h4>EditorAPIsPage.on_prepareApiButton_clicked</h4> 231 <h4>EditorAPIsPage.on_prepareApiButton_clicked</h4>
195 <b>on_prepareApiButton_clicked</b>(<i></i>) 232 <b>on_prepareApiButton_clicked</b>(<i></i>)
196 <p> 233 <p>
197 Private slot to prepare the API file for the currently selected 234 Private slot to prepare the API file for the currently selected
198 language. 235 language.
199 </p><a NAME="EditorAPIsPage.save" ID="EditorAPIsPage.save"></a> 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>
200 <h4>EditorAPIsPage.save</h4> 247 <h4>EditorAPIsPage.save</h4>
201 <b>save</b>(<i></i>) 248 <b>save</b>(<i></i>)
202 <p> 249 <p>
203 Public slot to save the Editor APIs configuration. 250 Public slot to save the Editor APIs configuration.
204 </p><a NAME="EditorAPIsPage.saveState" ID="EditorAPIsPage.saveState"></a> 251 </p><a NAME="EditorAPIsPage.saveState" ID="EditorAPIsPage.saveState"></a>
207 <p> 254 <p>
208 Public method to save the current state of the widget. 255 Public method to save the current state of the widget.
209 </p><dl> 256 </p><dl>
210 <dt>Returns:</dt> 257 <dt>Returns:</dt>
211 <dd> 258 <dd>
212 index of the selected lexer language (integer) 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
213 </dd> 266 </dd>
214 </dl><a NAME="EditorAPIsPage.setState" ID="EditorAPIsPage.setState"></a> 267 </dl><a NAME="EditorAPIsPage.setState" ID="EditorAPIsPage.setState"></a>
215 <h4>EditorAPIsPage.setState</h4> 268 <h4>EditorAPIsPage.setState</h4>
216 <b>setState</b>(<i>state</i>) 269 <b>setState</b>(<i>state</i>)
217 <p> 270 <p>

Mercurial Repository: eric

eric ide

mercurial