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