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