Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerPygments.html

src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerPygments.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9295
d14096c04126
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.QScintilla.Lexers.LexerPygments</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.QScintilla.Lexers.LexerPygments</h1>
10
11 <p>
12 Module implementing a custom lexer using pygments.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>PYGMENTS_ATTRIBUTE</td></tr><tr><td>PYGMENTS_BACKTICKSTRING</td></tr><tr><td>PYGMENTS_BUILTIN</td></tr><tr><td>PYGMENTS_CHAR</td></tr><tr><td>PYGMENTS_CLASS</td></tr><tr><td>PYGMENTS_COMMENT</td></tr><tr><td>PYGMENTS_CONSTANT</td></tr><tr><td>PYGMENTS_DECORATOR</td></tr><tr><td>PYGMENTS_DEFAULT</td></tr><tr><td>PYGMENTS_DELETED</td></tr><tr><td>PYGMENTS_DOCSTRING</td></tr><tr><td>PYGMENTS_DOUBLESTRING</td></tr><tr><td>PYGMENTS_EMPHASIZE</td></tr><tr><td>PYGMENTS_ENTITY</td></tr><tr><td>PYGMENTS_ERROR</td></tr><tr><td>PYGMENTS_ESCAPE</td></tr><tr><td>PYGMENTS_EXCEPTION</td></tr><tr><td>PYGMENTS_FUNCTION</td></tr><tr><td>PYGMENTS_GENERIC_ERROR</td></tr><tr><td>PYGMENTS_HASHBANG</td></tr><tr><td>PYGMENTS_HEADING</td></tr><tr><td>PYGMENTS_HEREDOC</td></tr><tr><td>PYGMENTS_INSERTED</td></tr><tr><td>PYGMENTS_KEYWORD</td></tr><tr><td>PYGMENTS_LABEL</td></tr><tr><td>PYGMENTS_LITERAL</td></tr><tr><td>PYGMENTS_MULTILINECOMMENT</td></tr><tr><td>PYGMENTS_NAMESPACE</td></tr><tr><td>PYGMENTS_NUMBER</td></tr><tr><td>PYGMENTS_OPERATOR</td></tr><tr><td>PYGMENTS_OTHER</td></tr><tr><td>PYGMENTS_OUTPUT</td></tr><tr><td>PYGMENTS_PREPROCESSOR</td></tr><tr><td>PYGMENTS_PROMPT</td></tr><tr><td>PYGMENTS_PROPERTY</td></tr><tr><td>PYGMENTS_PSEUDOKEYWORD</td></tr><tr><td>PYGMENTS_PUNCTUATION</td></tr><tr><td>PYGMENTS_REGEX</td></tr><tr><td>PYGMENTS_RESERVEDKEYWORD</td></tr><tr><td>PYGMENTS_SCALAR</td></tr><tr><td>PYGMENTS_SINGLESTRING</td></tr><tr><td>PYGMENTS_STRING</td></tr><tr><td>PYGMENTS_STRONG</td></tr><tr><td>PYGMENTS_SUBHEADING</td></tr><tr><td>PYGMENTS_SYMBOL</td></tr><tr><td>PYGMENTS_TAG</td></tr><tr><td>PYGMENTS_TRACEBACK</td></tr><tr><td>PYGMENTS_TYPEKEYWORD</td></tr><tr><td>PYGMENTS_VARIABLE</td></tr><tr><td>PYGMENTS_WHITESPACE</td></tr><tr><td>PYGMENTS_WORD</td></tr><tr><td>TOKEN_MAP</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#LexerPygments">LexerPygments</a></td>
25 <td>Class implementing a custom lexer using pygments.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="LexerPygments" ID="LexerPygments"></a>
36 <h2>LexerPygments</h2>
37
38 <p>
39 Class implementing a custom lexer using pygments.
40 </p>
41 <h3>Derived from</h3>
42 LexerContainer
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#LexerPygments.__init__">LexerPygments</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#LexerPygments.__guessLexer">__guessLexer</a></td>
63 <td>Private method to guess a pygments lexer.</td>
64 </tr>
65 <tr>
66 <td><a href="#LexerPygments.canStyle">canStyle</a></td>
67 <td>Public method to check, if the lexer is able to style the text.</td>
68 </tr>
69 <tr>
70 <td><a href="#LexerPygments.defaultColor">defaultColor</a></td>
71 <td>Public method to get the default foreground color for a style.</td>
72 </tr>
73 <tr>
74 <td><a href="#LexerPygments.defaultEolFill">defaultEolFill</a></td>
75 <td>Public method to get the default fill to eol flag.</td>
76 </tr>
77 <tr>
78 <td><a href="#LexerPygments.defaultFont">defaultFont</a></td>
79 <td>Public method to get the default font for a style.</td>
80 </tr>
81 <tr>
82 <td><a href="#LexerPygments.defaultKeywords">defaultKeywords</a></td>
83 <td>Public method to get the default keywords.</td>
84 </tr>
85 <tr>
86 <td><a href="#LexerPygments.defaultPaper">defaultPaper</a></td>
87 <td>Public method to get the default background color for a style.</td>
88 </tr>
89 <tr>
90 <td><a href="#LexerPygments.description">description</a></td>
91 <td>Public method returning the descriptions of the styles supported by the lexer.</td>
92 </tr>
93 <tr>
94 <td><a href="#LexerPygments.isCommentStyle">isCommentStyle</a></td>
95 <td>Public method to check, if a style is a comment style.</td>
96 </tr>
97 <tr>
98 <td><a href="#LexerPygments.isStringStyle">isStringStyle</a></td>
99 <td>Public method to check, if a style is a string style.</td>
100 </tr>
101 <tr>
102 <td><a href="#LexerPygments.language">language</a></td>
103 <td>Public method returning the language of the lexer.</td>
104 </tr>
105 <tr>
106 <td><a href="#LexerPygments.name">name</a></td>
107 <td>Public method to get the name of the pygments lexer.</td>
108 </tr>
109 <tr>
110 <td><a href="#LexerPygments.readSettings">readSettings</a></td>
111 <td>Public method to read the lexer settings.</td>
112 </tr>
113 <tr>
114 <td><a href="#LexerPygments.styleText">styleText</a></td>
115 <td>Public method to perform the styling.</td>
116 </tr>
117 </table>
118 <h3>Static Methods</h3>
119
120 <table>
121 <tr><td>None</td></tr>
122 </table>
123
124 <a NAME="LexerPygments.__init__" ID="LexerPygments.__init__"></a>
125 <h4>LexerPygments (Constructor)</h4>
126 <b>LexerPygments</b>(<i>parent=None, name=""</i>)
127
128 <p>
129 Constructor
130 </p>
131 <dl>
132
133 <dt><i>parent</i></dt>
134 <dd>
135 parent widget of this lexer
136 </dd>
137 <dt><i>name</i></dt>
138 <dd>
139 name of the pygments lexer to use (string)
140 </dd>
141 </dl>
142 <a NAME="LexerPygments.__guessLexer" ID="LexerPygments.__guessLexer"></a>
143 <h4>LexerPygments.__guessLexer</h4>
144 <b>__guessLexer</b>(<i>text</i>)
145
146 <p>
147 Private method to guess a pygments lexer.
148 </p>
149 <dl>
150
151 <dt><i>text</i></dt>
152 <dd>
153 text to base guessing on (string)
154 </dd>
155 </dl>
156 <dl>
157 <dt>Return:</dt>
158 <dd>
159 reference to the guessed lexer (pygments.lexer)
160 </dd>
161 </dl>
162 <a NAME="LexerPygments.canStyle" ID="LexerPygments.canStyle"></a>
163 <h4>LexerPygments.canStyle</h4>
164 <b>canStyle</b>(<i></i>)
165
166 <p>
167 Public method to check, if the lexer is able to style the text.
168 </p>
169 <dl>
170 <dt>Return:</dt>
171 <dd>
172 flag indicating the lexer capability (boolean)
173 </dd>
174 </dl>
175 <a NAME="LexerPygments.defaultColor" ID="LexerPygments.defaultColor"></a>
176 <h4>LexerPygments.defaultColor</h4>
177 <b>defaultColor</b>(<i>style</i>)
178
179 <p>
180 Public method to get the default foreground color for a style.
181 </p>
182 <dl>
183
184 <dt><i>style</i></dt>
185 <dd>
186 style number (integer)
187 </dd>
188 </dl>
189 <dl>
190 <dt>Return:</dt>
191 <dd>
192 foreground color (QColor)
193 </dd>
194 </dl>
195 <a NAME="LexerPygments.defaultEolFill" ID="LexerPygments.defaultEolFill"></a>
196 <h4>LexerPygments.defaultEolFill</h4>
197 <b>defaultEolFill</b>(<i>style</i>)
198
199 <p>
200 Public method to get the default fill to eol flag.
201 </p>
202 <dl>
203
204 <dt><i>style</i></dt>
205 <dd>
206 style number (integer)
207 </dd>
208 </dl>
209 <dl>
210 <dt>Return:</dt>
211 <dd>
212 fill to eol flag (boolean)
213 </dd>
214 </dl>
215 <a NAME="LexerPygments.defaultFont" ID="LexerPygments.defaultFont"></a>
216 <h4>LexerPygments.defaultFont</h4>
217 <b>defaultFont</b>(<i>style</i>)
218
219 <p>
220 Public method to get the default font for a style.
221 </p>
222 <dl>
223
224 <dt><i>style</i></dt>
225 <dd>
226 style number (integer)
227 </dd>
228 </dl>
229 <dl>
230 <dt>Return:</dt>
231 <dd>
232 font (QFont)
233 </dd>
234 </dl>
235 <a NAME="LexerPygments.defaultKeywords" ID="LexerPygments.defaultKeywords"></a>
236 <h4>LexerPygments.defaultKeywords</h4>
237 <b>defaultKeywords</b>(<i>kwSet</i>)
238
239 <p>
240 Public method to get the default keywords.
241 </p>
242 <dl>
243
244 <dt><i>kwSet</i></dt>
245 <dd>
246 number of the keyword set (integer)
247 </dd>
248 </dl>
249 <dl>
250 <dt>Return:</dt>
251 <dd>
252 string giving the keywords (string) or None
253 </dd>
254 </dl>
255 <a NAME="LexerPygments.defaultPaper" ID="LexerPygments.defaultPaper"></a>
256 <h4>LexerPygments.defaultPaper</h4>
257 <b>defaultPaper</b>(<i>style</i>)
258
259 <p>
260 Public method to get the default background color for a style.
261 </p>
262 <dl>
263
264 <dt><i>style</i></dt>
265 <dd>
266 style number (integer)
267 </dd>
268 </dl>
269 <dl>
270 <dt>Return:</dt>
271 <dd>
272 background color (QColor)
273 </dd>
274 </dl>
275 <a NAME="LexerPygments.description" ID="LexerPygments.description"></a>
276 <h4>LexerPygments.description</h4>
277 <b>description</b>(<i>style</i>)
278
279 <p>
280 Public method returning the descriptions of the styles supported
281 by the lexer.
282 </p>
283 <dl>
284
285 <dt><i>style</i></dt>
286 <dd>
287 style number (integer)
288 </dd>
289 </dl>
290 <dl>
291 <dt>Return:</dt>
292 <dd>
293 description for the style (string)
294 </dd>
295 </dl>
296 <a NAME="LexerPygments.isCommentStyle" ID="LexerPygments.isCommentStyle"></a>
297 <h4>LexerPygments.isCommentStyle</h4>
298 <b>isCommentStyle</b>(<i>style</i>)
299
300 <p>
301 Public method to check, if a style is a comment style.
302 </p>
303 <dl>
304
305 <dt><i>style</i></dt>
306 <dd>
307 style to check (integer)
308 </dd>
309 </dl>
310 <dl>
311 <dt>Return:</dt>
312 <dd>
313 flag indicating a comment style (boolean)
314 </dd>
315 </dl>
316 <a NAME="LexerPygments.isStringStyle" ID="LexerPygments.isStringStyle"></a>
317 <h4>LexerPygments.isStringStyle</h4>
318 <b>isStringStyle</b>(<i>style</i>)
319
320 <p>
321 Public method to check, if a style is a string style.
322 </p>
323 <dl>
324
325 <dt><i>style</i></dt>
326 <dd>
327 style to check (integer)
328 </dd>
329 </dl>
330 <dl>
331 <dt>Return:</dt>
332 <dd>
333 flag indicating a string style (boolean)
334 </dd>
335 </dl>
336 <a NAME="LexerPygments.language" ID="LexerPygments.language"></a>
337 <h4>LexerPygments.language</h4>
338 <b>language</b>(<i></i>)
339
340 <p>
341 Public method returning the language of the lexer.
342 </p>
343 <dl>
344 <dt>Return:</dt>
345 <dd>
346 language of the lexer (string)
347 </dd>
348 </dl>
349 <a NAME="LexerPygments.name" ID="LexerPygments.name"></a>
350 <h4>LexerPygments.name</h4>
351 <b>name</b>(<i></i>)
352
353 <p>
354 Public method to get the name of the pygments lexer.
355 </p>
356 <dl>
357 <dt>Return:</dt>
358 <dd>
359 name of the pygments lexer (string)
360 </dd>
361 </dl>
362 <a NAME="LexerPygments.readSettings" ID="LexerPygments.readSettings"></a>
363 <h4>LexerPygments.readSettings</h4>
364 <b>readSettings</b>(<i>qs, prefix="/Scintilla"</i>)
365
366 <p>
367 Public method to read the lexer settings.
368 </p>
369 <p>
370 Note: Overridden to treat the Pygments lexer specially.
371 </p>
372 <dl>
373
374 <dt><i>qs</i> (QSettings)</dt>
375 <dd>
376 reference to the settings object
377 </dd>
378 <dt><i>prefix</i> (str (optional))</dt>
379 <dd>
380 prefix for the settings key (defaults to "/Scintilla")
381 </dd>
382 </dl>
383 <a NAME="LexerPygments.styleText" ID="LexerPygments.styleText"></a>
384 <h4>LexerPygments.styleText</h4>
385 <b>styleText</b>(<i>start, end</i>)
386
387 <p>
388 Public method to perform the styling.
389 </p>
390 <dl>
391
392 <dt><i>start</i></dt>
393 <dd>
394 position of first character to be styled (integer)
395 </dd>
396 <dt><i>end</i></dt>
397 <dd>
398 position of last character to be styled (integer)
399 </dd>
400 </dl>
401 <div align="right"><a href="#top">Up</a></div>
402 <hr />
403 </body></html>

Mercurial Repository: eric

eric ide

mercurial