Mercurial Repositories > Eric Assistant / file comparison

comparison: AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.APIsManager.html

AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.APIsManager.html

changeset 131
7d868e8e1cfb
parent 107
728fde5bfdb1
child 140
a0ea7418d433
equal deleted inserted replaced
130:08c7aece376c 131:7d868e8e1cfb
80 <td>Private slot handling the preparation status signal of an API object.</td> 80 <td>Private slot handling the preparation status signal of an API object.</td>
81 </tr><tr> 81 </tr><tr>
82 <td><a href="#APIsManager.__showMessage">__showMessage</a></td> 82 <td><a href="#APIsManager.__showMessage">__showMessage</a></td>
83 <td>Private message to show a message in the main windows status bar.</td> 83 <td>Private message to show a message in the main windows status bar.</td>
84 </tr><tr> 84 </tr><tr>
85 <td><a href="#APIsManager.__supportedApiLanguages">__supportedApiLanguages</a></td>
86 <td>Private method to build a list of supported API languages.</td>
87 </tr><tr>
85 <td><a href="#APIsManager.deactivate">deactivate</a></td> 88 <td><a href="#APIsManager.deactivate">deactivate</a></td>
86 <td>Public method to perform actions upon deactivation.</td> 89 <td>Public method to perform actions upon deactivation.</td>
87 </tr><tr> 90 </tr><tr>
88 <td><a href="#APIsManager.getAPIs">getAPIs</a></td> 91 <td><a href="#APIsManager.getAPIs">getAPIs</a></td>
89 <td>Public method to get an apis object for autocompletion/calltips.</td> 92 <td>Public method to get an apis object for autocompletion/calltips.</td>
164 </p><dl> 167 </p><dl>
165 <dt><i>msg</i></dt> 168 <dt><i>msg</i></dt>
166 <dd> 169 <dd>
167 message to be shown (string) 170 message to be shown (string)
168 </dd> 171 </dd>
172 </dl><a NAME="APIsManager.__supportedApiLanguages" ID="APIsManager.__supportedApiLanguages"></a>
173 <h4>APIsManager.__supportedApiLanguages</h4>
174 <b>__supportedApiLanguages</b>(<i></i>)
175 <p>
176 Private method to build a list of supported API languages.
177 </p><p>
178 Note: This is a compatibility method to make this code work with
179 older eric versions.
180 </p><dl>
181 <dt>Returns:</dt>
182 <dd>
183 list of supported API languages
184 </dd>
185 </dl><dl>
186 <dt>Return Type:</dt>
187 <dd>
188 list of str
189 </dd>
169 </dl><a NAME="APIsManager.deactivate" ID="APIsManager.deactivate"></a> 190 </dl><a NAME="APIsManager.deactivate" ID="APIsManager.deactivate"></a>
170 <h4>APIsManager.deactivate</h4> 191 <h4>APIsManager.deactivate</h4>
171 <b>deactivate</b>(<i></i>) 192 <b>deactivate</b>(<i></i>)
172 <p> 193 <p>
173 Public method to perform actions upon deactivation. 194 Public method to perform actions upon deactivation.
174 </p><a NAME="APIsManager.getAPIs" ID="APIsManager.getAPIs"></a> 195 </p><a NAME="APIsManager.getAPIs" ID="APIsManager.getAPIs"></a>
175 <h4>APIsManager.getAPIs</h4> 196 <h4>APIsManager.getAPIs</h4>
176 <b>getAPIs</b>(<i>language</i>) 197 <b>getAPIs</b>(<i>language, projectType=""</i>)
177 <p> 198 <p>
178 Public method to get an apis object for autocompletion/calltips. 199 Public method to get an apis object for autocompletion/calltips.
179 </p><p> 200 </p><p>
180 This method creates and loads an APIs object dynamically upon request. 201 This method creates and loads an APIs object dynamically upon request.
181 This saves memory for languages, that might not be needed at the 202 This saves memory for languages, that might not be needed at the
182 moment. 203 moment.
183 </p><dl> 204 </p><dl>
184 <dt><i>language</i></dt> 205 <dt><i>language</i> (str)</dt>
185 <dd> 206 <dd>
186 the language of the requested api object (string) 207 language of the requested APIs object
187 </dd> 208 </dd><dt><i>projectType</i> (str)</dt>
188 </dl><dl> 209 <dd>
189 <dt>Returns:</dt> 210 type of the project
190 <dd> 211 </dd>
191 the apis object (APIs) 212 </dl><dl>
213 <dt>Returns:</dt>
214 <dd>
215 reference to the APIs object
216 </dd>
217 </dl><dl>
218 <dt>Return Type:</dt>
219 <dd>
220 APIs
192 </dd> 221 </dd>
193 </dl><a NAME="APIsManager.reloadAPIs" ID="APIsManager.reloadAPIs"></a> 222 </dl><a NAME="APIsManager.reloadAPIs" ID="APIsManager.reloadAPIs"></a>
194 <h4>APIsManager.reloadAPIs</h4> 223 <h4>APIsManager.reloadAPIs</h4>
195 <b>reloadAPIs</b>(<i></i>) 224 <b>reloadAPIs</b>(<i></i>)
196 <p> 225 <p>
300 <table> 329 <table>
301 <tr><td>None</td></tr> 330 <tr><td>None</td></tr>
302 </table> 331 </table>
303 <a NAME="DbAPIs.__init__" ID="DbAPIs.__init__"></a> 332 <a NAME="DbAPIs.__init__" ID="DbAPIs.__init__"></a>
304 <h4>DbAPIs (Constructor)</h4> 333 <h4>DbAPIs (Constructor)</h4>
305 <b>DbAPIs</b>(<i>language, parent=None</i>) 334 <b>DbAPIs</b>(<i>language, projectType="", parent=None</i>)
306 <p> 335 <p>
307 Constructor 336 Constructor
308 </p><dl> 337 </p><dl>
309 <dt><i>language</i></dt> 338 <dt><i>language</i> (str)</dt>
310 <dd> 339 <dd>
311 language of the APIs object (string) 340 language of the APIs object
312 </dd><dt><i>parent</i></dt> 341 </dd><dt><i>projectType</i> (str)</dt>
313 <dd> 342 <dd>
314 reference to the parent object (QObject) 343 type of the project
344 </dd><dt><i>parent</i> (QObject)</dt>
345 <dd>
346 reference to the parent object
315 </dd> 347 </dd>
316 </dl><a NAME="DbAPIs.__createApiDB" ID="DbAPIs.__createApiDB"></a> 348 </dl><a NAME="DbAPIs.__createApiDB" ID="DbAPIs.__createApiDB"></a>
317 <h4>DbAPIs.__createApiDB</h4> 349 <h4>DbAPIs.__createApiDB</h4>
318 <b>__createApiDB</b>(<i></i>) 350 <b>__createApiDB</b>(<i></i>)
319 <p> 351 <p>
620 <table> 652 <table>
621 <tr><td>None</td></tr> 653 <tr><td>None</td></tr>
622 </table> 654 </table>
623 <a NAME="DbAPIsWorker.__init__" ID="DbAPIsWorker.__init__"></a> 655 <a NAME="DbAPIsWorker.__init__" ID="DbAPIsWorker.__init__"></a>
624 <h4>DbAPIsWorker (Constructor)</h4> 656 <h4>DbAPIsWorker (Constructor)</h4>
625 <b>DbAPIsWorker</b>(<i>proxy, language, apiFiles, projectPath="", refresh=False</i>) 657 <b>DbAPIsWorker</b>(<i>proxy, language, apiFiles, projectPath="", refresh=False, projectType=""</i>)
626 <p> 658 <p>
627 Constructor 659 Constructor
628 </p><dl> 660 </p><dl>
629 <dt><i>proxy</i></dt> 661 <dt><i>proxy</i> (DbAPIs)</dt>
630 <dd> 662 <dd>
631 reference to the object that is proxied (DbAPIs) 663 reference to the object that is proxied
632 </dd><dt><i>language</i></dt> 664 </dd><dt><i>language</i> (str)</dt>
633 <dd> 665 <dd>
634 language of the APIs object (string) 666 language of the APIs object
635 </dd><dt><i>apiFiles</i></dt> 667 </dd><dt><i>apiFiles</i> (list of str)</dt>
636 <dd> 668 <dd>
637 list of API files to process (list of strings) 669 list of API files to process
638 </dd><dt><i>projectPath</i></dt> 670 </dd><dt><i>projectPath</i> (str)</dt>
639 <dd> 671 <dd>
640 path of the project. Only needed, if the APIs 672 path of the project. Only needed, if the APIs
641 are extracted out of the sources of a project. (string) 673 are extracted out of the sources of a project.
642 </dd><dt><i>refresh</i></dt> 674 </dd><dt><i>refresh</i> (bool)</dt>
643 <dd> 675 <dd>
644 flag indicating a refresh of the APIs of one file 676 flag indicating a refresh of the APIs of one file
645 (boolean) 677 </dd><dt><i>projectType</i> (str)</dt>
678 <dd>
679 type of the project
646 </dd> 680 </dd>
647 </dl><a NAME="DbAPIsWorker.__autoCompletionWordSeparators" ID="DbAPIsWorker.__autoCompletionWordSeparators"></a> 681 </dl><a NAME="DbAPIsWorker.__autoCompletionWordSeparators" ID="DbAPIsWorker.__autoCompletionWordSeparators"></a>
648 <h4>DbAPIsWorker.__autoCompletionWordSeparators</h4> 682 <h4>DbAPIsWorker.__autoCompletionWordSeparators</h4>
649 <b>__autoCompletionWordSeparators</b>(<i>language</i>) 683 <b>__autoCompletionWordSeparators</b>(<i>language</i>)
650 <p> 684 <p>

Mercurial Repository: Eric Assistant

eric ide

mercurial