Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.QScintilla.APIsManager.html

branch
APIs
changeset 5352
ddcf6fd8c316
parent 4134
c04c703d1ca4
equal deleted inserted replaced
5351:e87b1fec71d1 5352:ddcf6fd8c316
85 <td>Private method called to save an API, after it has been prepared.</td> 85 <td>Private method called to save an API, after it has been prepared.</td>
86 </tr><tr> 86 </tr><tr>
87 <td><a href="#APIs.__apiPreparationStarted">__apiPreparationStarted</a></td> 87 <td><a href="#APIs.__apiPreparationStarted">__apiPreparationStarted</a></td>
88 <td>Private method called, when the API preparation process started.</td> 88 <td>Private method called, when the API preparation process started.</td>
89 </tr><tr> 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> 90 <td><a href="#APIs.__loadAPIs">__loadAPIs</a></td>
94 <td>Private method to load the APIs.</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> 95 </tr><tr>
96 <td><a href="#APIs.cancelPreparation">cancelPreparation</a></td> 96 <td><a href="#APIs.cancelPreparation">cancelPreparation</a></td>
97 <td>Public slot to cancel the APIs preparation.</td> 97 <td>Public slot to cancel the APIs preparation.</td>
98 </tr><tr> 98 </tr><tr>
99 <td><a href="#APIs.getQsciAPIs">getQsciAPIs</a></td> 99 <td><a href="#APIs.getQsciAPIs">getQsciAPIs</a></td>
116 <table> 116 <table>
117 <tr><td>None</td></tr> 117 <tr><td>None</td></tr>
118 </table> 118 </table>
119 <a NAME="APIs.__init__" ID="APIs.__init__"></a> 119 <a NAME="APIs.__init__" ID="APIs.__init__"></a>
120 <h4>APIs (Constructor)</h4> 120 <h4>APIs (Constructor)</h4>
121 <b>APIs</b>(<i>language, forPreparation=False, parent=None</i>) 121 <b>APIs</b>(<i>language, projectType="", forPreparation=False, parent=None</i>)
122 <p> 122 <p>
123 Constructor 123 Constructor
124 </p><dl> 124 </p><dl>
125 <dt><i>language</i></dt> 125 <dt><i>language</i> (str)</dt>
126 <dd> 126 <dd>
127 language of the APIs object (string) 127 language of the APIs object
128 </dd><dt><i>forPreparation</i></dt> 128 </dd><dt><i>projectType</i> (str)</dt>
129 <dd>
130 type of the project
131 </dd><dt><i>forPreparation</i> (bool)</dt>
129 <dd> 132 <dd>
130 flag indicating this object is just needed 133 flag indicating this object is just needed
131 for a preparation process (boolean) 134 for a preparation process
132 </dd><dt><i>parent</i></dt> 135 </dd><dt><i>parent</i> (QObject)</dt>
133 <dd> 136 <dd>
134 reference to the parent object (QObject) 137 reference to the parent object
135 </dd> 138 </dd>
136 </dl><a NAME="APIs.__apiPreparationCancelled" ID="APIs.__apiPreparationCancelled"></a> 139 </dl><a NAME="APIs.__apiPreparationCancelled" ID="APIs.__apiPreparationCancelled"></a>
137 <h4>APIs.__apiPreparationCancelled</h4> 140 <h4>APIs.__apiPreparationCancelled</h4>
138 <b>__apiPreparationCancelled</b>(<i></i>) 141 <b>__apiPreparationCancelled</b>(<i></i>)
139 <p> 142 <p>
147 </p><a NAME="APIs.__apiPreparationStarted" ID="APIs.__apiPreparationStarted"></a> 150 </p><a NAME="APIs.__apiPreparationStarted" ID="APIs.__apiPreparationStarted"></a>
148 <h4>APIs.__apiPreparationStarted</h4> 151 <h4>APIs.__apiPreparationStarted</h4>
149 <b>__apiPreparationStarted</b>(<i></i>) 152 <b>__apiPreparationStarted</b>(<i></i>)
150 <p> 153 <p>
151 Private method called, when the API preparation process started. 154 Private method called, when the API preparation process started.
152 </p><a NAME="APIs.__defaultPreparedName" ID="APIs.__defaultPreparedName"></a> 155 </p><a NAME="APIs.__loadAPIs" ID="APIs.__loadAPIs"></a>
153 <h4>APIs.__defaultPreparedName</h4>
154 <b>__defaultPreparedName</b>(<i></i>)
155 <p>
156 Private method returning the default name of a prepared API file.
157 </p><dl>
158 <dt>Returns:</dt>
159 <dd>
160 complete filename for the Prepared APIs file (string)
161 </dd>
162 </dl><a NAME="APIs.__loadAPIs" ID="APIs.__loadAPIs"></a>
163 <h4>APIs.__loadAPIs</h4> 156 <h4>APIs.__loadAPIs</h4>
164 <b>__loadAPIs</b>(<i></i>) 157 <b>__loadAPIs</b>(<i></i>)
165 <p> 158 <p>
166 Private method to load the APIs. 159 Private method to load the APIs.
167 </p><a NAME="APIs.cancelPreparation" ID="APIs.cancelPreparation"></a> 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>
168 <h4>APIs.cancelPreparation</h4> 171 <h4>APIs.cancelPreparation</h4>
169 <b>cancelPreparation</b>(<i></i>) 172 <b>cancelPreparation</b>(<i></i>)
170 <p> 173 <p>
171 Public slot to cancel the APIs preparation. 174 Public slot to cancel the APIs preparation.
172 </p><a NAME="APIs.getQsciAPIs" ID="APIs.getQsciAPIs"></a> 175 </p><a NAME="APIs.getQsciAPIs" ID="APIs.getQsciAPIs"></a>
241 <tr> 244 <tr>
242 <td><a href="#APIsManager.__init__">APIsManager</a></td> 245 <td><a href="#APIsManager.__init__">APIsManager</a></td>
243 <td>Constructor</td> 246 <td>Constructor</td>
244 </tr><tr> 247 </tr><tr>
245 <td><a href="#APIsManager.getAPIs">getAPIs</a></td> 248 <td><a href="#APIsManager.getAPIs">getAPIs</a></td>
246 <td>Public method to get an apis object for autocompletion/calltips.</td> 249 <td>Public method to get an APIs object for autocompletion/calltips.</td>
247 </tr><tr> 250 </tr><tr>
248 <td><a href="#APIsManager.reloadAPIs">reloadAPIs</a></td> 251 <td><a href="#APIsManager.reloadAPIs">reloadAPIs</a></td>
249 <td>Public slot to reload the api information.</td> 252 <td>Public slot to reload the api information.</td>
250 </tr> 253 </tr>
251 </table> 254 </table>
263 <dd> 266 <dd>
264 reference to the parent object (QObject) 267 reference to the parent object (QObject)
265 </dd> 268 </dd>
266 </dl><a NAME="APIsManager.getAPIs" ID="APIsManager.getAPIs"></a> 269 </dl><a NAME="APIsManager.getAPIs" ID="APIsManager.getAPIs"></a>
267 <h4>APIsManager.getAPIs</h4> 270 <h4>APIsManager.getAPIs</h4>
268 <b>getAPIs</b>(<i>language, forPreparation=False</i>) 271 <b>getAPIs</b>(<i>language, projectType="", forPreparation=False</i>)
269 <p> 272 <p>
270 Public method to get an apis object for autocompletion/calltips. 273 Public method to get an APIs object for autocompletion/calltips.
271 </p><p> 274 </p><p>
272 This method creates and loads an APIs object dynamically upon request. 275 This method creates and loads an APIs object dynamically upon request.
273 This saves memory for languages, that might not be needed at the 276 This saves memory for languages, that might not be needed at the
274 moment. 277 moment.
275 </p><dl> 278 </p><dl>
276 <dt><i>language</i></dt> 279 <dt><i>language</i> (str)</dt>
277 <dd> 280 <dd>
278 the language of the requested api object (string) 281 language of the requested APIs object
279 </dd><dt><i>forPreparation</i></dt> 282 </dd><dt><i>projectType</i> (str)</dt>
280 <dd> 283 <dd>
281 flag indicating the requested api object is just 284 type of the project
282 needed for a preparation process (boolean) 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
283 </dd> 289 </dd>
284 </dl><dl> 290 </dl><dl>
285 <dt>Returns:</dt> 291 <dt>Returns:</dt>
286 <dd> 292 <dd>
287 the apis object (APIs) 293 reference to the APIs object
294 </dd>
295 </dl><dl>
296 <dt>Return Type:</dt>
297 <dd>
298 APIs
288 </dd> 299 </dd>
289 </dl><a NAME="APIsManager.reloadAPIs" ID="APIsManager.reloadAPIs"></a> 300 </dl><a NAME="APIsManager.reloadAPIs" ID="APIsManager.reloadAPIs"></a>
290 <h4>APIsManager.reloadAPIs</h4> 301 <h4>APIsManager.reloadAPIs</h4>
291 <b>reloadAPIs</b>(<i></i>) 302 <b>reloadAPIs</b>(<i></i>)
292 <p> 303 <p>

Mercurial Repository: eric

eric ide

mercurial