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

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

eric ide

mercurial