Mercurial Repositories > eric / file comparison

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

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

branch
eric7
changeset 10479
856476537696
parent 10428
a071d4065202
child 10493
f795d68d8e09
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Preferences.ConfigurationPages.EditorHighlightingStylesPage</h1> 9 <h1>eric7.Preferences.ConfigurationPages.EditorHighlightingStylesPage</h1>
10
11 <p> 10 <p>
12 Module implementing the Editor Highlighting Styles configuration page. 11 Module implementing the Editor Highlighting Styles configuration page.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#EditorHighlightingStylesPage">EditorHighlightingStylesPage</a></td> 22 <td><a href="#EditorHighlightingStylesPage">EditorHighlightingStylesPage</a></td>
25 <td>Class implementing the Editor Highlighting Styles configuration page.</td> 23 <td>Class implementing the Editor Highlighting Styles configuration page.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31
32 <tr> 29 <tr>
33 <td><a href="#create">create</a></td> 30 <td><a href="#create">create</a></td>
34 <td>Module function to create the configuration page.</td> 31 <td>Module function to create the configuration page.</td>
35 </tr> 32 </tr>
36 </table> 33 </table>
34
37 <hr /> 35 <hr />
38 <hr /> 36 <hr />
39 <a NAME="EditorHighlightingStylesPage" ID="EditorHighlightingStylesPage"></a> 37 <a NAME="EditorHighlightingStylesPage" ID="EditorHighlightingStylesPage"></a>
40 <h2>EditorHighlightingStylesPage</h2> 38 <h2>EditorHighlightingStylesPage</h2>
41
42 <p> 39 <p>
43 Class implementing the Editor Highlighting Styles configuration page. 40 Class implementing the Editor Highlighting Styles configuration page.
44 </p> 41 </p>
42
45 <h3>Derived from</h3> 43 <h3>Derived from</h3>
46 ConfigurationPageBase, Ui_EditorHighlightingStylesPage 44 ConfigurationPageBase, Ui_EditorHighlightingStylesPage
47 <h3>Class Attributes</h3> 45 <h3>Class Attributes</h3>
48
49 <table> 46 <table>
50 <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> 47 <tr><td>FAMILYANDSIZE</td></tr>
48 <tr><td>FAMILYONLY</td></tr>
49 <tr><td>FONT</td></tr>
50 <tr><td>SIZEONLY</td></tr>
51 <tr><td>StyleRole</td></tr>
52 <tr><td>SubstyleRole</td></tr>
51 </table> 53 </table>
54
52 <h3>Class Methods</h3> 55 <h3>Class Methods</h3>
53
54 <table> 56 <table>
55 <tr><td>None</td></tr> 57 <tr><td>None</td></tr>
56 </table> 58 </table>
59
57 <h3>Methods</h3> 60 <h3>Methods</h3>
58
59 <table> 61 <table>
60
61 <tr> 62 <tr>
62 <td><a href="#EditorHighlightingStylesPage.__init__">EditorHighlightingStylesPage</a></td> 63 <td><a href="#EditorHighlightingStylesPage.__init__">EditorHighlightingStylesPage</a></td>
63 <td>Constructor</td> 64 <td>Constructor</td>
64 </tr> 65 </tr>
65 <tr> 66 <tr>
209 <tr> 210 <tr>
210 <td><a href="#EditorHighlightingStylesPage.setState">setState</a></td> 211 <td><a href="#EditorHighlightingStylesPage.setState">setState</a></td>
211 <td>Public method to set the state of the widget.</td> 212 <td>Public method to set the state of the widget.</td>
212 </tr> 213 </tr>
213 </table> 214 </table>
215
214 <h3>Static Methods</h3> 216 <h3>Static Methods</h3>
215
216 <table> 217 <table>
217 <tr><td>None</td></tr> 218 <tr><td>None</td></tr>
218 </table> 219 </table>
219 220
221
220 <a NAME="EditorHighlightingStylesPage.__init__" ID="EditorHighlightingStylesPage.__init__"></a> 222 <a NAME="EditorHighlightingStylesPage.__init__" ID="EditorHighlightingStylesPage.__init__"></a>
221 <h4>EditorHighlightingStylesPage (Constructor)</h4> 223 <h4>EditorHighlightingStylesPage (Constructor)</h4>
222 <b>EditorHighlightingStylesPage</b>(<i>lexers</i>) 224 <b>EditorHighlightingStylesPage</b>(<i>lexers</i>)
223
224 <p> 225 <p>
225 Constructor 226 Constructor
226 </p> 227 </p>
228
227 <dl> 229 <dl>
228 230
229 <dt><i>lexers</i> (dict)</dt> 231 <dt><i>lexers</i> (dict)</dt>
230 <dd> 232 <dd>
231 reference to the lexers dictionary 233 reference to the lexers dictionary
232 </dd> 234 </dd>
233 </dl> 235 </dl>
234 <a NAME="EditorHighlightingStylesPage.__allFontsButtonMenuTriggered" ID="EditorHighlightingStylesPage.__allFontsButtonMenuTriggered"></a> 236 <a NAME="EditorHighlightingStylesPage.__allFontsButtonMenuTriggered" ID="EditorHighlightingStylesPage.__allFontsButtonMenuTriggered"></a>
235 <h4>EditorHighlightingStylesPage.__allFontsButtonMenuTriggered</h4> 237 <h4>EditorHighlightingStylesPage.__allFontsButtonMenuTriggered</h4>
236 <b>__allFontsButtonMenuTriggered</b>(<i>act</i>) 238 <b>__allFontsButtonMenuTriggered</b>(<i>act</i>)
237
238 <p> 239 <p>
239 Private slot used to change the font of all styles of a selected lexer. 240 Private slot used to change the font of all styles of a selected lexer.
240 </p> 241 </p>
242
241 <dl> 243 <dl>
242 244
243 <dt><i>act</i> (QAction)</dt> 245 <dt><i>act</i> (QAction)</dt>
244 <dd> 246 <dd>
245 reference to the triggering action 247 reference to the triggering action
246 </dd> 248 </dd>
247 </dl> 249 </dl>
248 <a NAME="EditorHighlightingStylesPage.__applyStyles" ID="EditorHighlightingStylesPage.__applyStyles"></a> 250 <a NAME="EditorHighlightingStylesPage.__applyStyles" ID="EditorHighlightingStylesPage.__applyStyles"></a>
249 <h4>EditorHighlightingStylesPage.__applyStyles</h4> 251 <h4>EditorHighlightingStylesPage.__applyStyles</h4>
250 <b>__applyStyles</b>(<i>stylesList, importAll=False</i>) 252 <b>__applyStyles</b>(<i>stylesList, importAll=False</i>)
251
252 <p> 253 <p>
253 Private method to apply the imported styles to this dialog. 254 Private method to apply the imported styles to this dialog.
254 </p> 255 </p>
256
255 <dl> 257 <dl>
256 258
257 <dt><i>stylesList</i> (list of dict)</dt> 259 <dt><i>stylesList</i> (list of dict)</dt>
258 <dd> 260 <dd>
259 list of imported lexer styles 261 list of imported lexer styles
265 </dd> 267 </dd>
266 </dl> 268 </dl>
267 <a NAME="EditorHighlightingStylesPage.__changeFont" ID="EditorHighlightingStylesPage.__changeFont"></a> 269 <a NAME="EditorHighlightingStylesPage.__changeFont" ID="EditorHighlightingStylesPage.__changeFont"></a>
268 <h4>EditorHighlightingStylesPage.__changeFont</h4> 270 <h4>EditorHighlightingStylesPage.__changeFont</h4>
269 <b>__changeFont</b>(<i>doAll, familyOnly, sizeOnly</i>) 271 <b>__changeFont</b>(<i>doAll, familyOnly, sizeOnly</i>)
270
271 <p> 272 <p>
272 Private slot to change the highlighter font. 273 Private slot to change the highlighter font.
273 </p> 274 </p>
275
274 <dl> 276 <dl>
275 277
276 <dt><i>doAll</i> (bool)</dt> 278 <dt><i>doAll</i> (bool)</dt>
277 <dd> 279 <dd>
278 flag indicating to change the font for all styles 280 flag indicating to change the font for all styles
287 </dd> 289 </dd>
288 </dl> 290 </dl>
289 <a NAME="EditorHighlightingStylesPage.__currentStyles" ID="EditorHighlightingStylesPage.__currentStyles"></a> 291 <a NAME="EditorHighlightingStylesPage.__currentStyles" ID="EditorHighlightingStylesPage.__currentStyles"></a>
290 <h4>EditorHighlightingStylesPage.__currentStyles</h4> 292 <h4>EditorHighlightingStylesPage.__currentStyles</h4>
291 <b>__currentStyles</b>(<i></i>) 293 <b>__currentStyles</b>(<i></i>)
292
293 <p> 294 <p>
294 Private method to get the styles of the current item. 295 Private method to get the styles of the current item.
295 </p> 296 </p>
297
296 <dl> 298 <dl>
297 <dt>Return:</dt> 299 <dt>Return:</dt>
298 <dd> 300 <dd>
299 tuple containing the style and sub-style numbers 301 tuple containing the style and sub-style numbers
300 </dd> 302 </dd>
306 </dd> 308 </dd>
307 </dl> 309 </dl>
308 <a NAME="EditorHighlightingStylesPage.__exportStyles" ID="EditorHighlightingStylesPage.__exportStyles"></a> 310 <a NAME="EditorHighlightingStylesPage.__exportStyles" ID="EditorHighlightingStylesPage.__exportStyles"></a>
309 <h4>EditorHighlightingStylesPage.__exportStyles</h4> 311 <h4>EditorHighlightingStylesPage.__exportStyles</h4>
310 <b>__exportStyles</b>(<i>exportAll=False</i>) 312 <b>__exportStyles</b>(<i>exportAll=False</i>)
311
312 <p> 313 <p>
313 Private method to export the styles of selectable lexers. 314 Private method to export the styles of selectable lexers.
314 </p> 315 </p>
316
315 <dl> 317 <dl>
316 318
317 <dt><i>exportAll</i> (bool (optional))</dt> 319 <dt><i>exportAll</i> (bool (optional))</dt>
318 <dd> 320 <dd>
319 flag indicating to export all styles without asking 321 flag indicating to export all styles without asking
321 </dd> 323 </dd>
322 </dl> 324 </dl>
323 <a NAME="EditorHighlightingStylesPage.__fontButtonMenuTriggered" ID="EditorHighlightingStylesPage.__fontButtonMenuTriggered"></a> 325 <a NAME="EditorHighlightingStylesPage.__fontButtonMenuTriggered" ID="EditorHighlightingStylesPage.__fontButtonMenuTriggered"></a>
324 <h4>EditorHighlightingStylesPage.__fontButtonMenuTriggered</h4> 326 <h4>EditorHighlightingStylesPage.__fontButtonMenuTriggered</h4>
325 <b>__fontButtonMenuTriggered</b>(<i>act</i>) 327 <b>__fontButtonMenuTriggered</b>(<i>act</i>)
326
327 <p> 328 <p>
328 Private slot used to select the font of the selected style and lexer. 329 Private slot used to select the font of the selected style and lexer.
329 </p> 330 </p>
331
330 <dl> 332 <dl>
331 333
332 <dt><i>act</i> (QAction)</dt> 334 <dt><i>act</i> (QAction)</dt>
333 <dd> 335 <dd>
334 reference to the triggering action 336 reference to the triggering action
335 </dd> 337 </dd>
336 </dl> 338 </dl>
337 <a NAME="EditorHighlightingStylesPage.__importStyles" ID="EditorHighlightingStylesPage.__importStyles"></a> 339 <a NAME="EditorHighlightingStylesPage.__importStyles" ID="EditorHighlightingStylesPage.__importStyles"></a>
338 <h4>EditorHighlightingStylesPage.__importStyles</h4> 340 <h4>EditorHighlightingStylesPage.__importStyles</h4>
339 <b>__importStyles</b>(<i>importAll=False</i>) 341 <b>__importStyles</b>(<i>importAll=False</i>)
340
341 <p> 342 <p>
342 Private method to import the styles of lexers to be selected. 343 Private method to import the styles of lexers to be selected.
343 </p> 344 </p>
345
344 <dl> 346 <dl>
345 347
346 <dt><i>importAll</i> (bool (optional))</dt> 348 <dt><i>importAll</i> (bool (optional))</dt>
347 <dd> 349 <dd>
348 flag indicating to import all styles without asking 350 flag indicating to import all styles without asking
350 </dd> 352 </dd>
351 </dl> 353 </dl>
352 <a NAME="EditorHighlightingStylesPage.__populateLanguages" ID="EditorHighlightingStylesPage.__populateLanguages"></a> 354 <a NAME="EditorHighlightingStylesPage.__populateLanguages" ID="EditorHighlightingStylesPage.__populateLanguages"></a>
353 <h4>EditorHighlightingStylesPage.__populateLanguages</h4> 355 <h4>EditorHighlightingStylesPage.__populateLanguages</h4>
354 <b>__populateLanguages</b>(<i>languages</i>) 356 <b>__populateLanguages</b>(<i>languages</i>)
355
356 <p> 357 <p>
357 Private method to populate the language selection box. 358 Private method to populate the language selection box.
358 </p> 359 </p>
360
359 <dl> 361 <dl>
360 362
361 <dt><i>languages</i> (list of str)</dt> 363 <dt><i>languages</i> (list of str)</dt>
362 <dd> 364 <dd>
363 list of languages to include in the language selector 365 list of languages to include in the language selector
364 </dd> 366 </dd>
365 </dl> 367 </dl>
366 <a NAME="EditorHighlightingStylesPage.__setToDefault" ID="EditorHighlightingStylesPage.__setToDefault"></a> 368 <a NAME="EditorHighlightingStylesPage.__setToDefault" ID="EditorHighlightingStylesPage.__setToDefault"></a>
367 <h4>EditorHighlightingStylesPage.__setToDefault</h4> 369 <h4>EditorHighlightingStylesPage.__setToDefault</h4>
368 <b>__setToDefault</b>(<i>style, substyle</i>) 370 <b>__setToDefault</b>(<i>style, substyle</i>)
369
370 <p> 371 <p>
371 Private method to set a specific style to its default values. 372 Private method to set a specific style to its default values.
372 </p> 373 </p>
374
373 <dl> 375 <dl>
374 376
375 <dt><i>style</i> (int)</dt> 377 <dt><i>style</i> (int)</dt>
376 <dd> 378 <dd>
377 style number 379 style number
382 </dd> 384 </dd>
383 </dl> 385 </dl>
384 <a NAME="EditorHighlightingStylesPage.__styleAllItems" ID="EditorHighlightingStylesPage.__styleAllItems"></a> 386 <a NAME="EditorHighlightingStylesPage.__styleAllItems" ID="EditorHighlightingStylesPage.__styleAllItems"></a>
385 <h4>EditorHighlightingStylesPage.__styleAllItems</h4> 387 <h4>EditorHighlightingStylesPage.__styleAllItems</h4>
386 <b>__styleAllItems</b>(<i></i>) 388 <b>__styleAllItems</b>(<i></i>)
387
388 <p> 389 <p>
389 Private method to style all items of the style element list. 390 Private method to style all items of the style element list.
390 </p> 391 </p>
392
391 <a NAME="EditorHighlightingStylesPage.__styleOneItem" ID="EditorHighlightingStylesPage.__styleOneItem"></a> 393 <a NAME="EditorHighlightingStylesPage.__styleOneItem" ID="EditorHighlightingStylesPage.__styleOneItem"></a>
392 <h4>EditorHighlightingStylesPage.__styleOneItem</h4> 394 <h4>EditorHighlightingStylesPage.__styleOneItem</h4>
393 <b>__styleOneItem</b>(<i>item, style, substyle</i>) 395 <b>__styleOneItem</b>(<i>item, style, substyle</i>)
394
395 <p> 396 <p>
396 Private method to style one item of the style element list. 397 Private method to style one item of the style element list.
397 </p> 398 </p>
399
398 <dl> 400 <dl>
399 401
400 <dt><i>item</i> (QTreeWidgetItem)</dt> 402 <dt><i>item</i> (QTreeWidgetItem)</dt>
401 <dd> 403 <dd>
402 reference to the item to be styled 404 reference to the item to be styled
411 </dd> 413 </dd>
412 </dl> 414 </dl>
413 <a NAME="EditorHighlightingStylesPage.__styleSample" ID="EditorHighlightingStylesPage.__styleSample"></a> 415 <a NAME="EditorHighlightingStylesPage.__styleSample" ID="EditorHighlightingStylesPage.__styleSample"></a>
414 <h4>EditorHighlightingStylesPage.__styleSample</h4> 416 <h4>EditorHighlightingStylesPage.__styleSample</h4>
415 <b>__styleSample</b>(<i>color, paper, font=None</i>) 417 <b>__styleSample</b>(<i>color, paper, font=None</i>)
416
417 <p> 418 <p>
418 Private method to style the sample text. 419 Private method to style the sample text.
419 </p> 420 </p>
421
420 <dl> 422 <dl>
421 423
422 <dt><i>color</i> (QColor)</dt> 424 <dt><i>color</i> (QColor)</dt>
423 <dd> 425 <dd>
424 foreground color for the sample 426 foreground color for the sample
433 </dd> 435 </dd>
434 </dl> 436 </dl>
435 <a NAME="EditorHighlightingStylesPage.__stylesForItem" ID="EditorHighlightingStylesPage.__stylesForItem"></a> 437 <a NAME="EditorHighlightingStylesPage.__stylesForItem" ID="EditorHighlightingStylesPage.__stylesForItem"></a>
436 <h4>EditorHighlightingStylesPage.__stylesForItem</h4> 438 <h4>EditorHighlightingStylesPage.__stylesForItem</h4>
437 <b>__stylesForItem</b>(<i>itm</i>) 439 <b>__stylesForItem</b>(<i>itm</i>)
438
439 <p> 440 <p>
440 Private method to get the style and sub-style number of the given item. 441 Private method to get the style and sub-style number of the given item.
441 </p> 442 </p>
443
442 <dl> 444 <dl>
443 445
444 <dt><i>itm</i> (QTreeWidgetItem)</dt> 446 <dt><i>itm</i> (QTreeWidgetItem)</dt>
445 <dd> 447 <dd>
446 reference to the item to extract the styles from 448 reference to the item to extract the styles from
459 </dd> 461 </dd>
460 </dl> 462 </dl>
461 <a NAME="EditorHighlightingStylesPage.on_addSubstyleButton_clicked" ID="EditorHighlightingStylesPage.on_addSubstyleButton_clicked"></a> 463 <a NAME="EditorHighlightingStylesPage.on_addSubstyleButton_clicked" ID="EditorHighlightingStylesPage.on_addSubstyleButton_clicked"></a>
462 <h4>EditorHighlightingStylesPage.on_addSubstyleButton_clicked</h4> 464 <h4>EditorHighlightingStylesPage.on_addSubstyleButton_clicked</h4>
463 <b>on_addSubstyleButton_clicked</b>(<i></i>) 465 <b>on_addSubstyleButton_clicked</b>(<i></i>)
464
465 <p> 466 <p>
466 Private slot to add a new sub-style. 467 Private slot to add a new sub-style.
467 </p> 468 </p>
469
468 <a NAME="EditorHighlightingStylesPage.on_allBackgroundColoursButton_clicked" ID="EditorHighlightingStylesPage.on_allBackgroundColoursButton_clicked"></a> 470 <a NAME="EditorHighlightingStylesPage.on_allBackgroundColoursButton_clicked" ID="EditorHighlightingStylesPage.on_allBackgroundColoursButton_clicked"></a>
469 <h4>EditorHighlightingStylesPage.on_allBackgroundColoursButton_clicked</h4> 471 <h4>EditorHighlightingStylesPage.on_allBackgroundColoursButton_clicked</h4>
470 <b>on_allBackgroundColoursButton_clicked</b>(<i></i>) 472 <b>on_allBackgroundColoursButton_clicked</b>(<i></i>)
471
472 <p> 473 <p>
473 Private method used to select the background colour of all styles of a 474 Private method used to select the background colour of all styles of a
474 selected lexer. 475 selected lexer.
475 </p> 476 </p>
477
476 <a NAME="EditorHighlightingStylesPage.on_allDefaultButton_clicked" ID="EditorHighlightingStylesPage.on_allDefaultButton_clicked"></a> 478 <a NAME="EditorHighlightingStylesPage.on_allDefaultButton_clicked" ID="EditorHighlightingStylesPage.on_allDefaultButton_clicked"></a>
477 <h4>EditorHighlightingStylesPage.on_allDefaultButton_clicked</h4> 479 <h4>EditorHighlightingStylesPage.on_allDefaultButton_clicked</h4>
478 <b>on_allDefaultButton_clicked</b>(<i></i>) 480 <b>on_allDefaultButton_clicked</b>(<i></i>)
479
480 <p> 481 <p>
481 Private method to set all styles to their default values. 482 Private method to set all styles to their default values.
482 </p> 483 </p>
484
483 <a NAME="EditorHighlightingStylesPage.on_allEolFillButton_clicked" ID="EditorHighlightingStylesPage.on_allEolFillButton_clicked"></a> 485 <a NAME="EditorHighlightingStylesPage.on_allEolFillButton_clicked" ID="EditorHighlightingStylesPage.on_allEolFillButton_clicked"></a>
484 <h4>EditorHighlightingStylesPage.on_allEolFillButton_clicked</h4> 486 <h4>EditorHighlightingStylesPage.on_allEolFillButton_clicked</h4>
485 <b>on_allEolFillButton_clicked</b>(<i></i>) 487 <b>on_allEolFillButton_clicked</b>(<i></i>)
486
487 <p> 488 <p>
488 Private method used to set the eolfill for all styles of a selected 489 Private method used to set the eolfill for all styles of a selected
489 lexer. 490 lexer.
490 </p> 491 </p>
492
491 <a NAME="EditorHighlightingStylesPage.on_backgroundButton_clicked" ID="EditorHighlightingStylesPage.on_backgroundButton_clicked"></a> 493 <a NAME="EditorHighlightingStylesPage.on_backgroundButton_clicked" ID="EditorHighlightingStylesPage.on_backgroundButton_clicked"></a>
492 <h4>EditorHighlightingStylesPage.on_backgroundButton_clicked</h4> 494 <h4>EditorHighlightingStylesPage.on_backgroundButton_clicked</h4>
493 <b>on_backgroundButton_clicked</b>(<i></i>) 495 <b>on_backgroundButton_clicked</b>(<i></i>)
494
495 <p> 496 <p>
496 Private method used to select the background colour of the selected 497 Private method used to select the background colour of the selected
497 style and lexer. 498 style and lexer.
498 </p> 499 </p>
500
499 <a NAME="EditorHighlightingStylesPage.on_copySubstyleButton_clicked" ID="EditorHighlightingStylesPage.on_copySubstyleButton_clicked"></a> 501 <a NAME="EditorHighlightingStylesPage.on_copySubstyleButton_clicked" ID="EditorHighlightingStylesPage.on_copySubstyleButton_clicked"></a>
500 <h4>EditorHighlightingStylesPage.on_copySubstyleButton_clicked</h4> 502 <h4>EditorHighlightingStylesPage.on_copySubstyleButton_clicked</h4>
501 <b>on_copySubstyleButton_clicked</b>(<i></i>) 503 <b>on_copySubstyleButton_clicked</b>(<i></i>)
502
503 <p> 504 <p>
504 Private slot to copy the selected sub-style. 505 Private slot to copy the selected sub-style.
505 </p> 506 </p>
507
506 <a NAME="EditorHighlightingStylesPage.on_defaultButton_clicked" ID="EditorHighlightingStylesPage.on_defaultButton_clicked"></a> 508 <a NAME="EditorHighlightingStylesPage.on_defaultButton_clicked" ID="EditorHighlightingStylesPage.on_defaultButton_clicked"></a>
507 <h4>EditorHighlightingStylesPage.on_defaultButton_clicked</h4> 509 <h4>EditorHighlightingStylesPage.on_defaultButton_clicked</h4>
508 <b>on_defaultButton_clicked</b>(<i></i>) 510 <b>on_defaultButton_clicked</b>(<i></i>)
509
510 <p> 511 <p>
511 Private method to set the current style to its default values. 512 Private method to set the current style to its default values.
512 </p> 513 </p>
514
513 <a NAME="EditorHighlightingStylesPage.on_defaultSubstylesButton_clicked" ID="EditorHighlightingStylesPage.on_defaultSubstylesButton_clicked"></a> 515 <a NAME="EditorHighlightingStylesPage.on_defaultSubstylesButton_clicked" ID="EditorHighlightingStylesPage.on_defaultSubstylesButton_clicked"></a>
514 <h4>EditorHighlightingStylesPage.on_defaultSubstylesButton_clicked</h4> 516 <h4>EditorHighlightingStylesPage.on_defaultSubstylesButton_clicked</h4>
515 <b>on_defaultSubstylesButton_clicked</b>(<i></i>) 517 <b>on_defaultSubstylesButton_clicked</b>(<i></i>)
516
517 <p> 518 <p>
518 Private slot to reset all substyles to default values. 519 Private slot to reset all substyles to default values.
519 </p> 520 </p>
521
520 <a NAME="EditorHighlightingStylesPage.on_deleteSubstyleButton_clicked" ID="EditorHighlightingStylesPage.on_deleteSubstyleButton_clicked"></a> 522 <a NAME="EditorHighlightingStylesPage.on_deleteSubstyleButton_clicked" ID="EditorHighlightingStylesPage.on_deleteSubstyleButton_clicked"></a>
521 <h4>EditorHighlightingStylesPage.on_deleteSubstyleButton_clicked</h4> 523 <h4>EditorHighlightingStylesPage.on_deleteSubstyleButton_clicked</h4>
522 <b>on_deleteSubstyleButton_clicked</b>(<i></i>) 524 <b>on_deleteSubstyleButton_clicked</b>(<i></i>)
523
524 <p> 525 <p>
525 Private slot to delete the selected sub-style. 526 Private slot to delete the selected sub-style.
526 </p> 527 </p>
528
527 <a NAME="EditorHighlightingStylesPage.on_editSubstyleButton_clicked" ID="EditorHighlightingStylesPage.on_editSubstyleButton_clicked"></a> 529 <a NAME="EditorHighlightingStylesPage.on_editSubstyleButton_clicked" ID="EditorHighlightingStylesPage.on_editSubstyleButton_clicked"></a>
528 <h4>EditorHighlightingStylesPage.on_editSubstyleButton_clicked</h4> 530 <h4>EditorHighlightingStylesPage.on_editSubstyleButton_clicked</h4>
529 <b>on_editSubstyleButton_clicked</b>(<i></i>) 531 <b>on_editSubstyleButton_clicked</b>(<i></i>)
530
531 <p> 532 <p>
532 Private slot to edit the selected sub-style entry. 533 Private slot to edit the selected sub-style entry.
533 </p> 534 </p>
535
534 <a NAME="EditorHighlightingStylesPage.on_eolfillCheckBox_clicked" ID="EditorHighlightingStylesPage.on_eolfillCheckBox_clicked"></a> 536 <a NAME="EditorHighlightingStylesPage.on_eolfillCheckBox_clicked" ID="EditorHighlightingStylesPage.on_eolfillCheckBox_clicked"></a>
535 <h4>EditorHighlightingStylesPage.on_eolfillCheckBox_clicked</h4> 537 <h4>EditorHighlightingStylesPage.on_eolfillCheckBox_clicked</h4>
536 <b>on_eolfillCheckBox_clicked</b>(<i>on</i>) 538 <b>on_eolfillCheckBox_clicked</b>(<i>on</i>)
537
538 <p> 539 <p>
539 Private method used to set the eolfill for the selected style and 540 Private method used to set the eolfill for the selected style and
540 lexer. 541 lexer.
541 </p> 542 </p>
543
542 <dl> 544 <dl>
543 545
544 <dt><i>on</i> (bool)</dt> 546 <dt><i>on</i> (bool)</dt>
545 <dd> 547 <dd>
546 flag indicating enabled or disabled state 548 flag indicating enabled or disabled state
547 </dd> 549 </dd>
548 </dl> 550 </dl>
549 <a NAME="EditorHighlightingStylesPage.on_exportAllButton_clicked" ID="EditorHighlightingStylesPage.on_exportAllButton_clicked"></a> 551 <a NAME="EditorHighlightingStylesPage.on_exportAllButton_clicked" ID="EditorHighlightingStylesPage.on_exportAllButton_clicked"></a>
550 <h4>EditorHighlightingStylesPage.on_exportAllButton_clicked</h4> 552 <h4>EditorHighlightingStylesPage.on_exportAllButton_clicked</h4>
551 <b>on_exportAllButton_clicked</b>(<i></i>) 553 <b>on_exportAllButton_clicked</b>(<i></i>)
552
553 <p> 554 <p>
554 Private slot to export the styles of all lexers. 555 Private slot to export the styles of all lexers.
555 </p> 556 </p>
557
556 <a NAME="EditorHighlightingStylesPage.on_exportButton_clicked" ID="EditorHighlightingStylesPage.on_exportButton_clicked"></a> 558 <a NAME="EditorHighlightingStylesPage.on_exportButton_clicked" ID="EditorHighlightingStylesPage.on_exportButton_clicked"></a>
557 <h4>EditorHighlightingStylesPage.on_exportButton_clicked</h4> 559 <h4>EditorHighlightingStylesPage.on_exportButton_clicked</h4>
558 <b>on_exportButton_clicked</b>(<i></i>) 560 <b>on_exportButton_clicked</b>(<i></i>)
559
560 <p> 561 <p>
561 Private slot to export styles to be selected. 562 Private slot to export styles to be selected.
562 </p> 563 </p>
564
563 <a NAME="EditorHighlightingStylesPage.on_foregroundButton_clicked" ID="EditorHighlightingStylesPage.on_foregroundButton_clicked"></a> 565 <a NAME="EditorHighlightingStylesPage.on_foregroundButton_clicked" ID="EditorHighlightingStylesPage.on_foregroundButton_clicked"></a>
564 <h4>EditorHighlightingStylesPage.on_foregroundButton_clicked</h4> 566 <h4>EditorHighlightingStylesPage.on_foregroundButton_clicked</h4>
565 <b>on_foregroundButton_clicked</b>(<i></i>) 567 <b>on_foregroundButton_clicked</b>(<i></i>)
566
567 <p> 568 <p>
568 Private method used to select the foreground colour of the selected 569 Private method used to select the foreground colour of the selected
569 style and lexer. 570 style and lexer.
570 </p> 571 </p>
572
571 <a NAME="EditorHighlightingStylesPage.on_importAllButton_clicked" ID="EditorHighlightingStylesPage.on_importAllButton_clicked"></a> 573 <a NAME="EditorHighlightingStylesPage.on_importAllButton_clicked" ID="EditorHighlightingStylesPage.on_importAllButton_clicked"></a>
572 <h4>EditorHighlightingStylesPage.on_importAllButton_clicked</h4> 574 <h4>EditorHighlightingStylesPage.on_importAllButton_clicked</h4>
573 <b>on_importAllButton_clicked</b>(<i></i>) 575 <b>on_importAllButton_clicked</b>(<i></i>)
574
575 <p> 576 <p>
576 Private slot to import the styles of all lexers. 577 Private slot to import the styles of all lexers.
577 </p> 578 </p>
579
578 <a NAME="EditorHighlightingStylesPage.on_importButton_clicked" ID="EditorHighlightingStylesPage.on_importButton_clicked"></a> 580 <a NAME="EditorHighlightingStylesPage.on_importButton_clicked" ID="EditorHighlightingStylesPage.on_importButton_clicked"></a>
579 <h4>EditorHighlightingStylesPage.on_importButton_clicked</h4> 581 <h4>EditorHighlightingStylesPage.on_importButton_clicked</h4>
580 <b>on_importButton_clicked</b>(<i></i>) 582 <b>on_importButton_clicked</b>(<i></i>)
581
582 <p> 583 <p>
583 Private slot to import styles to be selected. 584 Private slot to import styles to be selected.
584 </p> 585 </p>
586
585 <a NAME="EditorHighlightingStylesPage.on_lexerLanguageComboBox_activated" ID="EditorHighlightingStylesPage.on_lexerLanguageComboBox_activated"></a> 587 <a NAME="EditorHighlightingStylesPage.on_lexerLanguageComboBox_activated" ID="EditorHighlightingStylesPage.on_lexerLanguageComboBox_activated"></a>
586 <h4>EditorHighlightingStylesPage.on_lexerLanguageComboBox_activated</h4> 588 <h4>EditorHighlightingStylesPage.on_lexerLanguageComboBox_activated</h4>
587 <b>on_lexerLanguageComboBox_activated</b>(<i>index</i>) 589 <b>on_lexerLanguageComboBox_activated</b>(<i>index</i>)
588
589 <p> 590 <p>
590 Private slot to fill the style combo of the source page. 591 Private slot to fill the style combo of the source page.
591 </p> 592 </p>
593
592 <dl> 594 <dl>
593 595
594 <dt><i>index</i> (int)</dt> 596 <dt><i>index</i> (int)</dt>
595 <dd> 597 <dd>
596 index of the selected entry 598 index of the selected entry
597 </dd> 599 </dd>
598 </dl> 600 </dl>
599 <a NAME="EditorHighlightingStylesPage.on_styleElementList_currentItemChanged" ID="EditorHighlightingStylesPage.on_styleElementList_currentItemChanged"></a> 601 <a NAME="EditorHighlightingStylesPage.on_styleElementList_currentItemChanged" ID="EditorHighlightingStylesPage.on_styleElementList_currentItemChanged"></a>
600 <h4>EditorHighlightingStylesPage.on_styleElementList_currentItemChanged</h4> 602 <h4>EditorHighlightingStylesPage.on_styleElementList_currentItemChanged</h4>
601 <b>on_styleElementList_currentItemChanged</b>(<i>current, previous</i>) 603 <b>on_styleElementList_currentItemChanged</b>(<i>current, previous</i>)
602
603 <p> 604 <p>
604 Private method to handle a change of the current row. 605 Private method to handle a change of the current row.
605 </p> 606 </p>
607
606 <dl> 608 <dl>
607 609
608 <dt><i>current</i> (QTreeWidgetItem)</dt> 610 <dt><i>current</i> (QTreeWidgetItem)</dt>
609 <dd> 611 <dd>
610 reference to the current item 612 reference to the current item
615 </dd> 617 </dd>
616 </dl> 618 </dl>
617 <a NAME="EditorHighlightingStylesPage.save" ID="EditorHighlightingStylesPage.save"></a> 619 <a NAME="EditorHighlightingStylesPage.save" ID="EditorHighlightingStylesPage.save"></a>
618 <h4>EditorHighlightingStylesPage.save</h4> 620 <h4>EditorHighlightingStylesPage.save</h4>
619 <b>save</b>(<i></i>) 621 <b>save</b>(<i></i>)
620
621 <p> 622 <p>
622 Public slot to save the Editor Highlighting Styles configuration. 623 Public slot to save the Editor Highlighting Styles configuration.
623 </p> 624 </p>
625
624 <a NAME="EditorHighlightingStylesPage.saveState" ID="EditorHighlightingStylesPage.saveState"></a> 626 <a NAME="EditorHighlightingStylesPage.saveState" ID="EditorHighlightingStylesPage.saveState"></a>
625 <h4>EditorHighlightingStylesPage.saveState</h4> 627 <h4>EditorHighlightingStylesPage.saveState</h4>
626 <b>saveState</b>(<i></i>) 628 <b>saveState</b>(<i></i>)
627
628 <p> 629 <p>
629 Public method to save the current state of the widget. 630 Public method to save the current state of the widget.
630 </p> 631 </p>
632
631 <dl> 633 <dl>
632 <dt>Return:</dt> 634 <dt>Return:</dt>
633 <dd> 635 <dd>
634 list containing the index of the selected lexer language 636 list containing the index of the selected lexer language
635 and a tuple containing the index of the parent selected lexer 637 and a tuple containing the index of the parent selected lexer
643 </dd> 645 </dd>
644 </dl> 646 </dl>
645 <a NAME="EditorHighlightingStylesPage.setFont" ID="EditorHighlightingStylesPage.setFont"></a> 647 <a NAME="EditorHighlightingStylesPage.setFont" ID="EditorHighlightingStylesPage.setFont"></a>
646 <h4>EditorHighlightingStylesPage.setFont</h4> 648 <h4>EditorHighlightingStylesPage.setFont</h4>
647 <b>setFont</b>(<i>style, substyle, familyOnly, sizeOnly</i>) 649 <b>setFont</b>(<i>style, substyle, familyOnly, sizeOnly</i>)
648
649 <p> 650 <p>
650 Local function to set the font. 651 Local function to set the font.
651 </p> 652 </p>
653
652 <dl> 654 <dl>
653 655
654 <dt><i>font</i> (QFont)</dt> 656 <dt><i>font</i> (QFont)</dt>
655 <dd> 657 <dd>
656 font to be set 658 font to be set
673 </dd> 675 </dd>
674 </dl> 676 </dl>
675 <a NAME="EditorHighlightingStylesPage.setMode" ID="EditorHighlightingStylesPage.setMode"></a> 677 <a NAME="EditorHighlightingStylesPage.setMode" ID="EditorHighlightingStylesPage.setMode"></a>
676 <h4>EditorHighlightingStylesPage.setMode</h4> 678 <h4>EditorHighlightingStylesPage.setMode</h4>
677 <b>setMode</b>(<i>displayMode</i>) 679 <b>setMode</b>(<i>displayMode</i>)
678
679 <p> 680 <p>
680 Public method to perform mode dependent setups. 681 Public method to perform mode dependent setups.
681 </p> 682 </p>
683
682 <dl> 684 <dl>
683 685
684 <dt><i>displayMode</i> (ConfigurationMode)</dt> 686 <dt><i>displayMode</i> (ConfigurationMode)</dt>
685 <dd> 687 <dd>
686 mode of the configuration dialog 688 mode of the configuration dialog
687 </dd> 689 </dd>
688 </dl> 690 </dl>
689 <a NAME="EditorHighlightingStylesPage.setSampleFont" ID="EditorHighlightingStylesPage.setSampleFont"></a> 691 <a NAME="EditorHighlightingStylesPage.setSampleFont" ID="EditorHighlightingStylesPage.setSampleFont"></a>
690 <h4>EditorHighlightingStylesPage.setSampleFont</h4> 692 <h4>EditorHighlightingStylesPage.setSampleFont</h4>
691 <b>setSampleFont</b>(<i>familyOnly, sizeOnly</i>) 693 <b>setSampleFont</b>(<i>familyOnly, sizeOnly</i>)
692
693 <p> 694 <p>
694 Local function to set the font of the sample text. 695 Local function to set the font of the sample text.
695 </p> 696 </p>
697
696 <dl> 698 <dl>
697 699
698 <dt><i>font</i></dt> 700 <dt><i>font</i></dt>
699 <dd> 701 <dd>
700 font to be set (QFont) 702 font to be set (QFont)
710 </dd> 712 </dd>
711 </dl> 713 </dl>
712 <a NAME="EditorHighlightingStylesPage.setState" ID="EditorHighlightingStylesPage.setState"></a> 714 <a NAME="EditorHighlightingStylesPage.setState" ID="EditorHighlightingStylesPage.setState"></a>
713 <h4>EditorHighlightingStylesPage.setState</h4> 715 <h4>EditorHighlightingStylesPage.setState</h4>
714 <b>setState</b>(<i>state</i>) 716 <b>setState</b>(<i>state</i>)
715
716 <p> 717 <p>
717 Public method to set the state of the widget. 718 Public method to set the state of the widget.
718 </p> 719 </p>
720
719 <dl> 721 <dl>
720 722
721 <dt><i>state</i> (list of [int, tuple of (int, int)])</dt> 723 <dt><i>state</i> (list of [int, tuple of (int, int)])</dt>
722 <dd> 724 <dd>
723 state data generated by saveState 725 state data generated by saveState
727 <hr /> 729 <hr />
728 <hr /> 730 <hr />
729 <a NAME="create" ID="create"></a> 731 <a NAME="create" ID="create"></a>
730 <h2>create</h2> 732 <h2>create</h2>
731 <b>create</b>(<i>dlg</i>) 733 <b>create</b>(<i>dlg</i>)
732
733 <p> 734 <p>
734 Module function to create the configuration page. 735 Module function to create the configuration page.
735 </p> 736 </p>
737
736 <dl> 738 <dl>
737 739
738 <dt><i>dlg</i> (ConfigurationDialog)</dt> 740 <dt><i>dlg</i> (ConfigurationDialog)</dt>
739 <dd> 741 <dd>
740 reference to the configuration dialog 742 reference to the configuration dialog

Mercurial Repository: eric

eric ide

mercurial