Mercurial Repositories > eric / file comparison

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

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

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.QScintilla.APIsManager</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.QScintilla.APIsManager</h1>
23 <p>
24 Module implementing the APIsManager.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#APIs">APIs</a></td>
34 <td>Class implementing an API storage entity.</td>
35 </tr><tr>
36 <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>
38 </tr>
39 </table>
40 <h3>Functions</h3>
41 <table>
42 <tr><td>None</td></tr>
43 </table>
44 <hr /><hr />
45 <a NAME="APIs" ID="APIs"></a>
46 <h2>APIs</h2>
47 <p>
48 Class implementing an API storage entity.
49 </p><h3>Signals</h3>
50 <dl>
51 <dt>apiPreparationCancelled()</dt>
52 <dd>
53 emitted after the API preparation has
54 been cancelled
55 </dd><dt>apiPreparationFinished()</dt>
56 <dd>
57 emitted after the API preparation has
58 finished
59 </dd><dt>apiPreparationStarted()</dt>
60 <dd>
61 emitted after the API preparation has
62 started
63 </dd>
64 </dl>
65 <h3>Derived from</h3>
66 QObject
67 <h3>Class Attributes</h3>
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71 <h3>Class Methods</h3>
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75 <h3>Methods</h3>
76 <table>
77 <tr>
78 <td><a href="#APIs.__init__">APIs</a></td>
79 <td>Constructor</td>
80 </tr><tr>
81 <td><a href="#APIs.__apiPreparationCancelled">__apiPreparationCancelled</a></td>
82 <td>Private method called, after the API preparation process has been cancelled.</td>
83 </tr><tr>
84 <td><a href="#APIs.__apiPreparationFinished">__apiPreparationFinished</a></td>
85 <td>Private method called to save an API, after it has been prepared.</td>
86 </tr><tr>
87 <td><a href="#APIs.__apiPreparationStarted">__apiPreparationStarted</a></td>
88 <td>Private method called, when the API preparation process started.</td>
89 </tr><tr>
90 <td><a href="#APIs.__loadAPIs">__loadAPIs</a></td>
91 <td>Private method to load the APIs.</td>
92 </tr><tr>
93 <td><a href="#APIs.__preparedName">__preparedName</a></td>
94 <td>Private method returning the default name of a prepared API file.</td>
95 </tr><tr>
96 <td><a href="#APIs.cancelPreparation">cancelPreparation</a></td>
97 <td>Public slot to cancel the APIs preparation.</td>
98 </tr><tr>
99 <td><a href="#APIs.getQsciAPIs">getQsciAPIs</a></td>
100 <td>Public method to get a reference to QsciAPIs object.</td>
101 </tr><tr>
102 <td><a href="#APIs.installedAPIFiles">installedAPIFiles</a></td>
103 <td>Public method to get a list of installed API files.</td>
104 </tr><tr>
105 <td><a href="#APIs.isEmpty">isEmpty</a></td>
106 <td>Public method to check, if the object has API files configured.</td>
107 </tr><tr>
108 <td><a href="#APIs.prepareAPIs">prepareAPIs</a></td>
109 <td>Public method to prepare the APIs if necessary.</td>
110 </tr><tr>
111 <td><a href="#APIs.reloadAPIs">reloadAPIs</a></td>
112 <td>Public method to reload the API information.</td>
113 </tr>
114 </table>
115 <h3>Static Methods</h3>
116 <table>
117 <tr><td>None</td></tr>
118 </table>
119 <a NAME="APIs.__init__" ID="APIs.__init__"></a>
120 <h4>APIs (Constructor)</h4>
121 <b>APIs</b>(<i>language, projectType="", forPreparation=False, parent=None</i>)
122 <p>
123 Constructor
124 </p><dl>
125 <dt><i>language</i> (str)</dt>
126 <dd>
127 language of the APIs object
128 </dd><dt><i>projectType</i> (str)</dt>
129 <dd>
130 type of the project
131 </dd><dt><i>forPreparation</i> (bool)</dt>
132 <dd>
133 flag indicating this object is just needed
134 for a preparation process
135 </dd><dt><i>parent</i> (QObject)</dt>
136 <dd>
137 reference to the parent object
138 </dd>
139 </dl><a NAME="APIs.__apiPreparationCancelled" ID="APIs.__apiPreparationCancelled"></a>
140 <h4>APIs.__apiPreparationCancelled</h4>
141 <b>__apiPreparationCancelled</b>(<i></i>)
142 <p>
143 Private method called, after the API preparation process has been
144 cancelled.
145 </p><a NAME="APIs.__apiPreparationFinished" ID="APIs.__apiPreparationFinished"></a>
146 <h4>APIs.__apiPreparationFinished</h4>
147 <b>__apiPreparationFinished</b>(<i></i>)
148 <p>
149 Private method called to save an API, after it has been prepared.
150 </p><a NAME="APIs.__apiPreparationStarted" ID="APIs.__apiPreparationStarted"></a>
151 <h4>APIs.__apiPreparationStarted</h4>
152 <b>__apiPreparationStarted</b>(<i></i>)
153 <p>
154 Private method called, when the API preparation process started.
155 </p><a NAME="APIs.__loadAPIs" ID="APIs.__loadAPIs"></a>
156 <h4>APIs.__loadAPIs</h4>
157 <b>__loadAPIs</b>(<i></i>)
158 <p>
159 Private method to load the APIs.
160 </p><a NAME="APIs.__preparedName" ID="APIs.__preparedName"></a>
161 <h4>APIs.__preparedName</h4>
162 <b>__preparedName</b>(<i></i>)
163 <p>
164 Private method returning the default name of a prepared API file.
165 </p><dl>
166 <dt>Returns:</dt>
167 <dd>
168 complete filename for the Prepared APIs file (string)
169 </dd>
170 </dl><a NAME="APIs.cancelPreparation" ID="APIs.cancelPreparation"></a>
171 <h4>APIs.cancelPreparation</h4>
172 <b>cancelPreparation</b>(<i></i>)
173 <p>
174 Public slot to cancel the APIs preparation.
175 </p><a NAME="APIs.getQsciAPIs" ID="APIs.getQsciAPIs"></a>
176 <h4>APIs.getQsciAPIs</h4>
177 <b>getQsciAPIs</b>(<i></i>)
178 <p>
179 Public method to get a reference to QsciAPIs object.
180 </p><dl>
181 <dt>Returns:</dt>
182 <dd>
183 reference to the QsciAPIs object (QsciAPIs)
184 </dd>
185 </dl><a NAME="APIs.installedAPIFiles" ID="APIs.installedAPIFiles"></a>
186 <h4>APIs.installedAPIFiles</h4>
187 <b>installedAPIFiles</b>(<i></i>)
188 <p>
189 Public method to get a list of installed API files.
190 </p><dl>
191 <dt>Returns:</dt>
192 <dd>
193 list of installed API files (list of strings)
194 </dd>
195 </dl><a NAME="APIs.isEmpty" ID="APIs.isEmpty"></a>
196 <h4>APIs.isEmpty</h4>
197 <b>isEmpty</b>(<i></i>)
198 <p>
199 Public method to check, if the object has API files configured.
200 </p><dl>
201 <dt>Returns:</dt>
202 <dd>
203 flag indicating no API files have been configured (boolean)
204 </dd>
205 </dl><a NAME="APIs.prepareAPIs" ID="APIs.prepareAPIs"></a>
206 <h4>APIs.prepareAPIs</h4>
207 <b>prepareAPIs</b>(<i>ondemand=False, rawList=None</i>)
208 <p>
209 Public method to prepare the APIs if necessary.
210 </p><dl>
211 <dt><i>ondemand=</i></dt>
212 <dd>
213 flag indicating a requested preparation (boolean)
214 </dd><dt><i>rawList=</i></dt>
215 <dd>
216 list of raw API files (list of strings)
217 </dd>
218 </dl><a NAME="APIs.reloadAPIs" ID="APIs.reloadAPIs"></a>
219 <h4>APIs.reloadAPIs</h4>
220 <b>reloadAPIs</b>(<i></i>)
221 <p>
222 Public method to reload the API information.
223 </p>
224 <div align="right"><a href="#top">Up</a></div>
225 <hr /><hr />
226 <a NAME="APIsManager" ID="APIsManager"></a>
227 <h2>APIsManager</h2>
228 <p>
229 Class implementing the APIsManager class, which is the central store for
230 API information used by autocompletion and calltips.
231 </p>
232 <h3>Derived from</h3>
233 QObject
234 <h3>Class Attributes</h3>
235 <table>
236 <tr><td>None</td></tr>
237 </table>
238 <h3>Class Methods</h3>
239 <table>
240 <tr><td>None</td></tr>
241 </table>
242 <h3>Methods</h3>
243 <table>
244 <tr>
245 <td><a href="#APIsManager.__init__">APIsManager</a></td>
246 <td>Constructor</td>
247 </tr><tr>
248 <td><a href="#APIsManager.getAPIs">getAPIs</a></td>
249 <td>Public method to get an APIs object for autocompletion/calltips.</td>
250 </tr><tr>
251 <td><a href="#APIsManager.reloadAPIs">reloadAPIs</a></td>
252 <td>Public slot to reload the api information.</td>
253 </tr>
254 </table>
255 <h3>Static Methods</h3>
256 <table>
257 <tr><td>None</td></tr>
258 </table>
259 <a NAME="APIsManager.__init__" ID="APIsManager.__init__"></a>
260 <h4>APIsManager (Constructor)</h4>
261 <b>APIsManager</b>(<i>parent=None</i>)
262 <p>
263 Constructor
264 </p><dl>
265 <dt><i>parent</i></dt>
266 <dd>
267 reference to the parent object (QObject)
268 </dd>
269 </dl><a NAME="APIsManager.getAPIs" ID="APIsManager.getAPIs"></a>
270 <h4>APIsManager.getAPIs</h4>
271 <b>getAPIs</b>(<i>language, projectType="", forPreparation=False</i>)
272 <p>
273 Public method to get an APIs object for autocompletion/calltips.
274 </p><p>
275 This method creates and loads an APIs object dynamically upon request.
276 This saves memory for languages, that might not be needed at the
277 moment.
278 </p><dl>
279 <dt><i>language</i> (str)</dt>
280 <dd>
281 language of the requested APIs object
282 </dd><dt><i>projectType</i> (str)</dt>
283 <dd>
284 type of the project
285 </dd><dt><i>forPreparation</i> (bool)</dt>
286 <dd>
287 flag indicating the requested APIs object is just
288 needed for a preparation process
289 </dd>
290 </dl><dl>
291 <dt>Returns:</dt>
292 <dd>
293 reference to the APIs object
294 </dd>
295 </dl><dl>
296 <dt>Return Type:</dt>
297 <dd>
298 APIs
299 </dd>
300 </dl><a NAME="APIsManager.reloadAPIs" ID="APIsManager.reloadAPIs"></a>
301 <h4>APIsManager.reloadAPIs</h4>
302 <b>reloadAPIs</b>(<i></i>)
303 <p>
304 Public slot to reload the api information.
305 </p>
306 <div align="right"><a href="#top">Up</a></div>
307 <hr />
308 </body></html>

Mercurial Repository: eric

eric ide

mercurial