Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Preferences.PreferencesLexer.html

eric6/Documentation/Source/eric6.Preferences.PreferencesLexer.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Preferences.PreferencesLexer</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.Preferences.PreferencesLexer</h1>
23 <p>
24 Module implementing a special QScintilla lexer to handle the preferences.
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="#PreferencesLexer">PreferencesLexer</a></td>
34 <td>Class implementing a Lexer facade for the highlighting styles configuration.</td>
35 </tr><tr>
36 <td><a href="#PreferencesLexerError">PreferencesLexerError</a></td>
37 <td>Class defining a special error for the PreferencesLexer class.</td>
38 </tr><tr>
39 <td><a href="#PreferencesLexerLanguageError">PreferencesLexerLanguageError</a></td>
40 <td>Class defining a special error for the PreferencesLexer class.</td>
41 </tr>
42 </table>
43 <h3>Functions</h3>
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr /><hr />
48 <a NAME="PreferencesLexer" ID="PreferencesLexer"></a>
49 <h2>PreferencesLexer</h2>
50 <p>
51 Class implementing a Lexer facade for the highlighting styles
52 configuration.
53 </p>
54 <h3>Derived from</h3>
55 QObject
56 <h3>Class Attributes</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Class Methods</h3>
61 <table>
62 <tr><td>None</td></tr>
63 </table>
64 <h3>Methods</h3>
65 <table>
66 <tr>
67 <td><a href="#PreferencesLexer.__init__">PreferencesLexer</a></td>
68 <td>Constructor</td>
69 </tr><tr>
70 <td><a href="#PreferencesLexer.addSubstyle">addSubstyle</a></td>
71 <td>Public method to add an empty sub-style to a given style.</td>
72 </tr><tr>
73 <td><a href="#PreferencesLexer.color">color</a></td>
74 <td>Public method to get the color of a style.</td>
75 </tr><tr>
76 <td><a href="#PreferencesLexer.defaultColor">defaultColor</a></td>
77 <td>Public method to get the default color of a style.</td>
78 </tr><tr>
79 <td><a href="#PreferencesLexer.defaultDescription">defaultDescription</a></td>
80 <td>Public method to get the default descriptive string for a style.</td>
81 </tr><tr>
82 <td><a href="#PreferencesLexer.defaultEolFill">defaultEolFill</a></td>
83 <td>Public method to get the default eolFill flag for a style.</td>
84 </tr><tr>
85 <td><a href="#PreferencesLexer.defaultFont">defaultFont</a></td>
86 <td>Public method to get the default font for a style.</td>
87 </tr><tr>
88 <td><a href="#PreferencesLexer.defaultPaper">defaultPaper</a></td>
89 <td>Public method to get the default background for a style.</td>
90 </tr><tr>
91 <td><a href="#PreferencesLexer.defaultWords">defaultWords</a></td>
92 <td>Public method to get the default list of words for a style.</td>
93 </tr><tr>
94 <td><a href="#PreferencesLexer.delSubstyle">delSubstyle</a></td>
95 <td>Public method to delete a given sub-style definition.</td>
96 </tr><tr>
97 <td><a href="#PreferencesLexer.description">description</a></td>
98 <td>Public method to get a descriptive string for a style.</td>
99 </tr><tr>
100 <td><a href="#PreferencesLexer.eolFill">eolFill</a></td>
101 <td>Public method to get the eolFill flag for a style.</td>
102 </tr><tr>
103 <td><a href="#PreferencesLexer.font">font</a></td>
104 <td>Public method to get the font for a style.</td>
105 </tr><tr>
106 <td><a href="#PreferencesLexer.getStyles">getStyles</a></td>
107 <td>Public method to get a list of all supported styles.</td>
108 </tr><tr>
109 <td><a href="#PreferencesLexer.getSubStyles">getSubStyles</a></td>
110 <td>Public method to get a list of all sub-styles of a style.</td>
111 </tr><tr>
112 <td><a href="#PreferencesLexer.hasStyle">hasStyle</a></td>
113 <td>Public method to test for a given style definition.</td>
114 </tr><tr>
115 <td><a href="#PreferencesLexer.isBaseStyle">isBaseStyle</a></td>
116 <td>Public method to test, if a given style may have sub-styles.</td>
117 </tr><tr>
118 <td><a href="#PreferencesLexer.language">language</a></td>
119 <td>Public method to get the lexers programming language.</td>
120 </tr><tr>
121 <td><a href="#PreferencesLexer.loadDefaultSubStyles">loadDefaultSubStyles</a></td>
122 <td>Public method to load the default sub-styles for a given base style.</td>
123 </tr><tr>
124 <td><a href="#PreferencesLexer.paper">paper</a></td>
125 <td>Public method to get the background for a style.</td>
126 </tr><tr>
127 <td><a href="#PreferencesLexer.setColor">setColor</a></td>
128 <td>Public method to set the color for a style.</td>
129 </tr><tr>
130 <td><a href="#PreferencesLexer.setDescription">setDescription</a></td>
131 <td>Public method to set a descriptive string for a style.</td>
132 </tr><tr>
133 <td><a href="#PreferencesLexer.setEolFill">setEolFill</a></td>
134 <td>Public method to set the eolFill flag for a style.</td>
135 </tr><tr>
136 <td><a href="#PreferencesLexer.setFont">setFont</a></td>
137 <td>Public method to set the font for a style.</td>
138 </tr><tr>
139 <td><a href="#PreferencesLexer.setPaper">setPaper</a></td>
140 <td>Public method to set the background for a style.</td>
141 </tr><tr>
142 <td><a href="#PreferencesLexer.setWords">setWords</a></td>
143 <td>Public method to set the list of words for a style.</td>
144 </tr><tr>
145 <td><a href="#PreferencesLexer.words">words</a></td>
146 <td>Public method to get the list of words for a style.</td>
147 </tr><tr>
148 <td><a href="#PreferencesLexer.writeSettings">writeSettings</a></td>
149 <td>Public method to write the lexer settings.</td>
150 </tr>
151 </table>
152 <h3>Static Methods</h3>
153 <table>
154 <tr><td>None</td></tr>
155 </table>
156 <a NAME="PreferencesLexer.__init__" ID="PreferencesLexer.__init__"></a>
157 <h4>PreferencesLexer (Constructor)</h4>
158 <b>PreferencesLexer</b>(<i>language, parent=None</i>)
159 <p>
160 Constructor
161 </p><dl>
162 <dt><i>language</i> (str)</dt>
163 <dd>
164 language of the lexer
165 </dd><dt><i>parent</i></dt>
166 <dd>
167 parent widget of this lexer (QWidget)
168 </dd>
169 </dl><dl>
170 <dt>Raises <b>PreferencesLexerLanguageError</b>:</dt>
171 <dd>
172 raised to indicate an invalid
173 lexer language
174 </dd>
175 </dl><a NAME="PreferencesLexer.addSubstyle" ID="PreferencesLexer.addSubstyle"></a>
176 <h4>PreferencesLexer.addSubstyle</h4>
177 <b>addSubstyle</b>(<i>style</i>)
178 <p>
179 Public method to add an empty sub-style to a given style.
180 </p><dl>
181 <dt><i>style</i> (int)</dt>
182 <dd>
183 style number
184 </dd>
185 </dl><dl>
186 <dt>Returns:</dt>
187 <dd>
188 allocated sub-style number or -1 to indicate an error
189 </dd>
190 </dl><dl>
191 <dt>Return Type:</dt>
192 <dd>
193 int
194 </dd>
195 </dl><a NAME="PreferencesLexer.color" ID="PreferencesLexer.color"></a>
196 <h4>PreferencesLexer.color</h4>
197 <b>color</b>(<i>style, substyle=-1</i>)
198 <p>
199 Public method to get the color of a style.
200 </p><dl>
201 <dt><i>style</i> (int)</dt>
202 <dd>
203 style number
204 </dd><dt><i>substyle</i> (int)</dt>
205 <dd>
206 sub-style number
207 </dd>
208 </dl><dl>
209 <dt>Returns:</dt>
210 <dd>
211 color
212 </dd>
213 </dl><dl>
214 <dt>Return Type:</dt>
215 <dd>
216 QColor
217 </dd>
218 </dl><a NAME="PreferencesLexer.defaultColor" ID="PreferencesLexer.defaultColor"></a>
219 <h4>PreferencesLexer.defaultColor</h4>
220 <b>defaultColor</b>(<i>style, substyle=-1</i>)
221 <p>
222 Public method to get the default color of a style.
223 </p><dl>
224 <dt><i>style</i> (int)</dt>
225 <dd>
226 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 default color
235 </dd>
236 </dl><dl>
237 <dt>Return Type:</dt>
238 <dd>
239 QColor
240 </dd>
241 </dl><a NAME="PreferencesLexer.defaultDescription" ID="PreferencesLexer.defaultDescription"></a>
242 <h4>PreferencesLexer.defaultDescription</h4>
243 <b>defaultDescription</b>(<i>style, substyle=-1</i>)
244 <p>
245 Public method to get the default descriptive string for a style.
246 </p><dl>
247 <dt><i>style</i> (int)</dt>
248 <dd>
249 style number
250 </dd><dt><i>substyle</i> (int)</dt>
251 <dd>
252 sub-style number
253 </dd>
254 </dl><dl>
255 <dt>Returns:</dt>
256 <dd>
257 default description of the style
258 </dd>
259 </dl><dl>
260 <dt>Return Type:</dt>
261 <dd>
262 str
263 </dd>
264 </dl><a NAME="PreferencesLexer.defaultEolFill" ID="PreferencesLexer.defaultEolFill"></a>
265 <h4>PreferencesLexer.defaultEolFill</h4>
266 <b>defaultEolFill</b>(<i>style, substyle=-1</i>)
267 <p>
268 Public method to get the default eolFill flag for a style.
269 </p><dl>
270 <dt><i>style</i> (int)</dt>
271 <dd>
272 style number
273 </dd><dt><i>substyle</i> (int)</dt>
274 <dd>
275 sub-style number
276 </dd>
277 </dl><dl>
278 <dt>Returns:</dt>
279 <dd>
280 default eolFill flag
281 </dd>
282 </dl><dl>
283 <dt>Return Type:</dt>
284 <dd>
285 bool
286 </dd>
287 </dl><a NAME="PreferencesLexer.defaultFont" ID="PreferencesLexer.defaultFont"></a>
288 <h4>PreferencesLexer.defaultFont</h4>
289 <b>defaultFont</b>(<i>style, substyle=-1</i>)
290 <p>
291 Public method to get the default font for a style.
292 </p><dl>
293 <dt><i>style</i> (int)</dt>
294 <dd>
295 style number
296 </dd><dt><i>substyle</i> (int)</dt>
297 <dd>
298 sub-style number
299 </dd>
300 </dl><dl>
301 <dt>Returns:</dt>
302 <dd>
303 default font
304 </dd>
305 </dl><dl>
306 <dt>Return Type:</dt>
307 <dd>
308 QFont
309 </dd>
310 </dl><a NAME="PreferencesLexer.defaultPaper" ID="PreferencesLexer.defaultPaper"></a>
311 <h4>PreferencesLexer.defaultPaper</h4>
312 <b>defaultPaper</b>(<i>style, substyle=-1</i>)
313 <p>
314 Public method to get the default background for a style.
315 </p><dl>
316 <dt><i>style</i> (int)</dt>
317 <dd>
318 style number
319 </dd><dt><i>substyle</i> (int)</dt>
320 <dd>
321 sub-style number
322 </dd>
323 </dl><dl>
324 <dt>Returns:</dt>
325 <dd>
326 default background color
327 </dd>
328 </dl><dl>
329 <dt>Return Type:</dt>
330 <dd>
331 QColor
332 </dd>
333 </dl><a NAME="PreferencesLexer.defaultWords" ID="PreferencesLexer.defaultWords"></a>
334 <h4>PreferencesLexer.defaultWords</h4>
335 <b>defaultWords</b>(<i>style, substyle=-1</i>)
336 <p>
337 Public method to get the default list of words for a style.
338 </p><dl>
339 <dt><i>style</i> (int)</dt>
340 <dd>
341 style number
342 </dd><dt><i>substyle</i> (int)</dt>
343 <dd>
344 sub-style number
345 </dd>
346 </dl><dl>
347 <dt>Returns:</dt>
348 <dd>
349 whitespace separated default list of words
350 </dd>
351 </dl><dl>
352 <dt>Return Type:</dt>
353 <dd>
354 str
355 </dd>
356 </dl><a NAME="PreferencesLexer.delSubstyle" ID="PreferencesLexer.delSubstyle"></a>
357 <h4>PreferencesLexer.delSubstyle</h4>
358 <b>delSubstyle</b>(<i>style, substyle</i>)
359 <p>
360 Public method to delete a given sub-style definition.
361 </p><dl>
362 <dt><i>style</i> (int)</dt>
363 <dd>
364 base style number
365 </dd><dt><i>substyle</i> (int)</dt>
366 <dd>
367 sub-style number
368 </dd>
369 </dl><dl>
370 <dt>Returns:</dt>
371 <dd>
372 flag indicating successful deletion
373 </dd>
374 </dl><dl>
375 <dt>Return Type:</dt>
376 <dd>
377 bool
378 </dd>
379 </dl><a NAME="PreferencesLexer.description" ID="PreferencesLexer.description"></a>
380 <h4>PreferencesLexer.description</h4>
381 <b>description</b>(<i>style, substyle=-1</i>)
382 <p>
383 Public method to get a descriptive string for a style.
384 </p><dl>
385 <dt><i>style</i> (int)</dt>
386 <dd>
387 style number
388 </dd><dt><i>substyle</i> (int)</dt>
389 <dd>
390 sub-style number
391 </dd>
392 </dl><dl>
393 <dt>Returns:</dt>
394 <dd>
395 description of the style
396 </dd>
397 </dl><dl>
398 <dt>Return Type:</dt>
399 <dd>
400 str
401 </dd>
402 </dl><a NAME="PreferencesLexer.eolFill" ID="PreferencesLexer.eolFill"></a>
403 <h4>PreferencesLexer.eolFill</h4>
404 <b>eolFill</b>(<i>style, substyle=-1</i>)
405 <p>
406 Public method to get the eolFill flag for a style.
407 </p><dl>
408 <dt><i>style</i> (int)</dt>
409 <dd>
410 style number
411 </dd><dt><i>substyle</i> (int)</dt>
412 <dd>
413 sub-style number
414 </dd>
415 </dl><dl>
416 <dt>Returns:</dt>
417 <dd>
418 eolFill flag
419 </dd>
420 </dl><dl>
421 <dt>Return Type:</dt>
422 <dd>
423 bool
424 </dd>
425 </dl><a NAME="PreferencesLexer.font" ID="PreferencesLexer.font"></a>
426 <h4>PreferencesLexer.font</h4>
427 <b>font</b>(<i>style, substyle=-1</i>)
428 <p>
429 Public method to get the font for a style.
430 </p><dl>
431 <dt><i>style</i> (int)</dt>
432 <dd>
433 style number
434 </dd><dt><i>substyle</i> (int)</dt>
435 <dd>
436 sub-style number
437 </dd>
438 </dl><dl>
439 <dt>Returns:</dt>
440 <dd>
441 font
442 </dd>
443 </dl><dl>
444 <dt>Return Type:</dt>
445 <dd>
446 QFont
447 </dd>
448 </dl><a NAME="PreferencesLexer.getStyles" ID="PreferencesLexer.getStyles"></a>
449 <h4>PreferencesLexer.getStyles</h4>
450 <b>getStyles</b>(<i></i>)
451 <p>
452 Public method to get a list of all supported styles.
453 </p><dl>
454 <dt>Returns:</dt>
455 <dd>
456 list of tuples each containing the description of the style,
457 style number and sub-style number (or -1 for no sub-style)
458 </dd>
459 </dl><dl>
460 <dt>Return Type:</dt>
461 <dd>
462 list of tuples of (str, int, int)
463 </dd>
464 </dl><a NAME="PreferencesLexer.getSubStyles" ID="PreferencesLexer.getSubStyles"></a>
465 <h4>PreferencesLexer.getSubStyles</h4>
466 <b>getSubStyles</b>(<i>style</i>)
467 <p>
468 Public method to get a list of all sub-styles of a style.
469 </p><dl>
470 <dt><i>style</i> (int)</dt>
471 <dd>
472 style number
473 </dd>
474 </dl><dl>
475 <dt>Returns:</dt>
476 <dd>
477 list of tuples each containing the description of the style,
478 style number and sub-style number (or -1 for no sub-style)
479 </dd>
480 </dl><dl>
481 <dt>Return Type:</dt>
482 <dd>
483 list of tuples of (str, int, int)
484 </dd>
485 </dl><a NAME="PreferencesLexer.hasStyle" ID="PreferencesLexer.hasStyle"></a>
486 <h4>PreferencesLexer.hasStyle</h4>
487 <b>hasStyle</b>(<i>style, substyle</i>)
488 <p>
489 Public method to test for a given style definition.
490 </p><dl>
491 <dt><i>style</i> (int)</dt>
492 <dd>
493 style number
494 </dd><dt><i>substyle</i> (int)</dt>
495 <dd>
496 sub-style number
497 </dd>
498 </dl><dl>
499 <dt>Returns:</dt>
500 <dd>
501 flag indicating the existence of a style definition
502 </dd>
503 </dl><dl>
504 <dt>Return Type:</dt>
505 <dd>
506 bool
507 </dd>
508 </dl><a NAME="PreferencesLexer.isBaseStyle" ID="PreferencesLexer.isBaseStyle"></a>
509 <h4>PreferencesLexer.isBaseStyle</h4>
510 <b>isBaseStyle</b>(<i>style</i>)
511 <p>
512 Public method to test, if a given style may have sub-styles.
513 </p><dl>
514 <dt><i>style</i> (int)</dt>
515 <dd>
516 base style number
517 </dd>
518 </dl><dl>
519 <dt>Returns:</dt>
520 <dd>
521 flag indicating that the style may have sub-styles
522 </dd>
523 </dl><dl>
524 <dt>Return Type:</dt>
525 <dd>
526 bool
527 </dd>
528 </dl><a NAME="PreferencesLexer.language" ID="PreferencesLexer.language"></a>
529 <h4>PreferencesLexer.language</h4>
530 <b>language</b>(<i></i>)
531 <p>
532 Public method to get the lexers programming language.
533 </p><dl>
534 <dt>Returns:</dt>
535 <dd>
536 lexer programming language
537 </dd>
538 </dl><dl>
539 <dt>Return Type:</dt>
540 <dd>
541 str
542 </dd>
543 </dl><a NAME="PreferencesLexer.loadDefaultSubStyles" ID="PreferencesLexer.loadDefaultSubStyles"></a>
544 <h4>PreferencesLexer.loadDefaultSubStyles</h4>
545 <b>loadDefaultSubStyles</b>(<i>style</i>)
546 <p>
547 Public method to load the default sub-styles for a given base style.
548 </p><dl>
549 <dt><i>style</i> (int)</dt>
550 <dd>
551 style number
552 </dd>
553 </dl><a NAME="PreferencesLexer.paper" ID="PreferencesLexer.paper"></a>
554 <h4>PreferencesLexer.paper</h4>
555 <b>paper</b>(<i>style, substyle=-1</i>)
556 <p>
557 Public method to get the background for a style.
558 </p><dl>
559 <dt><i>style</i> (int)</dt>
560 <dd>
561 the 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 background color
570 </dd>
571 </dl><dl>
572 <dt>Return Type:</dt>
573 <dd>
574 QColor
575 </dd>
576 </dl><a NAME="PreferencesLexer.setColor" ID="PreferencesLexer.setColor"></a>
577 <h4>PreferencesLexer.setColor</h4>
578 <b>setColor</b>(<i>c, style, substyle=-1</i>)
579 <p>
580 Public method to set the color for a style.
581 </p><dl>
582 <dt><i>c</i> (QColor)</dt>
583 <dd>
584 color
585 </dd><dt><i>style</i> (int)</dt>
586 <dd>
587 style number
588 </dd><dt><i>substyle</i> (int)</dt>
589 <dd>
590 sub-style number
591 </dd>
592 </dl><a NAME="PreferencesLexer.setDescription" ID="PreferencesLexer.setDescription"></a>
593 <h4>PreferencesLexer.setDescription</h4>
594 <b>setDescription</b>(<i>description, style, substyle=-1</i>)
595 <p>
596 Public method to set a descriptive string for a style.
597 </p><dl>
598 <dt><i>description</i> (str)</dt>
599 <dd>
600 description for the style
601 </dd><dt><i>style</i> (int)</dt>
602 <dd>
603 style number
604 </dd><dt><i>substyle</i> (int)</dt>
605 <dd>
606 sub-style number
607 </dd>
608 </dl><a NAME="PreferencesLexer.setEolFill" ID="PreferencesLexer.setEolFill"></a>
609 <h4>PreferencesLexer.setEolFill</h4>
610 <b>setEolFill</b>(<i>eolfill, style, substyle=-1</i>)
611 <p>
612 Public method to set the eolFill flag for a style.
613 </p><dl>
614 <dt><i>eolfill</i> (bool)</dt>
615 <dd>
616 eolFill flag
617 </dd><dt><i>style</i> (int)</dt>
618 <dd>
619 style number
620 </dd><dt><i>substyle</i> (int)</dt>
621 <dd>
622 sub-style number
623 </dd>
624 </dl><a NAME="PreferencesLexer.setFont" ID="PreferencesLexer.setFont"></a>
625 <h4>PreferencesLexer.setFont</h4>
626 <b>setFont</b>(<i>f, style, substyle=-1</i>)
627 <p>
628 Public method to set the font for a style.
629 </p><dl>
630 <dt><i>f</i> (QFont)</dt>
631 <dd>
632 font
633 </dd><dt><i>style</i> (int)</dt>
634 <dd>
635 style number
636 </dd><dt><i>substyle</i> (int)</dt>
637 <dd>
638 sub-style number
639 </dd>
640 </dl><a NAME="PreferencesLexer.setPaper" ID="PreferencesLexer.setPaper"></a>
641 <h4>PreferencesLexer.setPaper</h4>
642 <b>setPaper</b>(<i>c, style, substyle=-1</i>)
643 <p>
644 Public method to set the background for a style.
645 </p><dl>
646 <dt><i>c</i> (QColor)</dt>
647 <dd>
648 background color
649 </dd><dt><i>style</i> (int)</dt>
650 <dd>
651 style number
652 </dd><dt><i>substyle</i> (int)</dt>
653 <dd>
654 sub-style number
655 </dd>
656 </dl><a NAME="PreferencesLexer.setWords" ID="PreferencesLexer.setWords"></a>
657 <h4>PreferencesLexer.setWords</h4>
658 <b>setWords</b>(<i>words, style, substyle=-1</i>)
659 <p>
660 Public method to set the list of words for a style.
661 </p><dl>
662 <dt><i>words</i> (str)</dt>
663 <dd>
664 whitespace separated list of words
665 </dd><dt><i>style</i> (int)</dt>
666 <dd>
667 style number
668 </dd><dt><i>substyle</i> (int)</dt>
669 <dd>
670 sub-style number
671 </dd>
672 </dl><a NAME="PreferencesLexer.words" ID="PreferencesLexer.words"></a>
673 <h4>PreferencesLexer.words</h4>
674 <b>words</b>(<i>style, substyle=-1</i>)
675 <p>
676 Public method to get the list of words for a style.
677 </p><dl>
678 <dt><i>style</i> (int)</dt>
679 <dd>
680 style number
681 </dd><dt><i>substyle</i> (int)</dt>
682 <dd>
683 sub-style number
684 </dd>
685 </dl><dl>
686 <dt>Returns:</dt>
687 <dd>
688 whitespace separated list of words
689 </dd>
690 </dl><dl>
691 <dt>Return Type:</dt>
692 <dd>
693 str
694 </dd>
695 </dl><a NAME="PreferencesLexer.writeSettings" ID="PreferencesLexer.writeSettings"></a>
696 <h4>PreferencesLexer.writeSettings</h4>
697 <b>writeSettings</b>(<i></i>)
698 <p>
699 Public method to write the lexer settings.
700 </p>
701 <div align="right"><a href="#top">Up</a></div>
702 <hr /><hr />
703 <a NAME="PreferencesLexerError" ID="PreferencesLexerError"></a>
704 <h2>PreferencesLexerError</h2>
705 <p>
706 Class defining a special error for the PreferencesLexer class.
707 </p>
708 <h3>Derived from</h3>
709 Exception
710 <h3>Class Attributes</h3>
711 <table>
712 <tr><td>None</td></tr>
713 </table>
714 <h3>Class Methods</h3>
715 <table>
716 <tr><td>None</td></tr>
717 </table>
718 <h3>Methods</h3>
719 <table>
720 <tr>
721 <td><a href="#PreferencesLexerError.__init__">PreferencesLexerError</a></td>
722 <td>Constructor</td>
723 </tr><tr>
724 <td><a href="#PreferencesLexerError.__repr__">__repr__</a></td>
725 <td>Special method returning a representation of the exception.</td>
726 </tr><tr>
727 <td><a href="#PreferencesLexerError.__str__">__str__</a></td>
728 <td>Special method returning a string representation of the exception.</td>
729 </tr>
730 </table>
731 <h3>Static Methods</h3>
732 <table>
733 <tr><td>None</td></tr>
734 </table>
735 <a NAME="PreferencesLexerError.__init__" ID="PreferencesLexerError.__init__"></a>
736 <h4>PreferencesLexerError (Constructor)</h4>
737 <b>PreferencesLexerError</b>(<i></i>)
738 <p>
739 Constructor
740 </p><a NAME="PreferencesLexerError.__repr__" ID="PreferencesLexerError.__repr__"></a>
741 <h4>PreferencesLexerError.__repr__</h4>
742 <b>__repr__</b>(<i></i>)
743 <p>
744 Special method returning a representation of the exception.
745 </p><dl>
746 <dt>Returns:</dt>
747 <dd>
748 string representing the error message
749 </dd>
750 </dl><dl>
751 <dt>Return Type:</dt>
752 <dd>
753 str
754 </dd>
755 </dl><a NAME="PreferencesLexerError.__str__" ID="PreferencesLexerError.__str__"></a>
756 <h4>PreferencesLexerError.__str__</h4>
757 <b>__str__</b>(<i></i>)
758 <p>
759 Special method returning a string representation of the exception.
760 </p><dl>
761 <dt>Returns:</dt>
762 <dd>
763 string representing the error message
764 </dd>
765 </dl><dl>
766 <dt>Return Type:</dt>
767 <dd>
768 str
769 </dd>
770 </dl>
771 <div align="right"><a href="#top">Up</a></div>
772 <hr /><hr />
773 <a NAME="PreferencesLexerLanguageError" ID="PreferencesLexerLanguageError"></a>
774 <h2>PreferencesLexerLanguageError</h2>
775 <p>
776 Class defining a special error for the PreferencesLexer class.
777 </p>
778 <h3>Derived from</h3>
779 PreferencesLexerError
780 <h3>Class Attributes</h3>
781 <table>
782 <tr><td>None</td></tr>
783 </table>
784 <h3>Class Methods</h3>
785 <table>
786 <tr><td>None</td></tr>
787 </table>
788 <h3>Methods</h3>
789 <table>
790 <tr>
791 <td><a href="#PreferencesLexerLanguageError.__init__">PreferencesLexerLanguageError</a></td>
792 <td>Constructor</td>
793 </tr>
794 </table>
795 <h3>Static Methods</h3>
796 <table>
797 <tr><td>None</td></tr>
798 </table>
799 <a NAME="PreferencesLexerLanguageError.__init__" ID="PreferencesLexerLanguageError.__init__"></a>
800 <h4>PreferencesLexerLanguageError (Constructor)</h4>
801 <b>PreferencesLexerLanguageError</b>(<i>language</i>)
802 <p>
803 Constructor
804 </p><dl>
805 <dt><i>language</i> (str)</dt>
806 <dd>
807 lexer language
808 </dd>
809 </dl>
810 <div align="right"><a href="#top">Up</a></div>
811 <hr />
812 </body></html>

Mercurial Repository: eric

eric ide

mercurial