196 Private method returning the default name of a prepared API file. |
196 Private method returning the default name of a prepared API file. |
197 </p> |
197 </p> |
198 <dl> |
198 <dl> |
199 <dt>Return:</dt> |
199 <dt>Return:</dt> |
200 <dd> |
200 <dd> |
201 complete filename for the Prepared APIs file (string) |
201 complete filename for the Prepared APIs file |
|
202 </dd> |
|
203 </dl> |
|
204 <dl> |
|
205 <dt>Return Type:</dt> |
|
206 <dd> |
|
207 str |
202 </dd> |
208 </dd> |
203 </dl> |
209 </dl> |
204 <a NAME="APIs.cancelPreparation" ID="APIs.cancelPreparation"></a> |
210 <a NAME="APIs.cancelPreparation" ID="APIs.cancelPreparation"></a> |
205 <h4>APIs.cancelPreparation</h4> |
211 <h4>APIs.cancelPreparation</h4> |
206 <b>cancelPreparation</b>(<i></i>) |
212 <b>cancelPreparation</b>(<i></i>) |
216 Public method to get a reference to QsciAPIs object. |
222 Public method to get a reference to QsciAPIs object. |
217 </p> |
223 </p> |
218 <dl> |
224 <dl> |
219 <dt>Return:</dt> |
225 <dt>Return:</dt> |
220 <dd> |
226 <dd> |
221 reference to the QsciAPIs object (QsciAPIs) |
227 reference to the QsciAPIs object |
|
228 </dd> |
|
229 </dl> |
|
230 <dl> |
|
231 <dt>Return Type:</dt> |
|
232 <dd> |
|
233 QsciAPIs |
222 </dd> |
234 </dd> |
223 </dl> |
235 </dl> |
224 <a NAME="APIs.installedAPIFiles" ID="APIs.installedAPIFiles"></a> |
236 <a NAME="APIs.installedAPIFiles" ID="APIs.installedAPIFiles"></a> |
225 <h4>APIs.installedAPIFiles</h4> |
237 <h4>APIs.installedAPIFiles</h4> |
226 <b>installedAPIFiles</b>(<i></i>) |
238 <b>installedAPIFiles</b>(<i></i>) |
229 Public method to get a list of installed API files. |
241 Public method to get a list of installed API files. |
230 </p> |
242 </p> |
231 <dl> |
243 <dl> |
232 <dt>Return:</dt> |
244 <dt>Return:</dt> |
233 <dd> |
245 <dd> |
234 list of installed API files (list of strings) |
246 list of installed API files |
|
247 </dd> |
|
248 </dl> |
|
249 <dl> |
|
250 <dt>Return Type:</dt> |
|
251 <dd> |
|
252 list of str |
235 </dd> |
253 </dd> |
236 </dl> |
254 </dl> |
237 <a NAME="APIs.isEmpty" ID="APIs.isEmpty"></a> |
255 <a NAME="APIs.isEmpty" ID="APIs.isEmpty"></a> |
238 <h4>APIs.isEmpty</h4> |
256 <h4>APIs.isEmpty</h4> |
239 <b>isEmpty</b>(<i></i>) |
257 <b>isEmpty</b>(<i></i>) |
242 Public method to check, if the object has API files configured. |
260 Public method to check, if the object has API files configured. |
243 </p> |
261 </p> |
244 <dl> |
262 <dl> |
245 <dt>Return:</dt> |
263 <dt>Return:</dt> |
246 <dd> |
264 <dd> |
247 flag indicating no API files have been configured (boolean) |
265 flag indicating no API files have been configured |
|
266 </dd> |
|
267 </dl> |
|
268 <dl> |
|
269 <dt>Return Type:</dt> |
|
270 <dd> |
|
271 bool |
248 </dd> |
272 </dd> |
249 </dl> |
273 </dl> |
250 <a NAME="APIs.prepareAPIs" ID="APIs.prepareAPIs"></a> |
274 <a NAME="APIs.prepareAPIs" ID="APIs.prepareAPIs"></a> |
251 <h4>APIs.prepareAPIs</h4> |
275 <h4>APIs.prepareAPIs</h4> |
252 <b>prepareAPIs</b>(<i>ondemand=False, rawList=None</i>) |
276 <b>prepareAPIs</b>(<i>ondemand=False, rawList=None</i>) |
254 <p> |
278 <p> |
255 Public method to prepare the APIs if necessary. |
279 Public method to prepare the APIs if necessary. |
256 </p> |
280 </p> |
257 <dl> |
281 <dl> |
258 |
282 |
259 <dt><i>ondemand</i></dt> |
283 <dt><i>ondemand</i> (bool)</dt> |
260 <dd> |
284 <dd> |
261 flag indicating a requested preparation (boolean) |
285 flag indicating a requested preparation |
262 </dd> |
286 </dd> |
263 <dt><i>rawList</i></dt> |
287 <dt><i>rawList</i> (list of str)</dt> |
264 <dd> |
288 <dd> |
265 list of raw API files (list of strings) |
289 list of raw API files |
266 </dd> |
290 </dd> |
267 </dl> |
291 </dl> |
268 <a NAME="APIs.reloadAPIs" ID="APIs.reloadAPIs"></a> |
292 <a NAME="APIs.reloadAPIs" ID="APIs.reloadAPIs"></a> |
269 <h4>APIs.reloadAPIs</h4> |
293 <h4>APIs.reloadAPIs</h4> |
270 <b>reloadAPIs</b>(<i></i>) |
294 <b>reloadAPIs</b>(<i></i>) |
324 <p> |
348 <p> |
325 Constructor |
349 Constructor |
326 </p> |
350 </p> |
327 <dl> |
351 <dl> |
328 |
352 |
329 <dt><i>parent</i></dt> |
353 <dt><i>parent</i> (QObject)</dt> |
330 <dd> |
354 <dd> |
331 reference to the parent object (QObject) |
355 reference to the parent object |
332 </dd> |
356 </dd> |
333 </dl> |
357 </dl> |
334 <a NAME="APIsManager.getAPIs" ID="APIsManager.getAPIs"></a> |
358 <a NAME="APIsManager.getAPIs" ID="APIsManager.getAPIs"></a> |
335 <h4>APIsManager.getAPIs</h4> |
359 <h4>APIsManager.getAPIs</h4> |
336 <b>getAPIs</b>(<i>language, projectType="", forPreparation=False</i>) |
360 <b>getAPIs</b>(<i>language, projectType="", forPreparation=False</i>) |