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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.QScintilla.Lexers.SubstyledLexer</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.SubstyledLexer</h1>
10
11 <p>
12 Module implementing the lexer mixin class.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#SubstyledLexer">SubstyledLexer</a></td>
25 <td>Class to implement the sub-styled lexer mixin class.</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="SubstyledLexer" ID="SubstyledLexer"></a>
36 <h2>SubstyledLexer</h2>
37
38 <p>
39 Class to implement the sub-styled lexer mixin class.
40 </p>
41 <h3>Derived from</h3>
42 Lexer
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="#SubstyledLexer.__init__">SubstyledLexer</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#SubstyledLexer.addSubstyle">addSubstyle</a></td>
63 <td>Public method to add an empty sub-style to a given base style.</td>
64 </tr>
65 <tr>
66 <td><a href="#SubstyledLexer.delSubstyle">delSubstyle</a></td>
67 <td>Public method to delete a given sub-style definition.</td>
68 </tr>
69 <tr>
70 <td><a href="#SubstyledLexer.getBaseStyles">getBaseStyles</a></td>
71 <td>Public method to get the list of supported base styles.</td>
72 </tr>
73 <tr>
74 <td><a href="#SubstyledLexer.hasSubstyle">hasSubstyle</a></td>
75 <td>Public method to test for a given sub-style definition.</td>
76 </tr>
77 <tr>
78 <td><a href="#SubstyledLexer.hasSubstyles">hasSubstyles</a></td>
79 <td>Public method to indicate the support of sub-styles.</td>
80 </tr>
81 <tr>
82 <td><a href="#SubstyledLexer.isBaseStyle">isBaseStyle</a></td>
83 <td>Public method to test, if a given style may have sub-styles.</td>
84 </tr>
85 <tr>
86 <td><a href="#SubstyledLexer.loadAllDefaultSubStyles">loadAllDefaultSubStyles</a></td>
87 <td>Public method to load the default sub-style definitions.</td>
88 </tr>
89 <tr>
90 <td><a href="#SubstyledLexer.loadDefaultSubStyles">loadDefaultSubStyles</a></td>
91 <td>Public method to load the default sub-styles for a given base style.</td>
92 </tr>
93 <tr>
94 <td><a href="#SubstyledLexer.loadSubstyles">loadSubstyles</a></td>
95 <td>Public method to load the sub-styles from the settings file.</td>
96 </tr>
97 <tr>
98 <td><a href="#SubstyledLexer.readSubstyles">readSubstyles</a></td>
99 <td>Public method to load the sub-styles and configure the editor.</td>
100 </tr>
101 <tr>
102 <td><a href="#SubstyledLexer.setSubstyleColor">setSubstyleColor</a></td>
103 <td>Public method to set the foreground color of a sub-style.</td>
104 </tr>
105 <tr>
106 <td><a href="#SubstyledLexer.setSubstyleDescription">setSubstyleDescription</a></td>
107 <td>Public method to set the description for a sub-style.</td>
108 </tr>
109 <tr>
110 <td><a href="#SubstyledLexer.setSubstyleEolFill">setSubstyleEolFill</a></td>
111 <td>Public method to set the eolfill flag of a sub-style.</td>
112 </tr>
113 <tr>
114 <td><a href="#SubstyledLexer.setSubstyleFont">setSubstyleFont</a></td>
115 <td>Public method to set the font of a sub-style.</td>
116 </tr>
117 <tr>
118 <td><a href="#SubstyledLexer.setSubstylePaper">setSubstylePaper</a></td>
119 <td>Public method to set the background color of a sub-style.</td>
120 </tr>
121 <tr>
122 <td><a href="#SubstyledLexer.setSubstyleWords">setSubstyleWords</a></td>
123 <td>Public method to set the words for a sub-style.</td>
124 </tr>
125 <tr>
126 <td><a href="#SubstyledLexer.substyleColor">substyleColor</a></td>
127 <td>Public method to get the sub-style foreground color.</td>
128 </tr>
129 <tr>
130 <td><a href="#SubstyledLexer.substyleDefaultColor">substyleDefaultColor</a></td>
131 <td>Public method to get the sub-style default foreground color.</td>
132 </tr>
133 <tr>
134 <td><a href="#SubstyledLexer.substyleDefaultDescription">substyleDefaultDescription</a></td>
135 <td>Public method to get the default description of a sub-style.</td>
136 </tr>
137 <tr>
138 <td><a href="#SubstyledLexer.substyleDefaultEolFill">substyleDefaultEolFill</a></td>
139 <td>Public method to get the default eolfill flag.</td>
140 </tr>
141 <tr>
142 <td><a href="#SubstyledLexer.substyleDefaultFont">substyleDefaultFont</a></td>
143 <td>Public method to get the default sub-style font.</td>
144 </tr>
145 <tr>
146 <td><a href="#SubstyledLexer.substyleDefaultPaper">substyleDefaultPaper</a></td>
147 <td>Public method to get the sub-style default background color.</td>
148 </tr>
149 <tr>
150 <td><a href="#SubstyledLexer.substyleDefaultWords">substyleDefaultWords</a></td>
151 <td>Public method to get the default words of a sub-style.</td>
152 </tr>
153 <tr>
154 <td><a href="#SubstyledLexer.substyleDescription">substyleDescription</a></td>
155 <td>Public method to get the description of a sub-style.</td>
156 </tr>
157 <tr>
158 <td><a href="#SubstyledLexer.substyleEolFill">substyleEolFill</a></td>
159 <td>Public method to get the eolfill flag.</td>
160 </tr>
161 <tr>
162 <td><a href="#SubstyledLexer.substyleFont">substyleFont</a></td>
163 <td>Public method to get the sub-style font.</td>
164 </tr>
165 <tr>
166 <td><a href="#SubstyledLexer.substylePaper">substylePaper</a></td>
167 <td>Public method to get the sub-style background color.</td>
168 </tr>
169 <tr>
170 <td><a href="#SubstyledLexer.substyleWords">substyleWords</a></td>
171 <td>Public method to get the words of a sub-style.</td>
172 </tr>
173 <tr>
174 <td><a href="#SubstyledLexer.substylesCount">substylesCount</a></td>
175 <td>Public method to get the number of defined sub-styles.</td>
176 </tr>
177 <tr>
178 <td><a href="#SubstyledLexer.writeSubstyles">writeSubstyles</a></td>
179 <td>Public method to save the sub-styles.</td>
180 </tr>
181 </table>
182 <h3>Static Methods</h3>
183
184 <table>
185 <tr><td>None</td></tr>
186 </table>
187
188 <a NAME="SubstyledLexer.__init__" ID="SubstyledLexer.__init__"></a>
189 <h4>SubstyledLexer (Constructor)</h4>
190 <b>SubstyledLexer</b>(<i></i>)
191
192 <p>
193 Constructor
194 </p>
195 <a NAME="SubstyledLexer.addSubstyle" ID="SubstyledLexer.addSubstyle"></a>
196 <h4>SubstyledLexer.addSubstyle</h4>
197 <b>addSubstyle</b>(<i>style</i>)
198
199 <p>
200 Public method to add an empty sub-style to a given base style.
201 </p>
202 <dl>
203
204 <dt><i>style</i> (int)</dt>
205 <dd>
206 base style number
207 </dd>
208 </dl>
209 <dl>
210 <dt>Return:</dt>
211 <dd>
212 allocated sub-style number or -1 to indicate an error
213 </dd>
214 </dl>
215 <dl>
216 <dt>Return Type:</dt>
217 <dd>
218 int
219 </dd>
220 </dl>
221 <a NAME="SubstyledLexer.delSubstyle" ID="SubstyledLexer.delSubstyle"></a>
222 <h4>SubstyledLexer.delSubstyle</h4>
223 <b>delSubstyle</b>(<i>style, substyle</i>)
224
225 <p>
226 Public method to delete a given sub-style definition.
227 </p>
228 <dl>
229
230 <dt><i>style</i> (int)</dt>
231 <dd>
232 base style number
233 </dd>
234 <dt><i>substyle</i> (int)</dt>
235 <dd>
236 sub-style number
237 </dd>
238 </dl>
239 <dl>
240 <dt>Return:</dt>
241 <dd>
242 flag indicating successful deletion
243 </dd>
244 </dl>
245 <dl>
246 <dt>Return Type:</dt>
247 <dd>
248 bool
249 </dd>
250 </dl>
251 <a NAME="SubstyledLexer.getBaseStyles" ID="SubstyledLexer.getBaseStyles"></a>
252 <h4>SubstyledLexer.getBaseStyles</h4>
253 <b>getBaseStyles</b>(<i></i>)
254
255 <p>
256 Public method to get the list of supported base styles.
257 </p>
258 <dl>
259 <dt>Return:</dt>
260 <dd>
261 list of base styles
262 </dd>
263 </dl>
264 <dl>
265 <dt>Return Type:</dt>
266 <dd>
267 list of int
268 </dd>
269 </dl>
270 <a NAME="SubstyledLexer.hasSubstyle" ID="SubstyledLexer.hasSubstyle"></a>
271 <h4>SubstyledLexer.hasSubstyle</h4>
272 <b>hasSubstyle</b>(<i>style, substyle</i>)
273
274 <p>
275 Public method to test for a given sub-style definition.
276 </p>
277 <dl>
278
279 <dt><i>style</i> (int)</dt>
280 <dd>
281 base style number
282 </dd>
283 <dt><i>substyle</i> (int)</dt>
284 <dd>
285 sub-style number
286 </dd>
287 </dl>
288 <dl>
289 <dt>Return:</dt>
290 <dd>
291 flag indicating the existence of a sub-style definition
292 </dd>
293 </dl>
294 <dl>
295 <dt>Return Type:</dt>
296 <dd>
297 bool
298 </dd>
299 </dl>
300 <a NAME="SubstyledLexer.hasSubstyles" ID="SubstyledLexer.hasSubstyles"></a>
301 <h4>SubstyledLexer.hasSubstyles</h4>
302 <b>hasSubstyles</b>(<i></i>)
303
304 <p>
305 Public method to indicate the support of sub-styles.
306 </p>
307 <dl>
308 <dt>Return:</dt>
309 <dd>
310 flag indicating sub-styling support
311 </dd>
312 </dl>
313 <dl>
314 <dt>Return Type:</dt>
315 <dd>
316 bool
317 </dd>
318 </dl>
319 <a NAME="SubstyledLexer.isBaseStyle" ID="SubstyledLexer.isBaseStyle"></a>
320 <h4>SubstyledLexer.isBaseStyle</h4>
321 <b>isBaseStyle</b>(<i>style</i>)
322
323 <p>
324 Public method to test, if a given style may have sub-styles.
325 </p>
326 <dl>
327
328 <dt><i>style</i> (int)</dt>
329 <dd>
330 base style number
331 </dd>
332 </dl>
333 <dl>
334 <dt>Return:</dt>
335 <dd>
336 flag indicating that the style may have sub-styles
337 </dd>
338 </dl>
339 <dl>
340 <dt>Return Type:</dt>
341 <dd>
342 bool
343 </dd>
344 </dl>
345 <a NAME="SubstyledLexer.loadAllDefaultSubStyles" ID="SubstyledLexer.loadAllDefaultSubStyles"></a>
346 <h4>SubstyledLexer.loadAllDefaultSubStyles</h4>
347 <b>loadAllDefaultSubStyles</b>(<i></i>)
348
349 <p>
350 Public method to load the default sub-style definitions.
351 </p>
352 <a NAME="SubstyledLexer.loadDefaultSubStyles" ID="SubstyledLexer.loadDefaultSubStyles"></a>
353 <h4>SubstyledLexer.loadDefaultSubStyles</h4>
354 <b>loadDefaultSubStyles</b>(<i>style</i>)
355
356 <p>
357 Public method to load the default sub-styles for a given base style.
358 </p>
359 <dl>
360
361 <dt><i>style</i> (int)</dt>
362 <dd>
363 style number
364 </dd>
365 </dl>
366 <a NAME="SubstyledLexer.loadSubstyles" ID="SubstyledLexer.loadSubstyles"></a>
367 <h4>SubstyledLexer.loadSubstyles</h4>
368 <b>loadSubstyles</b>(<i></i>)
369
370 <p>
371 Public method to load the sub-styles from the settings file.
372 </p>
373 <a NAME="SubstyledLexer.readSubstyles" ID="SubstyledLexer.readSubstyles"></a>
374 <h4>SubstyledLexer.readSubstyles</h4>
375 <b>readSubstyles</b>(<i>editor</i>)
376
377 <p>
378 Public method to load the sub-styles and configure the editor.
379 </p>
380 <dl>
381
382 <dt><i>editor</i> (QsciScintilla)</dt>
383 <dd>
384 reference to the editor object
385 </dd>
386 </dl>
387 <a NAME="SubstyledLexer.setSubstyleColor" ID="SubstyledLexer.setSubstyleColor"></a>
388 <h4>SubstyledLexer.setSubstyleColor</h4>
389 <b>setSubstyleColor</b>(<i>color, style, substyle</i>)
390
391 <p>
392 Public method to set the foreground color of a sub-style.
393 </p>
394 <dl>
395
396 <dt><i>color</i> (QColor)</dt>
397 <dd>
398 foreground color to be set
399 </dd>
400 <dt><i>style</i> (int)</dt>
401 <dd>
402 base style number
403 </dd>
404 <dt><i>substyle</i> (int)</dt>
405 <dd>
406 sub-style number
407 </dd>
408 </dl>
409 <a NAME="SubstyledLexer.setSubstyleDescription" ID="SubstyledLexer.setSubstyleDescription"></a>
410 <h4>SubstyledLexer.setSubstyleDescription</h4>
411 <b>setSubstyleDescription</b>(<i>description, style, substyle</i>)
412
413 <p>
414 Public method to set the description for a sub-style.
415 </p>
416 <dl>
417
418 <dt><i>description</i> (str)</dt>
419 <dd>
420 description to be set
421 </dd>
422 <dt><i>style</i> (int)</dt>
423 <dd>
424 base style number
425 </dd>
426 <dt><i>substyle</i> (int)</dt>
427 <dd>
428 sub-style number
429 </dd>
430 </dl>
431 <a NAME="SubstyledLexer.setSubstyleEolFill" ID="SubstyledLexer.setSubstyleEolFill"></a>
432 <h4>SubstyledLexer.setSubstyleEolFill</h4>
433 <b>setSubstyleEolFill</b>(<i>eolFill, style, substyle</i>)
434
435 <p>
436 Public method to set the eolfill flag of a sub-style.
437 </p>
438 <dl>
439
440 <dt><i>eolFill</i> (bool)</dt>
441 <dd>
442 eolfill flag to be set
443 </dd>
444 <dt><i>style</i> (int)</dt>
445 <dd>
446 base style number
447 </dd>
448 <dt><i>substyle</i> (int)</dt>
449 <dd>
450 sub-style number
451 </dd>
452 </dl>
453 <a NAME="SubstyledLexer.setSubstyleFont" ID="SubstyledLexer.setSubstyleFont"></a>
454 <h4>SubstyledLexer.setSubstyleFont</h4>
455 <b>setSubstyleFont</b>(<i>font, style, substyle</i>)
456
457 <p>
458 Public method to set the font of a sub-style.
459 </p>
460 <dl>
461
462 <dt><i>font</i> (QFont)</dt>
463 <dd>
464 font to be set
465 </dd>
466 <dt><i>style</i> (int)</dt>
467 <dd>
468 base style number
469 </dd>
470 <dt><i>substyle</i> (int)</dt>
471 <dd>
472 sub-style number
473 </dd>
474 </dl>
475 <a NAME="SubstyledLexer.setSubstylePaper" ID="SubstyledLexer.setSubstylePaper"></a>
476 <h4>SubstyledLexer.setSubstylePaper</h4>
477 <b>setSubstylePaper</b>(<i>color, style, substyle</i>)
478
479 <p>
480 Public method to set the background color of a sub-style.
481 </p>
482 <dl>
483
484 <dt><i>color</i> (QColor)</dt>
485 <dd>
486 background color to be set
487 </dd>
488 <dt><i>style</i> (int)</dt>
489 <dd>
490 base style number
491 </dd>
492 <dt><i>substyle</i> (int)</dt>
493 <dd>
494 sub-style number
495 </dd>
496 </dl>
497 <a NAME="SubstyledLexer.setSubstyleWords" ID="SubstyledLexer.setSubstyleWords"></a>
498 <h4>SubstyledLexer.setSubstyleWords</h4>
499 <b>setSubstyleWords</b>(<i>words, style, substyle</i>)
500
501 <p>
502 Public method to set the words for a sub-style.
503 </p>
504 <dl>
505
506 <dt><i>words</i> (str)</dt>
507 <dd>
508 words to be set separated by white-space
509 </dd>
510 <dt><i>style</i> (int)</dt>
511 <dd>
512 base style number
513 </dd>
514 <dt><i>substyle</i> (int)</dt>
515 <dd>
516 sub-style number
517 </dd>
518 </dl>
519 <a NAME="SubstyledLexer.substyleColor" ID="SubstyledLexer.substyleColor"></a>
520 <h4>SubstyledLexer.substyleColor</h4>
521 <b>substyleColor</b>(<i>style, substyle</i>)
522
523 <p>
524 Public method to get the sub-style foreground color.
525 </p>
526 <dl>
527
528 <dt><i>style</i> (int)</dt>
529 <dd>
530 base style number
531 </dd>
532 <dt><i>substyle</i> (int)</dt>
533 <dd>
534 sub-style number
535 </dd>
536 </dl>
537 <dl>
538 <dt>Return:</dt>
539 <dd>
540 foreground color
541 </dd>
542 </dl>
543 <dl>
544 <dt>Return Type:</dt>
545 <dd>
546 QColor
547 </dd>
548 </dl>
549 <a NAME="SubstyledLexer.substyleDefaultColor" ID="SubstyledLexer.substyleDefaultColor"></a>
550 <h4>SubstyledLexer.substyleDefaultColor</h4>
551 <b>substyleDefaultColor</b>(<i>style, substyle</i>)
552
553 <p>
554 Public method to get the sub-style default foreground color.
555 </p>
556 <dl>
557
558 <dt><i>style</i> (int)</dt>
559 <dd>
560 base style number
561 </dd>
562 <dt><i>substyle</i> (int)</dt>
563 <dd>
564 sub-style number
565 </dd>
566 </dl>
567 <dl>
568 <dt>Return:</dt>
569 <dd>
570 default foreground color
571 </dd>
572 </dl>
573 <dl>
574 <dt>Return Type:</dt>
575 <dd>
576 QColor
577 </dd>
578 </dl>
579 <a NAME="SubstyledLexer.substyleDefaultDescription" ID="SubstyledLexer.substyleDefaultDescription"></a>
580 <h4>SubstyledLexer.substyleDefaultDescription</h4>
581 <b>substyleDefaultDescription</b>(<i>style, substyle</i>)
582
583 <p>
584 Public method to get the default description of a sub-style.
585 </p>
586 <dl>
587
588 <dt><i>style</i> (int)</dt>
589 <dd>
590 base style number
591 </dd>
592 <dt><i>substyle</i> (int)</dt>
593 <dd>
594 sub-style number
595 </dd>
596 </dl>
597 <dl>
598 <dt>Return:</dt>
599 <dd>
600 sub-style default description
601 </dd>
602 </dl>
603 <dl>
604 <dt>Return Type:</dt>
605 <dd>
606 str
607 </dd>
608 </dl>
609 <a NAME="SubstyledLexer.substyleDefaultEolFill" ID="SubstyledLexer.substyleDefaultEolFill"></a>
610 <h4>SubstyledLexer.substyleDefaultEolFill</h4>
611 <b>substyleDefaultEolFill</b>(<i>style, substyle</i>)
612
613 <p>
614 Public method to get the default eolfill flag.
615 </p>
616 <dl>
617
618 <dt><i>style</i> (int)</dt>
619 <dd>
620 base style number
621 </dd>
622 <dt><i>substyle</i> (int)</dt>
623 <dd>
624 sub-style number
625 </dd>
626 </dl>
627 <dl>
628 <dt>Return:</dt>
629 <dd>
630 default eolfill flag
631 </dd>
632 </dl>
633 <dl>
634 <dt>Return Type:</dt>
635 <dd>
636 bool
637 </dd>
638 </dl>
639 <a NAME="SubstyledLexer.substyleDefaultFont" ID="SubstyledLexer.substyleDefaultFont"></a>
640 <h4>SubstyledLexer.substyleDefaultFont</h4>
641 <b>substyleDefaultFont</b>(<i>style, substyle</i>)
642
643 <p>
644 Public method to get the default sub-style font.
645 </p>
646 <dl>
647
648 <dt><i>style</i> (int)</dt>
649 <dd>
650 base style number
651 </dd>
652 <dt><i>substyle</i> (int)</dt>
653 <dd>
654 sub-style number
655 </dd>
656 </dl>
657 <dl>
658 <dt>Return:</dt>
659 <dd>
660 default font
661 </dd>
662 </dl>
663 <dl>
664 <dt>Return Type:</dt>
665 <dd>
666 QFont
667 </dd>
668 </dl>
669 <a NAME="SubstyledLexer.substyleDefaultPaper" ID="SubstyledLexer.substyleDefaultPaper"></a>
670 <h4>SubstyledLexer.substyleDefaultPaper</h4>
671 <b>substyleDefaultPaper</b>(<i>style, substyle</i>)
672
673 <p>
674 Public method to get the sub-style default background color.
675 </p>
676 <dl>
677
678 <dt><i>style</i> (int)</dt>
679 <dd>
680 base style number
681 </dd>
682 <dt><i>substyle</i> (int)</dt>
683 <dd>
684 sub-style number
685 </dd>
686 </dl>
687 <dl>
688 <dt>Return:</dt>
689 <dd>
690 default background color
691 </dd>
692 </dl>
693 <dl>
694 <dt>Return Type:</dt>
695 <dd>
696 QColor
697 </dd>
698 </dl>
699 <a NAME="SubstyledLexer.substyleDefaultWords" ID="SubstyledLexer.substyleDefaultWords"></a>
700 <h4>SubstyledLexer.substyleDefaultWords</h4>
701 <b>substyleDefaultWords</b>(<i>style, substyle</i>)
702
703 <p>
704 Public method to get the default words of a sub-style.
705 </p>
706 <dl>
707
708 <dt><i>style</i> (int)</dt>
709 <dd>
710 base style number
711 </dd>
712 <dt><i>substyle</i> (int)</dt>
713 <dd>
714 sub-style number
715 </dd>
716 </dl>
717 <dl>
718 <dt>Return:</dt>
719 <dd>
720 white-space separated default word list
721 </dd>
722 </dl>
723 <dl>
724 <dt>Return Type:</dt>
725 <dd>
726 str
727 </dd>
728 </dl>
729 <a NAME="SubstyledLexer.substyleDescription" ID="SubstyledLexer.substyleDescription"></a>
730 <h4>SubstyledLexer.substyleDescription</h4>
731 <b>substyleDescription</b>(<i>style, substyle</i>)
732
733 <p>
734 Public method to get the description of a sub-style.
735 </p>
736 <dl>
737
738 <dt><i>style</i> (int)</dt>
739 <dd>
740 base style number
741 </dd>
742 <dt><i>substyle</i> (int)</dt>
743 <dd>
744 sub-style number
745 </dd>
746 </dl>
747 <dl>
748 <dt>Return:</dt>
749 <dd>
750 sub-style description
751 </dd>
752 </dl>
753 <dl>
754 <dt>Return Type:</dt>
755 <dd>
756 str
757 </dd>
758 </dl>
759 <a NAME="SubstyledLexer.substyleEolFill" ID="SubstyledLexer.substyleEolFill"></a>
760 <h4>SubstyledLexer.substyleEolFill</h4>
761 <b>substyleEolFill</b>(<i>style, substyle</i>)
762
763 <p>
764 Public method to get the eolfill flag.
765 </p>
766 <dl>
767
768 <dt><i>style</i> (int)</dt>
769 <dd>
770 base style number
771 </dd>
772 <dt><i>substyle</i> (int)</dt>
773 <dd>
774 sub-style number
775 </dd>
776 </dl>
777 <dl>
778 <dt>Return:</dt>
779 <dd>
780 eolfill flag
781 </dd>
782 </dl>
783 <dl>
784 <dt>Return Type:</dt>
785 <dd>
786 bool
787 </dd>
788 </dl>
789 <a NAME="SubstyledLexer.substyleFont" ID="SubstyledLexer.substyleFont"></a>
790 <h4>SubstyledLexer.substyleFont</h4>
791 <b>substyleFont</b>(<i>style, substyle</i>)
792
793 <p>
794 Public method to get the sub-style font.
795 </p>
796 <dl>
797
798 <dt><i>style</i> (int)</dt>
799 <dd>
800 base style number
801 </dd>
802 <dt><i>substyle</i> (int)</dt>
803 <dd>
804 sub-style number
805 </dd>
806 </dl>
807 <dl>
808 <dt>Return:</dt>
809 <dd>
810 font
811 </dd>
812 </dl>
813 <dl>
814 <dt>Return Type:</dt>
815 <dd>
816 QFont
817 </dd>
818 </dl>
819 <a NAME="SubstyledLexer.substylePaper" ID="SubstyledLexer.substylePaper"></a>
820 <h4>SubstyledLexer.substylePaper</h4>
821 <b>substylePaper</b>(<i>style, substyle</i>)
822
823 <p>
824 Public method to get the sub-style background color.
825 </p>
826 <dl>
827
828 <dt><i>style</i> (int)</dt>
829 <dd>
830 base style number
831 </dd>
832 <dt><i>substyle</i> (int)</dt>
833 <dd>
834 sub-style number
835 </dd>
836 </dl>
837 <dl>
838 <dt>Return:</dt>
839 <dd>
840 background color
841 </dd>
842 </dl>
843 <dl>
844 <dt>Return Type:</dt>
845 <dd>
846 QColor
847 </dd>
848 </dl>
849 <a NAME="SubstyledLexer.substyleWords" ID="SubstyledLexer.substyleWords"></a>
850 <h4>SubstyledLexer.substyleWords</h4>
851 <b>substyleWords</b>(<i>style, substyle</i>)
852
853 <p>
854 Public method to get the words of a sub-style.
855 </p>
856 <dl>
857
858 <dt><i>style</i> (int)</dt>
859 <dd>
860 base style number
861 </dd>
862 <dt><i>substyle</i> (int)</dt>
863 <dd>
864 sub-style number
865 </dd>
866 </dl>
867 <dl>
868 <dt>Return:</dt>
869 <dd>
870 white-space separated word list
871 </dd>
872 </dl>
873 <dl>
874 <dt>Return Type:</dt>
875 <dd>
876 str
877 </dd>
878 </dl>
879 <a NAME="SubstyledLexer.substylesCount" ID="SubstyledLexer.substylesCount"></a>
880 <h4>SubstyledLexer.substylesCount</h4>
881 <b>substylesCount</b>(<i>style</i>)
882
883 <p>
884 Public method to get the number of defined sub-styles.
885 </p>
886 <dl>
887
888 <dt><i>style</i> (int)</dt>
889 <dd>
890 base style number
891 </dd>
892 </dl>
893 <dl>
894 <dt>Return:</dt>
895 <dd>
896 number of defined sub-styles
897 </dd>
898 </dl>
899 <dl>
900 <dt>Return Type:</dt>
901 <dd>
902 int
903 </dd>
904 </dl>
905 <a NAME="SubstyledLexer.writeSubstyles" ID="SubstyledLexer.writeSubstyles"></a>
906 <h4>SubstyledLexer.writeSubstyles</h4>
907 <b>writeSubstyles</b>(<i></i>)
908
909 <p>
910 Public method to save the sub-styles.
911 </p>
912 <div align="right"><a href="#top">Up</a></div>
913 <hr />
914 </body></html>

eric ide

mercurial