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