Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorHighlightingStylesPage.html

eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorHighlightingStylesPage.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Preferences.ConfigurationPages.EditorHighlightingStylesPage</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Preferences.ConfigurationPages.EditorHighlightingStylesPage</h1>
24
25 <p>
26 Module implementing the Editor Highlighting Styles configuration page.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#EditorHighlightingStylesPage">EditorHighlightingStylesPage</a></td>
39 <td>Class implementing the Editor Highlighting Styles configuration page.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45
46 <tr>
47 <td><a href="#create">create</a></td>
48 <td>Module function to create the configuration page.</td>
49 </tr>
50 </table>
51 <hr />
52 <hr />
53 <a NAME="EditorHighlightingStylesPage" ID="EditorHighlightingStylesPage"></a>
54 <h2>EditorHighlightingStylesPage</h2>
55
56 <p>
57 Class implementing the Editor Highlighting Styles configuration page.
58 </p>
59 <h3>Derived from</h3>
60 ConfigurationPageBase, Ui_EditorHighlightingStylesPage
61 <h3>Class Attributes</h3>
62
63 <table>
64 <tr><td>FAMILYANDSIZE</td></tr><tr><td>FAMILYONLY</td></tr><tr><td>FONT</td></tr><tr><td>SIZEONLY</td></tr><tr><td>StyleRole</td></tr><tr><td>SubstyleRole</td></tr>
65 </table>
66 <h3>Class Methods</h3>
67
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71 <h3>Methods</h3>
72
73 <table>
74
75 <tr>
76 <td><a href="#EditorHighlightingStylesPage.__init__">EditorHighlightingStylesPage</a></td>
77 <td>Constructor</td>
78 </tr>
79 <tr>
80 <td><a href="#EditorHighlightingStylesPage.__allFontsButtonMenuTriggered">__allFontsButtonMenuTriggered</a></td>
81 <td>Private slot used to change the font of all styles of a selected lexer.</td>
82 </tr>
83 <tr>
84 <td><a href="#EditorHighlightingStylesPage.__applyStyles">__applyStyles</a></td>
85 <td>Private method to apply the imported styles to this dialog.</td>
86 </tr>
87 <tr>
88 <td><a href="#EditorHighlightingStylesPage.__changeFont">__changeFont</a></td>
89 <td>Private slot to change the highlighter font.</td>
90 </tr>
91 <tr>
92 <td><a href="#EditorHighlightingStylesPage.__currentStyles">__currentStyles</a></td>
93 <td>Private method to get the styles of the current item.</td>
94 </tr>
95 <tr>
96 <td><a href="#EditorHighlightingStylesPage.__exportStyles">__exportStyles</a></td>
97 <td>Private method to export the styles of selectable lexers.</td>
98 </tr>
99 <tr>
100 <td><a href="#EditorHighlightingStylesPage.__fontButtonMenuTriggered">__fontButtonMenuTriggered</a></td>
101 <td>Private slot used to select the font of the selected style and lexer.</td>
102 </tr>
103 <tr>
104 <td><a href="#EditorHighlightingStylesPage.__importStyles">__importStyles</a></td>
105 <td>Private method to import the styles of lexers to be selected.</td>
106 </tr>
107 <tr>
108 <td><a href="#EditorHighlightingStylesPage.__setToDefault">__setToDefault</a></td>
109 <td>Private method to set a specific style to its default values.</td>
110 </tr>
111 <tr>
112 <td><a href="#EditorHighlightingStylesPage.__styleAllItems">__styleAllItems</a></td>
113 <td>Private method to style all items of the style element list.</td>
114 </tr>
115 <tr>
116 <td><a href="#EditorHighlightingStylesPage.__styleOneItem">__styleOneItem</a></td>
117 <td>Private method to style one item of the style element list.</td>
118 </tr>
119 <tr>
120 <td><a href="#EditorHighlightingStylesPage.__stylesForItem">__stylesForItem</a></td>
121 <td>Private method to get the style and sub-style number of the given item.</td>
122 </tr>
123 <tr>
124 <td><a href="#EditorHighlightingStylesPage.on_addSubstyleButton_clicked">on_addSubstyleButton_clicked</a></td>
125 <td>Private slot to add a new sub-style.</td>
126 </tr>
127 <tr>
128 <td><a href="#EditorHighlightingStylesPage.on_allBackgroundColoursButton_clicked">on_allBackgroundColoursButton_clicked</a></td>
129 <td>Private method used to select the background colour of all styles of a selected lexer.</td>
130 </tr>
131 <tr>
132 <td><a href="#EditorHighlightingStylesPage.on_allDefaultButton_clicked">on_allDefaultButton_clicked</a></td>
133 <td>Private method to set all styles to their default values.</td>
134 </tr>
135 <tr>
136 <td><a href="#EditorHighlightingStylesPage.on_allEolFillButton_clicked">on_allEolFillButton_clicked</a></td>
137 <td>Private method used to set the eolfill for all styles of a selected lexer.</td>
138 </tr>
139 <tr>
140 <td><a href="#EditorHighlightingStylesPage.on_backgroundButton_clicked">on_backgroundButton_clicked</a></td>
141 <td>Private method used to select the background colour of the selected style and lexer.</td>
142 </tr>
143 <tr>
144 <td><a href="#EditorHighlightingStylesPage.on_copySubstyleButton_clicked">on_copySubstyleButton_clicked</a></td>
145 <td>Private slot to copy the selected sub-style.</td>
146 </tr>
147 <tr>
148 <td><a href="#EditorHighlightingStylesPage.on_defaultButton_clicked">on_defaultButton_clicked</a></td>
149 <td>Private method to set the current style to its default values.</td>
150 </tr>
151 <tr>
152 <td><a href="#EditorHighlightingStylesPage.on_defaultSubstylesButton_clicked">on_defaultSubstylesButton_clicked</a></td>
153 <td>Private slot to reset all substyles to default values.</td>
154 </tr>
155 <tr>
156 <td><a href="#EditorHighlightingStylesPage.on_deleteSubstyleButton_clicked">on_deleteSubstyleButton_clicked</a></td>
157 <td>Private slot to delete the selected sub-style.</td>
158 </tr>
159 <tr>
160 <td><a href="#EditorHighlightingStylesPage.on_editSubstyleButton_clicked">on_editSubstyleButton_clicked</a></td>
161 <td>Private slot to edit the selected sub-style entry.</td>
162 </tr>
163 <tr>
164 <td><a href="#EditorHighlightingStylesPage.on_eolfillCheckBox_clicked">on_eolfillCheckBox_clicked</a></td>
165 <td>Private method used to set the eolfill for the selected style and lexer.</td>
166 </tr>
167 <tr>
168 <td><a href="#EditorHighlightingStylesPage.on_exportAllButton_clicked">on_exportAllButton_clicked</a></td>
169 <td>Private slot to export the styles of all lexers.</td>
170 </tr>
171 <tr>
172 <td><a href="#EditorHighlightingStylesPage.on_exportButton_clicked">on_exportButton_clicked</a></td>
173 <td>Private slot to export styles to be selected.</td>
174 </tr>
175 <tr>
176 <td><a href="#EditorHighlightingStylesPage.on_foregroundButton_clicked">on_foregroundButton_clicked</a></td>
177 <td>Private method used to select the foreground colour of the selected style and lexer.</td>
178 </tr>
179 <tr>
180 <td><a href="#EditorHighlightingStylesPage.on_importAllButton_clicked">on_importAllButton_clicked</a></td>
181 <td>Private slot to import the styles of all lexers.</td>
182 </tr>
183 <tr>
184 <td><a href="#EditorHighlightingStylesPage.on_importButton_clicked">on_importButton_clicked</a></td>
185 <td>Private slot to import styles to be selected.</td>
186 </tr>
187 <tr>
188 <td><a href="#EditorHighlightingStylesPage.on_lexerLanguageComboBox_activated">on_lexerLanguageComboBox_activated</a></td>
189 <td>Private slot to fill the style combo of the source page.</td>
190 </tr>
191 <tr>
192 <td><a href="#EditorHighlightingStylesPage.on_styleElementList_currentItemChanged">on_styleElementList_currentItemChanged</a></td>
193 <td>Private method to handle a change of the current row.</td>
194 </tr>
195 <tr>
196 <td><a href="#EditorHighlightingStylesPage.save">save</a></td>
197 <td>Public slot to save the Editor Highlighting Styles configuration.</td>
198 </tr>
199 <tr>
200 <td><a href="#EditorHighlightingStylesPage.saveState">saveState</a></td>
201 <td>Public method to save the current state of the widget.</td>
202 </tr>
203 <tr>
204 <td><a href="#EditorHighlightingStylesPage.setFont">setFont</a></td>
205 <td>Local function to set the font.</td>
206 </tr>
207 <tr>
208 <td><a href="#EditorHighlightingStylesPage.setSampleFont">setSampleFont</a></td>
209 <td>Local function to set the font of the sample text.</td>
210 </tr>
211 <tr>
212 <td><a href="#EditorHighlightingStylesPage.setState">setState</a></td>
213 <td>Public method to set the state of the widget.</td>
214 </tr>
215 </table>
216 <h3>Static Methods</h3>
217
218 <table>
219 <tr><td>None</td></tr>
220 </table>
221
222 <a NAME="EditorHighlightingStylesPage.__init__" ID="EditorHighlightingStylesPage.__init__"></a>
223 <h4>EditorHighlightingStylesPage (Constructor)</h4>
224 <b>EditorHighlightingStylesPage</b>(<i>lexers</i>)
225
226 <p>
227 Constructor
228 </p>
229 <dl>
230
231 <dt><i>lexers</i></dt>
232 <dd>
233 reference to the lexers dictionary
234 </dd>
235 </dl>
236 <a NAME="EditorHighlightingStylesPage.__allFontsButtonMenuTriggered" ID="EditorHighlightingStylesPage.__allFontsButtonMenuTriggered"></a>
237 <h4>EditorHighlightingStylesPage.__allFontsButtonMenuTriggered</h4>
238 <b>__allFontsButtonMenuTriggered</b>(<i>act</i>)
239
240 <p>
241 Private slot used to change the font of all styles of a selected lexer.
242 </p>
243 <dl>
244
245 <dt><i>act</i></dt>
246 <dd>
247 reference to the triggering action (QAction)
248 </dd>
249 </dl>
250 <a NAME="EditorHighlightingStylesPage.__applyStyles" ID="EditorHighlightingStylesPage.__applyStyles"></a>
251 <h4>EditorHighlightingStylesPage.__applyStyles</h4>
252 <b>__applyStyles</b>(<i>stylesList, importAll=False</i>)
253
254 <p>
255 Private method to apply the imported styles to this dialog.
256 </p>
257 <dl>
258
259 <dt><i>stylesList</i> (list of dict)</dt>
260 <dd>
261 list of imported lexer styles
262 </dd>
263 <dt><i>importAll</i> (bool (optional))</dt>
264 <dd>
265 flag indicating to import all styles without asking
266 (defaults to False)
267 </dd>
268 </dl>
269 <a NAME="EditorHighlightingStylesPage.__changeFont" ID="EditorHighlightingStylesPage.__changeFont"></a>
270 <h4>EditorHighlightingStylesPage.__changeFont</h4>
271 <b>__changeFont</b>(<i>doAll, familyOnly, sizeOnly</i>)
272
273 <p>
274 Private slot to change the highlighter font.
275 </p>
276 <dl>
277
278 <dt><i>doAll</i></dt>
279 <dd>
280 flag indicating to change the font for all styles
281 (boolean)
282 </dd>
283 <dt><i>familyOnly</i></dt>
284 <dd>
285 flag indicating to set the font family only (boolean)
286 </dd>
287 <dt><i>sizeOnly</i></dt>
288 <dd>
289 flag indicating to set the font size only (boolean
290 </dd>
291 </dl>
292 <a NAME="EditorHighlightingStylesPage.__currentStyles" ID="EditorHighlightingStylesPage.__currentStyles"></a>
293 <h4>EditorHighlightingStylesPage.__currentStyles</h4>
294 <b>__currentStyles</b>(<i></i>)
295
296 <p>
297 Private method to get the styles of the current item.
298 </p>
299 <dl>
300 <dt>Return:</dt>
301 <dd>
302 tuple containing the style and sub-style numbers
303 </dd>
304 </dl>
305 <dl>
306 <dt>Return Type:</dt>
307 <dd>
308 tuple of (int, int)
309 </dd>
310 </dl>
311 <a NAME="EditorHighlightingStylesPage.__exportStyles" ID="EditorHighlightingStylesPage.__exportStyles"></a>
312 <h4>EditorHighlightingStylesPage.__exportStyles</h4>
313 <b>__exportStyles</b>(<i>exportAll=False</i>)
314
315 <p>
316 Private method to export the styles of selectable lexers.
317 </p>
318 <dl>
319
320 <dt><i>exportAll</i> (bool (optional))</dt>
321 <dd>
322 flag indicating to export all styles without asking
323 (defaults to False)
324 </dd>
325 </dl>
326 <a NAME="EditorHighlightingStylesPage.__fontButtonMenuTriggered" ID="EditorHighlightingStylesPage.__fontButtonMenuTriggered"></a>
327 <h4>EditorHighlightingStylesPage.__fontButtonMenuTriggered</h4>
328 <b>__fontButtonMenuTriggered</b>(<i>act</i>)
329
330 <p>
331 Private slot used to select the font of the selected style and lexer.
332 </p>
333 <dl>
334
335 <dt><i>act</i></dt>
336 <dd>
337 reference to the triggering action (QAction)
338 </dd>
339 </dl>
340 <a NAME="EditorHighlightingStylesPage.__importStyles" ID="EditorHighlightingStylesPage.__importStyles"></a>
341 <h4>EditorHighlightingStylesPage.__importStyles</h4>
342 <b>__importStyles</b>(<i>importAll=False</i>)
343
344 <p>
345 Private method to import the styles of lexers to be selected.
346 </p>
347 <dl>
348
349 <dt><i>importAll</i> (bool (optional))</dt>
350 <dd>
351 flag indicating to import all styles without asking
352 (defaults to False)
353 </dd>
354 </dl>
355 <a NAME="EditorHighlightingStylesPage.__setToDefault" ID="EditorHighlightingStylesPage.__setToDefault"></a>
356 <h4>EditorHighlightingStylesPage.__setToDefault</h4>
357 <b>__setToDefault</b>(<i>style, substyle</i>)
358
359 <p>
360 Private method to set a specific style to its default values.
361 </p>
362 <dl>
363
364 <dt><i>style</i> (int)</dt>
365 <dd>
366 style number
367 </dd>
368 <dt><i>substyle</i> (int)</dt>
369 <dd>
370 sub-style number
371 </dd>
372 </dl>
373 <a NAME="EditorHighlightingStylesPage.__styleAllItems" ID="EditorHighlightingStylesPage.__styleAllItems"></a>
374 <h4>EditorHighlightingStylesPage.__styleAllItems</h4>
375 <b>__styleAllItems</b>(<i></i>)
376
377 <p>
378 Private method to style all items of the style element list.
379 </p>
380 <a NAME="EditorHighlightingStylesPage.__styleOneItem" ID="EditorHighlightingStylesPage.__styleOneItem"></a>
381 <h4>EditorHighlightingStylesPage.__styleOneItem</h4>
382 <b>__styleOneItem</b>(<i>item, style, substyle</i>)
383
384 <p>
385 Private method to style one item of the style element list.
386 </p>
387 <dl>
388
389 <dt><i>item</i> (QTreeWidgetItem)</dt>
390 <dd>
391 reference to the item to be styled
392 </dd>
393 <dt><i>style</i> (int)</dt>
394 <dd>
395 base style number
396 </dd>
397 <dt><i>substyle</i> (int)</dt>
398 <dd>
399 sub-style number
400 </dd>
401 </dl>
402 <a NAME="EditorHighlightingStylesPage.__stylesForItem" ID="EditorHighlightingStylesPage.__stylesForItem"></a>
403 <h4>EditorHighlightingStylesPage.__stylesForItem</h4>
404 <b>__stylesForItem</b>(<i>itm</i>)
405
406 <p>
407 Private method to get the style and sub-style number of the given item.
408 </p>
409 <dl>
410
411 <dt><i>itm</i> (QTreeWidgetItem)</dt>
412 <dd>
413 reference to the item to extract the styles from
414 </dd>
415 </dl>
416 <dl>
417 <dt>Return:</dt>
418 <dd>
419 tuple containing the style and sub-style numbers
420 </dd>
421 </dl>
422 <dl>
423 <dt>Return Type:</dt>
424 <dd>
425 tuple of (int, int)
426 </dd>
427 </dl>
428 <a NAME="EditorHighlightingStylesPage.on_addSubstyleButton_clicked" ID="EditorHighlightingStylesPage.on_addSubstyleButton_clicked"></a>
429 <h4>EditorHighlightingStylesPage.on_addSubstyleButton_clicked</h4>
430 <b>on_addSubstyleButton_clicked</b>(<i></i>)
431
432 <p>
433 Private slot to add a new sub-style.
434 </p>
435 <a NAME="EditorHighlightingStylesPage.on_allBackgroundColoursButton_clicked" ID="EditorHighlightingStylesPage.on_allBackgroundColoursButton_clicked"></a>
436 <h4>EditorHighlightingStylesPage.on_allBackgroundColoursButton_clicked</h4>
437 <b>on_allBackgroundColoursButton_clicked</b>(<i></i>)
438
439 <p>
440 Private method used to select the background colour of all styles of a
441 selected lexer.
442 </p>
443 <a NAME="EditorHighlightingStylesPage.on_allDefaultButton_clicked" ID="EditorHighlightingStylesPage.on_allDefaultButton_clicked"></a>
444 <h4>EditorHighlightingStylesPage.on_allDefaultButton_clicked</h4>
445 <b>on_allDefaultButton_clicked</b>(<i></i>)
446
447 <p>
448 Private method to set all styles to their default values.
449 </p>
450 <a NAME="EditorHighlightingStylesPage.on_allEolFillButton_clicked" ID="EditorHighlightingStylesPage.on_allEolFillButton_clicked"></a>
451 <h4>EditorHighlightingStylesPage.on_allEolFillButton_clicked</h4>
452 <b>on_allEolFillButton_clicked</b>(<i></i>)
453
454 <p>
455 Private method used to set the eolfill for all styles of a selected
456 lexer.
457 </p>
458 <a NAME="EditorHighlightingStylesPage.on_backgroundButton_clicked" ID="EditorHighlightingStylesPage.on_backgroundButton_clicked"></a>
459 <h4>EditorHighlightingStylesPage.on_backgroundButton_clicked</h4>
460 <b>on_backgroundButton_clicked</b>(<i></i>)
461
462 <p>
463 Private method used to select the background colour of the selected
464 style and lexer.
465 </p>
466 <a NAME="EditorHighlightingStylesPage.on_copySubstyleButton_clicked" ID="EditorHighlightingStylesPage.on_copySubstyleButton_clicked"></a>
467 <h4>EditorHighlightingStylesPage.on_copySubstyleButton_clicked</h4>
468 <b>on_copySubstyleButton_clicked</b>(<i></i>)
469
470 <p>
471 Private slot to copy the selected sub-style.
472 </p>
473 <a NAME="EditorHighlightingStylesPage.on_defaultButton_clicked" ID="EditorHighlightingStylesPage.on_defaultButton_clicked"></a>
474 <h4>EditorHighlightingStylesPage.on_defaultButton_clicked</h4>
475 <b>on_defaultButton_clicked</b>(<i></i>)
476
477 <p>
478 Private method to set the current style to its default values.
479 </p>
480 <a NAME="EditorHighlightingStylesPage.on_defaultSubstylesButton_clicked" ID="EditorHighlightingStylesPage.on_defaultSubstylesButton_clicked"></a>
481 <h4>EditorHighlightingStylesPage.on_defaultSubstylesButton_clicked</h4>
482 <b>on_defaultSubstylesButton_clicked</b>(<i></i>)
483
484 <p>
485 Private slot to reset all substyles to default values.
486 </p>
487 <a NAME="EditorHighlightingStylesPage.on_deleteSubstyleButton_clicked" ID="EditorHighlightingStylesPage.on_deleteSubstyleButton_clicked"></a>
488 <h4>EditorHighlightingStylesPage.on_deleteSubstyleButton_clicked</h4>
489 <b>on_deleteSubstyleButton_clicked</b>(<i></i>)
490
491 <p>
492 Private slot to delete the selected sub-style.
493 </p>
494 <a NAME="EditorHighlightingStylesPage.on_editSubstyleButton_clicked" ID="EditorHighlightingStylesPage.on_editSubstyleButton_clicked"></a>
495 <h4>EditorHighlightingStylesPage.on_editSubstyleButton_clicked</h4>
496 <b>on_editSubstyleButton_clicked</b>(<i></i>)
497
498 <p>
499 Private slot to edit the selected sub-style entry.
500 </p>
501 <a NAME="EditorHighlightingStylesPage.on_eolfillCheckBox_clicked" ID="EditorHighlightingStylesPage.on_eolfillCheckBox_clicked"></a>
502 <h4>EditorHighlightingStylesPage.on_eolfillCheckBox_clicked</h4>
503 <b>on_eolfillCheckBox_clicked</b>(<i>on</i>)
504
505 <p>
506 Private method used to set the eolfill for the selected style and
507 lexer.
508 </p>
509 <dl>
510
511 <dt><i>on</i></dt>
512 <dd>
513 flag indicating enabled or disabled state (boolean)
514 </dd>
515 </dl>
516 <a NAME="EditorHighlightingStylesPage.on_exportAllButton_clicked" ID="EditorHighlightingStylesPage.on_exportAllButton_clicked"></a>
517 <h4>EditorHighlightingStylesPage.on_exportAllButton_clicked</h4>
518 <b>on_exportAllButton_clicked</b>(<i></i>)
519
520 <p>
521 Private slot to export the styles of all lexers.
522 </p>
523 <a NAME="EditorHighlightingStylesPage.on_exportButton_clicked" ID="EditorHighlightingStylesPage.on_exportButton_clicked"></a>
524 <h4>EditorHighlightingStylesPage.on_exportButton_clicked</h4>
525 <b>on_exportButton_clicked</b>(<i></i>)
526
527 <p>
528 Private slot to export styles to be selected.
529 </p>
530 <a NAME="EditorHighlightingStylesPage.on_foregroundButton_clicked" ID="EditorHighlightingStylesPage.on_foregroundButton_clicked"></a>
531 <h4>EditorHighlightingStylesPage.on_foregroundButton_clicked</h4>
532 <b>on_foregroundButton_clicked</b>(<i></i>)
533
534 <p>
535 Private method used to select the foreground colour of the selected
536 style and lexer.
537 </p>
538 <a NAME="EditorHighlightingStylesPage.on_importAllButton_clicked" ID="EditorHighlightingStylesPage.on_importAllButton_clicked"></a>
539 <h4>EditorHighlightingStylesPage.on_importAllButton_clicked</h4>
540 <b>on_importAllButton_clicked</b>(<i></i>)
541
542 <p>
543 Private slot to import the styles of all lexers.
544 </p>
545 <a NAME="EditorHighlightingStylesPage.on_importButton_clicked" ID="EditorHighlightingStylesPage.on_importButton_clicked"></a>
546 <h4>EditorHighlightingStylesPage.on_importButton_clicked</h4>
547 <b>on_importButton_clicked</b>(<i></i>)
548
549 <p>
550 Private slot to import styles to be selected.
551 </p>
552 <a NAME="EditorHighlightingStylesPage.on_lexerLanguageComboBox_activated" ID="EditorHighlightingStylesPage.on_lexerLanguageComboBox_activated"></a>
553 <h4>EditorHighlightingStylesPage.on_lexerLanguageComboBox_activated</h4>
554 <b>on_lexerLanguageComboBox_activated</b>(<i>index</i>)
555
556 <p>
557 Private slot to fill the style combo of the source page.
558 </p>
559 <dl>
560
561 <dt><i>index</i> (int)</dt>
562 <dd>
563 index of the selected entry
564 </dd>
565 </dl>
566 <a NAME="EditorHighlightingStylesPage.on_styleElementList_currentItemChanged" ID="EditorHighlightingStylesPage.on_styleElementList_currentItemChanged"></a>
567 <h4>EditorHighlightingStylesPage.on_styleElementList_currentItemChanged</h4>
568 <b>on_styleElementList_currentItemChanged</b>(<i>current, previous</i>)
569
570 <p>
571 Private method to handle a change of the current row.
572 </p>
573 <dl>
574
575 <dt><i>current</i> (QTreeWidgetItem)</dt>
576 <dd>
577 reference to the current item
578 </dd>
579 <dt><i>previous</i> (QTreeWidgetItem)</dt>
580 <dd>
581 reference to the previous item
582 </dd>
583 </dl>
584 <a NAME="EditorHighlightingStylesPage.save" ID="EditorHighlightingStylesPage.save"></a>
585 <h4>EditorHighlightingStylesPage.save</h4>
586 <b>save</b>(<i></i>)
587
588 <p>
589 Public slot to save the Editor Highlighting Styles configuration.
590 </p>
591 <a NAME="EditorHighlightingStylesPage.saveState" ID="EditorHighlightingStylesPage.saveState"></a>
592 <h4>EditorHighlightingStylesPage.saveState</h4>
593 <b>saveState</b>(<i></i>)
594
595 <p>
596 Public method to save the current state of the widget.
597 </p>
598 <dl>
599 <dt>Return:</dt>
600 <dd>
601 list containing the index of the selected lexer language
602 and a tuple containing the index of the parent selected lexer
603 entry and the index of the selected entry
604 </dd>
605 </dl>
606 <dl>
607 <dt>Return Type:</dt>
608 <dd>
609 list of int and tuple of (int, int)
610 </dd>
611 </dl>
612 <a NAME="EditorHighlightingStylesPage.setFont" ID="EditorHighlightingStylesPage.setFont"></a>
613 <h4>EditorHighlightingStylesPage.setFont</h4>
614 <b>setFont</b>(<i>style, substyle, familyOnly, sizeOnly</i>)
615
616 <p>
617 Local function to set the font.
618 </p>
619 <dl>
620
621 <dt><i>font</i> (QFont)</dt>
622 <dd>
623 font to be set
624 </dd>
625 <dt><i>style</i> (int)</dt>
626 <dd>
627 style number
628 </dd>
629 <dt><i>substyle</i> (int)</dt>
630 <dd>
631 sub-style number
632 </dd>
633 <dt><i>familyOnly</i> (bool)</dt>
634 <dd>
635 flag indicating to set the font family only
636 </dd>
637 <dt><i>sizeOnly</i> (bool)</dt>
638 <dd>
639 flag indicating to set the font size only
640 </dd>
641 </dl>
642 <a NAME="EditorHighlightingStylesPage.setSampleFont" ID="EditorHighlightingStylesPage.setSampleFont"></a>
643 <h4>EditorHighlightingStylesPage.setSampleFont</h4>
644 <b>setSampleFont</b>(<i>familyOnly, sizeOnly</i>)
645
646 <p>
647 Local function to set the font of the sample text.
648 </p>
649 <dl>
650
651 <dt><i>font</i></dt>
652 <dd>
653 font to be set (QFont)
654 </dd>
655 <dt><i>familyOnly</i></dt>
656 <dd>
657 flag indicating to set the font family only
658 (boolean)
659 </dd>
660 <dt><i>sizeOnly</i></dt>
661 <dd>
662 flag indicating to set the font size only (boolean
663 </dd>
664 </dl>
665 <a NAME="EditorHighlightingStylesPage.setState" ID="EditorHighlightingStylesPage.setState"></a>
666 <h4>EditorHighlightingStylesPage.setState</h4>
667 <b>setState</b>(<i>state</i>)
668
669 <p>
670 Public method to set the state of the widget.
671 </p>
672 <dl>
673
674 <dt><i>state</i></dt>
675 <dd>
676 state data generated by saveState
677 </dd>
678 </dl>
679 <div align="right"><a href="#top">Up</a></div>
680 <hr />
681 <hr />
682 <a NAME="create" ID="create"></a>
683 <h2>create</h2>
684 <b>create</b>(<i>dlg</i>)
685
686 <p>
687 Module function to create the configuration page.
688 </p>
689 <dl>
690
691 <dt><i>dlg</i></dt>
692 <dd>
693 reference to the configuration dialog
694 </dd>
695 </dl>
696 <dl>
697 <dt>Return:</dt>
698 <dd>
699 reference to the instantiated page (ConfigurationPageBase)
700 </dd>
701 </dl>
702 <div align="right"><a href="#top">Up</a></div>
703 <hr />
704 </body></html>

Mercurial Repository: eric

eric ide

mercurial