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
|
<!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"/>
<title>QScintilla: QsciAbstractAPIs Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<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>
<div class="contents">
<h1>QsciAbstractAPIs Class Reference</h1><!-- doxytag: class="QsciAbstractAPIs" -->
<p>The <a class="el" href="classQsciAbstractAPIs.html" title="The QsciAbstractAPIs class represents the interface to the textual API information...">QsciAbstractAPIs</a> class represents the interface to the textual API information used in call tips and for auto-completion. A sub-class will provide the actual implementation of the interface.
<a href="#_details">More...</a></p>
<p><code>#include <qsciabstractapis.h></code></p>
<p>Inherited by <a class="el" href="classQsciAPIs.html">QsciAPIs</a>.</p>
<p><a href="classQsciAbstractAPIs-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classQsciAbstractAPIs.html#a9db5ebe8adda3f58892af676f5295e3a">QsciAbstractAPIs</a> (<a class="el" href="classQsciLexer.html">QsciLexer</a> *lexer)
<li><a class="anchor" id="a7ef866227b05482cb32c70b44e8bdec1"></a><!-- doxytag: member="QsciAbstractAPIs::~QsciAbstractAPIs" ref="a7ef866227b05482cb32c70b44e8bdec1" args="()" -->
virtual <a class="el" href="classQsciAbstractAPIs.html#a7ef866227b05482cb32c70b44e8bdec1">~QsciAbstractAPIs</a> ()
<li><a class="anchor" id="aab7f4330c918c3ae9001c89dde3dfde1"></a><!-- doxytag: member="QsciAbstractAPIs::lexer" ref="aab7f4330c918c3ae9001c89dde3dfde1" args="() const " -->
<a class="el" href="classQsciLexer.html">QsciLexer</a> * <a class="el" href="classQsciAbstractAPIs.html#aab7f4330c918c3ae9001c89dde3dfde1">lexer</a> () const
<li>virtual void <a class="el" href="classQsciAbstractAPIs.html#a62a50642b0b058016ed2fdf0922bdee8">updateAutoCompletionList</a> (const QStringList &context, QStringList &list)=0
<li>virtual void <a class="el" href="classQsciAbstractAPIs.html#a90fa0f912b748b707967ccb722f04ddc">autoCompletionSelected</a> (const QString &selection)
<li>virtual QStringList <a class="el" href="classQsciAbstractAPIs.html#af9c6c3f8dc068371398a50c6b23dcbf4">callTips</a> (const QStringList &context, int commas, <a class="el" href="classQsciScintilla.html#a62d0174cb0a07e3f2d48fc0603192668">QsciScintilla::CallTipsStyle</a> style, QList< int > &shifts)=0
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <a class="el" href="classQsciAbstractAPIs.html" title="The QsciAbstractAPIs class represents the interface to the textual API information...">QsciAbstractAPIs</a> class represents the interface to the textual API information used in call tips and for auto-completion. A sub-class will provide the actual implementation of the interface. </p>
<p>API information is specific to a particular language lexer but can be shared by multiple instances of the lexer. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9db5ebe8adda3f58892af676f5295e3a"></a><!-- doxytag: member="QsciAbstractAPIs::QsciAbstractAPIs" ref="a9db5ebe8adda3f58892af676f5295e3a" args="(QsciLexer *lexer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QsciAbstractAPIs::QsciAbstractAPIs </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="classQsciAbstractAPIs.html" title="The QsciAbstractAPIs class represents the interface to the textual API information...">QsciAbstractAPIs</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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a62a50642b0b058016ed2fdf0922bdee8"></a><!-- doxytag: member="QsciAbstractAPIs::updateAutoCompletionList" ref="a62a50642b0b058016ed2fdf0922bdee8" args="(const QStringList &context, QStringList &list)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void QsciAbstractAPIs::updateAutoCompletionList </td>
<td>(</td>
<td class="paramtype">const QStringList & </td>
<td class="paramname"> <em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QStringList & </td>
<td class="paramname"> <em>list</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the list <em>list</em> with API entries derived from <em>context</em>. <em>context</em> is the list of words in the text preceding the cursor position. The characters that make up a word and the characters that separate words are defined by the lexer. The last word is a partial word and may be empty if the user has just entered a word separator. </p>
<p>Implemented in <a class="el" href="classQsciAPIs.html#ab0f824492bb0f3ca54edb4d46945a3de">QsciAPIs</a>.</p>
</div>
</div>
<a class="anchor" id="a90fa0f912b748b707967ccb722f04ddc"></a><!-- doxytag: member="QsciAbstractAPIs::autoCompletionSelected" ref="a90fa0f912b748b707967ccb722f04ddc" args="(const QString &selection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void QsciAbstractAPIs::autoCompletionSelected </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>selection</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is called when the user selects the entry <em>selection</em> from the auto-completion list. A sub-class can use this as a hint to provide more specific API entries in future calls to <a class="el" href="classQsciAbstractAPIs.html#a62a50642b0b058016ed2fdf0922bdee8">updateAutoCompletionList()</a>. The default implementation does nothing. </p>
<p>Reimplemented in <a class="el" href="classQsciAPIs.html#adff0073d1f4ee2e0ea8b3bf234ff2dd3">QsciAPIs</a>.</p>
</div>
</div>
<a class="anchor" id="af9c6c3f8dc068371398a50c6b23dcbf4"></a><!-- doxytag: member="QsciAbstractAPIs::callTips" ref="af9c6c3f8dc068371398a50c6b23dcbf4" args="(const QStringList &context, int commas, QsciScintilla::CallTipsStyle style, QList< int > &shifts)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual QStringList QsciAbstractAPIs::callTips </td>
<td>(</td>
<td class="paramtype">const QStringList & </td>
<td class="paramname"> <em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>commas</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classQsciScintilla.html#a62d0174cb0a07e3f2d48fc0603192668">QsciScintilla::CallTipsStyle</a> </td>
<td class="paramname"> <em>style</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QList< int > & </td>
<td class="paramname"> <em>shifts</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the call tips valid for the context <em>context</em>. (Note that the last word of the context will always be empty.) <em>commas</em> is the number of commas the user has typed after the context and before the cursor position. The exact position of the list of call tips can be adjusted by specifying a corresponding left character shift in <em>shifts</em>. This is normally done to correct for any displayed context according to <em>style</em>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classQsciAbstractAPIs.html#a62a50642b0b058016ed2fdf0922bdee8">updateAutoCompletionList()</a> </dd></dl>
<p>Implemented in <a class="el" href="classQsciAPIs.html#a6a75974235c5e8d263bf962c778b3a3e">QsciAPIs</a>.</p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Jan 20 19:56:09 2010 for QScintilla by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
|
