1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>QScintilla: QsciAPIs Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">QScintilla
 <span id="projectnumber">2.9.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#signals">Signals</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classQsciAPIs-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">QsciAPIs Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <qsciapis.h></code></p>
<p>Inherits <a class="el" href="classQsciAbstractAPIs.html">QsciAbstractAPIs</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="signals"></a>
Signals</h2></td></tr>
<tr class="memitem:aaa47506820a2596004688e241fc4cd9f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAPIs.html#aaa47506820a2596004688e241fc4cd9f">apiPreparationCancelled</a> ()</td></tr>
<tr class="separator:aaa47506820a2596004688e241fc4cd9f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8fc5db618546fcfcc5bdc46e6d062995"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAPIs.html#a8fc5db618546fcfcc5bdc46e6d062995">apiPreparationStarted</a> ()</td></tr>
<tr class="separator:a8fc5db618546fcfcc5bdc46e6d062995"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adf779559d29fed004ec65ef560483e3c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAPIs.html#adf779559d29fed004ec65ef560483e3c">apiPreparationFinished</a> ()</td></tr>
<tr class="separator:adf779559d29fed004ec65ef560483e3c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aaf185d65d1034087b77995d8490b6475"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAPIs.html#aaf185d65d1034087b77995d8490b6475">QsciAPIs</a> (<a class="el" href="classQsciLexer.html">QsciLexer</a> *<a class="el" href="classQsciAbstractAPIs.html#aab7f4330c918c3ae9001c89dde3dfde1">lexer</a>)</td></tr>
<tr class="separator:aaf185d65d1034087b77995d8490b6475"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a07bc73b7a67f8f405578992bae29528c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a07bc73b7a67f8f405578992bae29528c"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAPIs.html#a07bc73b7a67f8f405578992bae29528c">~QsciAPIs</a> ()</td></tr>
<tr class="separator:a07bc73b7a67f8f405578992bae29528c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af46ca05571eb676d3aa65b080fb406c5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAPIs.html#af46ca05571eb676d3aa65b080fb406c5">add</a> (const QString &entry)</td></tr>
<tr class="separator:af46ca05571eb676d3aa65b080fb406c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b29d84b0b5d63f2b590988195c7557c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAPIs.html#a6b29d84b0b5d63f2b590988195c7557c">clear</a> ()</td></tr>
<tr class="separator:a6b29d84b0b5d63f2b590988195c7557c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3084b749e4eb1c741fc1004e8a84a631"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAPIs.html#a3084b749e4eb1c741fc1004e8a84a631">load</a> (const QString &filename)</td></tr>
<tr class="separator:a3084b749e4eb1c741fc1004e8a84a631"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acb1aa10ea05a7ee72a0d77376153b4d2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAPIs.html#acb1aa10ea05a7ee72a0d77376153b4d2">remove</a> (const QString &entry)</td></tr>
<tr class="separator:acb1aa10ea05a7ee72a0d77376153b4d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c26b8395c49cf61243e5f73c0ce577f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAPIs.html#a5c26b8395c49cf61243e5f73c0ce577f">prepare</a> ()</td></tr>
<tr class="separator:a5c26b8395c49cf61243e5f73c0ce577f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5c7c8855162eeb1be74c226ebf1b1b6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAPIs.html#aa5c7c8855162eeb1be74c226ebf1b1b6">cancelPreparation</a> ()</td></tr>
<tr class="separator:aa5c7c8855162eeb1be74c226ebf1b1b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1768bc2153e4d522dd8031543b033985"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAPIs.html#a1768bc2153e4d522dd8031543b033985">defaultPreparedName</a> () const </td></tr>
<tr class="separator:a1768bc2153e4d522dd8031543b033985"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a093f3d79ccba93b9de573a3281aa1763"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAPIs.html#a093f3d79ccba93b9de573a3281aa1763">isPrepared</a> (const QString &filename=QString()) const </td></tr>
<tr class="separator:a093f3d79ccba93b9de573a3281aa1763"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af42a26a050bfeb4249d35ab61567ea9e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAPIs.html#af42a26a050bfeb4249d35ab61567ea9e">loadPrepared</a> (const QString &filename=QString())</td></tr>
<tr class="separator:af42a26a050bfeb4249d35ab61567ea9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab35a2804e9e8e1509ff5e8896daa1d82"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAPIs.html#ab35a2804e9e8e1509ff5e8896daa1d82">savePrepared</a> (const QString &filename=QString()) const </td></tr>
<tr class="separator:ab35a2804e9e8e1509ff5e8896daa1d82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab0f824492bb0f3ca54edb4d46945a3de"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0f824492bb0f3ca54edb4d46945a3de"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAPIs.html#ab0f824492bb0f3ca54edb4d46945a3de">updateAutoCompletionList</a> (const QStringList &context, QStringList &list)</td></tr>
<tr class="separator:ab0f824492bb0f3ca54edb4d46945a3de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adff0073d1f4ee2e0ea8b3bf234ff2dd3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adff0073d1f4ee2e0ea8b3bf234ff2dd3"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAPIs.html#adff0073d1f4ee2e0ea8b3bf234ff2dd3">autoCompletionSelected</a> (const QString &sel)</td></tr>
<tr class="separator:adff0073d1f4ee2e0ea8b3bf234ff2dd3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6a75974235c5e8d263bf962c778b3a3e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a75974235c5e8d263bf962c778b3a3e"></a>
virtual QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAPIs.html#a6a75974235c5e8d263bf962c778b3a3e">callTips</a> (const QStringList &context, int commas, <a class="el" href="classQsciScintilla.html#a62d0174cb0a07e3f2d48fc0603192668">QsciScintilla::CallTipsStyle</a> style, QList< int > &shifts)</td></tr>
<tr class="separator:a6a75974235c5e8d263bf962c778b3a3e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aade407551cb7e9e116e098f08ef5d26c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aade407551cb7e9e116e098f08ef5d26c"></a>
virtual bool </td><td class="memItemRight" valign="bottom"><b>event</b> (QEvent *e)</td></tr>
<tr class="separator:aade407551cb7e9e116e098f08ef5d26c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af46f094f729bf246a2ffad6dbadf7f65"><td class="memItemLeft" align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAPIs.html#af46f094f729bf246a2ffad6dbadf7f65">installedAPIFiles</a> () const </td></tr>
<tr class="separator:af46f094f729bf246a2ffad6dbadf7f65"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classQsciAbstractAPIs"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classQsciAbstractAPIs')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classQsciAbstractAPIs.html">QsciAbstractAPIs</a></td></tr>
<tr class="memitem:a9db5ebe8adda3f58892af676f5295e3a inherit pub_methods_classQsciAbstractAPIs"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAbstractAPIs.html#a9db5ebe8adda3f58892af676f5295e3a">QsciAbstractAPIs</a> (<a class="el" href="classQsciLexer.html">QsciLexer</a> *<a class="el" href="classQsciAbstractAPIs.html#aab7f4330c918c3ae9001c89dde3dfde1">lexer</a>)</td></tr>
<tr class="separator:a9db5ebe8adda3f58892af676f5295e3a inherit pub_methods_classQsciAbstractAPIs"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ef866227b05482cb32c70b44e8bdec1 inherit pub_methods_classQsciAbstractAPIs"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7ef866227b05482cb32c70b44e8bdec1"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAbstractAPIs.html#a7ef866227b05482cb32c70b44e8bdec1">~QsciAbstractAPIs</a> ()</td></tr>
<tr class="separator:a7ef866227b05482cb32c70b44e8bdec1 inherit pub_methods_classQsciAbstractAPIs"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aab7f4330c918c3ae9001c89dde3dfde1 inherit pub_methods_classQsciAbstractAPIs"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aab7f4330c918c3ae9001c89dde3dfde1"></a>
<a class="el" href="classQsciLexer.html">QsciLexer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classQsciAbstractAPIs.html#aab7f4330c918c3ae9001c89dde3dfde1">lexer</a> () const </td></tr>
<tr class="separator:aab7f4330c918c3ae9001c89dde3dfde1 inherit pub_methods_classQsciAbstractAPIs"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classQsciAPIs.html" title="The QsciAPIs class provies an implementation of the textual API information used in call tips and for...">QsciAPIs</a> class provies an implementation of the textual API information used in call tips and for auto-completion. </p>
<p>Raw API information is read from one or more files. Each API function is described by a single line of text comprising the function's name, followed by the function's optional comma separated parameters enclosed in parenthesis, and finally followed by optional explanatory text.</p>
<p>A function name may be followed by a `?' and a number. The number is used by auto-completion to display a registered QPixmap with the function name.</p>
<p>All function names are used by auto-completion, but only those that include function parameters are used in call tips.</p>
<p>QScintilla only deals with prepared API information and not the raw information described above. This is done so that large APIs can be handled while still being responsive to user input. The conversion of raw information to prepared information is time consuming (think tens of seconds) and implemented in a separate thread. Prepared information can be quickly saved to and loaded from files. Such files are portable between different architectures.</p>
<p>QScintilla based applications that want to support large APIs would normally provide the user with the ability to specify a set of, possibly project specific, raw API files and convert them to prepared files that are loaded quickly when the application is invoked. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="aaf185d65d1034087b77995d8490b6475"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QsciAPIs::QsciAPIs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classQsciLexer.html">QsciLexer</a> * </td>
<td class="paramname"><em>lexer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a <a class="el" href="classQsciAPIs.html" title="The QsciAPIs class provies an implementation of the textual API information used in call tips and for...">QsciAPIs</a> instance attached to lexer <em>lexer</em>. <em>lexer</em> becomes the instance's parent object although the instance can also be subsequently attached to other lexers. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af46ca05571eb676d3aa65b080fb406c5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void QsciAPIs::add </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>entry</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add the single raw API entry <em>entry</em> to the current set.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classQsciAPIs.html#a6b29d84b0b5d63f2b590988195c7557c">clear()</a>, <a class="el" href="classQsciAPIs.html#a3084b749e4eb1c741fc1004e8a84a631">load()</a>, <a class="el" href="classQsciAPIs.html#acb1aa10ea05a7ee72a0d77376153b4d2">remove()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a6b29d84b0b5d63f2b590988195c7557c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void QsciAPIs::clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deletes all raw API information.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classQsciAPIs.html#af46ca05571eb676d3aa65b080fb406c5">add()</a>, <a class="el" href="classQsciAPIs.html#a3084b749e4eb1c741fc1004e8a84a631">load()</a>, <a class="el" href="classQsciAPIs.html#acb1aa10ea05a7ee72a0d77376153b4d2">remove()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a3084b749e4eb1c741fc1004e8a84a631"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool QsciAPIs::load </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load the API information from the file named <em>filename</em>, adding it to the current set. Returns true if successful, otherwise false. </p>
</div>
</div>
<a class="anchor" id="acb1aa10ea05a7ee72a0d77376153b4d2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void QsciAPIs::remove </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>entry</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove the single raw API entry <em>entry</em> from the current set.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classQsciAPIs.html#af46ca05571eb676d3aa65b080fb406c5">add()</a>, <a class="el" href="classQsciAPIs.html#a6b29d84b0b5d63f2b590988195c7557c">clear()</a>, <a class="el" href="classQsciAPIs.html#a3084b749e4eb1c741fc1004e8a84a631">load()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a5c26b8395c49cf61243e5f73c0ce577f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void QsciAPIs::prepare </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert the current raw API information to prepared API information. This is implemented by a separate thread.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classQsciAPIs.html#aa5c7c8855162eeb1be74c226ebf1b1b6">cancelPreparation()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aa5c7c8855162eeb1be74c226ebf1b1b6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void QsciAPIs::cancelPreparation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Cancel the conversion of the current raw API information to prepared API information.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classQsciAPIs.html#a5c26b8395c49cf61243e5f73c0ce577f">prepare()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1768bc2153e4d522dd8031543b033985"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString QsciAPIs::defaultPreparedName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the default name of the prepared API information file. It is based on the name of the associated lexer and in the directory defined by the QSCIDIR environment variable. If the environment variable isn't set then $HOME/.qsci is used. </p>
</div>
</div>
<a class="anchor" id="a093f3d79ccba93b9de573a3281aa1763"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool QsciAPIs::isPrepared </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>filename</em> = <code>QString()</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Check to see is a prepared API information file named <em>filename</em> exists. If <em>filename</em> is empty then the value returned by <a class="el" href="classQsciAPIs.html#a1768bc2153e4d522dd8031543b033985">defaultPreparedName()</a> is used. Returns true if successful, otherwise false.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classQsciAPIs.html#a1768bc2153e4d522dd8031543b033985">defaultPreparedName()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="af42a26a050bfeb4249d35ab61567ea9e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool QsciAPIs::loadPrepared </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>filename</em> = <code>QString()</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load the prepared API information from the file named <em>filename</em>. If <em>filename</em> is empty then a name is constructed based on the name of the associated lexer and saved in the directory defined by the QSCIDIR environment variable. If the environment variable isn't set then $HOME/.qsci is used. Returns true if successful, otherwise false. </p>
</div>
</div>
<a class="anchor" id="ab35a2804e9e8e1509ff5e8896daa1d82"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool QsciAPIs::savePrepared </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>filename</em> = <code>QString()</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Save the prepared API information to the file named <em>filename</em>. If <em>filename</em> is empty then a name is constructed based on the name of the associated lexer and saved in the directory defined by the QSCIDIR environment variable. If the environment variable isn't set then $HOME/.qsci is used. Returns true if successful, otherwise false. </p>
</div>
</div>
<a class="anchor" id="af46f094f729bf246a2ffad6dbadf7f65"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QStringList QsciAPIs::installedAPIFiles </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a list of the installed raw API file names for the associated lexer. </p>
</div>
</div>
<a class="anchor" id="aaa47506820a2596004688e241fc4cd9f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void QsciAPIs::apiPreparationCancelled </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This signal is emitted when the conversion of raw API information to prepared API information has been cancelled.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classQsciAPIs.html#adf779559d29fed004ec65ef560483e3c">apiPreparationFinished()</a>, <a class="el" href="classQsciAPIs.html#a8fc5db618546fcfcc5bdc46e6d062995">apiPreparationStarted()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a8fc5db618546fcfcc5bdc46e6d062995"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void QsciAPIs::apiPreparationStarted </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This signal is emitted when the conversion of raw API information to prepared API information starts and can be used to give some visual feedback to the user.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classQsciAPIs.html#aaa47506820a2596004688e241fc4cd9f">apiPreparationCancelled()</a>, <a class="el" href="classQsciAPIs.html#adf779559d29fed004ec65ef560483e3c">apiPreparationFinished()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="adf779559d29fed004ec65ef560483e3c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void QsciAPIs::apiPreparationFinished </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This signal is emitted when the conversion of raw API information to prepared API information has finished.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classQsciAPIs.html#aaa47506820a2596004688e241fc4cd9f">apiPreparationCancelled()</a>, <a class="el" href="classQsciAPIs.html#a8fc5db618546fcfcc5bdc46e6d062995">apiPreparationStarted()</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Oct 24 2015 14:00:38 for QScintilla by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
|
