Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Preferences.ConfigurationDialog.html
src/eric7/Documentation/Source/eric7.Preferences.ConfigurationDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8886
- d6c8e8105e57
- child 9236
- db53a9efe7ef
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Preferences.ConfigurationDialog</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.ConfigurationDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog for the configuration of eric. | |
| 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="#ConfigurationDialog">ConfigurationDialog</a></td> | |
| 25 <td>Class for the dialog variant.</td> | |
| 26 </tr> | |
| 27 <tr> | |
| 28 <td><a href="#ConfigurationMode">ConfigurationMode</a></td> | |
| 29 <td>Class defining the various modes of the configuration widget.</td> | |
| 30 </tr> | |
| 31 <tr> | |
| 32 <td><a href="#ConfigurationPageItem">ConfigurationPageItem</a></td> | |
| 33 <td>Class implementing a QTreeWidgetItem holding the configuration page data.</td> | |
| 34 </tr> | |
| 35 <tr> | |
| 36 <td><a href="#ConfigurationWidget">ConfigurationWidget</a></td> | |
| 37 <td>Class implementing a dialog for the configuration of eric.</td> | |
| 38 </tr> | |
| 39 <tr> | |
| 40 <td><a href="#ConfigurationWindow">ConfigurationWindow</a></td> | |
| 41 <td>Main window class for the standalone dialog.</td> | |
| 42 </tr> | |
| 43 </table> | |
| 44 <h3>Functions</h3> | |
| 45 | |
| 46 <table> | |
| 47 <tr><td>None</td></tr> | |
| 48 </table> | |
| 49 <hr /> | |
| 50 <hr /> | |
| 51 <a NAME="ConfigurationDialog" ID="ConfigurationDialog"></a> | |
| 52 <h2>ConfigurationDialog</h2> | |
| 53 | |
| 54 <p> | |
| 55 Class for the dialog variant. | |
| 56 </p> | |
| 57 <h3>Signals</h3> | |
| 58 <dl> | |
| 59 | |
| 60 <dt>masterPasswordChanged(str, str)</dt> | |
| 61 <dd> | |
| 62 emitted after the master | |
| 63 password has been changed with the old and the new password | |
| 64 </dd> | |
| 65 <dt>preferencesChanged()</dt> | |
| 66 <dd> | |
| 67 emitted after settings have been changed | |
| 68 </dd> | |
| 69 </dl> | |
| 70 <h3>Derived from</h3> | |
| 71 QDialog | |
| 72 <h3>Class Attributes</h3> | |
| 73 | |
| 74 <table> | |
| 75 <tr><td>None</td></tr> | |
| 76 </table> | |
| 77 <h3>Class Methods</h3> | |
| 78 | |
| 79 <table> | |
| 80 <tr><td>None</td></tr> | |
| 81 </table> | |
| 82 <h3>Methods</h3> | |
| 83 | |
| 84 <table> | |
| 85 | |
| 86 <tr> | |
| 87 <td><a href="#ConfigurationDialog.__init__">ConfigurationDialog</a></td> | |
| 88 <td>Constructor</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#ConfigurationDialog.__masterPasswordChanged">__masterPasswordChanged</a></td> | |
| 92 <td>Private slot to handle the change of the master password.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#ConfigurationDialog.__preferencesChanged">__preferencesChanged</a></td> | |
| 96 <td>Private slot to handle a change of the preferences.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#ConfigurationDialog.accept">accept</a></td> | |
| 100 <td>Public method to accept the dialog.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 103 <td><a href="#ConfigurationDialog.getConfigurationPageName">getConfigurationPageName</a></td> | |
| 104 <td>Public method to get the page name of the current page.</td> | |
| 105 </tr> | |
| 106 <tr> | |
| 107 <td><a href="#ConfigurationDialog.getExpandedEntries">getExpandedEntries</a></td> | |
| 108 <td>Public method to get a list of expanded entries.</td> | |
| 109 </tr> | |
| 110 <tr> | |
| 111 <td><a href="#ConfigurationDialog.setPreferences">setPreferences</a></td> | |
| 112 <td>Public method called to store the selected values into the preferences storage.</td> | |
| 113 </tr> | |
| 114 <tr> | |
| 115 <td><a href="#ConfigurationDialog.showConfigurationPageByName">showConfigurationPageByName</a></td> | |
| 116 <td>Public slot to show a named configuration page.</td> | |
| 117 </tr> | |
| 118 </table> | |
| 119 <h3>Static Methods</h3> | |
| 120 | |
| 121 <table> | |
| 122 <tr><td>None</td></tr> | |
| 123 </table> | |
| 124 | |
| 125 <a NAME="ConfigurationDialog.__init__" ID="ConfigurationDialog.__init__"></a> | |
| 126 <h4>ConfigurationDialog (Constructor)</h4> | |
| 127 <b>ConfigurationDialog</b>(<i>parent=None, name=None, modal=False, fromEric=True, displayMode=ConfigurationMode.DEFAULTMODE, expandedEntries=None</i>) | |
| 128 | |
| 129 <p> | |
| 130 Constructor | |
| 131 </p> | |
| 132 <dl> | |
| 133 | |
| 134 <dt><i>parent</i> (QWidget)</dt> | |
| 135 <dd> | |
| 136 reference to the parent widget | |
| 137 </dd> | |
| 138 <dt><i>name</i> (str)</dt> | |
| 139 <dd> | |
| 140 name of the dialog | |
| 141 </dd> | |
| 142 <dt><i>modal</i> (bool)</dt> | |
| 143 <dd> | |
| 144 flag indicating a modal dialog | |
| 145 </dd> | |
| 146 <dt><i>fromEric</i> (bool)</dt> | |
| 147 <dd> | |
| 148 flag indicating a dialog generation from within the | |
| 149 eric IDE | |
| 150 </dd> | |
| 151 <dt><i>displayMode</i> (ConfigurationMode)</dt> | |
| 152 <dd> | |
| 153 mode of the configuration dialog | |
| 154 </dd> | |
| 155 <dt><i>expandedEntries</i> (list of str)</dt> | |
| 156 <dd> | |
| 157 list of entries to be shown expanded | |
| 158 </dd> | |
| 159 </dl> | |
| 160 <a NAME="ConfigurationDialog.__masterPasswordChanged" ID="ConfigurationDialog.__masterPasswordChanged"></a> | |
| 161 <h4>ConfigurationDialog.__masterPasswordChanged</h4> | |
| 162 <b>__masterPasswordChanged</b>(<i>oldPassword, newPassword</i>) | |
| 163 | |
| 164 <p> | |
| 165 Private slot to handle the change of the master password. | |
| 166 </p> | |
| 167 <dl> | |
| 168 | |
| 169 <dt><i>oldPassword</i></dt> | |
| 170 <dd> | |
| 171 current master password (string) | |
| 172 </dd> | |
| 173 <dt><i>newPassword</i></dt> | |
| 174 <dd> | |
| 175 new master password (string) | |
| 176 </dd> | |
| 177 </dl> | |
| 178 <a NAME="ConfigurationDialog.__preferencesChanged" ID="ConfigurationDialog.__preferencesChanged"></a> | |
| 179 <h4>ConfigurationDialog.__preferencesChanged</h4> | |
| 180 <b>__preferencesChanged</b>(<i></i>) | |
| 181 | |
| 182 <p> | |
| 183 Private slot to handle a change of the preferences. | |
| 184 </p> | |
| 185 <a NAME="ConfigurationDialog.accept" ID="ConfigurationDialog.accept"></a> | |
| 186 <h4>ConfigurationDialog.accept</h4> | |
| 187 <b>accept</b>(<i></i>) | |
| 188 | |
| 189 <p> | |
| 190 Public method to accept the dialog. | |
| 191 </p> | |
| 192 <a NAME="ConfigurationDialog.getConfigurationPageName" ID="ConfigurationDialog.getConfigurationPageName"></a> | |
| 193 <h4>ConfigurationDialog.getConfigurationPageName</h4> | |
| 194 <b>getConfigurationPageName</b>(<i></i>) | |
| 195 | |
| 196 <p> | |
| 197 Public method to get the page name of the current page. | |
| 198 </p> | |
| 199 <dl> | |
| 200 <dt>Return:</dt> | |
| 201 <dd> | |
| 202 page name of the current page (string) | |
| 203 </dd> | |
| 204 </dl> | |
| 205 <a NAME="ConfigurationDialog.getExpandedEntries" ID="ConfigurationDialog.getExpandedEntries"></a> | |
| 206 <h4>ConfigurationDialog.getExpandedEntries</h4> | |
| 207 <b>getExpandedEntries</b>(<i></i>) | |
| 208 | |
| 209 <p> | |
| 210 Public method to get a list of expanded entries. | |
| 211 </p> | |
| 212 <dl> | |
| 213 <dt>Return:</dt> | |
| 214 <dd> | |
| 215 list of expanded entries (list of string) | |
| 216 </dd> | |
| 217 </dl> | |
| 218 <a NAME="ConfigurationDialog.setPreferences" ID="ConfigurationDialog.setPreferences"></a> | |
| 219 <h4>ConfigurationDialog.setPreferences</h4> | |
| 220 <b>setPreferences</b>(<i></i>) | |
| 221 | |
| 222 <p> | |
| 223 Public method called to store the selected values into the preferences | |
| 224 storage. | |
| 225 </p> | |
| 226 <a NAME="ConfigurationDialog.showConfigurationPageByName" ID="ConfigurationDialog.showConfigurationPageByName"></a> | |
| 227 <h4>ConfigurationDialog.showConfigurationPageByName</h4> | |
| 228 <b>showConfigurationPageByName</b>(<i>pageName</i>) | |
| 229 | |
| 230 <p> | |
| 231 Public slot to show a named configuration page. | |
| 232 </p> | |
| 233 <dl> | |
| 234 | |
| 235 <dt><i>pageName</i></dt> | |
| 236 <dd> | |
| 237 name of the configuration page to show (string) | |
| 238 </dd> | |
| 239 </dl> | |
| 240 <div align="right"><a href="#top">Up</a></div> | |
| 241 <hr /> | |
| 242 <hr /> | |
| 243 <a NAME="ConfigurationMode" ID="ConfigurationMode"></a> | |
| 244 <h2>ConfigurationMode</h2> | |
| 245 | |
| 246 <p> | |
| 247 Class defining the various modes of the configuration widget. | |
| 248 </p> | |
| 249 <h3>Derived from</h3> | |
| 250 enum.Enum | |
| 251 <h3>Class Attributes</h3> | |
| 252 | |
| 253 <table> | |
| 254 <tr><td>DEFAULTMODE</td></tr><tr><td>EDITORMODE</td></tr><tr><td>HEXEDITORMODE</td></tr><tr><td>TRAYSTARTERMODE</td></tr><tr><td>WEBBROWSERMODE</td></tr> | |
| 255 </table> | |
| 256 <h3>Class Methods</h3> | |
| 257 | |
| 258 <table> | |
| 259 <tr><td>None</td></tr> | |
| 260 </table> | |
| 261 <h3>Methods</h3> | |
| 262 | |
| 263 <table> | |
| 264 <tr><td>None</td></tr> | |
| 265 </table> | |
| 266 <h3>Static Methods</h3> | |
| 267 | |
| 268 <table> | |
| 269 <tr><td>None</td></tr> | |
| 270 </table> | |
| 271 | |
| 272 <div align="right"><a href="#top">Up</a></div> | |
| 273 <hr /> | |
| 274 <hr /> | |
| 275 <a NAME="ConfigurationPageItem" ID="ConfigurationPageItem"></a> | |
| 276 <h2>ConfigurationPageItem</h2> | |
| 277 | |
| 278 <p> | |
| 279 Class implementing a QTreeWidgetItem holding the configuration page data. | |
| 280 </p> | |
| 281 <h3>Derived from</h3> | |
| 282 QTreeWidgetItem | |
| 283 <h3>Class Attributes</h3> | |
| 284 | |
| 285 <table> | |
| 286 <tr><td>None</td></tr> | |
| 287 </table> | |
| 288 <h3>Class Methods</h3> | |
| 289 | |
| 290 <table> | |
| 291 <tr><td>None</td></tr> | |
| 292 </table> | |
| 293 <h3>Methods</h3> | |
| 294 | |
| 295 <table> | |
| 296 | |
| 297 <tr> | |
| 298 <td><a href="#ConfigurationPageItem.__init__">ConfigurationPageItem</a></td> | |
| 299 <td>Constructor</td> | |
| 300 </tr> | |
| 301 <tr> | |
| 302 <td><a href="#ConfigurationPageItem.getPageName">getPageName</a></td> | |
| 303 <td>Public method to get the name of the associated configuration page.</td> | |
| 304 </tr> | |
| 305 </table> | |
| 306 <h3>Static Methods</h3> | |
| 307 | |
| 308 <table> | |
| 309 <tr><td>None</td></tr> | |
| 310 </table> | |
| 311 | |
| 312 <a NAME="ConfigurationPageItem.__init__" ID="ConfigurationPageItem.__init__"></a> | |
| 313 <h4>ConfigurationPageItem (Constructor)</h4> | |
| 314 <b>ConfigurationPageItem</b>(<i>parent, text, pageName, iconFile</i>) | |
| 315 | |
| 316 <p> | |
| 317 Constructor | |
| 318 </p> | |
| 319 <dl> | |
| 320 | |
| 321 <dt><i>parent</i></dt> | |
| 322 <dd> | |
| 323 parent widget of the item (QTreeWidget or | |
| 324 QTreeWidgetItem) | |
| 325 </dd> | |
| 326 <dt><i>text</i></dt> | |
| 327 <dd> | |
| 328 text to be displayed (string) | |
| 329 </dd> | |
| 330 <dt><i>pageName</i></dt> | |
| 331 <dd> | |
| 332 name of the configuration page (string) | |
| 333 </dd> | |
| 334 <dt><i>iconFile</i></dt> | |
| 335 <dd> | |
| 336 file name of the icon to be shown (string) | |
| 337 </dd> | |
| 338 </dl> | |
| 339 <a NAME="ConfigurationPageItem.getPageName" ID="ConfigurationPageItem.getPageName"></a> | |
| 340 <h4>ConfigurationPageItem.getPageName</h4> | |
| 341 <b>getPageName</b>(<i></i>) | |
| 342 | |
| 343 <p> | |
| 344 Public method to get the name of the associated configuration page. | |
| 345 </p> | |
| 346 <dl> | |
| 347 <dt>Return:</dt> | |
| 348 <dd> | |
| 349 name of the configuration page (string) | |
| 350 </dd> | |
| 351 </dl> | |
| 352 <div align="right"><a href="#top">Up</a></div> | |
| 353 <hr /> | |
| 354 <hr /> | |
| 355 <a NAME="ConfigurationWidget" ID="ConfigurationWidget"></a> | |
| 356 <h2>ConfigurationWidget</h2> | |
| 357 | |
| 358 <p> | |
| 359 Class implementing a dialog for the configuration of eric. | |
| 360 </p> | |
| 361 <h3>Signals</h3> | |
| 362 <dl> | |
| 363 | |
| 364 <dt>accepted()</dt> | |
| 365 <dd> | |
| 366 emitted to indicate acceptance of the changes | |
| 367 </dd> | |
| 368 <dt>masterPasswordChanged(str, str)</dt> | |
| 369 <dd> | |
| 370 emitted after the master | |
| 371 password has been changed with the old and the new password | |
| 372 </dd> | |
| 373 <dt>preferencesChanged()</dt> | |
| 374 <dd> | |
| 375 emitted after settings have been changed | |
| 376 </dd> | |
| 377 <dt>rejected()</dt> | |
| 378 <dd> | |
| 379 emitted to indicate rejection of the changes | |
| 380 </dd> | |
| 381 </dl> | |
| 382 <h3>Derived from</h3> | |
| 383 QWidget | |
| 384 <h3>Class Attributes</h3> | |
| 385 | |
| 386 <table> | |
| 387 <tr><td>None</td></tr> | |
| 388 </table> | |
| 389 <h3>Class Methods</h3> | |
| 390 | |
| 391 <table> | |
| 392 <tr><td>None</td></tr> | |
| 393 </table> | |
| 394 <h3>Methods</h3> | |
| 395 | |
| 396 <table> | |
| 397 | |
| 398 <tr> | |
| 399 <td><a href="#ConfigurationWidget.__init__">ConfigurationWidget</a></td> | |
| 400 <td>Constructor</td> | |
| 401 </tr> | |
| 402 <tr> | |
| 403 <td><a href="#ConfigurationWidget.__importConfigurationPage">__importConfigurationPage</a></td> | |
| 404 <td>Private method to import a configuration page module.</td> | |
| 405 </tr> | |
| 406 <tr> | |
| 407 <td><a href="#ConfigurationWidget.__initLexers">__initLexers</a></td> | |
| 408 <td>Private method to initialize the dictionary of preferences lexers.</td> | |
| 409 </tr> | |
| 410 <tr> | |
| 411 <td><a href="#ConfigurationWidget.__initPage">__initPage</a></td> | |
| 412 <td>Private method to initialize a configuration page.</td> | |
| 413 </tr> | |
| 414 <tr> | |
| 415 <td><a href="#ConfigurationWidget.__resizeConfigStack">__resizeConfigStack</a></td> | |
| 416 <td>Private method to resize the stack of configuration pages.</td> | |
| 417 </tr> | |
| 418 <tr> | |
| 419 <td><a href="#ConfigurationWidget.__searchChildItems">__searchChildItems</a></td> | |
| 420 <td>Private method to enable child items based on a search string.</td> | |
| 421 </tr> | |
| 422 <tr> | |
| 423 <td><a href="#ConfigurationWidget.__searchTextChanged">__searchTextChanged</a></td> | |
| 424 <td>Private slot to handle a change of the search text.</td> | |
| 425 </tr> | |
| 426 <tr> | |
| 427 <td><a href="#ConfigurationWidget.__setupUi">__setupUi</a></td> | |
| 428 <td>Private method to perform the general setup of the configuration widget.</td> | |
| 429 </tr> | |
| 430 <tr> | |
| 431 <td><a href="#ConfigurationWidget.__showConfigurationPage">__showConfigurationPage</a></td> | |
| 432 <td>Private slot to show a selected configuration page.</td> | |
| 433 </tr> | |
| 434 <tr> | |
| 435 <td><a href="#ConfigurationWidget.accept">accept</a></td> | |
| 436 <td>Public slot to accept the buttonBox accept signal.</td> | |
| 437 </tr> | |
| 438 <tr> | |
| 439 <td><a href="#ConfigurationWidget.calledFromEric">calledFromEric</a></td> | |
| 440 <td>Public method to check, if invoked from within eric.</td> | |
| 441 </tr> | |
| 442 <tr> | |
| 443 <td><a href="#ConfigurationWidget.getConfigurationPageName">getConfigurationPageName</a></td> | |
| 444 <td>Public method to get the page name of the current page.</td> | |
| 445 </tr> | |
| 446 <tr> | |
| 447 <td><a href="#ConfigurationWidget.getExpandedEntries">getExpandedEntries</a></td> | |
| 448 <td>Public method to get a list of expanded entries.</td> | |
| 449 </tr> | |
| 450 <tr> | |
| 451 <td><a href="#ConfigurationWidget.getLexers">getLexers</a></td> | |
| 452 <td>Public method to get a reference to the lexers dictionary.</td> | |
| 453 </tr> | |
| 454 <tr> | |
| 455 <td><a href="#ConfigurationWidget.getPage">getPage</a></td> | |
| 456 <td>Public method to get a reference to the named page.</td> | |
| 457 </tr> | |
| 458 <tr> | |
| 459 <td><a href="#ConfigurationWidget.isUsingWebEngine">isUsingWebEngine</a></td> | |
| 460 <td>Public method to get an indication, if QtWebEngine is being used.</td> | |
| 461 </tr> | |
| 462 <tr> | |
| 463 <td><a href="#ConfigurationWidget.on_applyButton_clicked">on_applyButton_clicked</a></td> | |
| 464 <td>Private slot called to apply the settings of the current page.</td> | |
| 465 </tr> | |
| 466 <tr> | |
| 467 <td><a href="#ConfigurationWidget.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 468 <td>Private slot called by a button of the button box clicked.</td> | |
| 469 </tr> | |
| 470 <tr> | |
| 471 <td><a href="#ConfigurationWidget.on_configList_itemCollapsed">on_configList_itemCollapsed</a></td> | |
| 472 <td>Private slot handling a list entry being collapsed.</td> | |
| 473 </tr> | |
| 474 <tr> | |
| 475 <td><a href="#ConfigurationWidget.on_configList_itemExpanded">on_configList_itemExpanded</a></td> | |
| 476 <td>Private slot handling a list entry being expanded.</td> | |
| 477 </tr> | |
| 478 <tr> | |
| 479 <td><a href="#ConfigurationWidget.on_resetButton_clicked">on_resetButton_clicked</a></td> | |
| 480 <td>Private slot called to reset the settings of the current page.</td> | |
| 481 </tr> | |
| 482 <tr> | |
| 483 <td><a href="#ConfigurationWidget.resizeEvent">resizeEvent</a></td> | |
| 484 <td>Protected method to handle the resizing of the widget.</td> | |
| 485 </tr> | |
| 486 <tr> | |
| 487 <td><a href="#ConfigurationWidget.setPreferences">setPreferences</a></td> | |
| 488 <td>Public method called to store the selected values into the preferences storage.</td> | |
| 489 </tr> | |
| 490 <tr> | |
| 491 <td><a href="#ConfigurationWidget.showConfigurationPageByName">showConfigurationPageByName</a></td> | |
| 492 <td>Public slot to show a named configuration page.</td> | |
| 493 </tr> | |
| 494 </table> | |
| 495 <h3>Static Methods</h3> | |
| 496 | |
| 497 <table> | |
| 498 <tr><td>None</td></tr> | |
| 499 </table> | |
| 500 | |
| 501 <a NAME="ConfigurationWidget.__init__" ID="ConfigurationWidget.__init__"></a> | |
| 502 <h4>ConfigurationWidget (Constructor)</h4> | |
| 503 <b>ConfigurationWidget</b>(<i>parent=None, fromEric=True, displayMode=ConfigurationMode.DEFAULTMODE, expandedEntries=None</i>) | |
| 504 | |
| 505 <p> | |
| 506 Constructor | |
| 507 </p> | |
| 508 <dl> | |
| 509 | |
| 510 <dt><i>parent</i> (QWidget)</dt> | |
| 511 <dd> | |
| 512 reference to the parent widget | |
| 513 </dd> | |
| 514 <dt><i>fromEric</i> (bool)</dt> | |
| 515 <dd> | |
| 516 flag indicating a dialog generation from within the | |
| 517 eric IDE | |
| 518 </dd> | |
| 519 <dt><i>displayMode</i> (ConfigurationMode)</dt> | |
| 520 <dd> | |
| 521 mode of the configuration dialog | |
| 522 </dd> | |
| 523 <dt><i>expandedEntries</i> (list of str)</dt> | |
| 524 <dd> | |
| 525 list of entries to be shown expanded | |
| 526 </dd> | |
| 527 </dl> | |
| 528 <a NAME="ConfigurationWidget.__importConfigurationPage" ID="ConfigurationWidget.__importConfigurationPage"></a> | |
| 529 <h4>ConfigurationWidget.__importConfigurationPage</h4> | |
| 530 <b>__importConfigurationPage</b>(<i>name</i>) | |
| 531 | |
| 532 <p> | |
| 533 Private method to import a configuration page module. | |
| 534 </p> | |
| 535 <dl> | |
| 536 | |
| 537 <dt><i>name</i></dt> | |
| 538 <dd> | |
| 539 name of the configuration page module (string) | |
| 540 </dd> | |
| 541 </dl> | |
| 542 <dl> | |
| 543 <dt>Return:</dt> | |
| 544 <dd> | |
| 545 reference to the configuration page module | |
| 546 </dd> | |
| 547 </dl> | |
| 548 <a NAME="ConfigurationWidget.__initLexers" ID="ConfigurationWidget.__initLexers"></a> | |
| 549 <h4>ConfigurationWidget.__initLexers</h4> | |
| 550 <b>__initLexers</b>(<i></i>) | |
| 551 | |
| 552 <p> | |
| 553 Private method to initialize the dictionary of preferences lexers. | |
| 554 </p> | |
| 555 <a NAME="ConfigurationWidget.__initPage" ID="ConfigurationWidget.__initPage"></a> | |
| 556 <h4>ConfigurationWidget.__initPage</h4> | |
| 557 <b>__initPage</b>(<i>pageData</i>) | |
| 558 | |
| 559 <p> | |
| 560 Private method to initialize a configuration page. | |
| 561 </p> | |
| 562 <dl> | |
| 563 | |
| 564 <dt><i>pageData</i></dt> | |
| 565 <dd> | |
| 566 data structure for the page to initialize | |
| 567 </dd> | |
| 568 </dl> | |
| 569 <dl> | |
| 570 <dt>Return:</dt> | |
| 571 <dd> | |
| 572 reference to the initialized page | |
| 573 </dd> | |
| 574 </dl> | |
| 575 <a NAME="ConfigurationWidget.__resizeConfigStack" ID="ConfigurationWidget.__resizeConfigStack"></a> | |
| 576 <h4>ConfigurationWidget.__resizeConfigStack</h4> | |
| 577 <b>__resizeConfigStack</b>(<i></i>) | |
| 578 | |
| 579 <p> | |
| 580 Private method to resize the stack of configuration pages. | |
| 581 </p> | |
| 582 <a NAME="ConfigurationWidget.__searchChildItems" ID="ConfigurationWidget.__searchChildItems"></a> | |
| 583 <h4>ConfigurationWidget.__searchChildItems</h4> | |
| 584 <b>__searchChildItems</b>(<i>parent, text</i>) | |
| 585 | |
| 586 <p> | |
| 587 Private method to enable child items based on a search string. | |
| 588 </p> | |
| 589 <dl> | |
| 590 | |
| 591 <dt><i>parent</i></dt> | |
| 592 <dd> | |
| 593 reference to the parent item (QTreeWidgetItem) | |
| 594 </dd> | |
| 595 <dt><i>text</i></dt> | |
| 596 <dd> | |
| 597 text to search for (string) | |
| 598 </dd> | |
| 599 </dl> | |
| 600 <dl> | |
| 601 <dt>Return:</dt> | |
| 602 <dd> | |
| 603 flag indicating an enabled child item (boolean) | |
| 604 </dd> | |
| 605 </dl> | |
| 606 <a NAME="ConfigurationWidget.__searchTextChanged" ID="ConfigurationWidget.__searchTextChanged"></a> | |
| 607 <h4>ConfigurationWidget.__searchTextChanged</h4> | |
| 608 <b>__searchTextChanged</b>(<i>text</i>) | |
| 609 | |
| 610 <p> | |
| 611 Private slot to handle a change of the search text. | |
| 612 </p> | |
| 613 <dl> | |
| 614 | |
| 615 <dt><i>text</i></dt> | |
| 616 <dd> | |
| 617 text to search for (string) | |
| 618 </dd> | |
| 619 </dl> | |
| 620 <a NAME="ConfigurationWidget.__setupUi" ID="ConfigurationWidget.__setupUi"></a> | |
| 621 <h4>ConfigurationWidget.__setupUi</h4> | |
| 622 <b>__setupUi</b>(<i></i>) | |
| 623 | |
| 624 <p> | |
| 625 Private method to perform the general setup of the configuration | |
| 626 widget. | |
| 627 </p> | |
| 628 <a NAME="ConfigurationWidget.__showConfigurationPage" ID="ConfigurationWidget.__showConfigurationPage"></a> | |
| 629 <h4>ConfigurationWidget.__showConfigurationPage</h4> | |
| 630 <b>__showConfigurationPage</b>(<i>itm, column</i>) | |
| 631 | |
| 632 <p> | |
| 633 Private slot to show a selected configuration page. | |
| 634 </p> | |
| 635 <dl> | |
| 636 | |
| 637 <dt><i>itm</i></dt> | |
| 638 <dd> | |
| 639 reference to the selected item (QTreeWidgetItem) | |
| 640 </dd> | |
| 641 <dt><i>column</i></dt> | |
| 642 <dd> | |
| 643 column that was selected (integer) (ignored) | |
| 644 </dd> | |
| 645 </dl> | |
| 646 <a NAME="ConfigurationWidget.accept" ID="ConfigurationWidget.accept"></a> | |
| 647 <h4>ConfigurationWidget.accept</h4> | |
| 648 <b>accept</b>(<i></i>) | |
| 649 | |
| 650 <p> | |
| 651 Public slot to accept the buttonBox accept signal. | |
| 652 </p> | |
| 653 <a NAME="ConfigurationWidget.calledFromEric" ID="ConfigurationWidget.calledFromEric"></a> | |
| 654 <h4>ConfigurationWidget.calledFromEric</h4> | |
| 655 <b>calledFromEric</b>(<i></i>) | |
| 656 | |
| 657 <p> | |
| 658 Public method to check, if invoked from within eric. | |
| 659 </p> | |
| 660 <dl> | |
| 661 <dt>Return:</dt> | |
| 662 <dd> | |
| 663 flag indicating invocation from within eric (boolean) | |
| 664 </dd> | |
| 665 </dl> | |
| 666 <a NAME="ConfigurationWidget.getConfigurationPageName" ID="ConfigurationWidget.getConfigurationPageName"></a> | |
| 667 <h4>ConfigurationWidget.getConfigurationPageName</h4> | |
| 668 <b>getConfigurationPageName</b>(<i></i>) | |
| 669 | |
| 670 <p> | |
| 671 Public method to get the page name of the current page. | |
| 672 </p> | |
| 673 <dl> | |
| 674 <dt>Return:</dt> | |
| 675 <dd> | |
| 676 page name of the current page (string) | |
| 677 </dd> | |
| 678 </dl> | |
| 679 <a NAME="ConfigurationWidget.getExpandedEntries" ID="ConfigurationWidget.getExpandedEntries"></a> | |
| 680 <h4>ConfigurationWidget.getExpandedEntries</h4> | |
| 681 <b>getExpandedEntries</b>(<i></i>) | |
| 682 | |
| 683 <p> | |
| 684 Public method to get a list of expanded entries. | |
| 685 </p> | |
| 686 <dl> | |
| 687 <dt>Return:</dt> | |
| 688 <dd> | |
| 689 list of expanded entries (list of string) | |
| 690 </dd> | |
| 691 </dl> | |
| 692 <a NAME="ConfigurationWidget.getLexers" ID="ConfigurationWidget.getLexers"></a> | |
| 693 <h4>ConfigurationWidget.getLexers</h4> | |
| 694 <b>getLexers</b>(<i></i>) | |
| 695 | |
| 696 <p> | |
| 697 Public method to get a reference to the lexers dictionary. | |
| 698 </p> | |
| 699 <dl> | |
| 700 <dt>Return:</dt> | |
| 701 <dd> | |
| 702 reference to the lexers dictionary | |
| 703 </dd> | |
| 704 </dl> | |
| 705 <a NAME="ConfigurationWidget.getPage" ID="ConfigurationWidget.getPage"></a> | |
| 706 <h4>ConfigurationWidget.getPage</h4> | |
| 707 <b>getPage</b>(<i>pageName</i>) | |
| 708 | |
| 709 <p> | |
| 710 Public method to get a reference to the named page. | |
| 711 </p> | |
| 712 <dl> | |
| 713 | |
| 714 <dt><i>pageName</i></dt> | |
| 715 <dd> | |
| 716 name of the configuration page (string) | |
| 717 </dd> | |
| 718 </dl> | |
| 719 <dl> | |
| 720 <dt>Return:</dt> | |
| 721 <dd> | |
| 722 reference to the page or None, indicating page was | |
| 723 not loaded yet | |
| 724 </dd> | |
| 725 </dl> | |
| 726 <a NAME="ConfigurationWidget.isUsingWebEngine" ID="ConfigurationWidget.isUsingWebEngine"></a> | |
| 727 <h4>ConfigurationWidget.isUsingWebEngine</h4> | |
| 728 <b>isUsingWebEngine</b>(<i></i>) | |
| 729 | |
| 730 <p> | |
| 731 Public method to get an indication, if QtWebEngine is being used. | |
| 732 </p> | |
| 733 <dl> | |
| 734 <dt>Return:</dt> | |
| 735 <dd> | |
| 736 flag indicating the use of QtWebEngine | |
| 737 </dd> | |
| 738 </dl> | |
| 739 <dl> | |
| 740 <dt>Return Type:</dt> | |
| 741 <dd> | |
| 742 bool | |
| 743 </dd> | |
| 744 </dl> | |
| 745 <a NAME="ConfigurationWidget.on_applyButton_clicked" ID="ConfigurationWidget.on_applyButton_clicked"></a> | |
| 746 <h4>ConfigurationWidget.on_applyButton_clicked</h4> | |
| 747 <b>on_applyButton_clicked</b>(<i></i>) | |
| 748 | |
| 749 <p> | |
| 750 Private slot called to apply the settings of the current page. | |
| 751 </p> | |
| 752 <a NAME="ConfigurationWidget.on_buttonBox_clicked" ID="ConfigurationWidget.on_buttonBox_clicked"></a> | |
| 753 <h4>ConfigurationWidget.on_buttonBox_clicked</h4> | |
| 754 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 755 | |
| 756 <p> | |
| 757 Private slot called by a button of the button box clicked. | |
| 758 </p> | |
| 759 <dl> | |
| 760 | |
| 761 <dt><i>button</i></dt> | |
| 762 <dd> | |
| 763 button that was clicked (QAbstractButton) | |
| 764 </dd> | |
| 765 </dl> | |
| 766 <a NAME="ConfigurationWidget.on_configList_itemCollapsed" ID="ConfigurationWidget.on_configList_itemCollapsed"></a> | |
| 767 <h4>ConfigurationWidget.on_configList_itemCollapsed</h4> | |
| 768 <b>on_configList_itemCollapsed</b>(<i>item</i>) | |
| 769 | |
| 770 <p> | |
| 771 Private slot handling a list entry being collapsed. | |
| 772 </p> | |
| 773 <dl> | |
| 774 | |
| 775 <dt><i>item</i></dt> | |
| 776 <dd> | |
| 777 reference to the collapsed item (QTreeWidgetItem) | |
| 778 </dd> | |
| 779 </dl> | |
| 780 <a NAME="ConfigurationWidget.on_configList_itemExpanded" ID="ConfigurationWidget.on_configList_itemExpanded"></a> | |
| 781 <h4>ConfigurationWidget.on_configList_itemExpanded</h4> | |
| 782 <b>on_configList_itemExpanded</b>(<i>item</i>) | |
| 783 | |
| 784 <p> | |
| 785 Private slot handling a list entry being expanded. | |
| 786 </p> | |
| 787 <dl> | |
| 788 | |
| 789 <dt><i>item</i></dt> | |
| 790 <dd> | |
| 791 reference to the expanded item (QTreeWidgetItem) | |
| 792 </dd> | |
| 793 </dl> | |
| 794 <a NAME="ConfigurationWidget.on_resetButton_clicked" ID="ConfigurationWidget.on_resetButton_clicked"></a> | |
| 795 <h4>ConfigurationWidget.on_resetButton_clicked</h4> | |
| 796 <b>on_resetButton_clicked</b>(<i></i>) | |
| 797 | |
| 798 <p> | |
| 799 Private slot called to reset the settings of the current page. | |
| 800 </p> | |
| 801 <a NAME="ConfigurationWidget.resizeEvent" ID="ConfigurationWidget.resizeEvent"></a> | |
| 802 <h4>ConfigurationWidget.resizeEvent</h4> | |
| 803 <b>resizeEvent</b>(<i>evt</i>) | |
| 804 | |
| 805 <p> | |
| 806 Protected method to handle the resizing of the widget. | |
| 807 </p> | |
| 808 <dl> | |
| 809 | |
| 810 <dt><i>evt</i> (QResizeEvent)</dt> | |
| 811 <dd> | |
| 812 reference to the event object | |
| 813 </dd> | |
| 814 </dl> | |
| 815 <a NAME="ConfigurationWidget.setPreferences" ID="ConfigurationWidget.setPreferences"></a> | |
| 816 <h4>ConfigurationWidget.setPreferences</h4> | |
| 817 <b>setPreferences</b>(<i></i>) | |
| 818 | |
| 819 <p> | |
| 820 Public method called to store the selected values into the preferences | |
| 821 storage. | |
| 822 </p> | |
| 823 <a NAME="ConfigurationWidget.showConfigurationPageByName" ID="ConfigurationWidget.showConfigurationPageByName"></a> | |
| 824 <h4>ConfigurationWidget.showConfigurationPageByName</h4> | |
| 825 <b>showConfigurationPageByName</b>(<i>pageName, setCurrent=True</i>) | |
| 826 | |
| 827 <p> | |
| 828 Public slot to show a named configuration page. | |
| 829 </p> | |
| 830 <dl> | |
| 831 | |
| 832 <dt><i>pageName</i></dt> | |
| 833 <dd> | |
| 834 name of the configuration page to show (string) | |
| 835 </dd> | |
| 836 <dt><i>setCurrent</i></dt> | |
| 837 <dd> | |
| 838 flag indicating to set the current item (boolean) | |
| 839 </dd> | |
| 840 </dl> | |
| 841 <div align="right"><a href="#top">Up</a></div> | |
| 842 <hr /> | |
| 843 <hr /> | |
| 844 <a NAME="ConfigurationWindow" ID="ConfigurationWindow"></a> | |
| 845 <h2>ConfigurationWindow</h2> | |
| 846 | |
| 847 <p> | |
| 848 Main window class for the standalone dialog. | |
| 849 </p> | |
| 850 <h3>Derived from</h3> | |
| 851 EricMainWindow | |
| 852 <h3>Class Attributes</h3> | |
| 853 | |
| 854 <table> | |
| 855 <tr><td>None</td></tr> | |
| 856 </table> | |
| 857 <h3>Class Methods</h3> | |
| 858 | |
| 859 <table> | |
| 860 <tr><td>None</td></tr> | |
| 861 </table> | |
| 862 <h3>Methods</h3> | |
| 863 | |
| 864 <table> | |
| 865 | |
| 866 <tr> | |
| 867 <td><a href="#ConfigurationWindow.__init__">ConfigurationWindow</a></td> | |
| 868 <td>Constructor</td> | |
| 869 </tr> | |
| 870 <tr> | |
| 871 <td><a href="#ConfigurationWindow.accept">accept</a></td> | |
| 872 <td>Public slot called by the Ok button.</td> | |
| 873 </tr> | |
| 874 <tr> | |
| 875 <td><a href="#ConfigurationWindow.showConfigurationPageByName">showConfigurationPageByName</a></td> | |
| 876 <td>Public slot to show a named configuration page.</td> | |
| 877 </tr> | |
| 878 </table> | |
| 879 <h3>Static Methods</h3> | |
| 880 | |
| 881 <table> | |
| 882 <tr><td>None</td></tr> | |
| 883 </table> | |
| 884 | |
| 885 <a NAME="ConfigurationWindow.__init__" ID="ConfigurationWindow.__init__"></a> | |
| 886 <h4>ConfigurationWindow (Constructor)</h4> | |
| 887 <b>ConfigurationWindow</b>(<i>parent=None</i>) | |
| 888 | |
| 889 <p> | |
| 890 Constructor | |
| 891 </p> | |
| 892 <dl> | |
| 893 | |
| 894 <dt><i>parent</i></dt> | |
| 895 <dd> | |
| 896 reference to the parent widget (QWidget) | |
| 897 </dd> | |
| 898 </dl> | |
| 899 <a NAME="ConfigurationWindow.accept" ID="ConfigurationWindow.accept"></a> | |
| 900 <h4>ConfigurationWindow.accept</h4> | |
| 901 <b>accept</b>(<i></i>) | |
| 902 | |
| 903 <p> | |
| 904 Public slot called by the Ok button. | |
| 905 </p> | |
| 906 <a NAME="ConfigurationWindow.showConfigurationPageByName" ID="ConfigurationWindow.showConfigurationPageByName"></a> | |
| 907 <h4>ConfigurationWindow.showConfigurationPageByName</h4> | |
| 908 <b>showConfigurationPageByName</b>(<i>pageName</i>) | |
| 909 | |
| 910 <p> | |
| 911 Public slot to show a named configuration page. | |
| 912 </p> | |
| 913 <dl> | |
| 914 | |
| 915 <dt><i>pageName</i></dt> | |
| 916 <dd> | |
| 917 name of the configuration page to show (string) | |
| 918 </dd> | |
| 919 </dl> | |
| 920 <div align="right"><a href="#top">Up</a></div> | |
| 921 <hr /> | |
| 922 </body></html> |
