Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.QScintilla.APIsManager.html

eric6/Documentation/Source/eric6.QScintilla.APIsManager.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7900
72b88fb20261
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.QScintilla.APIsManager</h1> 23 <h1>eric6.QScintilla.APIsManager</h1>
24
23 <p> 25 <p>
24 Module implementing the APIsManager. 26 Module implementing the APIsManager.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#APIs">APIs</a></td> 38 <td><a href="#APIs">APIs</a></td>
34 <td>Class implementing an API storage entity.</td> 39 <td>Class implementing an API storage entity.</td>
35 </tr><tr> 40 </tr>
41 <tr>
36 <td><a href="#APIsManager">APIsManager</a></td> 42 <td><a href="#APIsManager">APIsManager</a></td>
37 <td>Class implementing the APIsManager class, which is the central store for API information used by autocompletion and calltips.</td> 43 <td>Class implementing the APIsManager class, which is the central store for API information used by autocompletion and calltips.</td>
38 </tr> 44 </tr>
39 </table> 45 </table>
40 <h3>Functions</h3> 46 <h3>Functions</h3>
41 <table> 47
42 <tr><td>None</td></tr> 48 <table>
43 </table> 49 <tr><td>None</td></tr>
44 <hr /><hr /> 50 </table>
51 <hr />
52 <hr />
45 <a NAME="APIs" ID="APIs"></a> 53 <a NAME="APIs" ID="APIs"></a>
46 <h2>APIs</h2> 54 <h2>APIs</h2>
55
47 <p> 56 <p>
48 Class implementing an API storage entity. 57 Class implementing an API storage entity.
49 </p><h3>Signals</h3> 58 </p>
50 <dl> 59 <h3>Signals</h3>
60 <dl>
61
51 <dt>apiPreparationCancelled()</dt> 62 <dt>apiPreparationCancelled()</dt>
52 <dd> 63 <dd>
53 emitted after the API preparation has 64 emitted after the API preparation has
54 been cancelled 65 been cancelled
55 </dd><dt>apiPreparationFinished()</dt> 66 </dd>
67 <dt>apiPreparationFinished()</dt>
56 <dd> 68 <dd>
57 emitted after the API preparation has 69 emitted after the API preparation has
58 finished 70 finished
59 </dd><dt>apiPreparationStarted()</dt> 71 </dd>
72 <dt>apiPreparationStarted()</dt>
60 <dd> 73 <dd>
61 emitted after the API preparation has 74 emitted after the API preparation has
62 started 75 started
63 </dd> 76 </dd>
64 </dl> 77 </dl>
65 <h3>Derived from</h3> 78 <h3>Derived from</h3>
66 QObject 79 QObject
67 <h3>Class Attributes</h3> 80 <h3>Class Attributes</h3>
81
68 <table> 82 <table>
69 <tr><td>None</td></tr> 83 <tr><td>None</td></tr>
70 </table> 84 </table>
71 <h3>Class Methods</h3> 85 <h3>Class Methods</h3>
86
72 <table> 87 <table>
73 <tr><td>None</td></tr> 88 <tr><td>None</td></tr>
74 </table> 89 </table>
75 <h3>Methods</h3> 90 <h3>Methods</h3>
76 <table> 91
92 <table>
93
77 <tr> 94 <tr>
78 <td><a href="#APIs.__init__">APIs</a></td> 95 <td><a href="#APIs.__init__">APIs</a></td>
79 <td>Constructor</td> 96 <td>Constructor</td>
80 </tr><tr> 97 </tr>
98 <tr>
81 <td><a href="#APIs.__apiPreparationCancelled">__apiPreparationCancelled</a></td> 99 <td><a href="#APIs.__apiPreparationCancelled">__apiPreparationCancelled</a></td>
82 <td>Private method called, after the API preparation process has been cancelled.</td> 100 <td>Private method called, after the API preparation process has been cancelled.</td>
83 </tr><tr> 101 </tr>
102 <tr>
84 <td><a href="#APIs.__apiPreparationFinished">__apiPreparationFinished</a></td> 103 <td><a href="#APIs.__apiPreparationFinished">__apiPreparationFinished</a></td>
85 <td>Private method called to save an API, after it has been prepared.</td> 104 <td>Private method called to save an API, after it has been prepared.</td>
86 </tr><tr> 105 </tr>
106 <tr>
87 <td><a href="#APIs.__apiPreparationStarted">__apiPreparationStarted</a></td> 107 <td><a href="#APIs.__apiPreparationStarted">__apiPreparationStarted</a></td>
88 <td>Private method called, when the API preparation process started.</td> 108 <td>Private method called, when the API preparation process started.</td>
89 </tr><tr> 109 </tr>
110 <tr>
90 <td><a href="#APIs.__loadAPIs">__loadAPIs</a></td> 111 <td><a href="#APIs.__loadAPIs">__loadAPIs</a></td>
91 <td>Private method to load the APIs.</td> 112 <td>Private method to load the APIs.</td>
92 </tr><tr> 113 </tr>
114 <tr>
93 <td><a href="#APIs.__preparedName">__preparedName</a></td> 115 <td><a href="#APIs.__preparedName">__preparedName</a></td>
94 <td>Private method returning the default name of a prepared API file.</td> 116 <td>Private method returning the default name of a prepared API file.</td>
95 </tr><tr> 117 </tr>
118 <tr>
96 <td><a href="#APIs.cancelPreparation">cancelPreparation</a></td> 119 <td><a href="#APIs.cancelPreparation">cancelPreparation</a></td>
97 <td>Public slot to cancel the APIs preparation.</td> 120 <td>Public slot to cancel the APIs preparation.</td>
98 </tr><tr> 121 </tr>
122 <tr>
99 <td><a href="#APIs.getQsciAPIs">getQsciAPIs</a></td> 123 <td><a href="#APIs.getQsciAPIs">getQsciAPIs</a></td>
100 <td>Public method to get a reference to QsciAPIs object.</td> 124 <td>Public method to get a reference to QsciAPIs object.</td>
101 </tr><tr> 125 </tr>
126 <tr>
102 <td><a href="#APIs.installedAPIFiles">installedAPIFiles</a></td> 127 <td><a href="#APIs.installedAPIFiles">installedAPIFiles</a></td>
103 <td>Public method to get a list of installed API files.</td> 128 <td>Public method to get a list of installed API files.</td>
104 </tr><tr> 129 </tr>
130 <tr>
105 <td><a href="#APIs.isEmpty">isEmpty</a></td> 131 <td><a href="#APIs.isEmpty">isEmpty</a></td>
106 <td>Public method to check, if the object has API files configured.</td> 132 <td>Public method to check, if the object has API files configured.</td>
107 </tr><tr> 133 </tr>
134 <tr>
108 <td><a href="#APIs.prepareAPIs">prepareAPIs</a></td> 135 <td><a href="#APIs.prepareAPIs">prepareAPIs</a></td>
109 <td>Public method to prepare the APIs if necessary.</td> 136 <td>Public method to prepare the APIs if necessary.</td>
110 </tr><tr> 137 </tr>
138 <tr>
111 <td><a href="#APIs.reloadAPIs">reloadAPIs</a></td> 139 <td><a href="#APIs.reloadAPIs">reloadAPIs</a></td>
112 <td>Public method to reload the API information.</td> 140 <td>Public method to reload the API information.</td>
113 </tr> 141 </tr>
114 </table> 142 </table>
115 <h3>Static Methods</h3> 143 <h3>Static Methods</h3>
116 <table> 144
117 <tr><td>None</td></tr> 145 <table>
118 </table> 146 <tr><td>None</td></tr>
147 </table>
148
119 <a NAME="APIs.__init__" ID="APIs.__init__"></a> 149 <a NAME="APIs.__init__" ID="APIs.__init__"></a>
120 <h4>APIs (Constructor)</h4> 150 <h4>APIs (Constructor)</h4>
121 <b>APIs</b>(<i>language, projectType="", forPreparation=False, parent=None</i>) 151 <b>APIs</b>(<i>language, projectType="", forPreparation=False, parent=None</i>)
152
122 <p> 153 <p>
123 Constructor 154 Constructor
124 </p><dl> 155 </p>
156 <dl>
157
125 <dt><i>language</i> (str)</dt> 158 <dt><i>language</i> (str)</dt>
126 <dd> 159 <dd>
127 language of the APIs object 160 language of the APIs object
128 </dd><dt><i>projectType</i> (str)</dt> 161 </dd>
162 <dt><i>projectType</i> (str)</dt>
129 <dd> 163 <dd>
130 type of the project 164 type of the project
131 </dd><dt><i>forPreparation</i> (bool)</dt> 165 </dd>
166 <dt><i>forPreparation</i> (bool)</dt>
132 <dd> 167 <dd>
133 flag indicating this object is just needed 168 flag indicating this object is just needed
134 for a preparation process 169 for a preparation process
135 </dd><dt><i>parent</i> (QObject)</dt> 170 </dd>
171 <dt><i>parent</i> (QObject)</dt>
136 <dd> 172 <dd>
137 reference to the parent object 173 reference to the parent object
138 </dd> 174 </dd>
139 </dl><a NAME="APIs.__apiPreparationCancelled" ID="APIs.__apiPreparationCancelled"></a> 175 </dl>
176 <a NAME="APIs.__apiPreparationCancelled" ID="APIs.__apiPreparationCancelled"></a>
140 <h4>APIs.__apiPreparationCancelled</h4> 177 <h4>APIs.__apiPreparationCancelled</h4>
141 <b>__apiPreparationCancelled</b>(<i></i>) 178 <b>__apiPreparationCancelled</b>(<i></i>)
179
142 <p> 180 <p>
143 Private method called, after the API preparation process has been 181 Private method called, after the API preparation process has been
144 cancelled. 182 cancelled.
145 </p><a NAME="APIs.__apiPreparationFinished" ID="APIs.__apiPreparationFinished"></a> 183 </p>
184 <a NAME="APIs.__apiPreparationFinished" ID="APIs.__apiPreparationFinished"></a>
146 <h4>APIs.__apiPreparationFinished</h4> 185 <h4>APIs.__apiPreparationFinished</h4>
147 <b>__apiPreparationFinished</b>(<i></i>) 186 <b>__apiPreparationFinished</b>(<i></i>)
187
148 <p> 188 <p>
149 Private method called to save an API, after it has been prepared. 189 Private method called to save an API, after it has been prepared.
150 </p><a NAME="APIs.__apiPreparationStarted" ID="APIs.__apiPreparationStarted"></a> 190 </p>
191 <a NAME="APIs.__apiPreparationStarted" ID="APIs.__apiPreparationStarted"></a>
151 <h4>APIs.__apiPreparationStarted</h4> 192 <h4>APIs.__apiPreparationStarted</h4>
152 <b>__apiPreparationStarted</b>(<i></i>) 193 <b>__apiPreparationStarted</b>(<i></i>)
194
153 <p> 195 <p>
154 Private method called, when the API preparation process started. 196 Private method called, when the API preparation process started.
155 </p><a NAME="APIs.__loadAPIs" ID="APIs.__loadAPIs"></a> 197 </p>
198 <a NAME="APIs.__loadAPIs" ID="APIs.__loadAPIs"></a>
156 <h4>APIs.__loadAPIs</h4> 199 <h4>APIs.__loadAPIs</h4>
157 <b>__loadAPIs</b>(<i></i>) 200 <b>__loadAPIs</b>(<i></i>)
201
158 <p> 202 <p>
159 Private method to load the APIs. 203 Private method to load the APIs.
160 </p><a NAME="APIs.__preparedName" ID="APIs.__preparedName"></a> 204 </p>
205 <a NAME="APIs.__preparedName" ID="APIs.__preparedName"></a>
161 <h4>APIs.__preparedName</h4> 206 <h4>APIs.__preparedName</h4>
162 <b>__preparedName</b>(<i></i>) 207 <b>__preparedName</b>(<i></i>)
208
163 <p> 209 <p>
164 Private method returning the default name of a prepared API file. 210 Private method returning the default name of a prepared API file.
165 </p><dl> 211 </p>
212 <dl>
166 <dt>Returns:</dt> 213 <dt>Returns:</dt>
167 <dd> 214 <dd>
168 complete filename for the Prepared APIs file (string) 215 complete filename for the Prepared APIs file (string)
169 </dd> 216 </dd>
170 </dl><a NAME="APIs.cancelPreparation" ID="APIs.cancelPreparation"></a> 217 </dl>
218 <a NAME="APIs.cancelPreparation" ID="APIs.cancelPreparation"></a>
171 <h4>APIs.cancelPreparation</h4> 219 <h4>APIs.cancelPreparation</h4>
172 <b>cancelPreparation</b>(<i></i>) 220 <b>cancelPreparation</b>(<i></i>)
221
173 <p> 222 <p>
174 Public slot to cancel the APIs preparation. 223 Public slot to cancel the APIs preparation.
175 </p><a NAME="APIs.getQsciAPIs" ID="APIs.getQsciAPIs"></a> 224 </p>
225 <a NAME="APIs.getQsciAPIs" ID="APIs.getQsciAPIs"></a>
176 <h4>APIs.getQsciAPIs</h4> 226 <h4>APIs.getQsciAPIs</h4>
177 <b>getQsciAPIs</b>(<i></i>) 227 <b>getQsciAPIs</b>(<i></i>)
228
178 <p> 229 <p>
179 Public method to get a reference to QsciAPIs object. 230 Public method to get a reference to QsciAPIs object.
180 </p><dl> 231 </p>
232 <dl>
181 <dt>Returns:</dt> 233 <dt>Returns:</dt>
182 <dd> 234 <dd>
183 reference to the QsciAPIs object (QsciAPIs) 235 reference to the QsciAPIs object (QsciAPIs)
184 </dd> 236 </dd>
185 </dl><a NAME="APIs.installedAPIFiles" ID="APIs.installedAPIFiles"></a> 237 </dl>
238 <a NAME="APIs.installedAPIFiles" ID="APIs.installedAPIFiles"></a>
186 <h4>APIs.installedAPIFiles</h4> 239 <h4>APIs.installedAPIFiles</h4>
187 <b>installedAPIFiles</b>(<i></i>) 240 <b>installedAPIFiles</b>(<i></i>)
241
188 <p> 242 <p>
189 Public method to get a list of installed API files. 243 Public method to get a list of installed API files.
190 </p><dl> 244 </p>
245 <dl>
191 <dt>Returns:</dt> 246 <dt>Returns:</dt>
192 <dd> 247 <dd>
193 list of installed API files (list of strings) 248 list of installed API files (list of strings)
194 </dd> 249 </dd>
195 </dl><a NAME="APIs.isEmpty" ID="APIs.isEmpty"></a> 250 </dl>
251 <a NAME="APIs.isEmpty" ID="APIs.isEmpty"></a>
196 <h4>APIs.isEmpty</h4> 252 <h4>APIs.isEmpty</h4>
197 <b>isEmpty</b>(<i></i>) 253 <b>isEmpty</b>(<i></i>)
254
198 <p> 255 <p>
199 Public method to check, if the object has API files configured. 256 Public method to check, if the object has API files configured.
200 </p><dl> 257 </p>
258 <dl>
201 <dt>Returns:</dt> 259 <dt>Returns:</dt>
202 <dd> 260 <dd>
203 flag indicating no API files have been configured (boolean) 261 flag indicating no API files have been configured (boolean)
204 </dd> 262 </dd>
205 </dl><a NAME="APIs.prepareAPIs" ID="APIs.prepareAPIs"></a> 263 </dl>
264 <a NAME="APIs.prepareAPIs" ID="APIs.prepareAPIs"></a>
206 <h4>APIs.prepareAPIs</h4> 265 <h4>APIs.prepareAPIs</h4>
207 <b>prepareAPIs</b>(<i>ondemand=False, rawList=None</i>) 266 <b>prepareAPIs</b>(<i>ondemand=False, rawList=None</i>)
267
208 <p> 268 <p>
209 Public method to prepare the APIs if necessary. 269 Public method to prepare the APIs if necessary.
210 </p><dl> 270 </p>
271 <dl>
272
211 <dt><i>ondemand=</i></dt> 273 <dt><i>ondemand=</i></dt>
212 <dd> 274 <dd>
213 flag indicating a requested preparation (boolean) 275 flag indicating a requested preparation (boolean)
214 </dd><dt><i>rawList=</i></dt> 276 </dd>
277 <dt><i>rawList=</i></dt>
215 <dd> 278 <dd>
216 list of raw API files (list of strings) 279 list of raw API files (list of strings)
217 </dd> 280 </dd>
218 </dl><a NAME="APIs.reloadAPIs" ID="APIs.reloadAPIs"></a> 281 </dl>
282 <a NAME="APIs.reloadAPIs" ID="APIs.reloadAPIs"></a>
219 <h4>APIs.reloadAPIs</h4> 283 <h4>APIs.reloadAPIs</h4>
220 <b>reloadAPIs</b>(<i></i>) 284 <b>reloadAPIs</b>(<i></i>)
285
221 <p> 286 <p>
222 Public method to reload the API information. 287 Public method to reload the API information.
223 </p> 288 </p>
224 <div align="right"><a href="#top">Up</a></div> 289 <div align="right"><a href="#top">Up</a></div>
225 <hr /><hr /> 290 <hr />
291 <hr />
226 <a NAME="APIsManager" ID="APIsManager"></a> 292 <a NAME="APIsManager" ID="APIsManager"></a>
227 <h2>APIsManager</h2> 293 <h2>APIsManager</h2>
294
228 <p> 295 <p>
229 Class implementing the APIsManager class, which is the central store for 296 Class implementing the APIsManager class, which is the central store for
230 API information used by autocompletion and calltips. 297 API information used by autocompletion and calltips.
231 </p> 298 </p>
232 <h3>Derived from</h3> 299 <h3>Derived from</h3>
233 QObject 300 QObject
234 <h3>Class Attributes</h3> 301 <h3>Class Attributes</h3>
302
235 <table> 303 <table>
236 <tr><td>None</td></tr> 304 <tr><td>None</td></tr>
237 </table> 305 </table>
238 <h3>Class Methods</h3> 306 <h3>Class Methods</h3>
307
239 <table> 308 <table>
240 <tr><td>None</td></tr> 309 <tr><td>None</td></tr>
241 </table> 310 </table>
242 <h3>Methods</h3> 311 <h3>Methods</h3>
243 <table> 312
313 <table>
314
244 <tr> 315 <tr>
245 <td><a href="#APIsManager.__init__">APIsManager</a></td> 316 <td><a href="#APIsManager.__init__">APIsManager</a></td>
246 <td>Constructor</td> 317 <td>Constructor</td>
247 </tr><tr> 318 </tr>
319 <tr>
248 <td><a href="#APIsManager.getAPIs">getAPIs</a></td> 320 <td><a href="#APIsManager.getAPIs">getAPIs</a></td>
249 <td>Public method to get an APIs object for autocompletion/calltips.</td> 321 <td>Public method to get an APIs object for autocompletion/calltips.</td>
250 </tr><tr> 322 </tr>
323 <tr>
251 <td><a href="#APIsManager.reloadAPIs">reloadAPIs</a></td> 324 <td><a href="#APIsManager.reloadAPIs">reloadAPIs</a></td>
252 <td>Public slot to reload the api information.</td> 325 <td>Public slot to reload the api information.</td>
253 </tr> 326 </tr>
254 </table> 327 </table>
255 <h3>Static Methods</h3> 328 <h3>Static Methods</h3>
256 <table> 329
257 <tr><td>None</td></tr> 330 <table>
258 </table> 331 <tr><td>None</td></tr>
332 </table>
333
259 <a NAME="APIsManager.__init__" ID="APIsManager.__init__"></a> 334 <a NAME="APIsManager.__init__" ID="APIsManager.__init__"></a>
260 <h4>APIsManager (Constructor)</h4> 335 <h4>APIsManager (Constructor)</h4>
261 <b>APIsManager</b>(<i>parent=None</i>) 336 <b>APIsManager</b>(<i>parent=None</i>)
337
262 <p> 338 <p>
263 Constructor 339 Constructor
264 </p><dl> 340 </p>
341 <dl>
342
265 <dt><i>parent</i></dt> 343 <dt><i>parent</i></dt>
266 <dd> 344 <dd>
267 reference to the parent object (QObject) 345 reference to the parent object (QObject)
268 </dd> 346 </dd>
269 </dl><a NAME="APIsManager.getAPIs" ID="APIsManager.getAPIs"></a> 347 </dl>
348 <a NAME="APIsManager.getAPIs" ID="APIsManager.getAPIs"></a>
270 <h4>APIsManager.getAPIs</h4> 349 <h4>APIsManager.getAPIs</h4>
271 <b>getAPIs</b>(<i>language, projectType="", forPreparation=False</i>) 350 <b>getAPIs</b>(<i>language, projectType="", forPreparation=False</i>)
351
272 <p> 352 <p>
273 Public method to get an APIs object for autocompletion/calltips. 353 Public method to get an APIs object for autocompletion/calltips.
274 </p><p> 354 </p>
355 <p>
275 This method creates and loads an APIs object dynamically upon request. 356 This method creates and loads an APIs object dynamically upon request.
276 This saves memory for languages, that might not be needed at the 357 This saves memory for languages, that might not be needed at the
277 moment. 358 moment.
278 </p><dl> 359 </p>
360 <dl>
361
279 <dt><i>language</i> (str)</dt> 362 <dt><i>language</i> (str)</dt>
280 <dd> 363 <dd>
281 language of the requested APIs object 364 language of the requested APIs object
282 </dd><dt><i>projectType</i> (str)</dt> 365 </dd>
366 <dt><i>projectType</i> (str)</dt>
283 <dd> 367 <dd>
284 type of the project 368 type of the project
285 </dd><dt><i>forPreparation</i> (bool)</dt> 369 </dd>
370 <dt><i>forPreparation</i> (bool)</dt>
286 <dd> 371 <dd>
287 flag indicating the requested APIs object is just 372 flag indicating the requested APIs object is just
288 needed for a preparation process 373 needed for a preparation process
289 </dd> 374 </dd>
290 </dl><dl> 375 </dl>
376 <dl>
291 <dt>Returns:</dt> 377 <dt>Returns:</dt>
292 <dd> 378 <dd>
293 reference to the APIs object 379 reference to the APIs object
294 </dd> 380 </dd>
295 </dl><dl> 381 </dl>
382 <dl>
296 <dt>Return Type:</dt> 383 <dt>Return Type:</dt>
297 <dd> 384 <dd>
298 APIs 385 APIs
299 </dd> 386 </dd>
300 </dl><a NAME="APIsManager.reloadAPIs" ID="APIsManager.reloadAPIs"></a> 387 </dl>
388 <a NAME="APIsManager.reloadAPIs" ID="APIsManager.reloadAPIs"></a>
301 <h4>APIsManager.reloadAPIs</h4> 389 <h4>APIsManager.reloadAPIs</h4>
302 <b>reloadAPIs</b>(<i></i>) 390 <b>reloadAPIs</b>(<i></i>)
391
303 <p> 392 <p>
304 Public slot to reload the api information. 393 Public slot to reload the api information.
305 </p> 394 </p>
306 <div align="right"><a href="#top">Up</a></div> 395 <div align="right"><a href="#top">Up</a></div>
307 <hr /> 396 <hr />

Mercurial Repository: eric

eric ide

mercurial