Mercurial Repositories > Eric Assistant / file comparison

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

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

changeset 163
842fce9b31ce
parent 143
468560828f55
child 177
25cb41783971
equal deleted inserted replaced
162:db992524e3f5 163:842fce9b31ce
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>Plugin_Assistant_Eric.AssistantEric.APIsManager</h1> 23 <h1>Plugin_Assistant_Eric.AssistantEric.APIsManager</h1>
24
23 <p> 25 <p>
24 Module implementing the APIsManager. 26 Module implementing the APIsManager.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>ApisNameProject</td></tr><tr><td>WorkerStatusAborted</td></tr><tr><td>WorkerStatusFile</td></tr><tr><td>WorkerStatusFinished</td></tr><tr><td>WorkerStatusStarted</td></tr> 31 <tr><td>ApisNameProject</td></tr><tr><td>WorkerStatusAborted</td></tr><tr><td>WorkerStatusFile</td></tr><tr><td>WorkerStatusFinished</td></tr><tr><td>WorkerStatusStarted</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#APIsManager">APIsManager</a></td> 38 <td><a href="#APIsManager">APIsManager</a></td>
34 <td>Class implementing the APIsManager class, which is the central store for API information used by autocompletion and calltips.</td> 39 <td>Class implementing the APIsManager class, which is the central store for API information used by autocompletion and calltips.</td>
35 </tr><tr> 40 </tr>
41 <tr>
36 <td><a href="#DbAPIs">DbAPIs</a></td> 42 <td><a href="#DbAPIs">DbAPIs</a></td>
37 <td>Class implementing an API storage entity.</td> 43 <td>Class implementing an API storage entity.</td>
38 </tr><tr> 44 </tr>
45 <tr>
39 <td><a href="#DbAPIsWorker">DbAPIsWorker</a></td> 46 <td><a href="#DbAPIsWorker">DbAPIsWorker</a></td>
40 <td>Class implementing a worker thread to prepare the API database.</td> 47 <td>Class implementing a worker thread to prepare the API database.</td>
41 </tr> 48 </tr>
42 </table> 49 </table>
43 <h3>Functions</h3> 50 <h3>Functions</h3>
51
44 <table> 52 <table>
45 <tr><td>None</td></tr> 53 <tr><td>None</td></tr>
46 </table> 54 </table>
47 <hr /><hr /> 55 <hr />
56 <hr />
48 <a NAME="APIsManager" ID="APIsManager"></a> 57 <a NAME="APIsManager" ID="APIsManager"></a>
49 <h2>APIsManager</h2> 58 <h2>APIsManager</h2>
59
50 <p> 60 <p>
51 Class implementing the APIsManager class, which is the central store for 61 Class implementing the APIsManager class, which is the central store for
52 API information used by autocompletion and calltips. 62 API information used by autocompletion and calltips.
53 </p> 63 </p>
54 <h3>Derived from</h3> 64 <h3>Derived from</h3>
55 QObject 65 QObject
56 <h3>Class Attributes</h3> 66 <h3>Class Attributes</h3>
67
57 <table> 68 <table>
58 <tr><td>None</td></tr> 69 <tr><td>None</td></tr>
59 </table> 70 </table>
60 <h3>Class Methods</h3> 71 <h3>Class Methods</h3>
72
61 <table> 73 <table>
62 <tr><td>None</td></tr> 74 <tr><td>None</td></tr>
63 </table> 75 </table>
64 <h3>Methods</h3> 76 <h3>Methods</h3>
65 <table> 77
78 <table>
79
66 <tr> 80 <tr>
67 <td><a href="#APIsManager.__init__">APIsManager</a></td> 81 <td><a href="#APIsManager.__init__">APIsManager</a></td>
68 <td>Constructor</td> 82 <td>Constructor</td>
69 </tr><tr> 83 </tr>
84 <tr>
70 <td><a href="#APIsManager.__apiPreparationStatus">__apiPreparationStatus</a></td> 85 <td><a href="#APIsManager.__apiPreparationStatus">__apiPreparationStatus</a></td>
71 <td>Private slot handling the preparation status signal of an API object.</td> 86 <td>Private slot handling the preparation status signal of an API object.</td>
72 </tr><tr> 87 </tr>
88 <tr>
73 <td><a href="#APIsManager.__showMessage">__showMessage</a></td> 89 <td><a href="#APIsManager.__showMessage">__showMessage</a></td>
74 <td>Private message to show a message in the main windows status bar.</td> 90 <td>Private message to show a message in the main windows status bar.</td>
75 </tr><tr> 91 </tr>
92 <tr>
76 <td><a href="#APIsManager.__supportedApiLanguages">__supportedApiLanguages</a></td> 93 <td><a href="#APIsManager.__supportedApiLanguages">__supportedApiLanguages</a></td>
77 <td>Private method to build a list of supported API languages.</td> 94 <td>Private method to build a list of supported API languages.</td>
78 </tr><tr> 95 </tr>
96 <tr>
79 <td><a href="#APIsManager.deactivate">deactivate</a></td> 97 <td><a href="#APIsManager.deactivate">deactivate</a></td>
80 <td>Public method to perform actions upon deactivation.</td> 98 <td>Public method to perform actions upon deactivation.</td>
81 </tr><tr> 99 </tr>
100 <tr>
82 <td><a href="#APIsManager.getAPIs">getAPIs</a></td> 101 <td><a href="#APIsManager.getAPIs">getAPIs</a></td>
83 <td>Public method to get an apis object for autocompletion/calltips.</td> 102 <td>Public method to get an apis object for autocompletion/calltips.</td>
84 </tr><tr> 103 </tr>
104 <tr>
85 <td><a href="#APIsManager.reloadAPIs">reloadAPIs</a></td> 105 <td><a href="#APIsManager.reloadAPIs">reloadAPIs</a></td>
86 <td>Public slot to reload the api information.</td> 106 <td>Public slot to reload the api information.</td>
87 </tr> 107 </tr>
88 </table> 108 </table>
89 <h3>Static Methods</h3> 109 <h3>Static Methods</h3>
110
90 <table> 111 <table>
91 <tr><td>None</td></tr> 112 <tr><td>None</td></tr>
92 </table> 113 </table>
114
93 <a NAME="APIsManager.__init__" ID="APIsManager.__init__"></a> 115 <a NAME="APIsManager.__init__" ID="APIsManager.__init__"></a>
94 <h4>APIsManager (Constructor)</h4> 116 <h4>APIsManager (Constructor)</h4>
95 <b>APIsManager</b>(<i>mainWindow, parent=None</i>) 117 <b>APIsManager</b>(<i>mainWindow, parent=None</i>)
118
96 <p> 119 <p>
97 Constructor 120 Constructor
98 </p><dl> 121 </p>
122 <dl>
123
99 <dt><i>mainWindow</i></dt> 124 <dt><i>mainWindow</i></dt>
100 <dd> 125 <dd>
101 reference to the main eric6 window (QMainWindow) 126 reference to the main eric6 window (QMainWindow)
102 </dd><dt><i>parent</i></dt> 127 </dd>
128 <dt><i>parent</i></dt>
103 <dd> 129 <dd>
104 reference to the parent object (QObject) 130 reference to the parent object (QObject)
105 </dd> 131 </dd>
106 </dl><a NAME="APIsManager.__apiPreparationStatus" ID="APIsManager.__apiPreparationStatus"></a> 132 </dl>
133 <a NAME="APIsManager.__apiPreparationStatus" ID="APIsManager.__apiPreparationStatus"></a>
107 <h4>APIsManager.__apiPreparationStatus</h4> 134 <h4>APIsManager.__apiPreparationStatus</h4>
108 <b>__apiPreparationStatus</b>(<i>language, status, filename</i>) 135 <b>__apiPreparationStatus</b>(<i>language, status, filename</i>)
136
109 <p> 137 <p>
110 Private slot handling the preparation status signal of an API object. 138 Private slot handling the preparation status signal of an API object.
111 </p><dl> 139 </p>
140 <dl>
141
112 <dt><i>language</i></dt> 142 <dt><i>language</i></dt>
113 <dd> 143 <dd>
114 language of the API (string) 144 language of the API (string)
115 </dd><dt><i>status</i></dt> 145 </dd>
146 <dt><i>status</i></dt>
116 <dd> 147 <dd>
117 preparation status (integer, one of WorkerStatus...) 148 preparation status (integer, one of WorkerStatus...)
118 </dd><dt><i>filename</i></dt> 149 </dd>
150 <dt><i>filename</i></dt>
119 <dd> 151 <dd>
120 name of the file being processed (string) 152 name of the file being processed (string)
121 </dd> 153 </dd>
122 </dl><a NAME="APIsManager.__showMessage" ID="APIsManager.__showMessage"></a> 154 </dl>
155 <a NAME="APIsManager.__showMessage" ID="APIsManager.__showMessage"></a>
123 <h4>APIsManager.__showMessage</h4> 156 <h4>APIsManager.__showMessage</h4>
124 <b>__showMessage</b>(<i>msg</i>) 157 <b>__showMessage</b>(<i>msg</i>)
158
125 <p> 159 <p>
126 Private message to show a message in the main windows status bar. 160 Private message to show a message in the main windows status bar.
127 </p><dl> 161 </p>
162 <dl>
163
128 <dt><i>msg</i></dt> 164 <dt><i>msg</i></dt>
129 <dd> 165 <dd>
130 message to be shown (string) 166 message to be shown (string)
131 </dd> 167 </dd>
132 </dl><a NAME="APIsManager.__supportedApiLanguages" ID="APIsManager.__supportedApiLanguages"></a> 168 </dl>
169 <a NAME="APIsManager.__supportedApiLanguages" ID="APIsManager.__supportedApiLanguages"></a>
133 <h4>APIsManager.__supportedApiLanguages</h4> 170 <h4>APIsManager.__supportedApiLanguages</h4>
134 <b>__supportedApiLanguages</b>(<i></i>) 171 <b>__supportedApiLanguages</b>(<i></i>)
172
135 <p> 173 <p>
136 Private method to build a list of supported API languages. 174 Private method to build a list of supported API languages.
137 </p><p> 175 </p>
176 <p>
138 Note: This is a compatibility method to make this code work with 177 Note: This is a compatibility method to make this code work with
139 older eric versions. 178 older eric versions.
140 </p><dl> 179 </p>
180 <dl>
141 <dt>Returns:</dt> 181 <dt>Returns:</dt>
142 <dd> 182 <dd>
143 list of supported API languages 183 list of supported API languages
144 </dd> 184 </dd>
145 </dl><dl> 185 </dl>
186 <dl>
146 <dt>Return Type:</dt> 187 <dt>Return Type:</dt>
147 <dd> 188 <dd>
148 list of str 189 list of str
149 </dd> 190 </dd>
150 </dl><a NAME="APIsManager.deactivate" ID="APIsManager.deactivate"></a> 191 </dl>
192 <a NAME="APIsManager.deactivate" ID="APIsManager.deactivate"></a>
151 <h4>APIsManager.deactivate</h4> 193 <h4>APIsManager.deactivate</h4>
152 <b>deactivate</b>(<i></i>) 194 <b>deactivate</b>(<i></i>)
195
153 <p> 196 <p>
154 Public method to perform actions upon deactivation. 197 Public method to perform actions upon deactivation.
155 </p><a NAME="APIsManager.getAPIs" ID="APIsManager.getAPIs"></a> 198 </p>
199 <a NAME="APIsManager.getAPIs" ID="APIsManager.getAPIs"></a>
156 <h4>APIsManager.getAPIs</h4> 200 <h4>APIsManager.getAPIs</h4>
157 <b>getAPIs</b>(<i>language, projectType=""</i>) 201 <b>getAPIs</b>(<i>language, projectType=""</i>)
202
158 <p> 203 <p>
159 Public method to get an apis object for autocompletion/calltips. 204 Public method to get an apis object for autocompletion/calltips.
160 </p><p> 205 </p>
206 <p>
161 This method creates and loads an APIs object dynamically upon request. 207 This method creates and loads an APIs object dynamically upon request.
162 This saves memory for languages, that might not be needed at the 208 This saves memory for languages, that might not be needed at the
163 moment. 209 moment.
164 </p><dl> 210 </p>
211 <dl>
212
165 <dt><i>language</i> (str)</dt> 213 <dt><i>language</i> (str)</dt>
166 <dd> 214 <dd>
167 language of the requested APIs object 215 language of the requested APIs object
168 </dd><dt><i>projectType</i> (str)</dt> 216 </dd>
217 <dt><i>projectType</i> (str)</dt>
169 <dd> 218 <dd>
170 type of the project 219 type of the project
171 </dd> 220 </dd>
172 </dl><dl> 221 </dl>
222 <dl>
173 <dt>Returns:</dt> 223 <dt>Returns:</dt>
174 <dd> 224 <dd>
175 reference to the APIs object 225 reference to the APIs object
176 </dd> 226 </dd>
177 </dl><dl> 227 </dl>
228 <dl>
178 <dt>Return Type:</dt> 229 <dt>Return Type:</dt>
179 <dd> 230 <dd>
180 APIs 231 APIs
181 </dd> 232 </dd>
182 </dl><a NAME="APIsManager.reloadAPIs" ID="APIsManager.reloadAPIs"></a> 233 </dl>
234 <a NAME="APIsManager.reloadAPIs" ID="APIsManager.reloadAPIs"></a>
183 <h4>APIsManager.reloadAPIs</h4> 235 <h4>APIsManager.reloadAPIs</h4>
184 <b>reloadAPIs</b>(<i></i>) 236 <b>reloadAPIs</b>(<i></i>)
237
185 <p> 238 <p>
186 Public slot to reload the api information. 239 Public slot to reload the api information.
187 </p> 240 </p>
188 <div align="right"><a href="#top">Up</a></div> 241 <div align="right"><a href="#top">Up</a></div>
189 <hr /><hr /> 242 <hr />
243 <hr />
190 <a NAME="DbAPIs" ID="DbAPIs"></a> 244 <a NAME="DbAPIs" ID="DbAPIs"></a>
191 <h2>DbAPIs</h2> 245 <h2>DbAPIs</h2>
246
192 <p> 247 <p>
193 Class implementing an API storage entity. 248 Class implementing an API storage entity.
194 </p><h3>Signals</h3> 249 </p>
195 <dl> 250 <h3>Signals</h3>
251 <dl>
252
196 <dt>apiPreparationStatus(language, status, file)</dt> 253 <dt>apiPreparationStatus(language, status, file)</dt>
197 <dd> 254 <dd>
198 emitted to indicate 255 emitted to indicate
199 the API preparation status for a language 256 the API preparation status for a language
200 </dd> 257 </dd>
201 </dl> 258 </dl>
202 <h3>Derived from</h3> 259 <h3>Derived from</h3>
203 QObject 260 QObject
204 <h3>Class Attributes</h3> 261 <h3>Class Attributes</h3>
262
205 <table> 263 <table>
206 <tr><td>DB_VERSION</td></tr><tr><td>ac_context_stmt</td></tr><tr><td>ac_context_word_stmt</td></tr><tr><td>ac_stmt</td></tr><tr><td>api_files_stmt</td></tr><tr><td>bases_stmt</td></tr><tr><td>create_acWord_idx</td></tr><tr><td>create_api_stmt</td></tr><tr><td>create_bases_idx</td></tr><tr><td>create_bases_stmt</td></tr><tr><td>create_context_idx</td></tr><tr><td>create_file_idx</td></tr><tr><td>create_file_stmt</td></tr><tr><td>create_fullContext_idx</td></tr><tr><td>create_mgmt_stmt</td></tr><tr><td>ct_context_stmt</td></tr><tr><td>ct_fullContext_stmt</td></tr><tr><td>ct_stmt</td></tr><tr><td>drop_acWord_idx</td></tr><tr><td>drop_api_stmt</td></tr><tr><td>drop_bases_idx</td></tr><tr><td>drop_bases_stmt</td></tr><tr><td>drop_context_idx</td></tr><tr><td>drop_file_idx</td></tr><tr><td>drop_file_stmt</td></tr><tr><td>drop_fullContext_idx</td></tr><tr><td>drop_mgmt_stmt</td></tr><tr><td>format_select_stmt</td></tr><tr><td>mgmt_insert_stmt</td></tr> 264 <tr><td>DB_VERSION</td></tr><tr><td>ac_context_stmt</td></tr><tr><td>ac_context_word_stmt</td></tr><tr><td>ac_stmt</td></tr><tr><td>api_files_stmt</td></tr><tr><td>bases_stmt</td></tr><tr><td>create_acWord_idx</td></tr><tr><td>create_api_stmt</td></tr><tr><td>create_bases_idx</td></tr><tr><td>create_bases_stmt</td></tr><tr><td>create_context_idx</td></tr><tr><td>create_file_idx</td></tr><tr><td>create_file_stmt</td></tr><tr><td>create_fullContext_idx</td></tr><tr><td>create_mgmt_stmt</td></tr><tr><td>ct_context_stmt</td></tr><tr><td>ct_fullContext_stmt</td></tr><tr><td>ct_stmt</td></tr><tr><td>drop_acWord_idx</td></tr><tr><td>drop_api_stmt</td></tr><tr><td>drop_bases_idx</td></tr><tr><td>drop_bases_stmt</td></tr><tr><td>drop_context_idx</td></tr><tr><td>drop_file_idx</td></tr><tr><td>drop_file_stmt</td></tr><tr><td>drop_fullContext_idx</td></tr><tr><td>drop_mgmt_stmt</td></tr><tr><td>format_select_stmt</td></tr><tr><td>mgmt_insert_stmt</td></tr>
207 </table> 265 </table>
208 <h3>Class Methods</h3> 266 <h3>Class Methods</h3>
267
209 <table> 268 <table>
210 <tr><td>None</td></tr> 269 <tr><td>None</td></tr>
211 </table> 270 </table>
212 <h3>Methods</h3> 271 <h3>Methods</h3>
213 <table> 272
273 <table>
274
214 <tr> 275 <tr>
215 <td><a href="#DbAPIs.__init__">DbAPIs</a></td> 276 <td><a href="#DbAPIs.__init__">DbAPIs</a></td>
216 <td>Constructor</td> 277 <td>Constructor</td>
217 </tr><tr> 278 </tr>
279 <tr>
218 <td><a href="#DbAPIs.__createApiDB">__createApiDB</a></td> 280 <td><a href="#DbAPIs.__createApiDB">__createApiDB</a></td>
219 <td>Private method to create an API database.</td> 281 <td>Private method to create an API database.</td>
220 </tr><tr> 282 </tr>
283 <tr>
221 <td><a href="#DbAPIs.__enoughCommas">__enoughCommas</a></td> 284 <td><a href="#DbAPIs.__enoughCommas">__enoughCommas</a></td>
222 <td>Private method to determine, if the given string contains enough commas.</td> 285 <td>Private method to determine, if the given string contains enough commas.</td>
223 </tr><tr> 286 </tr>
287 <tr>
224 <td><a href="#DbAPIs.__getProjectFormSources">__getProjectFormSources</a></td> 288 <td><a href="#DbAPIs.__getProjectFormSources">__getProjectFormSources</a></td>
225 <td>Private method to get the source files for the project forms.</td> 289 <td>Private method to get the source files for the project forms.</td>
226 </tr><tr> 290 </tr>
291 <tr>
227 <td><a href="#DbAPIs.__initAsLanguage">__initAsLanguage</a></td> 292 <td><a href="#DbAPIs.__initAsLanguage">__initAsLanguage</a></td>
228 <td>Private method to initialize as a language API object.</td> 293 <td>Private method to initialize as a language API object.</td>
229 </tr><tr> 294 </tr>
295 <tr>
230 <td><a href="#DbAPIs.__initAsProject">__initAsProject</a></td> 296 <td><a href="#DbAPIs.__initAsProject">__initAsProject</a></td>
231 <td>Private method to initialize as a project API object.</td> 297 <td>Private method to initialize as a project API object.</td>
232 </tr><tr> 298 </tr>
299 <tr>
233 <td><a href="#DbAPIs.__isPrepared">__isPrepared</a></td> 300 <td><a href="#DbAPIs.__isPrepared">__isPrepared</a></td>
234 <td>Private method to check, if the database has been prepared.</td> 301 <td>Private method to check, if the database has been prepared.</td>
235 </tr><tr> 302 </tr>
303 <tr>
236 <td><a href="#DbAPIs.__openAPIs">__openAPIs</a></td> 304 <td><a href="#DbAPIs.__openAPIs">__openAPIs</a></td>
237 <td>Private method to open the API database.</td> 305 <td>Private method to open the API database.</td>
238 </tr><tr> 306 </tr>
307 <tr>
239 <td><a href="#DbAPIs.__openApiDb">__openApiDb</a></td> 308 <td><a href="#DbAPIs.__openApiDb">__openApiDb</a></td>
240 <td>Private method to open the API database.</td> 309 <td>Private method to open the API database.</td>
241 </tr><tr> 310 </tr>
311 <tr>
242 <td><a href="#DbAPIs.__processQueue">__processQueue</a></td> 312 <td><a href="#DbAPIs.__processQueue">__processQueue</a></td>
243 <td>Private slot to process the queue of files to load.</td> 313 <td>Private slot to process the queue of files to load.</td>
244 </tr><tr> 314 </tr>
315 <tr>
245 <td><a href="#DbAPIs.__processingStatus">__processingStatus</a></td> 316 <td><a href="#DbAPIs.__processingStatus">__processingStatus</a></td>
246 <td>Private slot handling the processing signal of the API preparation thread.</td> 317 <td>Private slot handling the processing signal of the API preparation thread.</td>
247 </tr><tr> 318 </tr>
319 <tr>
248 <td><a href="#DbAPIs.__projectChanged">__projectChanged</a></td> 320 <td><a href="#DbAPIs.__projectChanged">__projectChanged</a></td>
249 <td>Private slot to handle the projectChanged signal.</td> 321 <td>Private slot to handle the projectChanged signal.</td>
250 </tr><tr> 322 </tr>
323 <tr>
251 <td><a href="#DbAPIs.__projectClosed">__projectClosed</a></td> 324 <td><a href="#DbAPIs.__projectClosed">__projectClosed</a></td>
252 <td>Private slot to perform actions after a project has been closed.</td> 325 <td>Private slot to perform actions after a project has been closed.</td>
253 </tr><tr> 326 </tr>
327 <tr>
254 <td><a href="#DbAPIs.__projectFormCompiled">__projectFormCompiled</a></td> 328 <td><a href="#DbAPIs.__projectFormCompiled">__projectFormCompiled</a></td>
255 <td>Private slot to handle the projectFormCompiled signal.</td> 329 <td>Private slot to handle the projectFormCompiled signal.</td>
256 </tr><tr> 330 </tr>
331 <tr>
257 <td><a href="#DbAPIs.__projectOpened">__projectOpened</a></td> 332 <td><a href="#DbAPIs.__projectOpened">__projectOpened</a></td>
258 <td>Private slot to perform actions after a project has been opened.</td> 333 <td>Private slot to perform actions after a project has been opened.</td>
259 </tr><tr> 334 </tr>
335 <tr>
260 <td><a href="#DbAPIs._apiDbName">_apiDbName</a></td> 336 <td><a href="#DbAPIs._apiDbName">_apiDbName</a></td>
261 <td>Protected method to determine the name of the database file.</td> 337 <td>Protected method to determine the name of the database file.</td>
262 </tr><tr> 338 </tr>
339 <tr>
263 <td><a href="#DbAPIs.autoCompletionWordSeparators">autoCompletionWordSeparators</a></td> 340 <td><a href="#DbAPIs.autoCompletionWordSeparators">autoCompletionWordSeparators</a></td>
264 <td>Public method to get the word separator characters.</td> 341 <td>Public method to get the word separator characters.</td>
265 </tr><tr> 342 </tr>
343 <tr>
266 <td><a href="#DbAPIs.close">close</a></td> 344 <td><a href="#DbAPIs.close">close</a></td>
267 <td>Public method to close the database.</td> 345 <td>Public method to close the database.</td>
268 </tr><tr> 346 </tr>
347 <tr>
269 <td><a href="#DbAPIs.editorSaved">editorSaved</a></td> 348 <td><a href="#DbAPIs.editorSaved">editorSaved</a></td>
270 <td>Public slot to handle the editorSaved signal.</td> 349 <td>Public slot to handle the editorSaved signal.</td>
271 </tr><tr> 350 </tr>
351 <tr>
272 <td><a href="#DbAPIs.getApiFiles">getApiFiles</a></td> 352 <td><a href="#DbAPIs.getApiFiles">getApiFiles</a></td>
273 <td>Public method to get a list of API files loaded into the database.</td> 353 <td>Public method to get a list of API files loaded into the database.</td>
274 </tr><tr> 354 </tr>
355 <tr>
275 <td><a href="#DbAPIs.getCalltips">getCalltips</a></td> 356 <td><a href="#DbAPIs.getCalltips">getCalltips</a></td>
276 <td>Public method to determine the calltips.</td> 357 <td>Public method to determine the calltips.</td>
277 </tr><tr> 358 </tr>
359 <tr>
278 <td><a href="#DbAPIs.getCompletions">getCompletions</a></td> 360 <td><a href="#DbAPIs.getCompletions">getCompletions</a></td>
279 <td>Public method to determine the possible completions.</td> 361 <td>Public method to determine the possible completions.</td>
280 </tr><tr> 362 </tr>
363 <tr>
281 <td><a href="#DbAPIs.getLexer">getLexer</a></td> 364 <td><a href="#DbAPIs.getLexer">getLexer</a></td>
282 <td>Public method to return a reference to our lexer object.</td> 365 <td>Public method to return a reference to our lexer object.</td>
283 </tr><tr> 366 </tr>
367 <tr>
284 <td><a href="#DbAPIs.prepareAPIs">prepareAPIs</a></td> 368 <td><a href="#DbAPIs.prepareAPIs">prepareAPIs</a></td>
285 <td>Public method to prepare the APIs if neccessary.</td> 369 <td>Public method to prepare the APIs if neccessary.</td>
286 </tr> 370 </tr>
287 </table> 371 </table>
288 <h3>Static Methods</h3> 372 <h3>Static Methods</h3>
373
289 <table> 374 <table>
290 <tr><td>None</td></tr> 375 <tr><td>None</td></tr>
291 </table> 376 </table>
377
292 <a NAME="DbAPIs.__init__" ID="DbAPIs.__init__"></a> 378 <a NAME="DbAPIs.__init__" ID="DbAPIs.__init__"></a>
293 <h4>DbAPIs (Constructor)</h4> 379 <h4>DbAPIs (Constructor)</h4>
294 <b>DbAPIs</b>(<i>language, projectType="", parent=None</i>) 380 <b>DbAPIs</b>(<i>language, projectType="", parent=None</i>)
381
295 <p> 382 <p>
296 Constructor 383 Constructor
297 </p><dl> 384 </p>
385 <dl>
386
298 <dt><i>language</i> (str)</dt> 387 <dt><i>language</i> (str)</dt>
299 <dd> 388 <dd>
300 language of the APIs object 389 language of the APIs object
301 </dd><dt><i>projectType</i> (str)</dt> 390 </dd>
391 <dt><i>projectType</i> (str)</dt>
302 <dd> 392 <dd>
303 type of the project 393 type of the project
304 </dd><dt><i>parent</i> (QObject)</dt> 394 </dd>
395 <dt><i>parent</i> (QObject)</dt>
305 <dd> 396 <dd>
306 reference to the parent object 397 reference to the parent object
307 </dd> 398 </dd>
308 </dl><a NAME="DbAPIs.__createApiDB" ID="DbAPIs.__createApiDB"></a> 399 </dl>
400 <a NAME="DbAPIs.__createApiDB" ID="DbAPIs.__createApiDB"></a>
309 <h4>DbAPIs.__createApiDB</h4> 401 <h4>DbAPIs.__createApiDB</h4>
310 <b>__createApiDB</b>(<i></i>) 402 <b>__createApiDB</b>(<i></i>)
403
311 <p> 404 <p>
312 Private method to create an API database. 405 Private method to create an API database.
313 </p><a NAME="DbAPIs.__enoughCommas" ID="DbAPIs.__enoughCommas"></a> 406 </p>
407 <a NAME="DbAPIs.__enoughCommas" ID="DbAPIs.__enoughCommas"></a>
314 <h4>DbAPIs.__enoughCommas</h4> 408 <h4>DbAPIs.__enoughCommas</h4>
315 <b>__enoughCommas</b>(<i>s, commas</i>) 409 <b>__enoughCommas</b>(<i>s, commas</i>)
410
316 <p> 411 <p>
317 Private method to determine, if the given string contains enough 412 Private method to determine, if the given string contains enough
318 commas. 413 commas.
319 </p><dl> 414 </p>
415 <dl>
416
320 <dt><i>s</i></dt> 417 <dt><i>s</i></dt>
321 <dd> 418 <dd>
322 string to check (string) 419 string to check (string)
323 </dd><dt><i>commas</i></dt> 420 </dd>
421 <dt><i>commas</i></dt>
324 <dd> 422 <dd>
325 number of commas to check for (integer) 423 number of commas to check for (integer)
326 </dd> 424 </dd>
327 </dl><dl> 425 </dl>
426 <dl>
328 <dt>Returns:</dt> 427 <dt>Returns:</dt>
329 <dd> 428 <dd>
330 flag indicating, that there are enough commas (boolean) 429 flag indicating, that there are enough commas (boolean)
331 </dd> 430 </dd>
332 </dl><a NAME="DbAPIs.__getProjectFormSources" ID="DbAPIs.__getProjectFormSources"></a> 431 </dl>
432 <a NAME="DbAPIs.__getProjectFormSources" ID="DbAPIs.__getProjectFormSources"></a>
333 <h4>DbAPIs.__getProjectFormSources</h4> 433 <h4>DbAPIs.__getProjectFormSources</h4>
334 <b>__getProjectFormSources</b>(<i>normalized=False</i>) 434 <b>__getProjectFormSources</b>(<i>normalized=False</i>)
435
335 <p> 436 <p>
336 Private method to get the source files for the project forms. 437 Private method to get the source files for the project forms.
337 </p><dl> 438 </p>
439 <dl>
440
338 <dt><i>normalized=</i></dt> 441 <dt><i>normalized=</i></dt>
339 <dd> 442 <dd>
340 flag indicating a normalized filename is wanted 443 flag indicating a normalized filename is wanted
341 (boolean) 444 (boolean)
342 </dd> 445 </dd>
343 </dl><dl> 446 </dl>
447 <dl>
344 <dt>Returns:</dt> 448 <dt>Returns:</dt>
345 <dd> 449 <dd>
346 list of project form sources (list of strings) 450 list of project form sources (list of strings)
347 </dd> 451 </dd>
348 </dl><a NAME="DbAPIs.__initAsLanguage" ID="DbAPIs.__initAsLanguage"></a> 452 </dl>
453 <a NAME="DbAPIs.__initAsLanguage" ID="DbAPIs.__initAsLanguage"></a>
349 <h4>DbAPIs.__initAsLanguage</h4> 454 <h4>DbAPIs.__initAsLanguage</h4>
350 <b>__initAsLanguage</b>(<i></i>) 455 <b>__initAsLanguage</b>(<i></i>)
456
351 <p> 457 <p>
352 Private method to initialize as a language API object. 458 Private method to initialize as a language API object.
353 </p><a NAME="DbAPIs.__initAsProject" ID="DbAPIs.__initAsProject"></a> 459 </p>
460 <a NAME="DbAPIs.__initAsProject" ID="DbAPIs.__initAsProject"></a>
354 <h4>DbAPIs.__initAsProject</h4> 461 <h4>DbAPIs.__initAsProject</h4>
355 <b>__initAsProject</b>(<i></i>) 462 <b>__initAsProject</b>(<i></i>)
463
356 <p> 464 <p>
357 Private method to initialize as a project API object. 465 Private method to initialize as a project API object.
358 </p><a NAME="DbAPIs.__isPrepared" ID="DbAPIs.__isPrepared"></a> 466 </p>
467 <a NAME="DbAPIs.__isPrepared" ID="DbAPIs.__isPrepared"></a>
359 <h4>DbAPIs.__isPrepared</h4> 468 <h4>DbAPIs.__isPrepared</h4>
360 <b>__isPrepared</b>(<i></i>) 469 <b>__isPrepared</b>(<i></i>)
470
361 <p> 471 <p>
362 Private method to check, if the database has been prepared. 472 Private method to check, if the database has been prepared.
363 </p><dl> 473 </p>
474 <dl>
364 <dt>Returns:</dt> 475 <dt>Returns:</dt>
365 <dd> 476 <dd>
366 flag indicating the prepared status (boolean) 477 flag indicating the prepared status (boolean)
367 </dd> 478 </dd>
368 </dl><a NAME="DbAPIs.__openAPIs" ID="DbAPIs.__openAPIs"></a> 479 </dl>
480 <a NAME="DbAPIs.__openAPIs" ID="DbAPIs.__openAPIs"></a>
369 <h4>DbAPIs.__openAPIs</h4> 481 <h4>DbAPIs.__openAPIs</h4>
370 <b>__openAPIs</b>(<i></i>) 482 <b>__openAPIs</b>(<i></i>)
483
371 <p> 484 <p>
372 Private method to open the API database. 485 Private method to open the API database.
373 </p><a NAME="DbAPIs.__openApiDb" ID="DbAPIs.__openApiDb"></a> 486 </p>
487 <a NAME="DbAPIs.__openApiDb" ID="DbAPIs.__openApiDb"></a>
374 <h4>DbAPIs.__openApiDb</h4> 488 <h4>DbAPIs.__openApiDb</h4>
375 <b>__openApiDb</b>(<i></i>) 489 <b>__openApiDb</b>(<i></i>)
490
376 <p> 491 <p>
377 Private method to open the API database. 492 Private method to open the API database.
378 </p><dl> 493 </p>
494 <dl>
379 <dt>Returns:</dt> 495 <dt>Returns:</dt>
380 <dd> 496 <dd>
381 flag indicating the database status (boolean) 497 flag indicating the database status (boolean)
382 </dd> 498 </dd>
383 </dl><a NAME="DbAPIs.__processQueue" ID="DbAPIs.__processQueue"></a> 499 </dl>
500 <a NAME="DbAPIs.__processQueue" ID="DbAPIs.__processQueue"></a>
384 <h4>DbAPIs.__processQueue</h4> 501 <h4>DbAPIs.__processQueue</h4>
385 <b>__processQueue</b>(<i></i>) 502 <b>__processQueue</b>(<i></i>)
503
386 <p> 504 <p>
387 Private slot to process the queue of files to load. 505 Private slot to process the queue of files to load.
388 </p><a NAME="DbAPIs.__processingStatus" ID="DbAPIs.__processingStatus"></a> 506 </p>
507 <a NAME="DbAPIs.__processingStatus" ID="DbAPIs.__processingStatus"></a>
389 <h4>DbAPIs.__processingStatus</h4> 508 <h4>DbAPIs.__processingStatus</h4>
390 <b>__processingStatus</b>(<i>status, filename</i>) 509 <b>__processingStatus</b>(<i>status, filename</i>)
510
391 <p> 511 <p>
392 Private slot handling the processing signal of the API preparation 512 Private slot handling the processing signal of the API preparation
393 thread. 513 thread.
394 </p><dl> 514 </p>
515 <dl>
516
395 <dt><i>status</i></dt> 517 <dt><i>status</i></dt>
396 <dd> 518 <dd>
397 preparation status (integer, one of WorkerStatus...) 519 preparation status (integer, one of WorkerStatus...)
398 </dd><dt><i>filename</i></dt> 520 </dd>
521 <dt><i>filename</i></dt>
399 <dd> 522 <dd>
400 name of the file being processed (string) 523 name of the file being processed (string)
401 </dd> 524 </dd>
402 </dl><a NAME="DbAPIs.__projectChanged" ID="DbAPIs.__projectChanged"></a> 525 </dl>
526 <a NAME="DbAPIs.__projectChanged" ID="DbAPIs.__projectChanged"></a>
403 <h4>DbAPIs.__projectChanged</h4> 527 <h4>DbAPIs.__projectChanged</h4>
404 <b>__projectChanged</b>(<i></i>) 528 <b>__projectChanged</b>(<i></i>)
529
405 <p> 530 <p>
406 Private slot to handle the projectChanged signal. 531 Private slot to handle the projectChanged signal.
407 </p><a NAME="DbAPIs.__projectClosed" ID="DbAPIs.__projectClosed"></a> 532 </p>
533 <a NAME="DbAPIs.__projectClosed" ID="DbAPIs.__projectClosed"></a>
408 <h4>DbAPIs.__projectClosed</h4> 534 <h4>DbAPIs.__projectClosed</h4>
409 <b>__projectClosed</b>(<i></i>) 535 <b>__projectClosed</b>(<i></i>)
536
410 <p> 537 <p>
411 Private slot to perform actions after a project has been closed. 538 Private slot to perform actions after a project has been closed.
412 </p><a NAME="DbAPIs.__projectFormCompiled" ID="DbAPIs.__projectFormCompiled"></a> 539 </p>
540 <a NAME="DbAPIs.__projectFormCompiled" ID="DbAPIs.__projectFormCompiled"></a>
413 <h4>DbAPIs.__projectFormCompiled</h4> 541 <h4>DbAPIs.__projectFormCompiled</h4>
414 <b>__projectFormCompiled</b>(<i>filename</i>) 542 <b>__projectFormCompiled</b>(<i>filename</i>)
543
415 <p> 544 <p>
416 Private slot to handle the projectFormCompiled signal. 545 Private slot to handle the projectFormCompiled signal.
417 </p><dl> 546 </p>
547 <dl>
548
418 <dt><i>filename</i></dt> 549 <dt><i>filename</i></dt>
419 <dd> 550 <dd>
420 name of the form file that was compiled (string) 551 name of the form file that was compiled (string)
421 </dd> 552 </dd>
422 </dl><a NAME="DbAPIs.__projectOpened" ID="DbAPIs.__projectOpened"></a> 553 </dl>
554 <a NAME="DbAPIs.__projectOpened" ID="DbAPIs.__projectOpened"></a>
423 <h4>DbAPIs.__projectOpened</h4> 555 <h4>DbAPIs.__projectOpened</h4>
424 <b>__projectOpened</b>(<i></i>) 556 <b>__projectOpened</b>(<i></i>)
557
425 <p> 558 <p>
426 Private slot to perform actions after a project has been opened. 559 Private slot to perform actions after a project has been opened.
427 </p><a NAME="DbAPIs._apiDbName" ID="DbAPIs._apiDbName"></a> 560 </p>
561 <a NAME="DbAPIs._apiDbName" ID="DbAPIs._apiDbName"></a>
428 <h4>DbAPIs._apiDbName</h4> 562 <h4>DbAPIs._apiDbName</h4>
429 <b>_apiDbName</b>(<i></i>) 563 <b>_apiDbName</b>(<i></i>)
564
430 <p> 565 <p>
431 Protected method to determine the name of the database file. 566 Protected method to determine the name of the database file.
432 </p><dl> 567 </p>
568 <dl>
433 <dt>Returns:</dt> 569 <dt>Returns:</dt>
434 <dd> 570 <dd>
435 name of the database file (string) 571 name of the database file (string)
436 </dd> 572 </dd>
437 </dl><a NAME="DbAPIs.autoCompletionWordSeparators" ID="DbAPIs.autoCompletionWordSeparators"></a> 573 </dl>
574 <a NAME="DbAPIs.autoCompletionWordSeparators" ID="DbAPIs.autoCompletionWordSeparators"></a>
438 <h4>DbAPIs.autoCompletionWordSeparators</h4> 575 <h4>DbAPIs.autoCompletionWordSeparators</h4>
439 <b>autoCompletionWordSeparators</b>(<i></i>) 576 <b>autoCompletionWordSeparators</b>(<i></i>)
577
440 <p> 578 <p>
441 Public method to get the word separator characters. 579 Public method to get the word separator characters.
442 </p><dl> 580 </p>
581 <dl>
443 <dt>Returns:</dt> 582 <dt>Returns:</dt>
444 <dd> 583 <dd>
445 word separator characters (list of strings) 584 word separator characters (list of strings)
446 </dd> 585 </dd>
447 </dl><a NAME="DbAPIs.close" ID="DbAPIs.close"></a> 586 </dl>
587 <a NAME="DbAPIs.close" ID="DbAPIs.close"></a>
448 <h4>DbAPIs.close</h4> 588 <h4>DbAPIs.close</h4>
449 <b>close</b>(<i></i>) 589 <b>close</b>(<i></i>)
590
450 <p> 591 <p>
451 Public method to close the database. 592 Public method to close the database.
452 </p><a NAME="DbAPIs.editorSaved" ID="DbAPIs.editorSaved"></a> 593 </p>
594 <a NAME="DbAPIs.editorSaved" ID="DbAPIs.editorSaved"></a>
453 <h4>DbAPIs.editorSaved</h4> 595 <h4>DbAPIs.editorSaved</h4>
454 <b>editorSaved</b>(<i>filename</i>) 596 <b>editorSaved</b>(<i>filename</i>)
597
455 <p> 598 <p>
456 Public slot to handle the editorSaved signal. 599 Public slot to handle the editorSaved signal.
457 </p><dl> 600 </p>
601 <dl>
602
458 <dt><i>filename</i></dt> 603 <dt><i>filename</i></dt>
459 <dd> 604 <dd>
460 name of the file that was saved (string) 605 name of the file that was saved (string)
461 </dd> 606 </dd>
462 </dl><a NAME="DbAPIs.getApiFiles" ID="DbAPIs.getApiFiles"></a> 607 </dl>
608 <a NAME="DbAPIs.getApiFiles" ID="DbAPIs.getApiFiles"></a>
463 <h4>DbAPIs.getApiFiles</h4> 609 <h4>DbAPIs.getApiFiles</h4>
464 <b>getApiFiles</b>(<i></i>) 610 <b>getApiFiles</b>(<i></i>)
611
465 <p> 612 <p>
466 Public method to get a list of API files loaded into the database. 613 Public method to get a list of API files loaded into the database.
467 </p><dl> 614 </p>
615 <dl>
468 <dt>Returns:</dt> 616 <dt>Returns:</dt>
469 <dd> 617 <dd>
470 list of API filenames (list of strings) 618 list of API filenames (list of strings)
471 </dd> 619 </dd>
472 </dl><a NAME="DbAPIs.getCalltips" ID="DbAPIs.getCalltips"></a> 620 </dl>
621 <a NAME="DbAPIs.getCalltips" ID="DbAPIs.getCalltips"></a>
473 <h4>DbAPIs.getCalltips</h4> 622 <h4>DbAPIs.getCalltips</h4>
474 <b>getCalltips</b>(<i>acWord, commas, context=None, fullContext=None, showContext=True, followHierarchy=False</i>) 623 <b>getCalltips</b>(<i>acWord, commas, context=None, fullContext=None, showContext=True, followHierarchy=False</i>)
624
475 <p> 625 <p>
476 Public method to determine the calltips. 626 Public method to determine the calltips.
477 </p><dl> 627 </p>
628 <dl>
629
478 <dt><i>acWord</i></dt> 630 <dt><i>acWord</i></dt>
479 <dd> 631 <dd>
480 function to get calltips for (string) 632 function to get calltips for (string)
481 </dd><dt><i>commas</i></dt> 633 </dd>
634 <dt><i>commas</i></dt>
482 <dd> 635 <dd>
483 minimum number of commas contained in the calltip 636 minimum number of commas contained in the calltip
484 (integer) 637 (integer)
485 </dd><dt><i>context</i></dt> 638 </dd>
639 <dt><i>context</i></dt>
486 <dd> 640 <dd>
487 string giving the context (e.g. classname) (string) 641 string giving the context (e.g. classname) (string)
488 </dd><dt><i>fullContext</i></dt> 642 </dd>
643 <dt><i>fullContext</i></dt>
489 <dd> 644 <dd>
490 string giving the full context (string) 645 string giving the full context (string)
491 </dd><dt><i>showContext</i></dt> 646 </dd>
647 <dt><i>showContext</i></dt>
492 <dd> 648 <dd>
493 flag indicating to show the calltip context 649 flag indicating to show the calltip context
494 (boolean) 650 (boolean)
495 </dd><dt><i>followHierarchy=</i></dt> 651 </dd>
652 <dt><i>followHierarchy=</i></dt>
496 <dd> 653 <dd>
497 flag indicating to follow the hierarchy of 654 flag indicating to follow the hierarchy of
498 base classes (boolean) 655 base classes (boolean)
499 </dd> 656 </dd>
500 </dl><dl> 657 </dl>
658 <dl>
501 <dt>Returns:</dt> 659 <dt>Returns:</dt>
502 <dd> 660 <dd>
503 list of calltips (list of string) 661 list of calltips (list of string)
504 </dd> 662 </dd>
505 </dl><a NAME="DbAPIs.getCompletions" ID="DbAPIs.getCompletions"></a> 663 </dl>
664 <a NAME="DbAPIs.getCompletions" ID="DbAPIs.getCompletions"></a>
506 <h4>DbAPIs.getCompletions</h4> 665 <h4>DbAPIs.getCompletions</h4>
507 <b>getCompletions</b>(<i>start=None, context=None, followHierarchy=False</i>) 666 <b>getCompletions</b>(<i>start=None, context=None, followHierarchy=False</i>)
667
508 <p> 668 <p>
509 Public method to determine the possible completions. 669 Public method to determine the possible completions.
510 </p><dl> 670 </p>
671 <dl>
672
511 <dt><i>start=</i></dt> 673 <dt><i>start=</i></dt>
512 <dd> 674 <dd>
513 string giving the start of the word to be 675 string giving the start of the word to be
514 completed (string) 676 completed (string)
515 </dd><dt><i>context=</i></dt> 677 </dd>
678 <dt><i>context=</i></dt>
516 <dd> 679 <dd>
517 string giving the context (e.g. classname) 680 string giving the context (e.g. classname)
518 to be completed (string) 681 to be completed (string)
519 </dd><dt><i>followHierarchy=</i></dt> 682 </dd>
683 <dt><i>followHierarchy=</i></dt>
520 <dd> 684 <dd>
521 flag indicating to follow the hierarchy of 685 flag indicating to follow the hierarchy of
522 base classes (boolean) 686 base classes (boolean)
523 </dd> 687 </dd>
524 </dl><dl> 688 </dl>
689 <dl>
525 <dt>Returns:</dt> 690 <dt>Returns:</dt>
526 <dd> 691 <dd>
527 list of dictionaries with possible completions 692 list of dictionaries with possible completions
528 (key 'completion' contains the completion (string), 693 (key 'completion' contains the completion (string),
529 key 'context' contains the context (string) and 694 key 'context' contains the context (string) and
530 key 'pictureId' contains the ID of the icon to be shown (string)) 695 key 'pictureId' contains the ID of the icon to be shown (string))
531 </dd> 696 </dd>
532 </dl><a NAME="DbAPIs.getLexer" ID="DbAPIs.getLexer"></a> 697 </dl>
698 <a NAME="DbAPIs.getLexer" ID="DbAPIs.getLexer"></a>
533 <h4>DbAPIs.getLexer</h4> 699 <h4>DbAPIs.getLexer</h4>
534 <b>getLexer</b>(<i></i>) 700 <b>getLexer</b>(<i></i>)
701
535 <p> 702 <p>
536 Public method to return a reference to our lexer object. 703 Public method to return a reference to our lexer object.
537 </p><dl> 704 </p>
705 <dl>
538 <dt>Returns:</dt> 706 <dt>Returns:</dt>
539 <dd> 707 <dd>
540 reference to the lexer object (QScintilla.Lexers.Lexer) 708 reference to the lexer object (QScintilla.Lexers.Lexer)
541 </dd> 709 </dd>
542 </dl><a NAME="DbAPIs.prepareAPIs" ID="DbAPIs.prepareAPIs"></a> 710 </dl>
711 <a NAME="DbAPIs.prepareAPIs" ID="DbAPIs.prepareAPIs"></a>
543 <h4>DbAPIs.prepareAPIs</h4> 712 <h4>DbAPIs.prepareAPIs</h4>
544 <b>prepareAPIs</b>(<i>rawList=None</i>) 713 <b>prepareAPIs</b>(<i>rawList=None</i>)
714
545 <p> 715 <p>
546 Public method to prepare the APIs if neccessary. 716 Public method to prepare the APIs if neccessary.
547 </p><dl> 717 </p>
718 <dl>
719
548 <dt><i>rawList=</i></dt> 720 <dt><i>rawList=</i></dt>
549 <dd> 721 <dd>
550 list of raw API files (list of strings) 722 list of raw API files (list of strings)
551 </dd> 723 </dd>
552 </dl> 724 </dl>
553 <div align="right"><a href="#top">Up</a></div> 725 <div align="right"><a href="#top">Up</a></div>
554 <hr /><hr /> 726 <hr />
727 <hr />
555 <a NAME="DbAPIsWorker" ID="DbAPIsWorker"></a> 728 <a NAME="DbAPIsWorker" ID="DbAPIsWorker"></a>
556 <h2>DbAPIsWorker</h2> 729 <h2>DbAPIsWorker</h2>
730
557 <p> 731 <p>
558 Class implementing a worker thread to prepare the API database. 732 Class implementing a worker thread to prepare the API database.
559 </p><h3>Signals</h3> 733 </p>
560 <dl> 734 <h3>Signals</h3>
735 <dl>
736
561 <dt>processing(status, file)</dt> 737 <dt>processing(status, file)</dt>
562 <dd> 738 <dd>
563 emitted to indicate the processing status 739 emitted to indicate the processing status
564 (one of WorkerStatus..., string) 740 (one of WorkerStatus..., string)
565 </dd> 741 </dd>
566 </dl> 742 </dl>
567 <h3>Derived from</h3> 743 <h3>Derived from</h3>
568 QThread 744 QThread
569 <h3>Class Attributes</h3> 745 <h3>Class Attributes</h3>
746
570 <table> 747 <table>
571 <tr><td>api_files_stmt</td></tr><tr><td>file_delete_id_stmt</td></tr><tr><td>file_id_stmt</td></tr><tr><td>file_loaded_stmt</td></tr><tr><td>populate_api_stmt</td></tr><tr><td>populate_bases_stmt</td></tr><tr><td>populate_del_api_stmt</td></tr><tr><td>populate_del_bases_stmt</td></tr><tr><td>populate_file_stmt</td></tr><tr><td>update_file_stmt</td></tr> 748 <tr><td>api_files_stmt</td></tr><tr><td>file_delete_id_stmt</td></tr><tr><td>file_id_stmt</td></tr><tr><td>file_loaded_stmt</td></tr><tr><td>populate_api_stmt</td></tr><tr><td>populate_bases_stmt</td></tr><tr><td>populate_del_api_stmt</td></tr><tr><td>populate_del_bases_stmt</td></tr><tr><td>populate_file_stmt</td></tr><tr><td>update_file_stmt</td></tr>
572 </table> 749 </table>
573 <h3>Class Methods</h3> 750 <h3>Class Methods</h3>
751
574 <table> 752 <table>
575 <tr><td>None</td></tr> 753 <tr><td>None</td></tr>
576 </table> 754 </table>
577 <h3>Methods</h3> 755 <h3>Methods</h3>
578 <table> 756
757 <table>
758
579 <tr> 759 <tr>
580 <td><a href="#DbAPIsWorker.__init__">DbAPIsWorker</a></td> 760 <td><a href="#DbAPIsWorker.__init__">DbAPIsWorker</a></td>
581 <td>Constructor</td> 761 <td>Constructor</td>
582 </tr><tr> 762 </tr>
763 <tr>
583 <td><a href="#DbAPIsWorker.__autoCompletionWordSeparators">__autoCompletionWordSeparators</a></td> 764 <td><a href="#DbAPIsWorker.__autoCompletionWordSeparators">__autoCompletionWordSeparators</a></td>
584 <td>Private method to get the word separator characters for a language.</td> 765 <td>Private method to get the word separator characters for a language.</td>
585 </tr><tr> 766 </tr>
767 <tr>
586 <td><a href="#DbAPIsWorker.__classesAttributesApi">__classesAttributesApi</a></td> 768 <td><a href="#DbAPIsWorker.__classesAttributesApi">__classesAttributesApi</a></td>
587 <td>Private method to generate class api section for class attributes.</td> 769 <td>Private method to generate class api section for class attributes.</td>
588 </tr><tr> 770 </tr>
771 <tr>
589 <td><a href="#DbAPIsWorker.__deleteApiFile">__deleteApiFile</a></td> 772 <td><a href="#DbAPIsWorker.__deleteApiFile">__deleteApiFile</a></td>
590 <td>Private method to delete all references to an api file.</td> 773 <td>Private method to delete all references to an api file.</td>
591 </tr><tr> 774 </tr>
775 <tr>
592 <td><a href="#DbAPIsWorker.__getApiFiles">__getApiFiles</a></td> 776 <td><a href="#DbAPIsWorker.__getApiFiles">__getApiFiles</a></td>
593 <td>Private method to get a list of API files loaded into the database.</td> 777 <td>Private method to get a list of API files loaded into the database.</td>
594 </tr><tr> 778 </tr>
779 <tr>
595 <td><a href="#DbAPIsWorker.__loadApiFile">__loadApiFile</a></td> 780 <td><a href="#DbAPIsWorker.__loadApiFile">__loadApiFile</a></td>
596 <td>Private method to read a raw API file into the database.</td> 781 <td>Private method to read a raw API file into the database.</td>
597 </tr><tr> 782 </tr>
783 <tr>
598 <td><a href="#DbAPIsWorker.__loadApiFileIfNewer">__loadApiFileIfNewer</a></td> 784 <td><a href="#DbAPIsWorker.__loadApiFileIfNewer">__loadApiFileIfNewer</a></td>
599 <td>Private method to load an API file, if it is newer than the one read into the database.</td> 785 <td>Private method to load an API file, if it is newer than the one read into the database.</td>
600 </tr><tr> 786 </tr>
787 <tr>
601 <td><a href="#DbAPIsWorker.__storeApis">__storeApis</a></td> 788 <td><a href="#DbAPIsWorker.__storeApis">__storeApis</a></td>
602 <td>Private method to put the API entries into the database.</td> 789 <td>Private method to put the API entries into the database.</td>
603 </tr><tr> 790 </tr>
791 <tr>
604 <td><a href="#DbAPIsWorker.__storeFileInfoOnly">__storeFileInfoOnly</a></td> 792 <td><a href="#DbAPIsWorker.__storeFileInfoOnly">__storeFileInfoOnly</a></td>
605 <td>Private method to store file info only.</td> 793 <td>Private method to store file info only.</td>
606 </tr><tr> 794 </tr>
795 <tr>
607 <td><a href="#DbAPIsWorker.abort">abort</a></td> 796 <td><a href="#DbAPIsWorker.abort">abort</a></td>
608 <td>Public method to ask the thread to stop.</td> 797 <td>Public method to ask the thread to stop.</td>
609 </tr><tr> 798 </tr>
799 <tr>
610 <td><a href="#DbAPIsWorker.run">run</a></td> 800 <td><a href="#DbAPIsWorker.run">run</a></td>
611 <td>Public method to perform the threads work.</td> 801 <td>Public method to perform the threads work.</td>
612 </tr> 802 </tr>
613 </table> 803 </table>
614 <h3>Static Methods</h3> 804 <h3>Static Methods</h3>
805
615 <table> 806 <table>
616 <tr><td>None</td></tr> 807 <tr><td>None</td></tr>
617 </table> 808 </table>
809
618 <a NAME="DbAPIsWorker.__init__" ID="DbAPIsWorker.__init__"></a> 810 <a NAME="DbAPIsWorker.__init__" ID="DbAPIsWorker.__init__"></a>
619 <h4>DbAPIsWorker (Constructor)</h4> 811 <h4>DbAPIsWorker (Constructor)</h4>
620 <b>DbAPIsWorker</b>(<i>proxy, language, apiFiles, dbName, projectPath="", refresh=False, projectType=""</i>) 812 <b>DbAPIsWorker</b>(<i>proxy, language, apiFiles, dbName, projectPath="", refresh=False, projectType=""</i>)
813
621 <p> 814 <p>
622 Constructor 815 Constructor
623 </p><dl> 816 </p>
817 <dl>
818
624 <dt><i>proxy</i> (DbAPIs)</dt> 819 <dt><i>proxy</i> (DbAPIs)</dt>
625 <dd> 820 <dd>
626 reference to the object that is proxied 821 reference to the object that is proxied
627 </dd><dt><i>language</i> (str)</dt> 822 </dd>
823 <dt><i>language</i> (str)</dt>
628 <dd> 824 <dd>
629 language of the APIs object 825 language of the APIs object
630 </dd><dt><i>apiFiles</i> (list of str)</dt> 826 </dd>
827 <dt><i>apiFiles</i> (list of str)</dt>
631 <dd> 828 <dd>
632 list of API files to process 829 list of API files to process
633 </dd><dt><i>dbName</i> (str)</dt> 830 </dd>
831 <dt><i>dbName</i> (str)</dt>
634 <dd> 832 <dd>
635 path name of the database file 833 path name of the database file
636 </dd><dt><i>projectPath</i> (str)</dt> 834 </dd>
835 <dt><i>projectPath</i> (str)</dt>
637 <dd> 836 <dd>
638 path of the project. Only needed, if the APIs 837 path of the project. Only needed, if the APIs
639 are extracted out of the sources of a project. 838 are extracted out of the sources of a project.
640 </dd><dt><i>refresh</i> (bool)</dt> 839 </dd>
840 <dt><i>refresh</i> (bool)</dt>
641 <dd> 841 <dd>
642 flag indicating a refresh of the APIs of one file 842 flag indicating a refresh of the APIs of one file
643 </dd><dt><i>projectType</i> (str)</dt> 843 </dd>
844 <dt><i>projectType</i> (str)</dt>
644 <dd> 845 <dd>
645 type of the project 846 type of the project
646 </dd> 847 </dd>
647 </dl><a NAME="DbAPIsWorker.__autoCompletionWordSeparators" ID="DbAPIsWorker.__autoCompletionWordSeparators"></a> 848 </dl>
849 <a NAME="DbAPIsWorker.__autoCompletionWordSeparators" ID="DbAPIsWorker.__autoCompletionWordSeparators"></a>
648 <h4>DbAPIsWorker.__autoCompletionWordSeparators</h4> 850 <h4>DbAPIsWorker.__autoCompletionWordSeparators</h4>
649 <b>__autoCompletionWordSeparators</b>(<i>language</i>) 851 <b>__autoCompletionWordSeparators</b>(<i>language</i>)
852
650 <p> 853 <p>
651 Private method to get the word separator characters for a language. 854 Private method to get the word separator characters for a language.
652 </p><dl> 855 </p>
856 <dl>
857
653 <dt><i>language</i></dt> 858 <dt><i>language</i></dt>
654 <dd> 859 <dd>
655 language of the APIs object (string) 860 language of the APIs object (string)
656 </dd> 861 </dd>
657 </dl><dl> 862 </dl>
863 <dl>
658 <dt>Returns:</dt> 864 <dt>Returns:</dt>
659 <dd> 865 <dd>
660 word separator characters (list of strings) 866 word separator characters (list of strings)
661 </dd> 867 </dd>
662 </dl><a NAME="DbAPIsWorker.__classesAttributesApi" ID="DbAPIsWorker.__classesAttributesApi"></a> 868 </dl>
869 <a NAME="DbAPIsWorker.__classesAttributesApi" ID="DbAPIsWorker.__classesAttributesApi"></a>
663 <h4>DbAPIsWorker.__classesAttributesApi</h4> 870 <h4>DbAPIsWorker.__classesAttributesApi</h4>
664 <b>__classesAttributesApi</b>(<i>module</i>) 871 <b>__classesAttributesApi</b>(<i>module</i>)
872
665 <p> 873 <p>
666 Private method to generate class api section for class attributes. 874 Private method to generate class api section for class attributes.
667 </p><dl> 875 </p>
876 <dl>
877
668 <dt><i>module</i></dt> 878 <dt><i>module</i></dt>
669 <dd> 879 <dd>
670 module object to get the info from (Module) 880 module object to get the info from (Module)
671 </dd> 881 </dd>
672 </dl><dl> 882 </dl>
883 <dl>
673 <dt>Returns:</dt> 884 <dt>Returns:</dt>
674 <dd> 885 <dd>
675 API information (list of strings) 886 API information (list of strings)
676 </dd> 887 </dd>
677 </dl><a NAME="DbAPIsWorker.__deleteApiFile" ID="DbAPIsWorker.__deleteApiFile"></a> 888 </dl>
889 <a NAME="DbAPIsWorker.__deleteApiFile" ID="DbAPIsWorker.__deleteApiFile"></a>
678 <h4>DbAPIsWorker.__deleteApiFile</h4> 890 <h4>DbAPIsWorker.__deleteApiFile</h4>
679 <b>__deleteApiFile</b>(<i>apiFile</i>) 891 <b>__deleteApiFile</b>(<i>apiFile</i>)
892
680 <p> 893 <p>
681 Private method to delete all references to an api file. 894 Private method to delete all references to an api file.
682 </p><dl> 895 </p>
896 <dl>
897
683 <dt><i>apiFile</i></dt> 898 <dt><i>apiFile</i></dt>
684 <dd> 899 <dd>
685 filename of the raw API file (string) 900 filename of the raw API file (string)
686 </dd> 901 </dd>
687 </dl><a NAME="DbAPIsWorker.__getApiFiles" ID="DbAPIsWorker.__getApiFiles"></a> 902 </dl>
903 <a NAME="DbAPIsWorker.__getApiFiles" ID="DbAPIsWorker.__getApiFiles"></a>
688 <h4>DbAPIsWorker.__getApiFiles</h4> 904 <h4>DbAPIsWorker.__getApiFiles</h4>
689 <b>__getApiFiles</b>(<i></i>) 905 <b>__getApiFiles</b>(<i></i>)
906
690 <p> 907 <p>
691 Private method to get a list of API files loaded into the database. 908 Private method to get a list of API files loaded into the database.
692 </p><dl> 909 </p>
910 <dl>
693 <dt>Returns:</dt> 911 <dt>Returns:</dt>
694 <dd> 912 <dd>
695 list of API filenames 913 list of API filenames
696 </dd> 914 </dd>
697 </dl><dl> 915 </dl>
916 <dl>
698 <dt>Return Type:</dt> 917 <dt>Return Type:</dt>
699 <dd> 918 <dd>
700 list of str 919 list of str
701 </dd> 920 </dd>
702 </dl><a NAME="DbAPIsWorker.__loadApiFile" ID="DbAPIsWorker.__loadApiFile"></a> 921 </dl>
922 <a NAME="DbAPIsWorker.__loadApiFile" ID="DbAPIsWorker.__loadApiFile"></a>
703 <h4>DbAPIsWorker.__loadApiFile</h4> 923 <h4>DbAPIsWorker.__loadApiFile</h4>
704 <b>__loadApiFile</b>(<i>apiFile</i>) 924 <b>__loadApiFile</b>(<i>apiFile</i>)
925
705 <p> 926 <p>
706 Private method to read a raw API file into the database. 927 Private method to read a raw API file into the database.
707 </p><dl> 928 </p>
929 <dl>
930
708 <dt><i>apiFile</i></dt> 931 <dt><i>apiFile</i></dt>
709 <dd> 932 <dd>
710 filename of the raw API file (string) 933 filename of the raw API file (string)
711 </dd> 934 </dd>
712 </dl><a NAME="DbAPIsWorker.__loadApiFileIfNewer" ID="DbAPIsWorker.__loadApiFileIfNewer"></a> 935 </dl>
936 <a NAME="DbAPIsWorker.__loadApiFileIfNewer" ID="DbAPIsWorker.__loadApiFileIfNewer"></a>
713 <h4>DbAPIsWorker.__loadApiFileIfNewer</h4> 937 <h4>DbAPIsWorker.__loadApiFileIfNewer</h4>
714 <b>__loadApiFileIfNewer</b>(<i>apiFile</i>) 938 <b>__loadApiFileIfNewer</b>(<i>apiFile</i>)
939
715 <p> 940 <p>
716 Private method to load an API file, if it is newer than the one read 941 Private method to load an API file, if it is newer than the one read
717 into the database. 942 into the database.
718 </p><dl> 943 </p>
944 <dl>
945
719 <dt><i>apiFile</i></dt> 946 <dt><i>apiFile</i></dt>
720 <dd> 947 <dd>
721 filename of the raw API file (string) 948 filename of the raw API file (string)
722 </dd> 949 </dd>
723 </dl><a NAME="DbAPIsWorker.__storeApis" ID="DbAPIsWorker.__storeApis"></a> 950 </dl>
951 <a NAME="DbAPIsWorker.__storeApis" ID="DbAPIsWorker.__storeApis"></a>
724 <h4>DbAPIsWorker.__storeApis</h4> 952 <h4>DbAPIsWorker.__storeApis</h4>
725 <b>__storeApis</b>(<i>apis, bases, apiFile, language</i>) 953 <b>__storeApis</b>(<i>apis, bases, apiFile, language</i>)
954
726 <p> 955 <p>
727 Private method to put the API entries into the database. 956 Private method to put the API entries into the database.
728 </p><dl> 957 </p>
958 <dl>
959
729 <dt><i>apis</i></dt> 960 <dt><i>apis</i></dt>
730 <dd> 961 <dd>
731 list of api entries (list of strings) 962 list of api entries (list of strings)
732 </dd><dt><i>bases</i></dt> 963 </dd>
964 <dt><i>bases</i></dt>
733 <dd> 965 <dd>
734 list of base class entries (list of strings) 966 list of base class entries (list of strings)
735 </dd><dt><i>apiFile</i></dt> 967 </dd>
968 <dt><i>apiFile</i></dt>
736 <dd> 969 <dd>
737 filename of the file read to get the APIs (string) 970 filename of the file read to get the APIs (string)
738 </dd><dt><i>language</i></dt> 971 </dd>
972 <dt><i>language</i></dt>
739 <dd> 973 <dd>
740 programming language of the file of the APIs (string) 974 programming language of the file of the APIs (string)
741 </dd> 975 </dd>
742 </dl><a NAME="DbAPIsWorker.__storeFileInfoOnly" ID="DbAPIsWorker.__storeFileInfoOnly"></a> 976 </dl>
977 <a NAME="DbAPIsWorker.__storeFileInfoOnly" ID="DbAPIsWorker.__storeFileInfoOnly"></a>
743 <h4>DbAPIsWorker.__storeFileInfoOnly</h4> 978 <h4>DbAPIsWorker.__storeFileInfoOnly</h4>
744 <b>__storeFileInfoOnly</b>(<i>apiFile</i>) 979 <b>__storeFileInfoOnly</b>(<i>apiFile</i>)
980
745 <p> 981 <p>
746 Private method to store file info only. 982 Private method to store file info only.
747 </p><p> 983 </p>
984 <p>
748 Doing this avoids rereading the file whenever the API is initialized 985 Doing this avoids rereading the file whenever the API is initialized
749 in case the given file doesn't contain API data. 986 in case the given file doesn't contain API data.
750 </p><dl> 987 </p>
988 <dl>
989
751 <dt><i>apiFile</i></dt> 990 <dt><i>apiFile</i></dt>
752 <dd> 991 <dd>
753 file name of the API file (string) 992 file name of the API file (string)
754 </dd> 993 </dd>
755 </dl><a NAME="DbAPIsWorker.abort" ID="DbAPIsWorker.abort"></a> 994 </dl>
995 <a NAME="DbAPIsWorker.abort" ID="DbAPIsWorker.abort"></a>
756 <h4>DbAPIsWorker.abort</h4> 996 <h4>DbAPIsWorker.abort</h4>
757 <b>abort</b>(<i></i>) 997 <b>abort</b>(<i></i>)
998
758 <p> 999 <p>
759 Public method to ask the thread to stop. 1000 Public method to ask the thread to stop.
760 </p><a NAME="DbAPIsWorker.run" ID="DbAPIsWorker.run"></a> 1001 </p>
1002 <a NAME="DbAPIsWorker.run" ID="DbAPIsWorker.run"></a>
761 <h4>DbAPIsWorker.run</h4> 1003 <h4>DbAPIsWorker.run</h4>
762 <b>run</b>(<i></i>) 1004 <b>run</b>(<i></i>)
1005
763 <p> 1006 <p>
764 Public method to perform the threads work. 1007 Public method to perform the threads work.
765 </p> 1008 </p>
766 <div align="right"><a href="#top">Up</a></div> 1009 <div align="right"><a href="#top">Up</a></div>
767 <hr /> 1010 <hr />

Mercurial Repository: Eric Assistant

eric ide

mercurial