|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.QScintilla.APIsManager</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.QScintilla.APIsManager</h1> |
|
12 <p> |
|
13 Module implementing the APIsManager. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#APIs">APIs</a></td> |
|
23 <td>Class implementing an API storage entity.</td> |
|
24 </tr><tr> |
|
25 <td><a href="#APIsManager">APIsManager</a></td> |
|
26 <td>Class implementing the APIsManager class, which is the central store for API information used by autocompletion and calltips.</td> |
|
27 </tr> |
|
28 </table> |
|
29 <h3>Functions</h3> |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <hr /><hr /> |
|
34 <a NAME="APIs" ID="APIs"></a> |
|
35 <h2>APIs</h2> |
|
36 <p> |
|
37 Class implementing an API storage entity. |
|
38 </p><h4>Signals</h4> |
|
39 <dl> |
|
40 <dt>apiPreparationCancelled()</dt> |
|
41 <dd> |
|
42 emitted after the API preparation has been cancelled |
|
43 </dd><dt>apiPreparationFinished()</dt> |
|
44 <dd> |
|
45 emitted after the API preparation has finished |
|
46 </dd><dt>apiPreparationStarted()</dt> |
|
47 <dd> |
|
48 emitted after the API preparation has started |
|
49 </dd> |
|
50 </dl> |
|
51 <h3>Derived from</h3> |
|
52 QObject |
|
53 <h3>Class Attributes</h3> |
|
54 <table> |
|
55 <tr><td>None</td></tr> |
|
56 </table> |
|
57 <h3>Methods</h3> |
|
58 <table> |
|
59 <tr> |
|
60 <td><a href="#APIs.__init__">APIs</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr><tr> |
|
63 <td><a href="#APIs.__apiPreparationCancelled">__apiPreparationCancelled</a></td> |
|
64 <td>Private method called, after the API preparation process has been cancelled.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#APIs.__apiPreparationFinished">__apiPreparationFinished</a></td> |
|
67 <td>Private method called to save an API, after it has been prepared.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#APIs.__apiPreparationStarted">__apiPreparationStarted</a></td> |
|
70 <td>Private method called, when the API preparation process started.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#APIs.__defaultPreparedName">__defaultPreparedName</a></td> |
|
73 <td>Private method returning the default name of a prepared API file.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#APIs.__loadAPIs">__loadAPIs</a></td> |
|
76 <td>Private method to load the APIs.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#APIs.cancelPreparation">cancelPreparation</a></td> |
|
79 <td>Public slot to cancel the APIs preparation.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#APIs.getQsciAPIs">getQsciAPIs</a></td> |
|
82 <td>Public method to get a reference to QsciAPIs object.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#APIs.installedAPIFiles">installedAPIFiles</a></td> |
|
85 <td>Public method to get a list of installed API files.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#APIs.prepareAPIs">prepareAPIs</a></td> |
|
88 <td>Public method to prepare the APIs if necessary.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#APIs.reloadAPIs">reloadAPIs</a></td> |
|
91 <td>Public method to reload the API information.</td> |
|
92 </tr> |
|
93 </table> |
|
94 <a NAME="APIs.__init__" ID="APIs.__init__"></a> |
|
95 <h4>APIs (Constructor)</h4> |
|
96 <b>APIs</b>(<i>language, forPreparation = False, parent = None</i>) |
|
97 <p> |
|
98 Constructor |
|
99 </p><dl> |
|
100 <dt><i>language</i></dt> |
|
101 <dd> |
|
102 language of the APIs object (string) |
|
103 </dd><dt><i>forPreparation</i></dt> |
|
104 <dd> |
|
105 flag indicating this object is just needed |
|
106 for a preparation process (boolean) |
|
107 </dd><dt><i>parent</i></dt> |
|
108 <dd> |
|
109 reference to the parent object (QObject) |
|
110 </dd> |
|
111 </dl><a NAME="APIs.__apiPreparationCancelled" ID="APIs.__apiPreparationCancelled"></a> |
|
112 <h4>APIs.__apiPreparationCancelled</h4> |
|
113 <b>__apiPreparationCancelled</b>(<i></i>) |
|
114 <p> |
|
115 Private method called, after the API preparation process has been cancelled. |
|
116 </p><a NAME="APIs.__apiPreparationFinished" ID="APIs.__apiPreparationFinished"></a> |
|
117 <h4>APIs.__apiPreparationFinished</h4> |
|
118 <b>__apiPreparationFinished</b>(<i></i>) |
|
119 <p> |
|
120 Private method called to save an API, after it has been prepared. |
|
121 </p><a NAME="APIs.__apiPreparationStarted" ID="APIs.__apiPreparationStarted"></a> |
|
122 <h4>APIs.__apiPreparationStarted</h4> |
|
123 <b>__apiPreparationStarted</b>(<i></i>) |
|
124 <p> |
|
125 Private method called, when the API preparation process started. |
|
126 </p><a NAME="APIs.__defaultPreparedName" ID="APIs.__defaultPreparedName"></a> |
|
127 <h4>APIs.__defaultPreparedName</h4> |
|
128 <b>__defaultPreparedName</b>(<i></i>) |
|
129 <p> |
|
130 Private method returning the default name of a prepared API file. |
|
131 </p><dl> |
|
132 <dt>Returns:</dt> |
|
133 <dd> |
|
134 complete filename for the Prepared APIs file (string) |
|
135 </dd> |
|
136 </dl><a NAME="APIs.__loadAPIs" ID="APIs.__loadAPIs"></a> |
|
137 <h4>APIs.__loadAPIs</h4> |
|
138 <b>__loadAPIs</b>(<i></i>) |
|
139 <p> |
|
140 Private method to load the APIs. |
|
141 </p><a NAME="APIs.cancelPreparation" ID="APIs.cancelPreparation"></a> |
|
142 <h4>APIs.cancelPreparation</h4> |
|
143 <b>cancelPreparation</b>(<i></i>) |
|
144 <p> |
|
145 Public slot to cancel the APIs preparation. |
|
146 </p><a NAME="APIs.getQsciAPIs" ID="APIs.getQsciAPIs"></a> |
|
147 <h4>APIs.getQsciAPIs</h4> |
|
148 <b>getQsciAPIs</b>(<i></i>) |
|
149 <p> |
|
150 Public method to get a reference to QsciAPIs object. |
|
151 </p><dl> |
|
152 <dt>Returns:</dt> |
|
153 <dd> |
|
154 reference to the QsciAPIs object (QsciAPIs) |
|
155 </dd> |
|
156 </dl><a NAME="APIs.installedAPIFiles" ID="APIs.installedAPIFiles"></a> |
|
157 <h4>APIs.installedAPIFiles</h4> |
|
158 <b>installedAPIFiles</b>(<i></i>) |
|
159 <p> |
|
160 Public method to get a list of installed API files. |
|
161 </p><dl> |
|
162 <dt>Returns:</dt> |
|
163 <dd> |
|
164 list of installed API files (list of strings) |
|
165 </dd> |
|
166 </dl><a NAME="APIs.prepareAPIs" ID="APIs.prepareAPIs"></a> |
|
167 <h4>APIs.prepareAPIs</h4> |
|
168 <b>prepareAPIs</b>(<i>ondemand = False, rawList = None</i>) |
|
169 <p> |
|
170 Public method to prepare the APIs if necessary. |
|
171 </p><dl> |
|
172 <dt><i>ondemand=</i></dt> |
|
173 <dd> |
|
174 flag indicating a requested preparation (boolean) |
|
175 </dd><dt><i>rawList=</i></dt> |
|
176 <dd> |
|
177 list of raw API files (list of strings) |
|
178 </dd> |
|
179 </dl><a NAME="APIs.reloadAPIs" ID="APIs.reloadAPIs"></a> |
|
180 <h4>APIs.reloadAPIs</h4> |
|
181 <b>reloadAPIs</b>(<i></i>) |
|
182 <p> |
|
183 Public method to reload the API information. |
|
184 </p> |
|
185 <div align="right"><a href="#top">Up</a></div> |
|
186 <hr /><hr /> |
|
187 <a NAME="APIsManager" ID="APIsManager"></a> |
|
188 <h2>APIsManager</h2> |
|
189 <p> |
|
190 Class implementing the APIsManager class, which is the central store for |
|
191 API information used by autocompletion and calltips. |
|
192 </p> |
|
193 <h3>Derived from</h3> |
|
194 QObject |
|
195 <h3>Class Attributes</h3> |
|
196 <table> |
|
197 <tr><td>None</td></tr> |
|
198 </table> |
|
199 <h3>Methods</h3> |
|
200 <table> |
|
201 <tr> |
|
202 <td><a href="#APIsManager.__init__">APIsManager</a></td> |
|
203 <td>Constructor</td> |
|
204 </tr><tr> |
|
205 <td><a href="#APIsManager.getAPIs">getAPIs</a></td> |
|
206 <td>Public method to get an apis object for autocompletion/calltips.</td> |
|
207 </tr><tr> |
|
208 <td><a href="#APIsManager.reloadAPIs">reloadAPIs</a></td> |
|
209 <td>Public slot to reload the api information.</td> |
|
210 </tr> |
|
211 </table> |
|
212 <a NAME="APIsManager.__init__" ID="APIsManager.__init__"></a> |
|
213 <h4>APIsManager (Constructor)</h4> |
|
214 <b>APIsManager</b>(<i>parent = None</i>) |
|
215 <p> |
|
216 Constructor |
|
217 </p><dl> |
|
218 <dt><i>parent</i></dt> |
|
219 <dd> |
|
220 reference to the parent object (QObject) |
|
221 </dd> |
|
222 </dl><a NAME="APIsManager.getAPIs" ID="APIsManager.getAPIs"></a> |
|
223 <h4>APIsManager.getAPIs</h4> |
|
224 <b>getAPIs</b>(<i>language, forPreparation = False</i>) |
|
225 <p> |
|
226 Public method to get an apis object for autocompletion/calltips. |
|
227 </p><p> |
|
228 This method creates and loads an APIs object dynamically upon request. |
|
229 This saves memory for languages, that might not be needed at the moment. |
|
230 </p><dl> |
|
231 <dt><i>language</i></dt> |
|
232 <dd> |
|
233 the language of the requested api object (string) |
|
234 </dd><dt><i>forPreparation</i></dt> |
|
235 <dd> |
|
236 flag indicating the requested api object is just needed |
|
237 for a preparation process (boolean) |
|
238 </dd> |
|
239 </dl><dl> |
|
240 <dt>Returns:</dt> |
|
241 <dd> |
|
242 the apis object (APIs) |
|
243 </dd> |
|
244 </dl><a NAME="APIsManager.reloadAPIs" ID="APIsManager.reloadAPIs"></a> |
|
245 <h4>APIsManager.reloadAPIs</h4> |
|
246 <b>reloadAPIs</b>(<i></i>) |
|
247 <p> |
|
248 Public slot to reload the api information. |
|
249 </p> |
|
250 <div align="right"><a href="#top">Up</a></div> |
|
251 <hr /> |
|
252 </body></html> |