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

branch
eric7
changeset 9295
d14096c04126
parent 9209
b99e7fd55fd3
child 10070
9f5758c0fec1
equal deleted inserted replaced
9294:3c12aacd98d8 9295:d14096c04126
61 <tr> 61 <tr>
62 <td><a href="#LexerPygments.__guessLexer">__guessLexer</a></td> 62 <td><a href="#LexerPygments.__guessLexer">__guessLexer</a></td>
63 <td>Private method to guess a pygments lexer.</td> 63 <td>Private method to guess a pygments lexer.</td>
64 </tr> 64 </tr>
65 <tr> 65 <tr>
66 <td><a href="#LexerPygments.boxCommentStr">boxCommentStr</a></td>
67 <td>Public method to return the box comment strings.</td>
68 </tr>
69 <tr>
70 <td><a href="#LexerPygments.canBlockComment">canBlockComment</a></td>
71 <td>Public method to determine, whether the lexer language supports a block comment.</td>
72 </tr>
73 <tr>
74 <td><a href="#LexerPygments.canBoxComment">canBoxComment</a></td>
75 <td>Public method to determine, whether the lexer language supports a box comment.</td>
76 </tr>
77 <tr>
78 <td><a href="#LexerPygments.canStreamComment">canStreamComment</a></td>
79 <td>Public method to determine, whether the lexer language supports a stream comment.</td>
80 </tr>
81 <tr>
66 <td><a href="#LexerPygments.canStyle">canStyle</a></td> 82 <td><a href="#LexerPygments.canStyle">canStyle</a></td>
67 <td>Public method to check, if the lexer is able to style the text.</td> 83 <td>Public method to check, if the lexer is able to style the text.</td>
68 </tr> 84 </tr>
69 <tr> 85 <tr>
86 <td><a href="#LexerPygments.commentStr">commentStr</a></td>
87 <td>Public method to return the comment string.</td>
88 </tr>
89 <tr>
70 <td><a href="#LexerPygments.defaultColor">defaultColor</a></td> 90 <td><a href="#LexerPygments.defaultColor">defaultColor</a></td>
71 <td>Public method to get the default foreground color for a style.</td> 91 <td>Public method to get the default foreground color for a style.</td>
72 </tr> 92 </tr>
73 <tr> 93 <tr>
74 <td><a href="#LexerPygments.defaultEolFill">defaultEolFill</a></td> 94 <td><a href="#LexerPygments.defaultEolFill">defaultEolFill</a></td>
107 <td>Public method to get the name of the pygments lexer.</td> 127 <td>Public method to get the name of the pygments lexer.</td>
108 </tr> 128 </tr>
109 <tr> 129 <tr>
110 <td><a href="#LexerPygments.readSettings">readSettings</a></td> 130 <td><a href="#LexerPygments.readSettings">readSettings</a></td>
111 <td>Public method to read the lexer settings.</td> 131 <td>Public method to read the lexer settings.</td>
132 </tr>
133 <tr>
134 <td><a href="#LexerPygments.streamCommentStr">streamCommentStr</a></td>
135 <td>Public method to return the stream comment strings.</td>
112 </tr> 136 </tr>
113 <tr> 137 <tr>
114 <td><a href="#LexerPygments.styleText">styleText</a></td> 138 <td><a href="#LexerPygments.styleText">styleText</a></td>
115 <td>Public method to perform the styling.</td> 139 <td>Public method to perform the styling.</td>
116 </tr> 140 </tr>
157 <dt>Return:</dt> 181 <dt>Return:</dt>
158 <dd> 182 <dd>
159 reference to the guessed lexer (pygments.lexer) 183 reference to the guessed lexer (pygments.lexer)
160 </dd> 184 </dd>
161 </dl> 185 </dl>
186 <a NAME="LexerPygments.boxCommentStr" ID="LexerPygments.boxCommentStr"></a>
187 <h4>LexerPygments.boxCommentStr</h4>
188 <b>boxCommentStr</b>(<i></i>)
189
190 <p>
191 Public method to return the box comment strings.
192 </p>
193 <dl>
194 <dt>Return:</dt>
195 <dd>
196 dictionary containing the start, middle and end box comment strings
197 </dd>
198 </dl>
199 <dl>
200 <dt>Return Type:</dt>
201 <dd>
202 dict of {"start": str, "middle": str, "end": str}
203 </dd>
204 </dl>
205 <a NAME="LexerPygments.canBlockComment" ID="LexerPygments.canBlockComment"></a>
206 <h4>LexerPygments.canBlockComment</h4>
207 <b>canBlockComment</b>(<i></i>)
208
209 <p>
210 Public method to determine, whether the lexer language supports a
211 block comment.
212 </p>
213 <dl>
214 <dt>Return:</dt>
215 <dd>
216 flag indicating block comment is available
217 </dd>
218 </dl>
219 <dl>
220 <dt>Return Type:</dt>
221 <dd>
222 bool
223 </dd>
224 </dl>
225 <a NAME="LexerPygments.canBoxComment" ID="LexerPygments.canBoxComment"></a>
226 <h4>LexerPygments.canBoxComment</h4>
227 <b>canBoxComment</b>(<i></i>)
228
229 <p>
230 Public method to determine, whether the lexer language supports a
231 box comment.
232 </p>
233 <dl>
234 <dt>Return:</dt>
235 <dd>
236 flag box comment is available
237 </dd>
238 </dl>
239 <dl>
240 <dt>Return Type:</dt>
241 <dd>
242 bool
243 </dd>
244 </dl>
245 <a NAME="LexerPygments.canStreamComment" ID="LexerPygments.canStreamComment"></a>
246 <h4>LexerPygments.canStreamComment</h4>
247 <b>canStreamComment</b>(<i></i>)
248
249 <p>
250 Public method to determine, whether the lexer language supports a
251 stream comment.
252 </p>
253 <dl>
254 <dt>Return:</dt>
255 <dd>
256 flag indicating stream comment is available
257 </dd>
258 </dl>
259 <dl>
260 <dt>Return Type:</dt>
261 <dd>
262 bool
263 </dd>
264 </dl>
162 <a NAME="LexerPygments.canStyle" ID="LexerPygments.canStyle"></a> 265 <a NAME="LexerPygments.canStyle" ID="LexerPygments.canStyle"></a>
163 <h4>LexerPygments.canStyle</h4> 266 <h4>LexerPygments.canStyle</h4>
164 <b>canStyle</b>(<i></i>) 267 <b>canStyle</b>(<i></i>)
165 268
166 <p> 269 <p>
170 <dt>Return:</dt> 273 <dt>Return:</dt>
171 <dd> 274 <dd>
172 flag indicating the lexer capability (boolean) 275 flag indicating the lexer capability (boolean)
173 </dd> 276 </dd>
174 </dl> 277 </dl>
278 <a NAME="LexerPygments.commentStr" ID="LexerPygments.commentStr"></a>
279 <h4>LexerPygments.commentStr</h4>
280 <b>commentStr</b>(<i></i>)
281
282 <p>
283 Public method to return the comment string.
284 </p>
285 <dl>
286 <dt>Return:</dt>
287 <dd>
288 comment string
289 </dd>
290 </dl>
291 <dl>
292 <dt>Return Type:</dt>
293 <dd>
294 str
295 </dd>
296 </dl>
175 <a NAME="LexerPygments.defaultColor" ID="LexerPygments.defaultColor"></a> 297 <a NAME="LexerPygments.defaultColor" ID="LexerPygments.defaultColor"></a>
176 <h4>LexerPygments.defaultColor</h4> 298 <h4>LexerPygments.defaultColor</h4>
177 <b>defaultColor</b>(<i>style</i>) 299 <b>defaultColor</b>(<i>style</i>)
178 300
179 <p> 301 <p>
378 <dt><i>prefix</i> (str (optional))</dt> 500 <dt><i>prefix</i> (str (optional))</dt>
379 <dd> 501 <dd>
380 prefix for the settings key (defaults to "/Scintilla") 502 prefix for the settings key (defaults to "/Scintilla")
381 </dd> 503 </dd>
382 </dl> 504 </dl>
505 <a NAME="LexerPygments.streamCommentStr" ID="LexerPygments.streamCommentStr"></a>
506 <h4>LexerPygments.streamCommentStr</h4>
507 <b>streamCommentStr</b>(<i></i>)
508
509 <p>
510 Public method to return the stream comment strings.
511 </p>
512 <dl>
513 <dt>Return:</dt>
514 <dd>
515 dictionary containing the start and end stream comment strings
516 </dd>
517 </dl>
518 <dl>
519 <dt>Return Type:</dt>
520 <dd>
521 dict of {"start": str, "end": str}
522 </dd>
523 </dl>
383 <a NAME="LexerPygments.styleText" ID="LexerPygments.styleText"></a> 524 <a NAME="LexerPygments.styleText" ID="LexerPygments.styleText"></a>
384 <h4>LexerPygments.styleText</h4> 525 <h4>LexerPygments.styleText</h4>
385 <b>styleText</b>(<i>start, end</i>) 526 <b>styleText</b>(<i>start, end</i>)
386 527
387 <p> 528 <p>

eric ide

mercurial