Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.QScintilla.APIsManager.html

changeset 3673
e26d7d0c1088
child 4134
c04c703d1ca4
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
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.__defaultPreparedName">__defaultPreparedName</a></td>
91 <td>Private method returning the default name of a prepared API file.</td>
92 </tr><tr>
93 <td><a href="#APIs.__loadAPIs">__loadAPIs</a></td>
94 <td>Private method to load the APIs.</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.prepareAPIs">prepareAPIs</a></td>
106 <td>Public method to prepare the APIs if necessary.</td>
107 </tr><tr>
108 <td><a href="#APIs.reloadAPIs">reloadAPIs</a></td>
109 <td>Public method to reload the API information.</td>
110 </tr>
111 </table>
112 <h3>Static Methods</h3>
113 <table>
114 <tr><td>None</td></tr>
115 </table>
116 <a NAME="APIs.__init__" ID="APIs.__init__"></a>
117 <h4>APIs (Constructor)</h4>
118 <b>APIs</b>(<i>language, forPreparation=False, parent=None</i>)
119 <p>
120 Constructor
121 </p><dl>
122 <dt><i>language</i></dt>
123 <dd>
124 language of the APIs object (string)
125 </dd><dt><i>forPreparation</i></dt>
126 <dd>
127 flag indicating this object is just needed
128 for a preparation process (boolean)
129 </dd><dt><i>parent</i></dt>
130 <dd>
131 reference to the parent object (QObject)
132 </dd>
133 </dl><a NAME="APIs.__apiPreparationCancelled" ID="APIs.__apiPreparationCancelled"></a>
134 <h4>APIs.__apiPreparationCancelled</h4>
135 <b>__apiPreparationCancelled</b>(<i></i>)
136 <p>
137 Private method called, after the API preparation process has been
138 cancelled.
139 </p><a NAME="APIs.__apiPreparationFinished" ID="APIs.__apiPreparationFinished"></a>
140 <h4>APIs.__apiPreparationFinished</h4>
141 <b>__apiPreparationFinished</b>(<i></i>)
142 <p>
143 Private method called to save an API, after it has been prepared.
144 </p><a NAME="APIs.__apiPreparationStarted" ID="APIs.__apiPreparationStarted"></a>
145 <h4>APIs.__apiPreparationStarted</h4>
146 <b>__apiPreparationStarted</b>(<i></i>)
147 <p>
148 Private method called, when the API preparation process started.
149 </p><a NAME="APIs.__defaultPreparedName" ID="APIs.__defaultPreparedName"></a>
150 <h4>APIs.__defaultPreparedName</h4>
151 <b>__defaultPreparedName</b>(<i></i>)
152 <p>
153 Private method returning the default name of a prepared API file.
154 </p><dl>
155 <dt>Returns:</dt>
156 <dd>
157 complete filename for the Prepared APIs file (string)
158 </dd>
159 </dl><a NAME="APIs.__loadAPIs" ID="APIs.__loadAPIs"></a>
160 <h4>APIs.__loadAPIs</h4>
161 <b>__loadAPIs</b>(<i></i>)
162 <p>
163 Private method to load the APIs.
164 </p><a NAME="APIs.cancelPreparation" ID="APIs.cancelPreparation"></a>
165 <h4>APIs.cancelPreparation</h4>
166 <b>cancelPreparation</b>(<i></i>)
167 <p>
168 Public slot to cancel the APIs preparation.
169 </p><a NAME="APIs.getQsciAPIs" ID="APIs.getQsciAPIs"></a>
170 <h4>APIs.getQsciAPIs</h4>
171 <b>getQsciAPIs</b>(<i></i>)
172 <p>
173 Public method to get a reference to QsciAPIs object.
174 </p><dl>
175 <dt>Returns:</dt>
176 <dd>
177 reference to the QsciAPIs object (QsciAPIs)
178 </dd>
179 </dl><a NAME="APIs.installedAPIFiles" ID="APIs.installedAPIFiles"></a>
180 <h4>APIs.installedAPIFiles</h4>
181 <b>installedAPIFiles</b>(<i></i>)
182 <p>
183 Public method to get a list of installed API files.
184 </p><dl>
185 <dt>Returns:</dt>
186 <dd>
187 list of installed API files (list of strings)
188 </dd>
189 </dl><a NAME="APIs.prepareAPIs" ID="APIs.prepareAPIs"></a>
190 <h4>APIs.prepareAPIs</h4>
191 <b>prepareAPIs</b>(<i>ondemand=False, rawList=None</i>)
192 <p>
193 Public method to prepare the APIs if necessary.
194 </p><dl>
195 <dt><i>ondemand=</i></dt>
196 <dd>
197 flag indicating a requested preparation (boolean)
198 </dd><dt><i>rawList=</i></dt>
199 <dd>
200 list of raw API files (list of strings)
201 </dd>
202 </dl><a NAME="APIs.reloadAPIs" ID="APIs.reloadAPIs"></a>
203 <h4>APIs.reloadAPIs</h4>
204 <b>reloadAPIs</b>(<i></i>)
205 <p>
206 Public method to reload the API information.
207 </p>
208 <div align="right"><a href="#top">Up</a></div>
209 <hr /><hr />
210 <a NAME="APIsManager" ID="APIsManager"></a>
211 <h2>APIsManager</h2>
212 <p>
213 Class implementing the APIsManager class, which is the central store for
214 API information used by autocompletion and calltips.
215 </p>
216 <h3>Derived from</h3>
217 QObject
218 <h3>Class Attributes</h3>
219 <table>
220 <tr><td>None</td></tr>
221 </table>
222 <h3>Class Methods</h3>
223 <table>
224 <tr><td>None</td></tr>
225 </table>
226 <h3>Methods</h3>
227 <table>
228 <tr>
229 <td><a href="#APIsManager.__init__">APIsManager</a></td>
230 <td>Constructor</td>
231 </tr><tr>
232 <td><a href="#APIsManager.getAPIs">getAPIs</a></td>
233 <td>Public method to get an apis object for autocompletion/calltips.</td>
234 </tr><tr>
235 <td><a href="#APIsManager.reloadAPIs">reloadAPIs</a></td>
236 <td>Public slot to reload the api information.</td>
237 </tr>
238 </table>
239 <h3>Static Methods</h3>
240 <table>
241 <tr><td>None</td></tr>
242 </table>
243 <a NAME="APIsManager.__init__" ID="APIsManager.__init__"></a>
244 <h4>APIsManager (Constructor)</h4>
245 <b>APIsManager</b>(<i>parent=None</i>)
246 <p>
247 Constructor
248 </p><dl>
249 <dt><i>parent</i></dt>
250 <dd>
251 reference to the parent object (QObject)
252 </dd>
253 </dl><a NAME="APIsManager.getAPIs" ID="APIsManager.getAPIs"></a>
254 <h4>APIsManager.getAPIs</h4>
255 <b>getAPIs</b>(<i>language, forPreparation=False</i>)
256 <p>
257 Public method to get an apis object for autocompletion/calltips.
258 </p><p>
259 This method creates and loads an APIs object dynamically upon request.
260 This saves memory for languages, that might not be needed at the
261 moment.
262 </p><dl>
263 <dt><i>language</i></dt>
264 <dd>
265 the language of the requested api object (string)
266 </dd><dt><i>forPreparation</i></dt>
267 <dd>
268 flag indicating the requested api object is just
269 needed for a preparation process (boolean)
270 </dd>
271 </dl><dl>
272 <dt>Returns:</dt>
273 <dd>
274 the apis object (APIs)
275 </dd>
276 </dl><a NAME="APIsManager.reloadAPIs" ID="APIsManager.reloadAPIs"></a>
277 <h4>APIsManager.reloadAPIs</h4>
278 <b>reloadAPIs</b>(<i></i>)
279 <p>
280 Public slot to reload the api information.
281 </p>
282 <div align="right"><a href="#top">Up</a></div>
283 <hr />
284 </body></html>

Mercurial Repository: eric

eric ide

mercurial