Mercurial Repositories > eric / file comparison

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

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

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
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_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>
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.styleText">styleText</a></td>
100 <td>Public method to perform the styling.</td>
101 </tr>
102 </table>
103 <h3>Static Methods</h3>
104 <table>
105 <tr><td>None</td></tr>
106 </table>
107 <a NAME="LexerPygments.__init__" ID="LexerPygments.__init__"></a>
108 <h4>LexerPygments (Constructor)</h4>
109 <b>LexerPygments</b>(<i>parent=None, name=""</i>)
110 <p>
111 Constructor
112 </p><dl>
113 <dt><i>parent</i></dt>
114 <dd>
115 parent widget of this lexer
116 </dd><dt><i>name=</i></dt>
117 <dd>
118 name of the pygments lexer to use (string)
119 </dd>
120 </dl><a NAME="LexerPygments.__guessLexer" ID="LexerPygments.__guessLexer"></a>
121 <h4>LexerPygments.__guessLexer</h4>
122 <b>__guessLexer</b>(<i>text</i>)
123 <p>
124 Private method to guess a pygments lexer.
125 </p><dl>
126 <dt><i>text</i></dt>
127 <dd>
128 text to base guessing on (string)
129 </dd>
130 </dl><dl>
131 <dt>Returns:</dt>
132 <dd>
133 reference to the guessed lexer (pygments.lexer)
134 </dd>
135 </dl><a NAME="LexerPygments.canStyle" ID="LexerPygments.canStyle"></a>
136 <h4>LexerPygments.canStyle</h4>
137 <b>canStyle</b>(<i></i>)
138 <p>
139 Public method to check, if the lexer is able to style the text.
140 </p><dl>
141 <dt>Returns:</dt>
142 <dd>
143 flag indicating the lexer capability (boolean)
144 </dd>
145 </dl><a NAME="LexerPygments.defaultColor" ID="LexerPygments.defaultColor"></a>
146 <h4>LexerPygments.defaultColor</h4>
147 <b>defaultColor</b>(<i>style</i>)
148 <p>
149 Public method to get the default foreground color for a style.
150 </p><dl>
151 <dt><i>style</i></dt>
152 <dd>
153 style number (integer)
154 </dd>
155 </dl><dl>
156 <dt>Returns:</dt>
157 <dd>
158 foreground color (QColor)
159 </dd>
160 </dl><a NAME="LexerPygments.defaultEolFill" ID="LexerPygments.defaultEolFill"></a>
161 <h4>LexerPygments.defaultEolFill</h4>
162 <b>defaultEolFill</b>(<i>style</i>)
163 <p>
164 Public method to get the default fill to eol flag.
165 </p><dl>
166 <dt><i>style</i></dt>
167 <dd>
168 style number (integer)
169 </dd>
170 </dl><dl>
171 <dt>Returns:</dt>
172 <dd>
173 fill to eol flag (boolean)
174 </dd>
175 </dl><a NAME="LexerPygments.defaultFont" ID="LexerPygments.defaultFont"></a>
176 <h4>LexerPygments.defaultFont</h4>
177 <b>defaultFont</b>(<i>style</i>)
178 <p>
179 Public method to get the default font for a style.
180 </p><dl>
181 <dt><i>style</i></dt>
182 <dd>
183 style number (integer)
184 </dd>
185 </dl><dl>
186 <dt>Returns:</dt>
187 <dd>
188 font (QFont)
189 </dd>
190 </dl><a NAME="LexerPygments.defaultKeywords" ID="LexerPygments.defaultKeywords"></a>
191 <h4>LexerPygments.defaultKeywords</h4>
192 <b>defaultKeywords</b>(<i>kwSet</i>)
193 <p>
194 Public method to get the default keywords.
195 </p><dl>
196 <dt><i>kwSet</i></dt>
197 <dd>
198 number of the keyword set (integer)
199 </dd>
200 </dl><dl>
201 <dt>Returns:</dt>
202 <dd>
203 string giving the keywords (string) or None
204 </dd>
205 </dl><a NAME="LexerPygments.defaultPaper" ID="LexerPygments.defaultPaper"></a>
206 <h4>LexerPygments.defaultPaper</h4>
207 <b>defaultPaper</b>(<i>style</i>)
208 <p>
209 Public method to get the default background color for a style.
210 </p><dl>
211 <dt><i>style</i></dt>
212 <dd>
213 style number (integer)
214 </dd>
215 </dl><dl>
216 <dt>Returns:</dt>
217 <dd>
218 background color (QColor)
219 </dd>
220 </dl><a NAME="LexerPygments.description" ID="LexerPygments.description"></a>
221 <h4>LexerPygments.description</h4>
222 <b>description</b>(<i>style</i>)
223 <p>
224 Public method returning the descriptions of the styles supported
225 by the lexer.
226 </p><dl>
227 <dt><i>style</i></dt>
228 <dd>
229 style number (integer)
230 </dd>
231 </dl><dl>
232 <dt>Returns:</dt>
233 <dd>
234 description for the style (string)
235 </dd>
236 </dl><a NAME="LexerPygments.isCommentStyle" ID="LexerPygments.isCommentStyle"></a>
237 <h4>LexerPygments.isCommentStyle</h4>
238 <b>isCommentStyle</b>(<i>style</i>)
239 <p>
240 Public method to check, if a style is a comment style.
241 </p><dl>
242 <dt><i>style</i></dt>
243 <dd>
244 style to check (integer)
245 </dd>
246 </dl><dl>
247 <dt>Returns:</dt>
248 <dd>
249 flag indicating a comment style (boolean)
250 </dd>
251 </dl><a NAME="LexerPygments.isStringStyle" ID="LexerPygments.isStringStyle"></a>
252 <h4>LexerPygments.isStringStyle</h4>
253 <b>isStringStyle</b>(<i>style</i>)
254 <p>
255 Public method to check, if a style is a string style.
256 </p><dl>
257 <dt><i>style</i></dt>
258 <dd>
259 style to check (integer)
260 </dd>
261 </dl><dl>
262 <dt>Returns:</dt>
263 <dd>
264 flag indicating a string style (boolean)
265 </dd>
266 </dl><a NAME="LexerPygments.language" ID="LexerPygments.language"></a>
267 <h4>LexerPygments.language</h4>
268 <b>language</b>(<i></i>)
269 <p>
270 Public method returning the language of the lexer.
271 </p><dl>
272 <dt>Returns:</dt>
273 <dd>
274 language of the lexer (string)
275 </dd>
276 </dl><a NAME="LexerPygments.name" ID="LexerPygments.name"></a>
277 <h4>LexerPygments.name</h4>
278 <b>name</b>(<i></i>)
279 <p>
280 Public method to get the name of the pygments lexer.
281 </p><dl>
282 <dt>Returns:</dt>
283 <dd>
284 name of the pygments lexer (string)
285 </dd>
286 </dl><a NAME="LexerPygments.styleText" ID="LexerPygments.styleText"></a>
287 <h4>LexerPygments.styleText</h4>
288 <b>styleText</b>(<i>start, end</i>)
289 <p>
290 Public method to perform the styling.
291 </p><dl>
292 <dt><i>start</i></dt>
293 <dd>
294 position of first character to be styled (integer)
295 </dd><dt><i>end</i></dt>
296 <dd>
297 position of last character to be styled (integer)
298 </dd>
299 </dl>
300 <div align="right"><a href="#top">Up</a></div>
301 <hr />
302 </body></html>

Mercurial Repository: eric

eric ide

mercurial