AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.APIsManager.html

changeset 54
89d28458ff40
parent 39
7b6ca9397ecc
child 66
f57b151c9761
equal deleted inserted replaced
53:cc91f2132635 54:89d28458ff40
161 <td>Private method to create an API database.</td> 161 <td>Private method to create an API database.</td>
162 </tr><tr> 162 </tr><tr>
163 <td><a href="#DbAPIs.__enoughCommas">__enoughCommas</a></td> 163 <td><a href="#DbAPIs.__enoughCommas">__enoughCommas</a></td>
164 <td>Private method to determine, if the given string contains enough commas.</td> 164 <td>Private method to determine, if the given string contains enough commas.</td>
165 </tr><tr> 165 </tr><tr>
166 <td><a href="#DbAPIs.__getProjectFormSources">__getProjectFormSources</a></td>
167 <td>Private method to get the source files for the project forms.</td>
168 </tr><tr>
166 <td><a href="#DbAPIs.__initAsLanguage">__initAsLanguage</a></td> 169 <td><a href="#DbAPIs.__initAsLanguage">__initAsLanguage</a></td>
167 <td>Private method to initialize as a language API object.</td> 170 <td>Private method to initialize as a language API object.</td>
168 </tr><tr> 171 </tr><tr>
169 <td><a href="#DbAPIs.__initAsProject">__initAsProject</a></td> 172 <td><a href="#DbAPIs.__initAsProject">__initAsProject</a></td>
170 <td>Private method to initialize as a project API object.</td> 173 <td>Private method to initialize as a project API object.</td>
181 <td><a href="#DbAPIs.__processQueue">__processQueue</a></td> 184 <td><a href="#DbAPIs.__processQueue">__processQueue</a></td>
182 <td>Private slot to process the queue of files to load.</td> 185 <td>Private slot to process the queue of files to load.</td>
183 </tr><tr> 186 </tr><tr>
184 <td><a href="#DbAPIs.__projectClosed">__projectClosed</a></td> 187 <td><a href="#DbAPIs.__projectClosed">__projectClosed</a></td>
185 <td>Private slot to perform actions after a project has been closed.</td> 188 <td>Private slot to perform actions after a project has been closed.</td>
189 </tr><tr>
190 <td><a href="#DbAPIs.__projectFormCompiled">__projectFormCompiled</a></td>
191 <td>Private slot to handle the projectFormCompiled signal.</td>
186 </tr><tr> 192 </tr><tr>
187 <td><a href="#DbAPIs.__projectOpened">__projectOpened</a></td> 193 <td><a href="#DbAPIs.__projectOpened">__projectOpened</a></td>
188 <td>Private slot to perform actions after a project has been opened.</td> 194 <td>Private slot to perform actions after a project has been opened.</td>
189 </tr><tr> 195 </tr><tr>
190 <td><a href="#DbAPIs._apiDbName">_apiDbName</a></td> 196 <td><a href="#DbAPIs._apiDbName">_apiDbName</a></td>
256 </dl><dl> 262 </dl><dl>
257 <dt>Returns:</dt> 263 <dt>Returns:</dt>
258 <dd> 264 <dd>
259 flag indicating, that there are enough commas (boolean) 265 flag indicating, that there are enough commas (boolean)
260 </dd> 266 </dd>
267 </dl><a NAME="DbAPIs.__getProjectFormSources" ID="DbAPIs.__getProjectFormSources"></a>
268 <h4>DbAPIs.__getProjectFormSources</h4>
269 <b>__getProjectFormSources</b>(<i>normalized=False</i>)
270 <p>
271 Private method to get the source files for the project forms.
272 </p><dl>
273 <dt><i>normalized=</i></dt>
274 <dd>
275 flag indicating a normalized filename is wanted (boolean)
276 </dd>
277 </dl><dl>
278 <dt>Returns:</dt>
279 <dd>
280 list of project form sources (list of strings)
281 </dd>
261 </dl><a NAME="DbAPIs.__initAsLanguage" ID="DbAPIs.__initAsLanguage"></a> 282 </dl><a NAME="DbAPIs.__initAsLanguage" ID="DbAPIs.__initAsLanguage"></a>
262 <h4>DbAPIs.__initAsLanguage</h4> 283 <h4>DbAPIs.__initAsLanguage</h4>
263 <b>__initAsLanguage</b>(<i></i>) 284 <b>__initAsLanguage</b>(<i></i>)
264 <p> 285 <p>
265 Private method to initialize as a language API object. 286 Private method to initialize as a language API object.
296 </p><a NAME="DbAPIs.__projectClosed" ID="DbAPIs.__projectClosed"></a> 317 </p><a NAME="DbAPIs.__projectClosed" ID="DbAPIs.__projectClosed"></a>
297 <h4>DbAPIs.__projectClosed</h4> 318 <h4>DbAPIs.__projectClosed</h4>
298 <b>__projectClosed</b>(<i></i>) 319 <b>__projectClosed</b>(<i></i>)
299 <p> 320 <p>
300 Private slot to perform actions after a project has been closed. 321 Private slot to perform actions after a project has been closed.
301 </p><a NAME="DbAPIs.__projectOpened" ID="DbAPIs.__projectOpened"></a> 322 </p><a NAME="DbAPIs.__projectFormCompiled" ID="DbAPIs.__projectFormCompiled"></a>
323 <h4>DbAPIs.__projectFormCompiled</h4>
324 <b>__projectFormCompiled</b>(<i>filename</i>)
325 <p>
326 Private slot to handle the projectFormCompiled signal.
327 </p><dl>
328 <dt><i>filename</i></dt>
329 <dd>
330 name of the form file that was compiled (string)
331 </dd>
332 </dl><a NAME="DbAPIs.__projectOpened" ID="DbAPIs.__projectOpened"></a>
302 <h4>DbAPIs.__projectOpened</h4> 333 <h4>DbAPIs.__projectOpened</h4>
303 <b>__projectOpened</b>(<i></i>) 334 <b>__projectOpened</b>(<i></i>)
304 <p> 335 <p>
305 Private slot to perform actions after a project has been opened. 336 Private slot to perform actions after a project has been opened.
306 </p><a NAME="DbAPIs._apiDbName" ID="DbAPIs._apiDbName"></a> 337 </p><a NAME="DbAPIs._apiDbName" ID="DbAPIs._apiDbName"></a>
466 <td>Constructor</td> 497 <td>Constructor</td>
467 </tr><tr> 498 </tr><tr>
468 <td><a href="#DbAPIsWorker.__autoCompletionWordSeparators">__autoCompletionWordSeparators</a></td> 499 <td><a href="#DbAPIsWorker.__autoCompletionWordSeparators">__autoCompletionWordSeparators</a></td>
469 <td>Private method to get the word separator characters for a language.</td> 500 <td>Private method to get the word separator characters for a language.</td>
470 </tr><tr> 501 </tr><tr>
502 <td><a href="#DbAPIsWorker.__classesAttributesApi">__classesAttributesApi</a></td>
503 <td>Private method to generate class api section for class attributes.</td>
504 </tr><tr>
471 <td><a href="#DbAPIsWorker.__deleteApiFile">__deleteApiFile</a></td> 505 <td><a href="#DbAPIsWorker.__deleteApiFile">__deleteApiFile</a></td>
472 <td>Private method to delete all references to an api file.</td> 506 <td>Private method to delete all references to an api file.</td>
473 </tr><tr> 507 </tr><tr>
474 <td><a href="#DbAPIsWorker.__loadApiFile">__loadApiFile</a></td> 508 <td><a href="#DbAPIsWorker.__loadApiFile">__loadApiFile</a></td>
475 <td>Private method to read a raw API file into the database.</td> 509 <td>Private method to read a raw API file into the database.</td>
526 </dd> 560 </dd>
527 </dl><dl> 561 </dl><dl>
528 <dt>Returns:</dt> 562 <dt>Returns:</dt>
529 <dd> 563 <dd>
530 word separator characters (list of strings) 564 word separator characters (list of strings)
565 </dd>
566 </dl><a NAME="DbAPIsWorker.__classesAttributesApi" ID="DbAPIsWorker.__classesAttributesApi"></a>
567 <h4>DbAPIsWorker.__classesAttributesApi</h4>
568 <b>__classesAttributesApi</b>(<i>module</i>)
569 <p>
570 Private method to generate class api section for class attributes.
571 </p><dl>
572 <dt><i>module</i></dt>
573 <dd>
574 module object to get the info from (Module)
575 </dd>
576 </dl><dl>
577 <dt>Returns:</dt>
578 <dd>
579 API information (list of strings)
531 </dd> 580 </dd>
532 </dl><a NAME="DbAPIsWorker.__deleteApiFile" ID="DbAPIsWorker.__deleteApiFile"></a> 581 </dl><a NAME="DbAPIsWorker.__deleteApiFile" ID="DbAPIsWorker.__deleteApiFile"></a>
533 <h4>DbAPIsWorker.__deleteApiFile</h4> 582 <h4>DbAPIsWorker.__deleteApiFile</h4>
534 <b>__deleteApiFile</b>(<i>apiFile</i>) 583 <b>__deleteApiFile</b>(<i>apiFile</i>)
535 <p> 584 <p>

eric ide

mercurial