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

branch
sub_styles
changeset 6866
b792455b35cd
child 6884
2a34f22cdbc1
equal deleted inserted replaced
6865:a65349424cb7 6866:b792455b35cd
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.QScintilla.Lexers.SubstyledLexer</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.SubstyledLexer</h1>
23 <p>
24 Module implementing the lexer mixin class.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#SubstyledLexer">SubstyledLexer</a></td>
34 <td>Class to implement the sub-styled lexer mixin class.</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="SubstyledLexer" ID="SubstyledLexer"></a>
43 <h2>SubstyledLexer</h2>
44 <p>
45 Class to implement the sub-styled lexer mixin class.
46 </p>
47 <h3>Derived from</h3>
48 Lexer
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="#SubstyledLexer.__init__">SubstyledLexer</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#SubstyledLexer.addSubstyle">addSubstyle</a></td>
64 <td>Public method to add an empty sub-style to a given base style.</td>
65 </tr><tr>
66 <td><a href="#SubstyledLexer.delSubstyle">delSubstyle</a></td>
67 <td>Public method to delete a given sub-style definition.</td>
68 </tr><tr>
69 <td><a href="#SubstyledLexer.getBaseStyles">getBaseStyles</a></td>
70 <td>Public method to get the list of supported base styles.</td>
71 </tr><tr>
72 <td><a href="#SubstyledLexer.hasSubstyle">hasSubstyle</a></td>
73 <td>Public method to test for a given sub-style definition.</td>
74 </tr><tr>
75 <td><a href="#SubstyledLexer.hasSubstyles">hasSubstyles</a></td>
76 <td>Public method to indicate the support of sub-styles.</td>
77 </tr><tr>
78 <td><a href="#SubstyledLexer.isBaseStyle">isBaseStyle</a></td>
79 <td>Public method to test, if a given style may have sub-styles.</td>
80 </tr><tr>
81 <td><a href="#SubstyledLexer.loadDefaultSubStyles">loadDefaultSubStyles</a></td>
82 <td>Public method to load the default sub-style definitions.</td>
83 </tr><tr>
84 <td><a href="#SubstyledLexer.loadSubstyles">loadSubstyles</a></td>
85 <td>Public method to load the sub-styles from the settings file.</td>
86 </tr><tr>
87 <td><a href="#SubstyledLexer.readSubstyles">readSubstyles</a></td>
88 <td>Public method to load the sub-styles and configure the editor.</td>
89 </tr><tr>
90 <td><a href="#SubstyledLexer.setSubstyleColor">setSubstyleColor</a></td>
91 <td>Public method to set the foreground color of a sub-style.</td>
92 </tr><tr>
93 <td><a href="#SubstyledLexer.setSubstyleDescription">setSubstyleDescription</a></td>
94 <td>Public method to set the description for a sub-style.</td>
95 </tr><tr>
96 <td><a href="#SubstyledLexer.setSubstyleEolFill">setSubstyleEolFill</a></td>
97 <td>Public method to set the eolfill flag of a sub-style.</td>
98 </tr><tr>
99 <td><a href="#SubstyledLexer.setSubstyleFont">setSubstyleFont</a></td>
100 <td>Public method to set the font of a sub-style.</td>
101 </tr><tr>
102 <td><a href="#SubstyledLexer.setSubstylePaper">setSubstylePaper</a></td>
103 <td>Public method to set the background color of a sub-style.</td>
104 </tr><tr>
105 <td><a href="#SubstyledLexer.setSubstyleWords">setSubstyleWords</a></td>
106 <td>Public method to set the words for a sub-style.</td>
107 </tr><tr>
108 <td><a href="#SubstyledLexer.substyleColor">substyleColor</a></td>
109 <td>Public method to get the sub-style foreground color.</td>
110 </tr><tr>
111 <td><a href="#SubstyledLexer.substyleDefaultColor">substyleDefaultColor</a></td>
112 <td>Public method to get the sub-style default foreground color.</td>
113 </tr><tr>
114 <td><a href="#SubstyledLexer.substyleDefaultDescription">substyleDefaultDescription</a></td>
115 <td>Public method to get the default description of a sub-style.</td>
116 </tr><tr>
117 <td><a href="#SubstyledLexer.substyleDefaultEolFill">substyleDefaultEolFill</a></td>
118 <td>Public method to get the default eolfill flag.</td>
119 </tr><tr>
120 <td><a href="#SubstyledLexer.substyleDefaultFont">substyleDefaultFont</a></td>
121 <td>Public method to get the default sub-style font.</td>
122 </tr><tr>
123 <td><a href="#SubstyledLexer.substyleDefaultPaper">substyleDefaultPaper</a></td>
124 <td>Public method to get the sub-style default background color.</td>
125 </tr><tr>
126 <td><a href="#SubstyledLexer.substyleDefaultWords">substyleDefaultWords</a></td>
127 <td>Public method to get the default words of a sub-style.</td>
128 </tr><tr>
129 <td><a href="#SubstyledLexer.substyleDescription">substyleDescription</a></td>
130 <td>Public method to get the description of a sub-style.</td>
131 </tr><tr>
132 <td><a href="#SubstyledLexer.substyleEolFill">substyleEolFill</a></td>
133 <td>Public method to get the eolfill flag.</td>
134 </tr><tr>
135 <td><a href="#SubstyledLexer.substyleFont">substyleFont</a></td>
136 <td>Public method to get the sub-style font.</td>
137 </tr><tr>
138 <td><a href="#SubstyledLexer.substylePaper">substylePaper</a></td>
139 <td>Public method to get the sub-style background color.</td>
140 </tr><tr>
141 <td><a href="#SubstyledLexer.substyleWords">substyleWords</a></td>
142 <td>Public method to get the words of a sub-style.</td>
143 </tr><tr>
144 <td><a href="#SubstyledLexer.substylesCount">substylesCount</a></td>
145 <td>Public method to get the number of defined sub-styles.</td>
146 </tr><tr>
147 <td><a href="#SubstyledLexer.writeSubstyles">writeSubstyles</a></td>
148 <td>Public method to save the sub-styles.</td>
149 </tr>
150 </table>
151 <h3>Static Methods</h3>
152 <table>
153 <tr><td>None</td></tr>
154 </table>
155 <a NAME="SubstyledLexer.__init__" ID="SubstyledLexer.__init__"></a>
156 <h4>SubstyledLexer (Constructor)</h4>
157 <b>SubstyledLexer</b>(<i></i>)
158 <p>
159 Constructor
160 </p><a NAME="SubstyledLexer.addSubstyle" ID="SubstyledLexer.addSubstyle"></a>
161 <h4>SubstyledLexer.addSubstyle</h4>
162 <b>addSubstyle</b>(<i>style</i>)
163 <p>
164 Public method to add an empty sub-style to a given base style.
165 </p><dl>
166 <dt><i>style</i> (int)</dt>
167 <dd>
168 base style number
169 </dd>
170 </dl><dl>
171 <dt>Returns:</dt>
172 <dd>
173 allocated sub-style number or -1 to indicate an error
174 </dd>
175 </dl><dl>
176 <dt>Return Type:</dt>
177 <dd>
178 int
179 </dd>
180 </dl><a NAME="SubstyledLexer.delSubstyle" ID="SubstyledLexer.delSubstyle"></a>
181 <h4>SubstyledLexer.delSubstyle</h4>
182 <b>delSubstyle</b>(<i>style, substyle</i>)
183 <p>
184 Public method to delete a given sub-style definition.
185 </p><dl>
186 <dt><i>style</i> (int)</dt>
187 <dd>
188 base style number
189 </dd><dt><i>substyle</i> (int)</dt>
190 <dd>
191 sub-style number
192 </dd>
193 </dl><dl>
194 <dt>Returns:</dt>
195 <dd>
196 flag indicating successful deletion
197 </dd>
198 </dl><dl>
199 <dt>Return Type:</dt>
200 <dd>
201 bool
202 </dd>
203 </dl><a NAME="SubstyledLexer.getBaseStyles" ID="SubstyledLexer.getBaseStyles"></a>
204 <h4>SubstyledLexer.getBaseStyles</h4>
205 <b>getBaseStyles</b>(<i></i>)
206 <p>
207 Public method to get the list of supported base styles.
208 </p><dl>
209 <dt>Returns:</dt>
210 <dd>
211 list of base styles
212 </dd>
213 </dl><dl>
214 <dt>Return Type:</dt>
215 <dd>
216 list of int
217 </dd>
218 </dl><a NAME="SubstyledLexer.hasSubstyle" ID="SubstyledLexer.hasSubstyle"></a>
219 <h4>SubstyledLexer.hasSubstyle</h4>
220 <b>hasSubstyle</b>(<i>style, substyle</i>)
221 <p>
222 Public method to test for a given sub-style definition.
223 </p><dl>
224 <dt><i>style</i> (int)</dt>
225 <dd>
226 base style number
227 </dd><dt><i>substyle</i> (int)</dt>
228 <dd>
229 sub-style number
230 </dd>
231 </dl><dl>
232 <dt>Returns:</dt>
233 <dd>
234 flag indicating the existence of a sub-style definition
235 </dd>
236 </dl><dl>
237 <dt>Return Type:</dt>
238 <dd>
239 bool
240 </dd>
241 </dl><a NAME="SubstyledLexer.hasSubstyles" ID="SubstyledLexer.hasSubstyles"></a>
242 <h4>SubstyledLexer.hasSubstyles</h4>
243 <b>hasSubstyles</b>(<i></i>)
244 <p>
245 Public method to indicate the support of sub-styles.
246 </p><dl>
247 <dt>Returns:</dt>
248 <dd>
249 flag indicating sub-styling support
250 </dd>
251 </dl><dl>
252 <dt>Return Type:</dt>
253 <dd>
254 bool
255 </dd>
256 </dl><a NAME="SubstyledLexer.isBaseStyle" ID="SubstyledLexer.isBaseStyle"></a>
257 <h4>SubstyledLexer.isBaseStyle</h4>
258 <b>isBaseStyle</b>(<i>style</i>)
259 <p>
260 Public method to test, if a given style may have sub-styles.
261 </p><dl>
262 <dt><i>style</i> (int)</dt>
263 <dd>
264 base style number
265 </dd>
266 </dl><dl>
267 <dt>Returns:</dt>
268 <dd>
269 flag indicating that the style may have sub-styles
270 </dd>
271 </dl><dl>
272 <dt>Return Type:</dt>
273 <dd>
274 bool
275 </dd>
276 </dl><a NAME="SubstyledLexer.loadDefaultSubStyles" ID="SubstyledLexer.loadDefaultSubStyles"></a>
277 <h4>SubstyledLexer.loadDefaultSubStyles</h4>
278 <b>loadDefaultSubStyles</b>(<i></i>)
279 <p>
280 Public method to load the default sub-style definitions.
281 </p><a NAME="SubstyledLexer.loadSubstyles" ID="SubstyledLexer.loadSubstyles"></a>
282 <h4>SubstyledLexer.loadSubstyles</h4>
283 <b>loadSubstyles</b>(<i></i>)
284 <p>
285 Public method to load the sub-styles from the settings file.
286 </p><a NAME="SubstyledLexer.readSubstyles" ID="SubstyledLexer.readSubstyles"></a>
287 <h4>SubstyledLexer.readSubstyles</h4>
288 <b>readSubstyles</b>(<i>editor</i>)
289 <p>
290 Public method to load the sub-styles and configure the editor.
291 </p><dl>
292 <dt><i>editor</i> (QsciScintilla)</dt>
293 <dd>
294 reference to the editor object
295 </dd>
296 </dl><a NAME="SubstyledLexer.setSubstyleColor" ID="SubstyledLexer.setSubstyleColor"></a>
297 <h4>SubstyledLexer.setSubstyleColor</h4>
298 <b>setSubstyleColor</b>(<i>color, style, substyle</i>)
299 <p>
300 Public method to set the foreground color of a sub-style.
301 </p><dl>
302 <dt><i>color</i> (QColor)</dt>
303 <dd>
304 foreground color to be set
305 </dd><dt><i>style</i> (int)</dt>
306 <dd>
307 base style number
308 </dd><dt><i>substyle</i> (int)</dt>
309 <dd>
310 sub-style number
311 </dd>
312 </dl><a NAME="SubstyledLexer.setSubstyleDescription" ID="SubstyledLexer.setSubstyleDescription"></a>
313 <h4>SubstyledLexer.setSubstyleDescription</h4>
314 <b>setSubstyleDescription</b>(<i>description, style, substyle</i>)
315 <p>
316 Public method to set the description for a sub-style.
317 </p><dl>
318 <dt><i>description</i> (str)</dt>
319 <dd>
320 description to be set
321 </dd><dt><i>style</i> (int)</dt>
322 <dd>
323 base style number
324 </dd><dt><i>substyle</i> (int)</dt>
325 <dd>
326 sub-style number
327 </dd>
328 </dl><a NAME="SubstyledLexer.setSubstyleEolFill" ID="SubstyledLexer.setSubstyleEolFill"></a>
329 <h4>SubstyledLexer.setSubstyleEolFill</h4>
330 <b>setSubstyleEolFill</b>(<i>eolFill, style, substyle</i>)
331 <p>
332 Public method to set the eolfill flag of a sub-style.
333 </p><dl>
334 <dt><i>eolFill</i> (bool)</dt>
335 <dd>
336 eolfill flag to be set
337 </dd><dt><i>style</i> (int)</dt>
338 <dd>
339 base style number
340 </dd><dt><i>substyle</i> (int)</dt>
341 <dd>
342 sub-style number
343 </dd>
344 </dl><a NAME="SubstyledLexer.setSubstyleFont" ID="SubstyledLexer.setSubstyleFont"></a>
345 <h4>SubstyledLexer.setSubstyleFont</h4>
346 <b>setSubstyleFont</b>(<i>font, style, substyle</i>)
347 <p>
348 Public method to set the font of a sub-style.
349 </p><dl>
350 <dt><i>font</i> (QFont)</dt>
351 <dd>
352 font to be set
353 </dd><dt><i>style</i> (int)</dt>
354 <dd>
355 base style number
356 </dd><dt><i>substyle</i> (int)</dt>
357 <dd>
358 sub-style number
359 </dd>
360 </dl><a NAME="SubstyledLexer.setSubstylePaper" ID="SubstyledLexer.setSubstylePaper"></a>
361 <h4>SubstyledLexer.setSubstylePaper</h4>
362 <b>setSubstylePaper</b>(<i>color, style, substyle</i>)
363 <p>
364 Public method to set the background color of a sub-style.
365 </p><dl>
366 <dt><i>color</i> (QColor)</dt>
367 <dd>
368 background color to be set
369 </dd><dt><i>style</i> (int)</dt>
370 <dd>
371 base style number
372 </dd><dt><i>substyle</i> (int)</dt>
373 <dd>
374 sub-style number
375 </dd>
376 </dl><a NAME="SubstyledLexer.setSubstyleWords" ID="SubstyledLexer.setSubstyleWords"></a>
377 <h4>SubstyledLexer.setSubstyleWords</h4>
378 <b>setSubstyleWords</b>(<i>words, style, substyle</i>)
379 <p>
380 Public method to set the words for a sub-style.
381 </p><dl>
382 <dt><i>words</i> (str)</dt>
383 <dd>
384 words to be set separated by white-space
385 </dd><dt><i>style</i> (int)</dt>
386 <dd>
387 base style number
388 </dd><dt><i>substyle</i> (int)</dt>
389 <dd>
390 sub-style number
391 </dd>
392 </dl><a NAME="SubstyledLexer.substyleColor" ID="SubstyledLexer.substyleColor"></a>
393 <h4>SubstyledLexer.substyleColor</h4>
394 <b>substyleColor</b>(<i>style, substyle</i>)
395 <p>
396 Public method to get the sub-style foreground color.
397 </p><dl>
398 <dt><i>style</i> (int)</dt>
399 <dd>
400 base style number
401 </dd><dt><i>substyle</i> (int)</dt>
402 <dd>
403 sub-style number
404 </dd>
405 </dl><dl>
406 <dt>Returns:</dt>
407 <dd>
408 foreground color
409 </dd>
410 </dl><dl>
411 <dt>Return Type:</dt>
412 <dd>
413 QColor
414 </dd>
415 </dl><a NAME="SubstyledLexer.substyleDefaultColor" ID="SubstyledLexer.substyleDefaultColor"></a>
416 <h4>SubstyledLexer.substyleDefaultColor</h4>
417 <b>substyleDefaultColor</b>(<i>style, substyle</i>)
418 <p>
419 Public method to get the sub-style default foreground color.
420 </p><dl>
421 <dt><i>style</i> (int)</dt>
422 <dd>
423 base style number
424 </dd><dt><i>substyle</i> (int)</dt>
425 <dd>
426 sub-style number
427 </dd>
428 </dl><dl>
429 <dt>Returns:</dt>
430 <dd>
431 default foreground color
432 </dd>
433 </dl><dl>
434 <dt>Return Type:</dt>
435 <dd>
436 QColor
437 </dd>
438 </dl><a NAME="SubstyledLexer.substyleDefaultDescription" ID="SubstyledLexer.substyleDefaultDescription"></a>
439 <h4>SubstyledLexer.substyleDefaultDescription</h4>
440 <b>substyleDefaultDescription</b>(<i>style, substyle</i>)
441 <p>
442 Public method to get the default description of a sub-style.
443 </p><dl>
444 <dt><i>style</i> (int)</dt>
445 <dd>
446 base style number
447 </dd><dt><i>substyle</i> (int)</dt>
448 <dd>
449 sub-style number
450 </dd>
451 </dl><dl>
452 <dt>Returns:</dt>
453 <dd>
454 sub-style default description
455 </dd>
456 </dl><dl>
457 <dt>Return Type:</dt>
458 <dd>
459 str
460 </dd>
461 </dl><a NAME="SubstyledLexer.substyleDefaultEolFill" ID="SubstyledLexer.substyleDefaultEolFill"></a>
462 <h4>SubstyledLexer.substyleDefaultEolFill</h4>
463 <b>substyleDefaultEolFill</b>(<i>style, substyle</i>)
464 <p>
465 Public method to get the default eolfill flag.
466 </p><dl>
467 <dt><i>style</i> (int)</dt>
468 <dd>
469 base style number
470 </dd><dt><i>substyle</i> (int)</dt>
471 <dd>
472 sub-style number
473 </dd>
474 </dl><dl>
475 <dt>Returns:</dt>
476 <dd>
477 default eolfill flag
478 </dd>
479 </dl><dl>
480 <dt>Return Type:</dt>
481 <dd>
482 bool
483 </dd>
484 </dl><a NAME="SubstyledLexer.substyleDefaultFont" ID="SubstyledLexer.substyleDefaultFont"></a>
485 <h4>SubstyledLexer.substyleDefaultFont</h4>
486 <b>substyleDefaultFont</b>(<i>style, substyle</i>)
487 <p>
488 Public method to get the default sub-style font.
489 </p><dl>
490 <dt><i>style</i> (int)</dt>
491 <dd>
492 base style number
493 </dd><dt><i>substyle</i> (int)</dt>
494 <dd>
495 sub-style number
496 </dd>
497 </dl><dl>
498 <dt>Returns:</dt>
499 <dd>
500 default font
501 </dd>
502 </dl><dl>
503 <dt>Return Type:</dt>
504 <dd>
505 QFont
506 </dd>
507 </dl><a NAME="SubstyledLexer.substyleDefaultPaper" ID="SubstyledLexer.substyleDefaultPaper"></a>
508 <h4>SubstyledLexer.substyleDefaultPaper</h4>
509 <b>substyleDefaultPaper</b>(<i>style, substyle</i>)
510 <p>
511 Public method to get the sub-style default background color.
512 </p><dl>
513 <dt><i>style</i> (int)</dt>
514 <dd>
515 base style number
516 </dd><dt><i>substyle</i> (int)</dt>
517 <dd>
518 sub-style number
519 </dd>
520 </dl><dl>
521 <dt>Returns:</dt>
522 <dd>
523 default background color
524 </dd>
525 </dl><dl>
526 <dt>Return Type:</dt>
527 <dd>
528 QColor
529 </dd>
530 </dl><a NAME="SubstyledLexer.substyleDefaultWords" ID="SubstyledLexer.substyleDefaultWords"></a>
531 <h4>SubstyledLexer.substyleDefaultWords</h4>
532 <b>substyleDefaultWords</b>(<i>style, substyle</i>)
533 <p>
534 Public method to get the default words of a sub-style.
535 </p><dl>
536 <dt><i>style</i> (int)</dt>
537 <dd>
538 base style number
539 </dd><dt><i>substyle</i> (int)</dt>
540 <dd>
541 sub-style number
542 </dd>
543 </dl><dl>
544 <dt>Returns:</dt>
545 <dd>
546 white-space separated default word list
547 </dd>
548 </dl><dl>
549 <dt>Return Type:</dt>
550 <dd>
551 str
552 </dd>
553 </dl><a NAME="SubstyledLexer.substyleDescription" ID="SubstyledLexer.substyleDescription"></a>
554 <h4>SubstyledLexer.substyleDescription</h4>
555 <b>substyleDescription</b>(<i>style, substyle</i>)
556 <p>
557 Public method to get the description of a sub-style.
558 </p><dl>
559 <dt><i>style</i> (int)</dt>
560 <dd>
561 base style number
562 </dd><dt><i>substyle</i> (int)</dt>
563 <dd>
564 sub-style number
565 </dd>
566 </dl><dl>
567 <dt>Returns:</dt>
568 <dd>
569 sub-style description
570 </dd>
571 </dl><dl>
572 <dt>Return Type:</dt>
573 <dd>
574 str
575 </dd>
576 </dl><a NAME="SubstyledLexer.substyleEolFill" ID="SubstyledLexer.substyleEolFill"></a>
577 <h4>SubstyledLexer.substyleEolFill</h4>
578 <b>substyleEolFill</b>(<i>style, substyle</i>)
579 <p>
580 Public method to get the eolfill flag.
581 </p><dl>
582 <dt><i>style</i> (int)</dt>
583 <dd>
584 base style number
585 </dd><dt><i>substyle</i> (int)</dt>
586 <dd>
587 sub-style number
588 </dd>
589 </dl><dl>
590 <dt>Returns:</dt>
591 <dd>
592 eolfill flag
593 </dd>
594 </dl><dl>
595 <dt>Return Type:</dt>
596 <dd>
597 bool
598 </dd>
599 </dl><a NAME="SubstyledLexer.substyleFont" ID="SubstyledLexer.substyleFont"></a>
600 <h4>SubstyledLexer.substyleFont</h4>
601 <b>substyleFont</b>(<i>style, substyle</i>)
602 <p>
603 Public method to get the sub-style font.
604 </p><dl>
605 <dt><i>style</i> (int)</dt>
606 <dd>
607 base style number
608 </dd><dt><i>substyle</i> (int)</dt>
609 <dd>
610 sub-style number
611 </dd>
612 </dl><dl>
613 <dt>Returns:</dt>
614 <dd>
615 font
616 </dd>
617 </dl><dl>
618 <dt>Return Type:</dt>
619 <dd>
620 QFont
621 </dd>
622 </dl><a NAME="SubstyledLexer.substylePaper" ID="SubstyledLexer.substylePaper"></a>
623 <h4>SubstyledLexer.substylePaper</h4>
624 <b>substylePaper</b>(<i>style, substyle</i>)
625 <p>
626 Public method to get the sub-style background color.
627 </p><dl>
628 <dt><i>style</i> (int)</dt>
629 <dd>
630 base style number
631 </dd><dt><i>substyle</i> (int)</dt>
632 <dd>
633 sub-style number
634 </dd>
635 </dl><dl>
636 <dt>Returns:</dt>
637 <dd>
638 background color
639 </dd>
640 </dl><dl>
641 <dt>Return Type:</dt>
642 <dd>
643 QColor
644 </dd>
645 </dl><a NAME="SubstyledLexer.substyleWords" ID="SubstyledLexer.substyleWords"></a>
646 <h4>SubstyledLexer.substyleWords</h4>
647 <b>substyleWords</b>(<i>style, substyle</i>)
648 <p>
649 Public method to get the words of a sub-style.
650 </p><dl>
651 <dt><i>style</i> (int)</dt>
652 <dd>
653 base style number
654 </dd><dt><i>substyle</i> (int)</dt>
655 <dd>
656 sub-style number
657 </dd>
658 </dl><dl>
659 <dt>Returns:</dt>
660 <dd>
661 white-space separated word list
662 </dd>
663 </dl><dl>
664 <dt>Return Type:</dt>
665 <dd>
666 str
667 </dd>
668 </dl><a NAME="SubstyledLexer.substylesCount" ID="SubstyledLexer.substylesCount"></a>
669 <h4>SubstyledLexer.substylesCount</h4>
670 <b>substylesCount</b>(<i>style</i>)
671 <p>
672 Public method to get the number of defined sub-styles.
673 </p><dl>
674 <dt><i>style</i> (int)</dt>
675 <dd>
676 base style number
677 </dd>
678 </dl><dl>
679 <dt>Returns:</dt>
680 <dd>
681 number of defined sub-styles
682 </dd>
683 </dl><dl>
684 <dt>Return Type:</dt>
685 <dd>
686 int
687 </dd>
688 </dl><a NAME="SubstyledLexer.writeSubstyles" ID="SubstyledLexer.writeSubstyles"></a>
689 <h4>SubstyledLexer.writeSubstyles</h4>
690 <b>writeSubstyles</b>(<i></i>)
691 <p>
692 Public method to save the sub-styles.
693 </p>
694 <div align="right"><a href="#top">Up</a></div>
695 <hr />
696 </body></html>

eric ide

mercurial