Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric4.QScintilla.APIsManager.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.QScintilla.APIsManager</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.QScintilla.APIsManager</h1>
24 <p>
25 Module implementing the APIsManager.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#APIs">APIs</a></td>
35 <td>Class implementing an API storage entity.</td>
36 </tr><tr>
37 <td><a href="#APIsManager">APIsManager</a></td>
38 <td>Class implementing the APIsManager class, which is the central store for API information used by autocompletion and calltips.</td>
39 </tr>
40 </table>
41 <h3>Functions</h3>
42 <table>
43 <tr><td>None</td></tr>
44 </table>
45 <hr /><hr />
46 <a NAME="APIs" ID="APIs"></a>
47 <h2>APIs</h2>
48 <p>
49 Class implementing an API storage entity.
50 </p><h4>Signals</h4>
51 <dl>
52 <dt>apiPreparationCancelled()</dt>
53 <dd>
54 emitted after the API preparation has been cancelled
55 </dd><dt>apiPreparationFinished()</dt>
56 <dd>
57 emitted after the API preparation has finished
58 </dd><dt>apiPreparationStarted()</dt>
59 <dd>
60 emitted after the API preparation has started
61 </dd>
62 </dl>
63 <h3>Derived from</h3>
64 QObject
65 <h3>Class Attributes</h3>
66 <table>
67 <tr><td>None</td></tr>
68 </table>
69 <h3>Methods</h3>
70 <table>
71 <tr>
72 <td><a href="#APIs.__init__">APIs</a></td>
73 <td>Constructor</td>
74 </tr><tr>
75 <td><a href="#APIs.__apiPreparationCancelled">__apiPreparationCancelled</a></td>
76 <td>Private method called, after the API preparation process has been cancelled.</td>
77 </tr><tr>
78 <td><a href="#APIs.__apiPreparationFinished">__apiPreparationFinished</a></td>
79 <td>Private method called to save an API, after it has been prepared.</td>
80 </tr><tr>
81 <td><a href="#APIs.__apiPreparationStarted">__apiPreparationStarted</a></td>
82 <td>Private method called, when the API preparation process started.</td>
83 </tr><tr>
84 <td><a href="#APIs.__defaultPreparedName">__defaultPreparedName</a></td>
85 <td>Private method returning the default name of a prepared API file.</td>
86 </tr><tr>
87 <td><a href="#APIs.__loadAPIs">__loadAPIs</a></td>
88 <td>Private method to load the APIs.</td>
89 </tr><tr>
90 <td><a href="#APIs.cancelPreparation">cancelPreparation</a></td>
91 <td>Public slot to cancel the APIs preparation.</td>
92 </tr><tr>
93 <td><a href="#APIs.getQsciAPIs">getQsciAPIs</a></td>
94 <td>Public method to get a reference to QsciAPIs object.</td>
95 </tr><tr>
96 <td><a href="#APIs.installedAPIFiles">installedAPIFiles</a></td>
97 <td>Public method to get a list of installed API files.</td>
98 </tr><tr>
99 <td><a href="#APIs.prepareAPIs">prepareAPIs</a></td>
100 <td>Public method to prepare the APIs if necessary.</td>
101 </tr><tr>
102 <td><a href="#APIs.reloadAPIs">reloadAPIs</a></td>
103 <td>Public method to reload the API information.</td>
104 </tr>
105 </table>
106 <a NAME="APIs.__init__" ID="APIs.__init__"></a>
107 <h4>APIs (Constructor)</h4>
108 <b>APIs</b>(<i>language, forPreparation = False, parent = None</i>)
109 <p>
110 Constructor
111 </p><dl>
112 <dt><i>language</i></dt>
113 <dd>
114 language of the APIs object (string)
115 </dd><dt><i>forPreparation</i></dt>
116 <dd>
117 flag indicating this object is just needed
118 for a preparation process (boolean)
119 </dd><dt><i>parent</i></dt>
120 <dd>
121 reference to the parent object (QObject)
122 </dd>
123 </dl><a NAME="APIs.__apiPreparationCancelled" ID="APIs.__apiPreparationCancelled"></a>
124 <h4>APIs.__apiPreparationCancelled</h4>
125 <b>__apiPreparationCancelled</b>(<i></i>)
126 <p>
127 Private method called, after the API preparation process has been cancelled.
128 </p><a NAME="APIs.__apiPreparationFinished" ID="APIs.__apiPreparationFinished"></a>
129 <h4>APIs.__apiPreparationFinished</h4>
130 <b>__apiPreparationFinished</b>(<i></i>)
131 <p>
132 Private method called to save an API, after it has been prepared.
133 </p><a NAME="APIs.__apiPreparationStarted" ID="APIs.__apiPreparationStarted"></a>
134 <h4>APIs.__apiPreparationStarted</h4>
135 <b>__apiPreparationStarted</b>(<i></i>)
136 <p>
137 Private method called, when the API preparation process started.
138 </p><a NAME="APIs.__defaultPreparedName" ID="APIs.__defaultPreparedName"></a>
139 <h4>APIs.__defaultPreparedName</h4>
140 <b>__defaultPreparedName</b>(<i></i>)
141 <p>
142 Private method returning the default name of a prepared API file.
143 </p><dl>
144 <dt>Returns:</dt>
145 <dd>
146 complete filename for the Prepared APIs file (string)
147 </dd>
148 </dl><a NAME="APIs.__loadAPIs" ID="APIs.__loadAPIs"></a>
149 <h4>APIs.__loadAPIs</h4>
150 <b>__loadAPIs</b>(<i></i>)
151 <p>
152 Private method to load the APIs.
153 </p><a NAME="APIs.cancelPreparation" ID="APIs.cancelPreparation"></a>
154 <h4>APIs.cancelPreparation</h4>
155 <b>cancelPreparation</b>(<i></i>)
156 <p>
157 Public slot to cancel the APIs preparation.
158 </p><a NAME="APIs.getQsciAPIs" ID="APIs.getQsciAPIs"></a>
159 <h4>APIs.getQsciAPIs</h4>
160 <b>getQsciAPIs</b>(<i></i>)
161 <p>
162 Public method to get a reference to QsciAPIs object.
163 </p><dl>
164 <dt>Returns:</dt>
165 <dd>
166 reference to the QsciAPIs object (QsciAPIs)
167 </dd>
168 </dl><a NAME="APIs.installedAPIFiles" ID="APIs.installedAPIFiles"></a>
169 <h4>APIs.installedAPIFiles</h4>
170 <b>installedAPIFiles</b>(<i></i>)
171 <p>
172 Public method to get a list of installed API files.
173 </p><dl>
174 <dt>Returns:</dt>
175 <dd>
176 list of installed API files (list of strings)
177 </dd>
178 </dl><a NAME="APIs.prepareAPIs" ID="APIs.prepareAPIs"></a>
179 <h4>APIs.prepareAPIs</h4>
180 <b>prepareAPIs</b>(<i>ondemand = False, rawList = None</i>)
181 <p>
182 Public method to prepare the APIs if necessary.
183 </p><dl>
184 <dt><i>ondemand=</i></dt>
185 <dd>
186 flag indicating a requested preparation (boolean)
187 </dd><dt><i>rawList=</i></dt>
188 <dd>
189 list of raw API files (list of strings)
190 </dd>
191 </dl><a NAME="APIs.reloadAPIs" ID="APIs.reloadAPIs"></a>
192 <h4>APIs.reloadAPIs</h4>
193 <b>reloadAPIs</b>(<i></i>)
194 <p>
195 Public method to reload the API information.
196 </p>
197 <div align="right"><a href="#top">Up</a></div>
198 <hr /><hr />
199 <a NAME="APIsManager" ID="APIsManager"></a>
200 <h2>APIsManager</h2>
201 <p>
202 Class implementing the APIsManager class, which is the central store for
203 API information used by autocompletion and calltips.
204 </p>
205 <h3>Derived from</h3>
206 QObject
207 <h3>Class Attributes</h3>
208 <table>
209 <tr><td>None</td></tr>
210 </table>
211 <h3>Methods</h3>
212 <table>
213 <tr>
214 <td><a href="#APIsManager.__init__">APIsManager</a></td>
215 <td>Constructor</td>
216 </tr><tr>
217 <td><a href="#APIsManager.getAPIs">getAPIs</a></td>
218 <td>Public method to get an apis object for autocompletion/calltips.</td>
219 </tr><tr>
220 <td><a href="#APIsManager.reloadAPIs">reloadAPIs</a></td>
221 <td>Public slot to reload the api information.</td>
222 </tr>
223 </table>
224 <a NAME="APIsManager.__init__" ID="APIsManager.__init__"></a>
225 <h4>APIsManager (Constructor)</h4>
226 <b>APIsManager</b>(<i>parent = None</i>)
227 <p>
228 Constructor
229 </p><dl>
230 <dt><i>parent</i></dt>
231 <dd>
232 reference to the parent object (QObject)
233 </dd>
234 </dl><a NAME="APIsManager.getAPIs" ID="APIsManager.getAPIs"></a>
235 <h4>APIsManager.getAPIs</h4>
236 <b>getAPIs</b>(<i>language, forPreparation = False</i>)
237 <p>
238 Public method to get an apis object for autocompletion/calltips.
239 </p><p>
240 This method creates and loads an APIs object dynamically upon request.
241 This saves memory for languages, that might not be needed at the moment.
242 </p><dl>
243 <dt><i>language</i></dt>
244 <dd>
245 the language of the requested api object (string)
246 </dd><dt><i>forPreparation</i></dt>
247 <dd>
248 flag indicating the requested api object is just needed
249 for a preparation process (boolean)
250 </dd>
251 </dl><dl>
252 <dt>Returns:</dt>
253 <dd>
254 the apis object (APIs)
255 </dd>
256 </dl><a NAME="APIsManager.reloadAPIs" ID="APIsManager.reloadAPIs"></a>
257 <h4>APIsManager.reloadAPIs</h4>
258 <b>reloadAPIs</b>(<i></i>)
259 <p>
260 Public slot to reload the api information.
261 </p>
262 <div align="right"><a href="#top">Up</a></div>
263 <hr />
264 </body></html>

Mercurial Repository: eric

eric ide

mercurial