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

branch
eric7
changeset 10431
64157aeb0312
parent 10259
b51dfacef37f
child 10479
856476537696
equal deleted inserted replaced
10430:e440aaf179ce 10431:64157aeb0312
152 <p> 152 <p>
153 Constructor 153 Constructor
154 </p> 154 </p>
155 <dl> 155 <dl>
156 156
157 <dt><i>parent</i></dt> 157 <dt><i>parent</i> (QWidget)</dt>
158 <dd> 158 <dd>
159 parent widget of this lexer 159 parent widget of this lexer
160 </dd> 160 </dd>
161 <dt><i>name</i></dt> 161 <dt><i>name</i> (str)</dt>
162 <dd> 162 <dd>
163 name of the pygments lexer to use (string) 163 name of the pygments lexer to use
164 </dd> 164 </dd>
165 </dl> 165 </dl>
166 <a NAME="LexerPygments.__guessLexer" ID="LexerPygments.__guessLexer"></a> 166 <a NAME="LexerPygments.__guessLexer" ID="LexerPygments.__guessLexer"></a>
167 <h4>LexerPygments.__guessLexer</h4> 167 <h4>LexerPygments.__guessLexer</h4>
168 <b>__guessLexer</b>(<i>text</i>) 168 <b>__guessLexer</b>(<i>text</i>)
170 <p> 170 <p>
171 Private method to guess a pygments lexer. 171 Private method to guess a pygments lexer.
172 </p> 172 </p>
173 <dl> 173 <dl>
174 174
175 <dt><i>text</i></dt> 175 <dt><i>text</i> (str)</dt>
176 <dd> 176 <dd>
177 text to base guessing on (string) 177 text to base guessing on
178 </dd> 178 </dd>
179 </dl> 179 </dl>
180 <dl> 180 <dl>
181 <dt>Return:</dt> 181 <dt>Return:</dt>
182 <dd> 182 <dd>
183 reference to the guessed lexer (pygments.lexer) 183 reference to the guessed lexer
184 </dd>
185 </dl>
186 <dl>
187 <dt>Return Type:</dt>
188 <dd>
189 pygments.lexer
184 </dd> 190 </dd>
185 </dl> 191 </dl>
186 <a NAME="LexerPygments.boxCommentStr" ID="LexerPygments.boxCommentStr"></a> 192 <a NAME="LexerPygments.boxCommentStr" ID="LexerPygments.boxCommentStr"></a>
187 <h4>LexerPygments.boxCommentStr</h4> 193 <h4>LexerPygments.boxCommentStr</h4>
188 <b>boxCommentStr</b>(<i></i>) 194 <b>boxCommentStr</b>(<i></i>)
270 Public method to check, if the lexer is able to style the text. 276 Public method to check, if the lexer is able to style the text.
271 </p> 277 </p>
272 <dl> 278 <dl>
273 <dt>Return:</dt> 279 <dt>Return:</dt>
274 <dd> 280 <dd>
275 flag indicating the lexer capability (boolean) 281 flag indicating the lexer capability
282 </dd>
283 </dl>
284 <dl>
285 <dt>Return Type:</dt>
286 <dd>
287 bool
276 </dd> 288 </dd>
277 </dl> 289 </dl>
278 <a NAME="LexerPygments.commentStr" ID="LexerPygments.commentStr"></a> 290 <a NAME="LexerPygments.commentStr" ID="LexerPygments.commentStr"></a>
279 <h4>LexerPygments.commentStr</h4> 291 <h4>LexerPygments.commentStr</h4>
280 <b>commentStr</b>(<i></i>) 292 <b>commentStr</b>(<i></i>)
301 <p> 313 <p>
302 Public method to get the default foreground color for a style. 314 Public method to get the default foreground color for a style.
303 </p> 315 </p>
304 <dl> 316 <dl>
305 317
306 <dt><i>style</i></dt> 318 <dt><i>style</i> (int)</dt>
307 <dd> 319 <dd>
308 style number (integer) 320 style number
309 </dd> 321 </dd>
310 </dl> 322 </dl>
311 <dl> 323 <dl>
312 <dt>Return:</dt> 324 <dt>Return:</dt>
313 <dd> 325 <dd>
314 foreground color (QColor) 326 foreground color
327 </dd>
328 </dl>
329 <dl>
330 <dt>Return Type:</dt>
331 <dd>
332 QColor
315 </dd> 333 </dd>
316 </dl> 334 </dl>
317 <a NAME="LexerPygments.defaultEolFill" ID="LexerPygments.defaultEolFill"></a> 335 <a NAME="LexerPygments.defaultEolFill" ID="LexerPygments.defaultEolFill"></a>
318 <h4>LexerPygments.defaultEolFill</h4> 336 <h4>LexerPygments.defaultEolFill</h4>
319 <b>defaultEolFill</b>(<i>style</i>) 337 <b>defaultEolFill</b>(<i>style</i>)
321 <p> 339 <p>
322 Public method to get the default fill to eol flag. 340 Public method to get the default fill to eol flag.
323 </p> 341 </p>
324 <dl> 342 <dl>
325 343
326 <dt><i>style</i></dt> 344 <dt><i>style</i> (int)</dt>
327 <dd> 345 <dd>
328 style number (integer) 346 style number
329 </dd> 347 </dd>
330 </dl> 348 </dl>
331 <dl> 349 <dl>
332 <dt>Return:</dt> 350 <dt>Return:</dt>
333 <dd> 351 <dd>
334 fill to eol flag (boolean) 352 fill to eol flag
353 </dd>
354 </dl>
355 <dl>
356 <dt>Return Type:</dt>
357 <dd>
358 bool
335 </dd> 359 </dd>
336 </dl> 360 </dl>
337 <a NAME="LexerPygments.defaultFont" ID="LexerPygments.defaultFont"></a> 361 <a NAME="LexerPygments.defaultFont" ID="LexerPygments.defaultFont"></a>
338 <h4>LexerPygments.defaultFont</h4> 362 <h4>LexerPygments.defaultFont</h4>
339 <b>defaultFont</b>(<i>style</i>) 363 <b>defaultFont</b>(<i>style</i>)
341 <p> 365 <p>
342 Public method to get the default font for a style. 366 Public method to get the default font for a style.
343 </p> 367 </p>
344 <dl> 368 <dl>
345 369
346 <dt><i>style</i></dt> 370 <dt><i>style</i> (int)</dt>
347 <dd> 371 <dd>
348 style number (integer) 372 style number
349 </dd> 373 </dd>
350 </dl> 374 </dl>
351 <dl> 375 <dl>
352 <dt>Return:</dt> 376 <dt>Return:</dt>
353 <dd> 377 <dd>
354 font (QFont) 378 font
379 </dd>
380 </dl>
381 <dl>
382 <dt>Return Type:</dt>
383 <dd>
384 QFont
355 </dd> 385 </dd>
356 </dl> 386 </dl>
357 <a NAME="LexerPygments.defaultKeywords" ID="LexerPygments.defaultKeywords"></a> 387 <a NAME="LexerPygments.defaultKeywords" ID="LexerPygments.defaultKeywords"></a>
358 <h4>LexerPygments.defaultKeywords</h4> 388 <h4>LexerPygments.defaultKeywords</h4>
359 <b>defaultKeywords</b>(<i>kwSet</i>) 389 <b>defaultKeywords</b>(<i>kwSet</i>)
361 <p> 391 <p>
362 Public method to get the default keywords. 392 Public method to get the default keywords.
363 </p> 393 </p>
364 <dl> 394 <dl>
365 395
366 <dt><i>kwSet</i></dt> 396 <dt><i>kwSet</i> (int)</dt>
367 <dd> 397 <dd>
368 number of the keyword set (integer) 398 number of the keyword set
369 </dd> 399 </dd>
370 </dl> 400 </dl>
371 <dl> 401 <dl>
372 <dt>Return:</dt> 402 <dt>Return:</dt>
373 <dd> 403 <dd>
374 string giving the keywords (string) or None 404 string giving the keywords or None
405 </dd>
406 </dl>
407 <dl>
408 <dt>Return Type:</dt>
409 <dd>
410 str
375 </dd> 411 </dd>
376 </dl> 412 </dl>
377 <a NAME="LexerPygments.defaultPaper" ID="LexerPygments.defaultPaper"></a> 413 <a NAME="LexerPygments.defaultPaper" ID="LexerPygments.defaultPaper"></a>
378 <h4>LexerPygments.defaultPaper</h4> 414 <h4>LexerPygments.defaultPaper</h4>
379 <b>defaultPaper</b>(<i>style</i>) 415 <b>defaultPaper</b>(<i>style</i>)
381 <p> 417 <p>
382 Public method to get the default background color for a style. 418 Public method to get the default background color for a style.
383 </p> 419 </p>
384 <dl> 420 <dl>
385 421
386 <dt><i>style</i></dt> 422 <dt><i>style</i> (int)</dt>
387 <dd> 423 <dd>
388 style number (integer) 424 style number
389 </dd> 425 </dd>
390 </dl> 426 </dl>
391 <dl> 427 <dl>
392 <dt>Return:</dt> 428 <dt>Return:</dt>
393 <dd> 429 <dd>
394 background color (QColor) 430 background color
431 </dd>
432 </dl>
433 <dl>
434 <dt>Return Type:</dt>
435 <dd>
436 QColor
395 </dd> 437 </dd>
396 </dl> 438 </dl>
397 <a NAME="LexerPygments.description" ID="LexerPygments.description"></a> 439 <a NAME="LexerPygments.description" ID="LexerPygments.description"></a>
398 <h4>LexerPygments.description</h4> 440 <h4>LexerPygments.description</h4>
399 <b>description</b>(<i>style</i>) 441 <b>description</b>(<i>style</i>)
402 Public method returning the descriptions of the styles supported 444 Public method returning the descriptions of the styles supported
403 by the lexer. 445 by the lexer.
404 </p> 446 </p>
405 <dl> 447 <dl>
406 448
407 <dt><i>style</i></dt> 449 <dt><i>style</i> (int)</dt>
408 <dd> 450 <dd>
409 style number (integer) 451 style number
410 </dd> 452 </dd>
411 </dl> 453 </dl>
412 <dl> 454 <dl>
413 <dt>Return:</dt> 455 <dt>Return:</dt>
414 <dd> 456 <dd>
415 description for the style (string) 457 description for the style
458 </dd>
459 </dl>
460 <dl>
461 <dt>Return Type:</dt>
462 <dd>
463 str
416 </dd> 464 </dd>
417 </dl> 465 </dl>
418 <a NAME="LexerPygments.isCommentStyle" ID="LexerPygments.isCommentStyle"></a> 466 <a NAME="LexerPygments.isCommentStyle" ID="LexerPygments.isCommentStyle"></a>
419 <h4>LexerPygments.isCommentStyle</h4> 467 <h4>LexerPygments.isCommentStyle</h4>
420 <b>isCommentStyle</b>(<i>style</i>) 468 <b>isCommentStyle</b>(<i>style</i>)
422 <p> 470 <p>
423 Public method to check, if a style is a comment style. 471 Public method to check, if a style is a comment style.
424 </p> 472 </p>
425 <dl> 473 <dl>
426 474
427 <dt><i>style</i></dt> 475 <dt><i>style</i> (int)</dt>
428 <dd> 476 <dd>
429 style to check (integer) 477 style to check
430 </dd> 478 </dd>
431 </dl> 479 </dl>
432 <dl> 480 <dl>
433 <dt>Return:</dt> 481 <dt>Return:</dt>
434 <dd> 482 <dd>
435 flag indicating a comment style (boolean) 483 flag indicating a comment style
484 </dd>
485 </dl>
486 <dl>
487 <dt>Return Type:</dt>
488 <dd>
489 bool
436 </dd> 490 </dd>
437 </dl> 491 </dl>
438 <a NAME="LexerPygments.isStringStyle" ID="LexerPygments.isStringStyle"></a> 492 <a NAME="LexerPygments.isStringStyle" ID="LexerPygments.isStringStyle"></a>
439 <h4>LexerPygments.isStringStyle</h4> 493 <h4>LexerPygments.isStringStyle</h4>
440 <b>isStringStyle</b>(<i>style</i>) 494 <b>isStringStyle</b>(<i>style</i>)
442 <p> 496 <p>
443 Public method to check, if a style is a string style. 497 Public method to check, if a style is a string style.
444 </p> 498 </p>
445 <dl> 499 <dl>
446 500
447 <dt><i>style</i></dt> 501 <dt><i>style</i> (int)</dt>
448 <dd> 502 <dd>
449 style to check (integer) 503 style to check
450 </dd> 504 </dd>
451 </dl> 505 </dl>
452 <dl> 506 <dl>
453 <dt>Return:</dt> 507 <dt>Return:</dt>
454 <dd> 508 <dd>
455 flag indicating a string style (boolean) 509 flag indicating a string style
510 </dd>
511 </dl>
512 <dl>
513 <dt>Return Type:</dt>
514 <dd>
515 bool
456 </dd> 516 </dd>
457 </dl> 517 </dl>
458 <a NAME="LexerPygments.language" ID="LexerPygments.language"></a> 518 <a NAME="LexerPygments.language" ID="LexerPygments.language"></a>
459 <h4>LexerPygments.language</h4> 519 <h4>LexerPygments.language</h4>
460 <b>language</b>(<i></i>) 520 <b>language</b>(<i></i>)
463 Public method returning the language of the lexer. 523 Public method returning the language of the lexer.
464 </p> 524 </p>
465 <dl> 525 <dl>
466 <dt>Return:</dt> 526 <dt>Return:</dt>
467 <dd> 527 <dd>
468 language of the lexer (string) 528 language of the lexer
529 </dd>
530 </dl>
531 <dl>
532 <dt>Return Type:</dt>
533 <dd>
534 str
469 </dd> 535 </dd>
470 </dl> 536 </dl>
471 <a NAME="LexerPygments.name" ID="LexerPygments.name"></a> 537 <a NAME="LexerPygments.name" ID="LexerPygments.name"></a>
472 <h4>LexerPygments.name</h4> 538 <h4>LexerPygments.name</h4>
473 <b>name</b>(<i></i>) 539 <b>name</b>(<i></i>)
476 Public method to get the name of the pygments lexer. 542 Public method to get the name of the pygments lexer.
477 </p> 543 </p>
478 <dl> 544 <dl>
479 <dt>Return:</dt> 545 <dt>Return:</dt>
480 <dd> 546 <dd>
481 name of the pygments lexer (string) 547 name of the pygments lexer
548 </dd>
549 </dl>
550 <dl>
551 <dt>Return Type:</dt>
552 <dd>
553 str
482 </dd> 554 </dd>
483 </dl> 555 </dl>
484 <a NAME="LexerPygments.readSettings" ID="LexerPygments.readSettings"></a> 556 <a NAME="LexerPygments.readSettings" ID="LexerPygments.readSettings"></a>
485 <h4>LexerPygments.readSettings</h4> 557 <h4>LexerPygments.readSettings</h4>
486 <b>readSettings</b>(<i>qs, prefix="/Scintilla"</i>) 558 <b>readSettings</b>(<i>qs, prefix="/Scintilla"</i>)
528 <p> 600 <p>
529 Public method to perform the styling. 601 Public method to perform the styling.
530 </p> 602 </p>
531 <dl> 603 <dl>
532 604
533 <dt><i>start</i></dt> 605 <dt><i>start</i> (int)</dt>
534 <dd> 606 <dd>
535 position of first character to be styled (integer) 607 position of first character to be styled
536 </dd> 608 </dd>
537 <dt><i>end</i></dt> 609 <dt><i>end</i> (int)</dt>
538 <dd> 610 <dd>
539 position of last character to be styled (integer) 611 position of last character to be styled
540 </dd> 612 </dd>
541 </dl> 613 </dl>
542 <div align="right"><a href="#top">Up</a></div> 614 <div align="right"><a href="#top">Up</a></div>
543 <hr /> 615 <hr />
544 </body></html> 616 </body></html>

eric ide

mercurial