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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.Preferences.PreferencesLexer</h1> 23 <h1>eric6.Preferences.PreferencesLexer</h1>
24
23 <p> 25 <p>
24 Module implementing a special QScintilla lexer to handle the preferences. 26 Module implementing a special QScintilla lexer to handle the preferences.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#PreferencesLexer">PreferencesLexer</a></td> 38 <td><a href="#PreferencesLexer">PreferencesLexer</a></td>
34 <td>Class implementing a Lexer facade for the highlighting styles configuration.</td> 39 <td>Class implementing a Lexer facade for the highlighting styles configuration.</td>
35 </tr><tr> 40 </tr>
41 <tr>
36 <td><a href="#PreferencesLexerError">PreferencesLexerError</a></td> 42 <td><a href="#PreferencesLexerError">PreferencesLexerError</a></td>
37 <td>Class defining a special error for the PreferencesLexer class.</td> 43 <td>Class defining a special error for the PreferencesLexer class.</td>
38 </tr><tr> 44 </tr>
45 <tr>
39 <td><a href="#PreferencesLexerLanguageError">PreferencesLexerLanguageError</a></td> 46 <td><a href="#PreferencesLexerLanguageError">PreferencesLexerLanguageError</a></td>
40 <td>Class defining a special error for the PreferencesLexer class.</td> 47 <td>Class defining a special error for the PreferencesLexer class.</td>
41 </tr> 48 </tr>
42 </table> 49 </table>
43 <h3>Functions</h3> 50 <h3>Functions</h3>
51
44 <table> 52 <table>
45 <tr><td>None</td></tr> 53 <tr><td>None</td></tr>
46 </table> 54 </table>
47 <hr /><hr /> 55 <hr />
56 <hr />
48 <a NAME="PreferencesLexer" ID="PreferencesLexer"></a> 57 <a NAME="PreferencesLexer" ID="PreferencesLexer"></a>
49 <h2>PreferencesLexer</h2> 58 <h2>PreferencesLexer</h2>
59
50 <p> 60 <p>
51 Class implementing a Lexer facade for the highlighting styles 61 Class implementing a Lexer facade for the highlighting styles
52 configuration. 62 configuration.
53 </p> 63 </p>
54 <h3>Derived from</h3> 64 <h3>Derived from</h3>
55 QObject 65 QObject
56 <h3>Class Attributes</h3> 66 <h3>Class Attributes</h3>
67
57 <table> 68 <table>
58 <tr><td>None</td></tr> 69 <tr><td>None</td></tr>
59 </table> 70 </table>
60 <h3>Class Methods</h3> 71 <h3>Class Methods</h3>
72
61 <table> 73 <table>
62 <tr><td>None</td></tr> 74 <tr><td>None</td></tr>
63 </table> 75 </table>
64 <h3>Methods</h3> 76 <h3>Methods</h3>
65 <table> 77
78 <table>
79
66 <tr> 80 <tr>
67 <td><a href="#PreferencesLexer.__init__">PreferencesLexer</a></td> 81 <td><a href="#PreferencesLexer.__init__">PreferencesLexer</a></td>
68 <td>Constructor</td> 82 <td>Constructor</td>
69 </tr><tr> 83 </tr>
84 <tr>
70 <td><a href="#PreferencesLexer.addSubstyle">addSubstyle</a></td> 85 <td><a href="#PreferencesLexer.addSubstyle">addSubstyle</a></td>
71 <td>Public method to add an empty sub-style to a given style.</td> 86 <td>Public method to add an empty sub-style to a given style.</td>
72 </tr><tr> 87 </tr>
88 <tr>
73 <td><a href="#PreferencesLexer.color">color</a></td> 89 <td><a href="#PreferencesLexer.color">color</a></td>
74 <td>Public method to get the color of a style.</td> 90 <td>Public method to get the color of a style.</td>
75 </tr><tr> 91 </tr>
92 <tr>
76 <td><a href="#PreferencesLexer.defaultColor">defaultColor</a></td> 93 <td><a href="#PreferencesLexer.defaultColor">defaultColor</a></td>
77 <td>Public method to get the default color of a style.</td> 94 <td>Public method to get the default color of a style.</td>
78 </tr><tr> 95 </tr>
96 <tr>
79 <td><a href="#PreferencesLexer.defaultDescription">defaultDescription</a></td> 97 <td><a href="#PreferencesLexer.defaultDescription">defaultDescription</a></td>
80 <td>Public method to get the default descriptive string for a style.</td> 98 <td>Public method to get the default descriptive string for a style.</td>
81 </tr><tr> 99 </tr>
100 <tr>
82 <td><a href="#PreferencesLexer.defaultEolFill">defaultEolFill</a></td> 101 <td><a href="#PreferencesLexer.defaultEolFill">defaultEolFill</a></td>
83 <td>Public method to get the default eolFill flag for a style.</td> 102 <td>Public method to get the default eolFill flag for a style.</td>
84 </tr><tr> 103 </tr>
104 <tr>
85 <td><a href="#PreferencesLexer.defaultFont">defaultFont</a></td> 105 <td><a href="#PreferencesLexer.defaultFont">defaultFont</a></td>
86 <td>Public method to get the default font for a style.</td> 106 <td>Public method to get the default font for a style.</td>
87 </tr><tr> 107 </tr>
108 <tr>
88 <td><a href="#PreferencesLexer.defaultPaper">defaultPaper</a></td> 109 <td><a href="#PreferencesLexer.defaultPaper">defaultPaper</a></td>
89 <td>Public method to get the default background for a style.</td> 110 <td>Public method to get the default background for a style.</td>
90 </tr><tr> 111 </tr>
112 <tr>
91 <td><a href="#PreferencesLexer.defaultWords">defaultWords</a></td> 113 <td><a href="#PreferencesLexer.defaultWords">defaultWords</a></td>
92 <td>Public method to get the default list of words for a style.</td> 114 <td>Public method to get the default list of words for a style.</td>
93 </tr><tr> 115 </tr>
116 <tr>
94 <td><a href="#PreferencesLexer.delSubstyle">delSubstyle</a></td> 117 <td><a href="#PreferencesLexer.delSubstyle">delSubstyle</a></td>
95 <td>Public method to delete a given sub-style definition.</td> 118 <td>Public method to delete a given sub-style definition.</td>
96 </tr><tr> 119 </tr>
120 <tr>
97 <td><a href="#PreferencesLexer.description">description</a></td> 121 <td><a href="#PreferencesLexer.description">description</a></td>
98 <td>Public method to get a descriptive string for a style.</td> 122 <td>Public method to get a descriptive string for a style.</td>
99 </tr><tr> 123 </tr>
124 <tr>
100 <td><a href="#PreferencesLexer.eolFill">eolFill</a></td> 125 <td><a href="#PreferencesLexer.eolFill">eolFill</a></td>
101 <td>Public method to get the eolFill flag for a style.</td> 126 <td>Public method to get the eolFill flag for a style.</td>
102 </tr><tr> 127 </tr>
128 <tr>
103 <td><a href="#PreferencesLexer.font">font</a></td> 129 <td><a href="#PreferencesLexer.font">font</a></td>
104 <td>Public method to get the font for a style.</td> 130 <td>Public method to get the font for a style.</td>
105 </tr><tr> 131 </tr>
132 <tr>
106 <td><a href="#PreferencesLexer.getStyles">getStyles</a></td> 133 <td><a href="#PreferencesLexer.getStyles">getStyles</a></td>
107 <td>Public method to get a list of all supported styles.</td> 134 <td>Public method to get a list of all supported styles.</td>
108 </tr><tr> 135 </tr>
136 <tr>
109 <td><a href="#PreferencesLexer.getSubStyles">getSubStyles</a></td> 137 <td><a href="#PreferencesLexer.getSubStyles">getSubStyles</a></td>
110 <td>Public method to get a list of all sub-styles of a style.</td> 138 <td>Public method to get a list of all sub-styles of a style.</td>
111 </tr><tr> 139 </tr>
140 <tr>
112 <td><a href="#PreferencesLexer.hasStyle">hasStyle</a></td> 141 <td><a href="#PreferencesLexer.hasStyle">hasStyle</a></td>
113 <td>Public method to test for a given style definition.</td> 142 <td>Public method to test for a given style definition.</td>
114 </tr><tr> 143 </tr>
144 <tr>
115 <td><a href="#PreferencesLexer.isBaseStyle">isBaseStyle</a></td> 145 <td><a href="#PreferencesLexer.isBaseStyle">isBaseStyle</a></td>
116 <td>Public method to test, if a given style may have sub-styles.</td> 146 <td>Public method to test, if a given style may have sub-styles.</td>
117 </tr><tr> 147 </tr>
148 <tr>
118 <td><a href="#PreferencesLexer.language">language</a></td> 149 <td><a href="#PreferencesLexer.language">language</a></td>
119 <td>Public method to get the lexers programming language.</td> 150 <td>Public method to get the lexers programming language.</td>
120 </tr><tr> 151 </tr>
152 <tr>
121 <td><a href="#PreferencesLexer.loadDefaultSubStyles">loadDefaultSubStyles</a></td> 153 <td><a href="#PreferencesLexer.loadDefaultSubStyles">loadDefaultSubStyles</a></td>
122 <td>Public method to load the default sub-styles for a given base style.</td> 154 <td>Public method to load the default sub-styles for a given base style.</td>
123 </tr><tr> 155 </tr>
156 <tr>
124 <td><a href="#PreferencesLexer.paper">paper</a></td> 157 <td><a href="#PreferencesLexer.paper">paper</a></td>
125 <td>Public method to get the background for a style.</td> 158 <td>Public method to get the background for a style.</td>
126 </tr><tr> 159 </tr>
160 <tr>
127 <td><a href="#PreferencesLexer.setColor">setColor</a></td> 161 <td><a href="#PreferencesLexer.setColor">setColor</a></td>
128 <td>Public method to set the color for a style.</td> 162 <td>Public method to set the color for a style.</td>
129 </tr><tr> 163 </tr>
164 <tr>
130 <td><a href="#PreferencesLexer.setDescription">setDescription</a></td> 165 <td><a href="#PreferencesLexer.setDescription">setDescription</a></td>
131 <td>Public method to set a descriptive string for a style.</td> 166 <td>Public method to set a descriptive string for a style.</td>
132 </tr><tr> 167 </tr>
168 <tr>
133 <td><a href="#PreferencesLexer.setEolFill">setEolFill</a></td> 169 <td><a href="#PreferencesLexer.setEolFill">setEolFill</a></td>
134 <td>Public method to set the eolFill flag for a style.</td> 170 <td>Public method to set the eolFill flag for a style.</td>
135 </tr><tr> 171 </tr>
172 <tr>
136 <td><a href="#PreferencesLexer.setFont">setFont</a></td> 173 <td><a href="#PreferencesLexer.setFont">setFont</a></td>
137 <td>Public method to set the font for a style.</td> 174 <td>Public method to set the font for a style.</td>
138 </tr><tr> 175 </tr>
176 <tr>
139 <td><a href="#PreferencesLexer.setPaper">setPaper</a></td> 177 <td><a href="#PreferencesLexer.setPaper">setPaper</a></td>
140 <td>Public method to set the background for a style.</td> 178 <td>Public method to set the background for a style.</td>
141 </tr><tr> 179 </tr>
180 <tr>
142 <td><a href="#PreferencesLexer.setWords">setWords</a></td> 181 <td><a href="#PreferencesLexer.setWords">setWords</a></td>
143 <td>Public method to set the list of words for a style.</td> 182 <td>Public method to set the list of words for a style.</td>
144 </tr><tr> 183 </tr>
184 <tr>
145 <td><a href="#PreferencesLexer.words">words</a></td> 185 <td><a href="#PreferencesLexer.words">words</a></td>
146 <td>Public method to get the list of words for a style.</td> 186 <td>Public method to get the list of words for a style.</td>
147 </tr><tr> 187 </tr>
188 <tr>
148 <td><a href="#PreferencesLexer.writeSettings">writeSettings</a></td> 189 <td><a href="#PreferencesLexer.writeSettings">writeSettings</a></td>
149 <td>Public method to write the lexer settings.</td> 190 <td>Public method to write the lexer settings.</td>
150 </tr> 191 </tr>
151 </table> 192 </table>
152 <h3>Static Methods</h3> 193 <h3>Static Methods</h3>
194
153 <table> 195 <table>
154 <tr><td>None</td></tr> 196 <tr><td>None</td></tr>
155 </table> 197 </table>
198
156 <a NAME="PreferencesLexer.__init__" ID="PreferencesLexer.__init__"></a> 199 <a NAME="PreferencesLexer.__init__" ID="PreferencesLexer.__init__"></a>
157 <h4>PreferencesLexer (Constructor)</h4> 200 <h4>PreferencesLexer (Constructor)</h4>
158 <b>PreferencesLexer</b>(<i>language, parent=None</i>) 201 <b>PreferencesLexer</b>(<i>language, parent=None</i>)
202
159 <p> 203 <p>
160 Constructor 204 Constructor
161 </p><dl> 205 </p>
206 <dl>
207
162 <dt><i>language</i> (str)</dt> 208 <dt><i>language</i> (str)</dt>
163 <dd> 209 <dd>
164 language of the lexer 210 language of the lexer
165 </dd><dt><i>parent</i></dt> 211 </dd>
212 <dt><i>parent</i></dt>
166 <dd> 213 <dd>
167 parent widget of this lexer (QWidget) 214 parent widget of this lexer (QWidget)
168 </dd> 215 </dd>
169 </dl><dl> 216 </dl>
217 <dl>
218
170 <dt>Raises <b>PreferencesLexerLanguageError</b>:</dt> 219 <dt>Raises <b>PreferencesLexerLanguageError</b>:</dt>
171 <dd> 220 <dd>
172 raised to indicate an invalid 221 raised to indicate an invalid
173 lexer language 222 lexer language
174 </dd> 223 </dd>
175 </dl><a NAME="PreferencesLexer.addSubstyle" ID="PreferencesLexer.addSubstyle"></a> 224 </dl>
225 <a NAME="PreferencesLexer.addSubstyle" ID="PreferencesLexer.addSubstyle"></a>
176 <h4>PreferencesLexer.addSubstyle</h4> 226 <h4>PreferencesLexer.addSubstyle</h4>
177 <b>addSubstyle</b>(<i>style</i>) 227 <b>addSubstyle</b>(<i>style</i>)
228
178 <p> 229 <p>
179 Public method to add an empty sub-style to a given style. 230 Public method to add an empty sub-style to a given style.
180 </p><dl> 231 </p>
181 <dt><i>style</i> (int)</dt> 232 <dl>
182 <dd> 233
183 style number 234 <dt><i>style</i> (int)</dt>
184 </dd> 235 <dd>
185 </dl><dl> 236 style number
237 </dd>
238 </dl>
239 <dl>
186 <dt>Returns:</dt> 240 <dt>Returns:</dt>
187 <dd> 241 <dd>
188 allocated sub-style number or -1 to indicate an error 242 allocated sub-style number or -1 to indicate an error
189 </dd> 243 </dd>
190 </dl><dl> 244 </dl>
245 <dl>
191 <dt>Return Type:</dt> 246 <dt>Return Type:</dt>
192 <dd> 247 <dd>
193 int 248 int
194 </dd> 249 </dd>
195 </dl><a NAME="PreferencesLexer.color" ID="PreferencesLexer.color"></a> 250 </dl>
251 <a NAME="PreferencesLexer.color" ID="PreferencesLexer.color"></a>
196 <h4>PreferencesLexer.color</h4> 252 <h4>PreferencesLexer.color</h4>
197 <b>color</b>(<i>style, substyle=-1</i>) 253 <b>color</b>(<i>style, substyle=-1</i>)
254
198 <p> 255 <p>
199 Public method to get the color of a style. 256 Public method to get the color of a style.
200 </p><dl> 257 </p>
201 <dt><i>style</i> (int)</dt> 258 <dl>
202 <dd> 259
203 style number 260 <dt><i>style</i> (int)</dt>
204 </dd><dt><i>substyle</i> (int)</dt> 261 <dd>
205 <dd> 262 style number
206 sub-style number 263 </dd>
207 </dd> 264 <dt><i>substyle</i> (int)</dt>
208 </dl><dl> 265 <dd>
266 sub-style number
267 </dd>
268 </dl>
269 <dl>
209 <dt>Returns:</dt> 270 <dt>Returns:</dt>
210 <dd> 271 <dd>
211 color 272 color
212 </dd> 273 </dd>
213 </dl><dl> 274 </dl>
275 <dl>
214 <dt>Return Type:</dt> 276 <dt>Return Type:</dt>
215 <dd> 277 <dd>
216 QColor 278 QColor
217 </dd> 279 </dd>
218 </dl><a NAME="PreferencesLexer.defaultColor" ID="PreferencesLexer.defaultColor"></a> 280 </dl>
281 <a NAME="PreferencesLexer.defaultColor" ID="PreferencesLexer.defaultColor"></a>
219 <h4>PreferencesLexer.defaultColor</h4> 282 <h4>PreferencesLexer.defaultColor</h4>
220 <b>defaultColor</b>(<i>style, substyle=-1</i>) 283 <b>defaultColor</b>(<i>style, substyle=-1</i>)
284
221 <p> 285 <p>
222 Public method to get the default color of a style. 286 Public method to get the default color of a style.
223 </p><dl> 287 </p>
224 <dt><i>style</i> (int)</dt> 288 <dl>
225 <dd> 289
226 style number 290 <dt><i>style</i> (int)</dt>
227 </dd><dt><i>substyle</i> (int)</dt> 291 <dd>
228 <dd> 292 style number
229 sub-style number 293 </dd>
230 </dd> 294 <dt><i>substyle</i> (int)</dt>
231 </dl><dl> 295 <dd>
296 sub-style number
297 </dd>
298 </dl>
299 <dl>
232 <dt>Returns:</dt> 300 <dt>Returns:</dt>
233 <dd> 301 <dd>
234 default color 302 default color
235 </dd> 303 </dd>
236 </dl><dl> 304 </dl>
305 <dl>
237 <dt>Return Type:</dt> 306 <dt>Return Type:</dt>
238 <dd> 307 <dd>
239 QColor 308 QColor
240 </dd> 309 </dd>
241 </dl><a NAME="PreferencesLexer.defaultDescription" ID="PreferencesLexer.defaultDescription"></a> 310 </dl>
311 <a NAME="PreferencesLexer.defaultDescription" ID="PreferencesLexer.defaultDescription"></a>
242 <h4>PreferencesLexer.defaultDescription</h4> 312 <h4>PreferencesLexer.defaultDescription</h4>
243 <b>defaultDescription</b>(<i>style, substyle=-1</i>) 313 <b>defaultDescription</b>(<i>style, substyle=-1</i>)
314
244 <p> 315 <p>
245 Public method to get the default descriptive string for a style. 316 Public method to get the default descriptive string for a style.
246 </p><dl> 317 </p>
247 <dt><i>style</i> (int)</dt> 318 <dl>
248 <dd> 319
249 style number 320 <dt><i>style</i> (int)</dt>
250 </dd><dt><i>substyle</i> (int)</dt> 321 <dd>
251 <dd> 322 style number
252 sub-style number 323 </dd>
253 </dd> 324 <dt><i>substyle</i> (int)</dt>
254 </dl><dl> 325 <dd>
326 sub-style number
327 </dd>
328 </dl>
329 <dl>
255 <dt>Returns:</dt> 330 <dt>Returns:</dt>
256 <dd> 331 <dd>
257 default description of the style 332 default description of the style
258 </dd> 333 </dd>
259 </dl><dl> 334 </dl>
335 <dl>
260 <dt>Return Type:</dt> 336 <dt>Return Type:</dt>
261 <dd> 337 <dd>
262 str 338 str
263 </dd> 339 </dd>
264 </dl><a NAME="PreferencesLexer.defaultEolFill" ID="PreferencesLexer.defaultEolFill"></a> 340 </dl>
341 <a NAME="PreferencesLexer.defaultEolFill" ID="PreferencesLexer.defaultEolFill"></a>
265 <h4>PreferencesLexer.defaultEolFill</h4> 342 <h4>PreferencesLexer.defaultEolFill</h4>
266 <b>defaultEolFill</b>(<i>style, substyle=-1</i>) 343 <b>defaultEolFill</b>(<i>style, substyle=-1</i>)
344
267 <p> 345 <p>
268 Public method to get the default eolFill flag for a style. 346 Public method to get the default eolFill flag for a style.
269 </p><dl> 347 </p>
270 <dt><i>style</i> (int)</dt> 348 <dl>
271 <dd> 349
272 style number 350 <dt><i>style</i> (int)</dt>
273 </dd><dt><i>substyle</i> (int)</dt> 351 <dd>
274 <dd> 352 style number
275 sub-style number 353 </dd>
276 </dd> 354 <dt><i>substyle</i> (int)</dt>
277 </dl><dl> 355 <dd>
356 sub-style number
357 </dd>
358 </dl>
359 <dl>
278 <dt>Returns:</dt> 360 <dt>Returns:</dt>
279 <dd> 361 <dd>
280 default eolFill flag 362 default eolFill flag
281 </dd> 363 </dd>
282 </dl><dl> 364 </dl>
365 <dl>
283 <dt>Return Type:</dt> 366 <dt>Return Type:</dt>
284 <dd> 367 <dd>
285 bool 368 bool
286 </dd> 369 </dd>
287 </dl><a NAME="PreferencesLexer.defaultFont" ID="PreferencesLexer.defaultFont"></a> 370 </dl>
371 <a NAME="PreferencesLexer.defaultFont" ID="PreferencesLexer.defaultFont"></a>
288 <h4>PreferencesLexer.defaultFont</h4> 372 <h4>PreferencesLexer.defaultFont</h4>
289 <b>defaultFont</b>(<i>style, substyle=-1</i>) 373 <b>defaultFont</b>(<i>style, substyle=-1</i>)
374
290 <p> 375 <p>
291 Public method to get the default font for a style. 376 Public method to get the default font for a style.
292 </p><dl> 377 </p>
293 <dt><i>style</i> (int)</dt> 378 <dl>
294 <dd> 379
295 style number 380 <dt><i>style</i> (int)</dt>
296 </dd><dt><i>substyle</i> (int)</dt> 381 <dd>
297 <dd> 382 style number
298 sub-style number 383 </dd>
299 </dd> 384 <dt><i>substyle</i> (int)</dt>
300 </dl><dl> 385 <dd>
386 sub-style number
387 </dd>
388 </dl>
389 <dl>
301 <dt>Returns:</dt> 390 <dt>Returns:</dt>
302 <dd> 391 <dd>
303 default font 392 default font
304 </dd> 393 </dd>
305 </dl><dl> 394 </dl>
395 <dl>
306 <dt>Return Type:</dt> 396 <dt>Return Type:</dt>
307 <dd> 397 <dd>
308 QFont 398 QFont
309 </dd> 399 </dd>
310 </dl><a NAME="PreferencesLexer.defaultPaper" ID="PreferencesLexer.defaultPaper"></a> 400 </dl>
401 <a NAME="PreferencesLexer.defaultPaper" ID="PreferencesLexer.defaultPaper"></a>
311 <h4>PreferencesLexer.defaultPaper</h4> 402 <h4>PreferencesLexer.defaultPaper</h4>
312 <b>defaultPaper</b>(<i>style, substyle=-1</i>) 403 <b>defaultPaper</b>(<i>style, substyle=-1</i>)
404
313 <p> 405 <p>
314 Public method to get the default background for a style. 406 Public method to get the default background for a style.
315 </p><dl> 407 </p>
316 <dt><i>style</i> (int)</dt> 408 <dl>
317 <dd> 409
318 style number 410 <dt><i>style</i> (int)</dt>
319 </dd><dt><i>substyle</i> (int)</dt> 411 <dd>
320 <dd> 412 style number
321 sub-style number 413 </dd>
322 </dd> 414 <dt><i>substyle</i> (int)</dt>
323 </dl><dl> 415 <dd>
416 sub-style number
417 </dd>
418 </dl>
419 <dl>
324 <dt>Returns:</dt> 420 <dt>Returns:</dt>
325 <dd> 421 <dd>
326 default background color 422 default background color
327 </dd> 423 </dd>
328 </dl><dl> 424 </dl>
425 <dl>
329 <dt>Return Type:</dt> 426 <dt>Return Type:</dt>
330 <dd> 427 <dd>
331 QColor 428 QColor
332 </dd> 429 </dd>
333 </dl><a NAME="PreferencesLexer.defaultWords" ID="PreferencesLexer.defaultWords"></a> 430 </dl>
431 <a NAME="PreferencesLexer.defaultWords" ID="PreferencesLexer.defaultWords"></a>
334 <h4>PreferencesLexer.defaultWords</h4> 432 <h4>PreferencesLexer.defaultWords</h4>
335 <b>defaultWords</b>(<i>style, substyle=-1</i>) 433 <b>defaultWords</b>(<i>style, substyle=-1</i>)
434
336 <p> 435 <p>
337 Public method to get the default list of words for a style. 436 Public method to get the default list of words for a style.
338 </p><dl> 437 </p>
339 <dt><i>style</i> (int)</dt> 438 <dl>
340 <dd> 439
341 style number 440 <dt><i>style</i> (int)</dt>
342 </dd><dt><i>substyle</i> (int)</dt> 441 <dd>
343 <dd> 442 style number
344 sub-style number 443 </dd>
345 </dd> 444 <dt><i>substyle</i> (int)</dt>
346 </dl><dl> 445 <dd>
446 sub-style number
447 </dd>
448 </dl>
449 <dl>
347 <dt>Returns:</dt> 450 <dt>Returns:</dt>
348 <dd> 451 <dd>
349 whitespace separated default list of words 452 whitespace separated default list of words
350 </dd> 453 </dd>
351 </dl><dl> 454 </dl>
455 <dl>
352 <dt>Return Type:</dt> 456 <dt>Return Type:</dt>
353 <dd> 457 <dd>
354 str 458 str
355 </dd> 459 </dd>
356 </dl><a NAME="PreferencesLexer.delSubstyle" ID="PreferencesLexer.delSubstyle"></a> 460 </dl>
461 <a NAME="PreferencesLexer.delSubstyle" ID="PreferencesLexer.delSubstyle"></a>
357 <h4>PreferencesLexer.delSubstyle</h4> 462 <h4>PreferencesLexer.delSubstyle</h4>
358 <b>delSubstyle</b>(<i>style, substyle</i>) 463 <b>delSubstyle</b>(<i>style, substyle</i>)
464
359 <p> 465 <p>
360 Public method to delete a given sub-style definition. 466 Public method to delete a given sub-style definition.
361 </p><dl> 467 </p>
468 <dl>
469
362 <dt><i>style</i> (int)</dt> 470 <dt><i>style</i> (int)</dt>
363 <dd> 471 <dd>
364 base style number 472 base style number
365 </dd><dt><i>substyle</i> (int)</dt> 473 </dd>
366 <dd> 474 <dt><i>substyle</i> (int)</dt>
367 sub-style number 475 <dd>
368 </dd> 476 sub-style number
369 </dl><dl> 477 </dd>
478 </dl>
479 <dl>
370 <dt>Returns:</dt> 480 <dt>Returns:</dt>
371 <dd> 481 <dd>
372 flag indicating successful deletion 482 flag indicating successful deletion
373 </dd> 483 </dd>
374 </dl><dl> 484 </dl>
485 <dl>
375 <dt>Return Type:</dt> 486 <dt>Return Type:</dt>
376 <dd> 487 <dd>
377 bool 488 bool
378 </dd> 489 </dd>
379 </dl><a NAME="PreferencesLexer.description" ID="PreferencesLexer.description"></a> 490 </dl>
491 <a NAME="PreferencesLexer.description" ID="PreferencesLexer.description"></a>
380 <h4>PreferencesLexer.description</h4> 492 <h4>PreferencesLexer.description</h4>
381 <b>description</b>(<i>style, substyle=-1</i>) 493 <b>description</b>(<i>style, substyle=-1</i>)
494
382 <p> 495 <p>
383 Public method to get a descriptive string for a style. 496 Public method to get a descriptive string for a style.
384 </p><dl> 497 </p>
385 <dt><i>style</i> (int)</dt> 498 <dl>
386 <dd> 499
387 style number 500 <dt><i>style</i> (int)</dt>
388 </dd><dt><i>substyle</i> (int)</dt> 501 <dd>
389 <dd> 502 style number
390 sub-style number 503 </dd>
391 </dd> 504 <dt><i>substyle</i> (int)</dt>
392 </dl><dl> 505 <dd>
506 sub-style number
507 </dd>
508 </dl>
509 <dl>
393 <dt>Returns:</dt> 510 <dt>Returns:</dt>
394 <dd> 511 <dd>
395 description of the style 512 description of the style
396 </dd> 513 </dd>
397 </dl><dl> 514 </dl>
515 <dl>
398 <dt>Return Type:</dt> 516 <dt>Return Type:</dt>
399 <dd> 517 <dd>
400 str 518 str
401 </dd> 519 </dd>
402 </dl><a NAME="PreferencesLexer.eolFill" ID="PreferencesLexer.eolFill"></a> 520 </dl>
521 <a NAME="PreferencesLexer.eolFill" ID="PreferencesLexer.eolFill"></a>
403 <h4>PreferencesLexer.eolFill</h4> 522 <h4>PreferencesLexer.eolFill</h4>
404 <b>eolFill</b>(<i>style, substyle=-1</i>) 523 <b>eolFill</b>(<i>style, substyle=-1</i>)
524
405 <p> 525 <p>
406 Public method to get the eolFill flag for a style. 526 Public method to get the eolFill flag for a style.
407 </p><dl> 527 </p>
408 <dt><i>style</i> (int)</dt> 528 <dl>
409 <dd> 529
410 style number 530 <dt><i>style</i> (int)</dt>
411 </dd><dt><i>substyle</i> (int)</dt> 531 <dd>
412 <dd> 532 style number
413 sub-style number 533 </dd>
414 </dd> 534 <dt><i>substyle</i> (int)</dt>
415 </dl><dl> 535 <dd>
536 sub-style number
537 </dd>
538 </dl>
539 <dl>
416 <dt>Returns:</dt> 540 <dt>Returns:</dt>
417 <dd> 541 <dd>
418 eolFill flag 542 eolFill flag
419 </dd> 543 </dd>
420 </dl><dl> 544 </dl>
545 <dl>
421 <dt>Return Type:</dt> 546 <dt>Return Type:</dt>
422 <dd> 547 <dd>
423 bool 548 bool
424 </dd> 549 </dd>
425 </dl><a NAME="PreferencesLexer.font" ID="PreferencesLexer.font"></a> 550 </dl>
551 <a NAME="PreferencesLexer.font" ID="PreferencesLexer.font"></a>
426 <h4>PreferencesLexer.font</h4> 552 <h4>PreferencesLexer.font</h4>
427 <b>font</b>(<i>style, substyle=-1</i>) 553 <b>font</b>(<i>style, substyle=-1</i>)
554
428 <p> 555 <p>
429 Public method to get the font for a style. 556 Public method to get the font for a style.
430 </p><dl> 557 </p>
431 <dt><i>style</i> (int)</dt> 558 <dl>
432 <dd> 559
433 style number 560 <dt><i>style</i> (int)</dt>
434 </dd><dt><i>substyle</i> (int)</dt> 561 <dd>
435 <dd> 562 style number
436 sub-style number 563 </dd>
437 </dd> 564 <dt><i>substyle</i> (int)</dt>
438 </dl><dl> 565 <dd>
566 sub-style number
567 </dd>
568 </dl>
569 <dl>
439 <dt>Returns:</dt> 570 <dt>Returns:</dt>
440 <dd> 571 <dd>
441 font 572 font
442 </dd> 573 </dd>
443 </dl><dl> 574 </dl>
575 <dl>
444 <dt>Return Type:</dt> 576 <dt>Return Type:</dt>
445 <dd> 577 <dd>
446 QFont 578 QFont
447 </dd> 579 </dd>
448 </dl><a NAME="PreferencesLexer.getStyles" ID="PreferencesLexer.getStyles"></a> 580 </dl>
581 <a NAME="PreferencesLexer.getStyles" ID="PreferencesLexer.getStyles"></a>
449 <h4>PreferencesLexer.getStyles</h4> 582 <h4>PreferencesLexer.getStyles</h4>
450 <b>getStyles</b>(<i></i>) 583 <b>getStyles</b>(<i></i>)
584
451 <p> 585 <p>
452 Public method to get a list of all supported styles. 586 Public method to get a list of all supported styles.
453 </p><dl> 587 </p>
588 <dl>
454 <dt>Returns:</dt> 589 <dt>Returns:</dt>
455 <dd> 590 <dd>
456 list of tuples each containing the description of the style, 591 list of tuples each containing the description of the style,
457 style number and sub-style number (or -1 for no sub-style) 592 style number and sub-style number (or -1 for no sub-style)
458 </dd> 593 </dd>
459 </dl><dl> 594 </dl>
595 <dl>
460 <dt>Return Type:</dt> 596 <dt>Return Type:</dt>
461 <dd> 597 <dd>
462 list of tuples of (str, int, int) 598 list of tuples of (str, int, int)
463 </dd> 599 </dd>
464 </dl><a NAME="PreferencesLexer.getSubStyles" ID="PreferencesLexer.getSubStyles"></a> 600 </dl>
601 <a NAME="PreferencesLexer.getSubStyles" ID="PreferencesLexer.getSubStyles"></a>
465 <h4>PreferencesLexer.getSubStyles</h4> 602 <h4>PreferencesLexer.getSubStyles</h4>
466 <b>getSubStyles</b>(<i>style</i>) 603 <b>getSubStyles</b>(<i>style</i>)
604
467 <p> 605 <p>
468 Public method to get a list of all sub-styles of a style. 606 Public method to get a list of all sub-styles of a style.
469 </p><dl> 607 </p>
470 <dt><i>style</i> (int)</dt> 608 <dl>
471 <dd> 609
472 style number 610 <dt><i>style</i> (int)</dt>
473 </dd> 611 <dd>
474 </dl><dl> 612 style number
613 </dd>
614 </dl>
615 <dl>
475 <dt>Returns:</dt> 616 <dt>Returns:</dt>
476 <dd> 617 <dd>
477 list of tuples each containing the description of the style, 618 list of tuples each containing the description of the style,
478 style number and sub-style number (or -1 for no sub-style) 619 style number and sub-style number (or -1 for no sub-style)
479 </dd> 620 </dd>
480 </dl><dl> 621 </dl>
622 <dl>
481 <dt>Return Type:</dt> 623 <dt>Return Type:</dt>
482 <dd> 624 <dd>
483 list of tuples of (str, int, int) 625 list of tuples of (str, int, int)
484 </dd> 626 </dd>
485 </dl><a NAME="PreferencesLexer.hasStyle" ID="PreferencesLexer.hasStyle"></a> 627 </dl>
628 <a NAME="PreferencesLexer.hasStyle" ID="PreferencesLexer.hasStyle"></a>
486 <h4>PreferencesLexer.hasStyle</h4> 629 <h4>PreferencesLexer.hasStyle</h4>
487 <b>hasStyle</b>(<i>style, substyle</i>) 630 <b>hasStyle</b>(<i>style, substyle</i>)
631
488 <p> 632 <p>
489 Public method to test for a given style definition. 633 Public method to test for a given style definition.
490 </p><dl> 634 </p>
491 <dt><i>style</i> (int)</dt> 635 <dl>
492 <dd> 636
493 style number 637 <dt><i>style</i> (int)</dt>
494 </dd><dt><i>substyle</i> (int)</dt> 638 <dd>
495 <dd> 639 style number
496 sub-style number 640 </dd>
497 </dd> 641 <dt><i>substyle</i> (int)</dt>
498 </dl><dl> 642 <dd>
643 sub-style number
644 </dd>
645 </dl>
646 <dl>
499 <dt>Returns:</dt> 647 <dt>Returns:</dt>
500 <dd> 648 <dd>
501 flag indicating the existence of a style definition 649 flag indicating the existence of a style definition
502 </dd> 650 </dd>
503 </dl><dl> 651 </dl>
652 <dl>
504 <dt>Return Type:</dt> 653 <dt>Return Type:</dt>
505 <dd> 654 <dd>
506 bool 655 bool
507 </dd> 656 </dd>
508 </dl><a NAME="PreferencesLexer.isBaseStyle" ID="PreferencesLexer.isBaseStyle"></a> 657 </dl>
658 <a NAME="PreferencesLexer.isBaseStyle" ID="PreferencesLexer.isBaseStyle"></a>
509 <h4>PreferencesLexer.isBaseStyle</h4> 659 <h4>PreferencesLexer.isBaseStyle</h4>
510 <b>isBaseStyle</b>(<i>style</i>) 660 <b>isBaseStyle</b>(<i>style</i>)
661
511 <p> 662 <p>
512 Public method to test, if a given style may have sub-styles. 663 Public method to test, if a given style may have sub-styles.
513 </p><dl> 664 </p>
665 <dl>
666
514 <dt><i>style</i> (int)</dt> 667 <dt><i>style</i> (int)</dt>
515 <dd> 668 <dd>
516 base style number 669 base style number
517 </dd> 670 </dd>
518 </dl><dl> 671 </dl>
672 <dl>
519 <dt>Returns:</dt> 673 <dt>Returns:</dt>
520 <dd> 674 <dd>
521 flag indicating that the style may have sub-styles 675 flag indicating that the style may have sub-styles
522 </dd> 676 </dd>
523 </dl><dl> 677 </dl>
678 <dl>
524 <dt>Return Type:</dt> 679 <dt>Return Type:</dt>
525 <dd> 680 <dd>
526 bool 681 bool
527 </dd> 682 </dd>
528 </dl><a NAME="PreferencesLexer.language" ID="PreferencesLexer.language"></a> 683 </dl>
684 <a NAME="PreferencesLexer.language" ID="PreferencesLexer.language"></a>
529 <h4>PreferencesLexer.language</h4> 685 <h4>PreferencesLexer.language</h4>
530 <b>language</b>(<i></i>) 686 <b>language</b>(<i></i>)
687
531 <p> 688 <p>
532 Public method to get the lexers programming language. 689 Public method to get the lexers programming language.
533 </p><dl> 690 </p>
691 <dl>
534 <dt>Returns:</dt> 692 <dt>Returns:</dt>
535 <dd> 693 <dd>
536 lexer programming language 694 lexer programming language
537 </dd> 695 </dd>
538 </dl><dl> 696 </dl>
697 <dl>
539 <dt>Return Type:</dt> 698 <dt>Return Type:</dt>
540 <dd> 699 <dd>
541 str 700 str
542 </dd> 701 </dd>
543 </dl><a NAME="PreferencesLexer.loadDefaultSubStyles" ID="PreferencesLexer.loadDefaultSubStyles"></a> 702 </dl>
703 <a NAME="PreferencesLexer.loadDefaultSubStyles" ID="PreferencesLexer.loadDefaultSubStyles"></a>
544 <h4>PreferencesLexer.loadDefaultSubStyles</h4> 704 <h4>PreferencesLexer.loadDefaultSubStyles</h4>
545 <b>loadDefaultSubStyles</b>(<i>style</i>) 705 <b>loadDefaultSubStyles</b>(<i>style</i>)
706
546 <p> 707 <p>
547 Public method to load the default sub-styles for a given base style. 708 Public method to load the default sub-styles for a given base style.
548 </p><dl> 709 </p>
549 <dt><i>style</i> (int)</dt> 710 <dl>
550 <dd> 711
551 style number 712 <dt><i>style</i> (int)</dt>
552 </dd> 713 <dd>
553 </dl><a NAME="PreferencesLexer.paper" ID="PreferencesLexer.paper"></a> 714 style number
715 </dd>
716 </dl>
717 <a NAME="PreferencesLexer.paper" ID="PreferencesLexer.paper"></a>
554 <h4>PreferencesLexer.paper</h4> 718 <h4>PreferencesLexer.paper</h4>
555 <b>paper</b>(<i>style, substyle=-1</i>) 719 <b>paper</b>(<i>style, substyle=-1</i>)
720
556 <p> 721 <p>
557 Public method to get the background for a style. 722 Public method to get the background for a style.
558 </p><dl> 723 </p>
724 <dl>
725
559 <dt><i>style</i> (int)</dt> 726 <dt><i>style</i> (int)</dt>
560 <dd> 727 <dd>
561 the style number 728 the style number
562 </dd><dt><i>substyle</i> (int)</dt> 729 </dd>
563 <dd> 730 <dt><i>substyle</i> (int)</dt>
564 sub-style number 731 <dd>
565 </dd> 732 sub-style number
566 </dl><dl> 733 </dd>
734 </dl>
735 <dl>
567 <dt>Returns:</dt> 736 <dt>Returns:</dt>
568 <dd> 737 <dd>
569 background color 738 background color
570 </dd> 739 </dd>
571 </dl><dl> 740 </dl>
741 <dl>
572 <dt>Return Type:</dt> 742 <dt>Return Type:</dt>
573 <dd> 743 <dd>
574 QColor 744 QColor
575 </dd> 745 </dd>
576 </dl><a NAME="PreferencesLexer.setColor" ID="PreferencesLexer.setColor"></a> 746 </dl>
747 <a NAME="PreferencesLexer.setColor" ID="PreferencesLexer.setColor"></a>
577 <h4>PreferencesLexer.setColor</h4> 748 <h4>PreferencesLexer.setColor</h4>
578 <b>setColor</b>(<i>c, style, substyle=-1</i>) 749 <b>setColor</b>(<i>c, style, substyle=-1</i>)
750
579 <p> 751 <p>
580 Public method to set the color for a style. 752 Public method to set the color for a style.
581 </p><dl> 753 </p>
754 <dl>
755
582 <dt><i>c</i> (QColor)</dt> 756 <dt><i>c</i> (QColor)</dt>
583 <dd> 757 <dd>
584 color 758 color
585 </dd><dt><i>style</i> (int)</dt> 759 </dd>
586 <dd> 760 <dt><i>style</i> (int)</dt>
587 style number 761 <dd>
588 </dd><dt><i>substyle</i> (int)</dt> 762 style number
589 <dd> 763 </dd>
590 sub-style number 764 <dt><i>substyle</i> (int)</dt>
591 </dd> 765 <dd>
592 </dl><a NAME="PreferencesLexer.setDescription" ID="PreferencesLexer.setDescription"></a> 766 sub-style number
767 </dd>
768 </dl>
769 <a NAME="PreferencesLexer.setDescription" ID="PreferencesLexer.setDescription"></a>
593 <h4>PreferencesLexer.setDescription</h4> 770 <h4>PreferencesLexer.setDescription</h4>
594 <b>setDescription</b>(<i>description, style, substyle=-1</i>) 771 <b>setDescription</b>(<i>description, style, substyle=-1</i>)
772
595 <p> 773 <p>
596 Public method to set a descriptive string for a style. 774 Public method to set a descriptive string for a style.
597 </p><dl> 775 </p>
776 <dl>
777
598 <dt><i>description</i> (str)</dt> 778 <dt><i>description</i> (str)</dt>
599 <dd> 779 <dd>
600 description for the style 780 description for the style
601 </dd><dt><i>style</i> (int)</dt> 781 </dd>
602 <dd> 782 <dt><i>style</i> (int)</dt>
603 style number 783 <dd>
604 </dd><dt><i>substyle</i> (int)</dt> 784 style number
605 <dd> 785 </dd>
606 sub-style number 786 <dt><i>substyle</i> (int)</dt>
607 </dd> 787 <dd>
608 </dl><a NAME="PreferencesLexer.setEolFill" ID="PreferencesLexer.setEolFill"></a> 788 sub-style number
789 </dd>
790 </dl>
791 <a NAME="PreferencesLexer.setEolFill" ID="PreferencesLexer.setEolFill"></a>
609 <h4>PreferencesLexer.setEolFill</h4> 792 <h4>PreferencesLexer.setEolFill</h4>
610 <b>setEolFill</b>(<i>eolfill, style, substyle=-1</i>) 793 <b>setEolFill</b>(<i>eolfill, style, substyle=-1</i>)
794
611 <p> 795 <p>
612 Public method to set the eolFill flag for a style. 796 Public method to set the eolFill flag for a style.
613 </p><dl> 797 </p>
798 <dl>
799
614 <dt><i>eolfill</i> (bool)</dt> 800 <dt><i>eolfill</i> (bool)</dt>
615 <dd> 801 <dd>
616 eolFill flag 802 eolFill flag
617 </dd><dt><i>style</i> (int)</dt> 803 </dd>
618 <dd> 804 <dt><i>style</i> (int)</dt>
619 style number 805 <dd>
620 </dd><dt><i>substyle</i> (int)</dt> 806 style number
621 <dd> 807 </dd>
622 sub-style number 808 <dt><i>substyle</i> (int)</dt>
623 </dd> 809 <dd>
624 </dl><a NAME="PreferencesLexer.setFont" ID="PreferencesLexer.setFont"></a> 810 sub-style number
811 </dd>
812 </dl>
813 <a NAME="PreferencesLexer.setFont" ID="PreferencesLexer.setFont"></a>
625 <h4>PreferencesLexer.setFont</h4> 814 <h4>PreferencesLexer.setFont</h4>
626 <b>setFont</b>(<i>f, style, substyle=-1</i>) 815 <b>setFont</b>(<i>f, style, substyle=-1</i>)
816
627 <p> 817 <p>
628 Public method to set the font for a style. 818 Public method to set the font for a style.
629 </p><dl> 819 </p>
820 <dl>
821
630 <dt><i>f</i> (QFont)</dt> 822 <dt><i>f</i> (QFont)</dt>
631 <dd> 823 <dd>
632 font 824 font
633 </dd><dt><i>style</i> (int)</dt> 825 </dd>
634 <dd> 826 <dt><i>style</i> (int)</dt>
635 style number 827 <dd>
636 </dd><dt><i>substyle</i> (int)</dt> 828 style number
637 <dd> 829 </dd>
638 sub-style number 830 <dt><i>substyle</i> (int)</dt>
639 </dd> 831 <dd>
640 </dl><a NAME="PreferencesLexer.setPaper" ID="PreferencesLexer.setPaper"></a> 832 sub-style number
833 </dd>
834 </dl>
835 <a NAME="PreferencesLexer.setPaper" ID="PreferencesLexer.setPaper"></a>
641 <h4>PreferencesLexer.setPaper</h4> 836 <h4>PreferencesLexer.setPaper</h4>
642 <b>setPaper</b>(<i>c, style, substyle=-1</i>) 837 <b>setPaper</b>(<i>c, style, substyle=-1</i>)
838
643 <p> 839 <p>
644 Public method to set the background for a style. 840 Public method to set the background for a style.
645 </p><dl> 841 </p>
842 <dl>
843
646 <dt><i>c</i> (QColor)</dt> 844 <dt><i>c</i> (QColor)</dt>
647 <dd> 845 <dd>
648 background color 846 background color
649 </dd><dt><i>style</i> (int)</dt> 847 </dd>
650 <dd> 848 <dt><i>style</i> (int)</dt>
651 style number 849 <dd>
652 </dd><dt><i>substyle</i> (int)</dt> 850 style number
653 <dd> 851 </dd>
654 sub-style number 852 <dt><i>substyle</i> (int)</dt>
655 </dd> 853 <dd>
656 </dl><a NAME="PreferencesLexer.setWords" ID="PreferencesLexer.setWords"></a> 854 sub-style number
855 </dd>
856 </dl>
857 <a NAME="PreferencesLexer.setWords" ID="PreferencesLexer.setWords"></a>
657 <h4>PreferencesLexer.setWords</h4> 858 <h4>PreferencesLexer.setWords</h4>
658 <b>setWords</b>(<i>words, style, substyle=-1</i>) 859 <b>setWords</b>(<i>words, style, substyle=-1</i>)
860
659 <p> 861 <p>
660 Public method to set the list of words for a style. 862 Public method to set the list of words for a style.
661 </p><dl> 863 </p>
864 <dl>
865
662 <dt><i>words</i> (str)</dt> 866 <dt><i>words</i> (str)</dt>
663 <dd> 867 <dd>
664 whitespace separated list of words 868 whitespace separated list of words
665 </dd><dt><i>style</i> (int)</dt> 869 </dd>
666 <dd> 870 <dt><i>style</i> (int)</dt>
667 style number 871 <dd>
668 </dd><dt><i>substyle</i> (int)</dt> 872 style number
669 <dd> 873 </dd>
670 sub-style number 874 <dt><i>substyle</i> (int)</dt>
671 </dd> 875 <dd>
672 </dl><a NAME="PreferencesLexer.words" ID="PreferencesLexer.words"></a> 876 sub-style number
877 </dd>
878 </dl>
879 <a NAME="PreferencesLexer.words" ID="PreferencesLexer.words"></a>
673 <h4>PreferencesLexer.words</h4> 880 <h4>PreferencesLexer.words</h4>
674 <b>words</b>(<i>style, substyle=-1</i>) 881 <b>words</b>(<i>style, substyle=-1</i>)
882
675 <p> 883 <p>
676 Public method to get the list of words for a style. 884 Public method to get the list of words for a style.
677 </p><dl> 885 </p>
678 <dt><i>style</i> (int)</dt> 886 <dl>
679 <dd> 887
680 style number 888 <dt><i>style</i> (int)</dt>
681 </dd><dt><i>substyle</i> (int)</dt> 889 <dd>
682 <dd> 890 style number
683 sub-style number 891 </dd>
684 </dd> 892 <dt><i>substyle</i> (int)</dt>
685 </dl><dl> 893 <dd>
894 sub-style number
895 </dd>
896 </dl>
897 <dl>
686 <dt>Returns:</dt> 898 <dt>Returns:</dt>
687 <dd> 899 <dd>
688 whitespace separated list of words 900 whitespace separated list of words
689 </dd> 901 </dd>
690 </dl><dl> 902 </dl>
903 <dl>
691 <dt>Return Type:</dt> 904 <dt>Return Type:</dt>
692 <dd> 905 <dd>
693 str 906 str
694 </dd> 907 </dd>
695 </dl><a NAME="PreferencesLexer.writeSettings" ID="PreferencesLexer.writeSettings"></a> 908 </dl>
909 <a NAME="PreferencesLexer.writeSettings" ID="PreferencesLexer.writeSettings"></a>
696 <h4>PreferencesLexer.writeSettings</h4> 910 <h4>PreferencesLexer.writeSettings</h4>
697 <b>writeSettings</b>(<i></i>) 911 <b>writeSettings</b>(<i></i>)
912
698 <p> 913 <p>
699 Public method to write the lexer settings. 914 Public method to write the lexer settings.
700 </p> 915 </p>
701 <div align="right"><a href="#top">Up</a></div> 916 <div align="right"><a href="#top">Up</a></div>
702 <hr /><hr /> 917 <hr />
918 <hr />
703 <a NAME="PreferencesLexerError" ID="PreferencesLexerError"></a> 919 <a NAME="PreferencesLexerError" ID="PreferencesLexerError"></a>
704 <h2>PreferencesLexerError</h2> 920 <h2>PreferencesLexerError</h2>
921
705 <p> 922 <p>
706 Class defining a special error for the PreferencesLexer class. 923 Class defining a special error for the PreferencesLexer class.
707 </p> 924 </p>
708 <h3>Derived from</h3> 925 <h3>Derived from</h3>
709 Exception 926 Exception
710 <h3>Class Attributes</h3> 927 <h3>Class Attributes</h3>
928
711 <table> 929 <table>
712 <tr><td>None</td></tr> 930 <tr><td>None</td></tr>
713 </table> 931 </table>
714 <h3>Class Methods</h3> 932 <h3>Class Methods</h3>
933
715 <table> 934 <table>
716 <tr><td>None</td></tr> 935 <tr><td>None</td></tr>
717 </table> 936 </table>
718 <h3>Methods</h3> 937 <h3>Methods</h3>
719 <table> 938
939 <table>
940
720 <tr> 941 <tr>
721 <td><a href="#PreferencesLexerError.__init__">PreferencesLexerError</a></td> 942 <td><a href="#PreferencesLexerError.__init__">PreferencesLexerError</a></td>
722 <td>Constructor</td> 943 <td>Constructor</td>
723 </tr><tr> 944 </tr>
945 <tr>
724 <td><a href="#PreferencesLexerError.__repr__">__repr__</a></td> 946 <td><a href="#PreferencesLexerError.__repr__">__repr__</a></td>
725 <td>Special method returning a representation of the exception.</td> 947 <td>Special method returning a representation of the exception.</td>
726 </tr><tr> 948 </tr>
949 <tr>
727 <td><a href="#PreferencesLexerError.__str__">__str__</a></td> 950 <td><a href="#PreferencesLexerError.__str__">__str__</a></td>
728 <td>Special method returning a string representation of the exception.</td> 951 <td>Special method returning a string representation of the exception.</td>
729 </tr> 952 </tr>
730 </table> 953 </table>
731 <h3>Static Methods</h3> 954 <h3>Static Methods</h3>
955
732 <table> 956 <table>
733 <tr><td>None</td></tr> 957 <tr><td>None</td></tr>
734 </table> 958 </table>
959
735 <a NAME="PreferencesLexerError.__init__" ID="PreferencesLexerError.__init__"></a> 960 <a NAME="PreferencesLexerError.__init__" ID="PreferencesLexerError.__init__"></a>
736 <h4>PreferencesLexerError (Constructor)</h4> 961 <h4>PreferencesLexerError (Constructor)</h4>
737 <b>PreferencesLexerError</b>(<i></i>) 962 <b>PreferencesLexerError</b>(<i></i>)
963
738 <p> 964 <p>
739 Constructor 965 Constructor
740 </p><a NAME="PreferencesLexerError.__repr__" ID="PreferencesLexerError.__repr__"></a> 966 </p>
967 <a NAME="PreferencesLexerError.__repr__" ID="PreferencesLexerError.__repr__"></a>
741 <h4>PreferencesLexerError.__repr__</h4> 968 <h4>PreferencesLexerError.__repr__</h4>
742 <b>__repr__</b>(<i></i>) 969 <b>__repr__</b>(<i></i>)
970
743 <p> 971 <p>
744 Special method returning a representation of the exception. 972 Special method returning a representation of the exception.
745 </p><dl> 973 </p>
974 <dl>
746 <dt>Returns:</dt> 975 <dt>Returns:</dt>
747 <dd> 976 <dd>
748 string representing the error message 977 string representing the error message
749 </dd> 978 </dd>
750 </dl><dl> 979 </dl>
980 <dl>
751 <dt>Return Type:</dt> 981 <dt>Return Type:</dt>
752 <dd> 982 <dd>
753 str 983 str
754 </dd> 984 </dd>
755 </dl><a NAME="PreferencesLexerError.__str__" ID="PreferencesLexerError.__str__"></a> 985 </dl>
986 <a NAME="PreferencesLexerError.__str__" ID="PreferencesLexerError.__str__"></a>
756 <h4>PreferencesLexerError.__str__</h4> 987 <h4>PreferencesLexerError.__str__</h4>
757 <b>__str__</b>(<i></i>) 988 <b>__str__</b>(<i></i>)
989
758 <p> 990 <p>
759 Special method returning a string representation of the exception. 991 Special method returning a string representation of the exception.
760 </p><dl> 992 </p>
993 <dl>
761 <dt>Returns:</dt> 994 <dt>Returns:</dt>
762 <dd> 995 <dd>
763 string representing the error message 996 string representing the error message
764 </dd> 997 </dd>
765 </dl><dl> 998 </dl>
999 <dl>
766 <dt>Return Type:</dt> 1000 <dt>Return Type:</dt>
767 <dd> 1001 <dd>
768 str 1002 str
769 </dd> 1003 </dd>
770 </dl> 1004 </dl>
771 <div align="right"><a href="#top">Up</a></div> 1005 <div align="right"><a href="#top">Up</a></div>
772 <hr /><hr /> 1006 <hr />
1007 <hr />
773 <a NAME="PreferencesLexerLanguageError" ID="PreferencesLexerLanguageError"></a> 1008 <a NAME="PreferencesLexerLanguageError" ID="PreferencesLexerLanguageError"></a>
774 <h2>PreferencesLexerLanguageError</h2> 1009 <h2>PreferencesLexerLanguageError</h2>
1010
775 <p> 1011 <p>
776 Class defining a special error for the PreferencesLexer class. 1012 Class defining a special error for the PreferencesLexer class.
777 </p> 1013 </p>
778 <h3>Derived from</h3> 1014 <h3>Derived from</h3>
779 PreferencesLexerError 1015 PreferencesLexerError
780 <h3>Class Attributes</h3> 1016 <h3>Class Attributes</h3>
1017
781 <table> 1018 <table>
782 <tr><td>None</td></tr> 1019 <tr><td>None</td></tr>
783 </table> 1020 </table>
784 <h3>Class Methods</h3> 1021 <h3>Class Methods</h3>
1022
785 <table> 1023 <table>
786 <tr><td>None</td></tr> 1024 <tr><td>None</td></tr>
787 </table> 1025 </table>
788 <h3>Methods</h3> 1026 <h3>Methods</h3>
789 <table> 1027
1028 <table>
1029
790 <tr> 1030 <tr>
791 <td><a href="#PreferencesLexerLanguageError.__init__">PreferencesLexerLanguageError</a></td> 1031 <td><a href="#PreferencesLexerLanguageError.__init__">PreferencesLexerLanguageError</a></td>
792 <td>Constructor</td> 1032 <td>Constructor</td>
793 </tr> 1033 </tr>
794 </table> 1034 </table>
795 <h3>Static Methods</h3> 1035 <h3>Static Methods</h3>
1036
796 <table> 1037 <table>
797 <tr><td>None</td></tr> 1038 <tr><td>None</td></tr>
798 </table> 1039 </table>
1040
799 <a NAME="PreferencesLexerLanguageError.__init__" ID="PreferencesLexerLanguageError.__init__"></a> 1041 <a NAME="PreferencesLexerLanguageError.__init__" ID="PreferencesLexerLanguageError.__init__"></a>
800 <h4>PreferencesLexerLanguageError (Constructor)</h4> 1042 <h4>PreferencesLexerLanguageError (Constructor)</h4>
801 <b>PreferencesLexerLanguageError</b>(<i>language</i>) 1043 <b>PreferencesLexerLanguageError</b>(<i>language</i>)
1044
802 <p> 1045 <p>
803 Constructor 1046 Constructor
804 </p><dl> 1047 </p>
1048 <dl>
1049
805 <dt><i>language</i> (str)</dt> 1050 <dt><i>language</i> (str)</dt>
806 <dd> 1051 <dd>
807 lexer language 1052 lexer language
808 </dd> 1053 </dd>
809 </dl> 1054 </dl>

eric ide

mercurial