Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.QScintilla.Lexers.LexerPygments.html

Documentation/Source/eric6.QScintilla.Lexers.LexerPygments.html

changeset 3673
e26d7d0c1088
child 4697
c2e9bf425554
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.QScintilla.Lexers.LexerPygments</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.QScintilla.Lexers.LexerPygments</h1>
23 <p>
24 Module implementing a custom lexer using pygments.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>PYGMENTS_ATTRIBUTE</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_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_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_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_SCALAR</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_WORD</td></tr><tr><td>TOKEN_MAP</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#LexerPygments">LexerPygments</a></td>
34 <td>Class implementing a custom lexer using pygments.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="LexerPygments" ID="LexerPygments"></a>
43 <h2>LexerPygments</h2>
44 <p>
45 Class implementing a custom lexer using pygments.
46 </p>
47 <h3>Derived from</h3>
48 LexerContainer
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#LexerPygments.__init__">LexerPygments</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#LexerPygments.__guessLexer">__guessLexer</a></td>
64 <td>Private method to guess a pygments lexer.</td>
65 </tr><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><tr>
69 <td><a href="#LexerPygments.defaultColor">defaultColor</a></td>
70 <td>Public method to get the default foreground color for a style.</td>
71 </tr><tr>
72 <td><a href="#LexerPygments.defaultEolFill">defaultEolFill</a></td>
73 <td>Public method to get the default fill to eol flag.</td>
74 </tr><tr>
75 <td><a href="#LexerPygments.defaultFont">defaultFont</a></td>
76 <td>Public method to get the default font for a style.</td>
77 </tr><tr>
78 <td><a href="#LexerPygments.defaultKeywords">defaultKeywords</a></td>
79 <td>Public method to get the default keywords.</td>
80 </tr><tr>
81 <td><a href="#LexerPygments.defaultPaper">defaultPaper</a></td>
82 <td>Public method to get the default background color for a style.</td>
83 </tr><tr>
84 <td><a href="#LexerPygments.description">description</a></td>
85 <td>Public method returning the descriptions of the styles supported by the lexer.</td>
86 </tr><tr>
87 <td><a href="#LexerPygments.isCommentStyle">isCommentStyle</a></td>
88 <td>Public method to check, if a style is a comment style.</td>
89 </tr><tr>
90 <td><a href="#LexerPygments.isStringStyle">isStringStyle</a></td>
91 <td>Public method to check, if a style is a string style.</td>
92 </tr><tr>
93 <td><a href="#LexerPygments.language">language</a></td>
94 <td>Public method returning the language of the lexer.</td>
95 </tr><tr>
96 <td><a href="#LexerPygments.name">name</a></td>
97 <td>Public method to get the name of the pygments lexer.</td>
98 </tr><tr>
99 <td><a href="#LexerPygments.styleBitsNeeded">styleBitsNeeded</a></td>
100 <td>Public method to get the number of style bits needed by the lexer.</td>
101 </tr><tr>
102 <td><a href="#LexerPygments.styleText">styleText</a></td>
103 <td>Public method to perform the styling.</td>
104 </tr>
105 </table>
106 <h3>Static Methods</h3>
107 <table>
108 <tr><td>None</td></tr>
109 </table>
110 <a NAME="LexerPygments.__init__" ID="LexerPygments.__init__"></a>
111 <h4>LexerPygments (Constructor)</h4>
112 <b>LexerPygments</b>(<i>parent=None, name=""</i>)
113 <p>
114 Constructor
115 </p><dl>
116 <dt><i>parent</i></dt>
117 <dd>
118 parent widget of this lexer
119 </dd><dt><i>name=</i></dt>
120 <dd>
121 name of the pygments lexer to use (string)
122 </dd>
123 </dl><a NAME="LexerPygments.__guessLexer" ID="LexerPygments.__guessLexer"></a>
124 <h4>LexerPygments.__guessLexer</h4>
125 <b>__guessLexer</b>(<i>text</i>)
126 <p>
127 Private method to guess a pygments lexer.
128 </p><dl>
129 <dt><i>text</i></dt>
130 <dd>
131 text to base guessing on (string)
132 </dd>
133 </dl><dl>
134 <dt>Returns:</dt>
135 <dd>
136 reference to the guessed lexer (pygments.lexer)
137 </dd>
138 </dl><a NAME="LexerPygments.canStyle" ID="LexerPygments.canStyle"></a>
139 <h4>LexerPygments.canStyle</h4>
140 <b>canStyle</b>(<i></i>)
141 <p>
142 Public method to check, if the lexer is able to style the text.
143 </p><dl>
144 <dt>Returns:</dt>
145 <dd>
146 flag indicating the lexer capability (boolean)
147 </dd>
148 </dl><a NAME="LexerPygments.defaultColor" ID="LexerPygments.defaultColor"></a>
149 <h4>LexerPygments.defaultColor</h4>
150 <b>defaultColor</b>(<i>style</i>)
151 <p>
152 Public method to get the default foreground color for a style.
153 </p><dl>
154 <dt><i>style</i></dt>
155 <dd>
156 style number (integer)
157 </dd>
158 </dl><dl>
159 <dt>Returns:</dt>
160 <dd>
161 foreground color (QColor)
162 </dd>
163 </dl><a NAME="LexerPygments.defaultEolFill" ID="LexerPygments.defaultEolFill"></a>
164 <h4>LexerPygments.defaultEolFill</h4>
165 <b>defaultEolFill</b>(<i>style</i>)
166 <p>
167 Public method to get the default fill to eol flag.
168 </p><dl>
169 <dt><i>style</i></dt>
170 <dd>
171 style number (integer)
172 </dd>
173 </dl><dl>
174 <dt>Returns:</dt>
175 <dd>
176 fill to eol flag (boolean)
177 </dd>
178 </dl><a NAME="LexerPygments.defaultFont" ID="LexerPygments.defaultFont"></a>
179 <h4>LexerPygments.defaultFont</h4>
180 <b>defaultFont</b>(<i>style</i>)
181 <p>
182 Public method to get the default font for a style.
183 </p><dl>
184 <dt><i>style</i></dt>
185 <dd>
186 style number (integer)
187 </dd>
188 </dl><dl>
189 <dt>Returns:</dt>
190 <dd>
191 font (QFont)
192 </dd>
193 </dl><a NAME="LexerPygments.defaultKeywords" ID="LexerPygments.defaultKeywords"></a>
194 <h4>LexerPygments.defaultKeywords</h4>
195 <b>defaultKeywords</b>(<i>kwSet</i>)
196 <p>
197 Public method to get the default keywords.
198 </p><dl>
199 <dt><i>kwSet</i></dt>
200 <dd>
201 number of the keyword set (integer)
202 </dd>
203 </dl><dl>
204 <dt>Returns:</dt>
205 <dd>
206 string giving the keywords (string) or None
207 </dd>
208 </dl><a NAME="LexerPygments.defaultPaper" ID="LexerPygments.defaultPaper"></a>
209 <h4>LexerPygments.defaultPaper</h4>
210 <b>defaultPaper</b>(<i>style</i>)
211 <p>
212 Public method to get the default background color for a style.
213 </p><dl>
214 <dt><i>style</i></dt>
215 <dd>
216 style number (integer)
217 </dd>
218 </dl><dl>
219 <dt>Returns:</dt>
220 <dd>
221 background color (QColor)
222 </dd>
223 </dl><a NAME="LexerPygments.description" ID="LexerPygments.description"></a>
224 <h4>LexerPygments.description</h4>
225 <b>description</b>(<i>style</i>)
226 <p>
227 Public method returning the descriptions of the styles supported
228 by the lexer.
229 </p><dl>
230 <dt><i>style</i></dt>
231 <dd>
232 style number (integer)
233 </dd>
234 </dl><dl>
235 <dt>Returns:</dt>
236 <dd>
237 description for the style (string)
238 </dd>
239 </dl><a NAME="LexerPygments.isCommentStyle" ID="LexerPygments.isCommentStyle"></a>
240 <h4>LexerPygments.isCommentStyle</h4>
241 <b>isCommentStyle</b>(<i>style</i>)
242 <p>
243 Public method to check, if a style is a comment style.
244 </p><dl>
245 <dt><i>style</i></dt>
246 <dd>
247 style to check (integer)
248 </dd>
249 </dl><dl>
250 <dt>Returns:</dt>
251 <dd>
252 flag indicating a comment style (boolean)
253 </dd>
254 </dl><a NAME="LexerPygments.isStringStyle" ID="LexerPygments.isStringStyle"></a>
255 <h4>LexerPygments.isStringStyle</h4>
256 <b>isStringStyle</b>(<i>style</i>)
257 <p>
258 Public method to check, if a style is a string style.
259 </p><dl>
260 <dt><i>style</i></dt>
261 <dd>
262 style to check (integer)
263 </dd>
264 </dl><dl>
265 <dt>Returns:</dt>
266 <dd>
267 flag indicating a string style (boolean)
268 </dd>
269 </dl><a NAME="LexerPygments.language" ID="LexerPygments.language"></a>
270 <h4>LexerPygments.language</h4>
271 <b>language</b>(<i></i>)
272 <p>
273 Public method returning the language of the lexer.
274 </p><dl>
275 <dt>Returns:</dt>
276 <dd>
277 language of the lexer (string)
278 </dd>
279 </dl><a NAME="LexerPygments.name" ID="LexerPygments.name"></a>
280 <h4>LexerPygments.name</h4>
281 <b>name</b>(<i></i>)
282 <p>
283 Public method to get the name of the pygments lexer.
284 </p><dl>
285 <dt>Returns:</dt>
286 <dd>
287 name of the pygments lexer (string)
288 </dd>
289 </dl><a NAME="LexerPygments.styleBitsNeeded" ID="LexerPygments.styleBitsNeeded"></a>
290 <h4>LexerPygments.styleBitsNeeded</h4>
291 <b>styleBitsNeeded</b>(<i></i>)
292 <p>
293 Public method to get the number of style bits needed by the lexer.
294 </p><dl>
295 <dt>Returns:</dt>
296 <dd>
297 number of style bits needed (integer)
298 </dd>
299 </dl><a NAME="LexerPygments.styleText" ID="LexerPygments.styleText"></a>
300 <h4>LexerPygments.styleText</h4>
301 <b>styleText</b>(<i>start, end</i>)
302 <p>
303 Public method to perform the styling.
304 </p><dl>
305 <dt><i>start</i></dt>
306 <dd>
307 position of first character to be styled (integer)
308 </dd><dt><i>end</i></dt>
309 <dd>
310 position of last character to be styled (integer)
311 </dd>
312 </dl>
313 <div align="right"><a href="#top">Up</a></div>
314 <hr />
315 </body></html>

Mercurial Repository: eric

eric ide

mercurial