Documentation/Source/eric6.Preferences.ConfigurationDialog.html

changeset 4216
bca19a75be32
parent 4213
0bbb56fc9e65
child 4666
bc52ef526e11
equal deleted inserted replaced
4214:b8fd47f8b707 4216:bca19a75be32
89 <td>Public method to accept the dialog.</td> 89 <td>Public method to accept the dialog.</td>
90 </tr><tr> 90 </tr><tr>
91 <td><a href="#ConfigurationDialog.getConfigurationPageName">getConfigurationPageName</a></td> 91 <td><a href="#ConfigurationDialog.getConfigurationPageName">getConfigurationPageName</a></td>
92 <td>Public method to get the page name of the current page.</td> 92 <td>Public method to get the page name of the current page.</td>
93 </tr><tr> 93 </tr><tr>
94 <td><a href="#ConfigurationDialog.getExpandedEntries">getExpandedEntries</a></td>
95 <td>Public method to get a list of expanded entries.</td>
96 </tr><tr>
94 <td><a href="#ConfigurationDialog.setPreferences">setPreferences</a></td> 97 <td><a href="#ConfigurationDialog.setPreferences">setPreferences</a></td>
95 <td>Public method called to store the selected values into the preferences storage.</td> 98 <td>Public method called to store the selected values into the preferences storage.</td>
96 </tr><tr> 99 </tr><tr>
97 <td><a href="#ConfigurationDialog.showConfigurationPageByName">showConfigurationPageByName</a></td> 100 <td><a href="#ConfigurationDialog.showConfigurationPageByName">showConfigurationPageByName</a></td>
98 <td>Public slot to show a named configuration page.</td> 101 <td>Public slot to show a named configuration page.</td>
102 <table> 105 <table>
103 <tr><td>None</td></tr> 106 <tr><td>None</td></tr>
104 </table> 107 </table>
105 <a NAME="ConfigurationDialog.__init__" ID="ConfigurationDialog.__init__"></a> 108 <a NAME="ConfigurationDialog.__init__" ID="ConfigurationDialog.__init__"></a>
106 <h4>ConfigurationDialog (Constructor)</h4> 109 <h4>ConfigurationDialog (Constructor)</h4>
107 <b>ConfigurationDialog</b>(<i>parent=None, name=None, modal=False, fromEric=True, displayMode=ConfigurationWidget.DefaultMode</i>) 110 <b>ConfigurationDialog</b>(<i>parent=None, name=None, modal=False, fromEric=True, displayMode=ConfigurationWidget.DefaultMode, expandedEntries=[]</i>)
108 <p> 111 <p>
109 Constructor 112 Constructor
110 </p><dl> 113 </p><dl>
111 <dt><i>parent</i></dt> 114 <dt><i>parent</i></dt>
112 <dd> 115 <dd>
123 eric6 ide (boolean) 126 eric6 ide (boolean)
124 </dd><dt><i>displayMode=</i></dt> 127 </dd><dt><i>displayMode=</i></dt>
125 <dd> 128 <dd>
126 mode of the configuration dialog 129 mode of the configuration dialog
127 (DefaultMode, HelpBrowserMode, TrayStarterMode) 130 (DefaultMode, HelpBrowserMode, TrayStarterMode)
131 </dd><dt><i>expandedEntries=</i></dt>
132 <dd>
133 list of entries to be shown expanded
134 (list of strings)
128 </dd> 135 </dd>
129 </dl><a NAME="ConfigurationDialog.__masterPasswordChanged" ID="ConfigurationDialog.__masterPasswordChanged"></a> 136 </dl><a NAME="ConfigurationDialog.__masterPasswordChanged" ID="ConfigurationDialog.__masterPasswordChanged"></a>
130 <h4>ConfigurationDialog.__masterPasswordChanged</h4> 137 <h4>ConfigurationDialog.__masterPasswordChanged</h4>
131 <b>__masterPasswordChanged</b>(<i>oldPassword, newPassword</i>) 138 <b>__masterPasswordChanged</b>(<i>oldPassword, newPassword</i>)
132 <p> 139 <p>
156 Public method to get the page name of the current page. 163 Public method to get the page name of the current page.
157 </p><dl> 164 </p><dl>
158 <dt>Returns:</dt> 165 <dt>Returns:</dt>
159 <dd> 166 <dd>
160 page name of the current page (string) 167 page name of the current page (string)
168 </dd>
169 </dl><a NAME="ConfigurationDialog.getExpandedEntries" ID="ConfigurationDialog.getExpandedEntries"></a>
170 <h4>ConfigurationDialog.getExpandedEntries</h4>
171 <b>getExpandedEntries</b>(<i></i>)
172 <p>
173 Public method to get a list of expanded entries.
174 </p><dl>
175 <dt>Returns:</dt>
176 <dd>
177 list of expanded entries (list of string)
161 </dd> 178 </dd>
162 </dl><a NAME="ConfigurationDialog.setPreferences" ID="ConfigurationDialog.setPreferences"></a> 179 </dl><a NAME="ConfigurationDialog.setPreferences" ID="ConfigurationDialog.setPreferences"></a>
163 <h4>ConfigurationDialog.setPreferences</h4> 180 <h4>ConfigurationDialog.setPreferences</h4>
164 <b>setPreferences</b>(<i></i>) 181 <b>setPreferences</b>(<i></i>)
165 <p> 182 <p>
305 <td>Public method to check, if invoked from within eric.</td> 322 <td>Public method to check, if invoked from within eric.</td>
306 </tr><tr> 323 </tr><tr>
307 <td><a href="#ConfigurationWidget.getConfigurationPageName">getConfigurationPageName</a></td> 324 <td><a href="#ConfigurationWidget.getConfigurationPageName">getConfigurationPageName</a></td>
308 <td>Public method to get the page name of the current page.</td> 325 <td>Public method to get the page name of the current page.</td>
309 </tr><tr> 326 </tr><tr>
327 <td><a href="#ConfigurationWidget.getExpandedEntries">getExpandedEntries</a></td>
328 <td>Public method to get a list of expanded entries.</td>
329 </tr><tr>
310 <td><a href="#ConfigurationWidget.getLexers">getLexers</a></td> 330 <td><a href="#ConfigurationWidget.getLexers">getLexers</a></td>
311 <td>Public method to get a reference to the lexers dictionary.</td> 331 <td>Public method to get a reference to the lexers dictionary.</td>
312 </tr><tr> 332 </tr><tr>
313 <td><a href="#ConfigurationWidget.getPage">getPage</a></td> 333 <td><a href="#ConfigurationWidget.getPage">getPage</a></td>
314 <td>Public method to get a reference to the named page.</td> 334 <td>Public method to get a reference to the named page.</td>
316 <td><a href="#ConfigurationWidget.on_applyButton_clicked">on_applyButton_clicked</a></td> 336 <td><a href="#ConfigurationWidget.on_applyButton_clicked">on_applyButton_clicked</a></td>
317 <td>Private slot called to apply the settings of the current page.</td> 337 <td>Private slot called to apply the settings of the current page.</td>
318 </tr><tr> 338 </tr><tr>
319 <td><a href="#ConfigurationWidget.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 339 <td><a href="#ConfigurationWidget.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
320 <td>Private slot called by a button of the button box clicked.</td> 340 <td>Private slot called by a button of the button box clicked.</td>
341 </tr><tr>
342 <td><a href="#ConfigurationWidget.on_configList_itemCollapsed">on_configList_itemCollapsed</a></td>
343 <td>Private slot handling a list entry being collapsed.</td>
344 </tr><tr>
345 <td><a href="#ConfigurationWidget.on_configList_itemExpanded">on_configList_itemExpanded</a></td>
346 <td>Private slot handling a list entry being expanded.</td>
321 </tr><tr> 347 </tr><tr>
322 <td><a href="#ConfigurationWidget.on_resetButton_clicked">on_resetButton_clicked</a></td> 348 <td><a href="#ConfigurationWidget.on_resetButton_clicked">on_resetButton_clicked</a></td>
323 <td>Private slot called to reset the settings of the current page.</td> 349 <td>Private slot called to reset the settings of the current page.</td>
324 </tr><tr> 350 </tr><tr>
325 <td><a href="#ConfigurationWidget.setPreferences">setPreferences</a></td> 351 <td><a href="#ConfigurationWidget.setPreferences">setPreferences</a></td>
333 <table> 359 <table>
334 <tr><td>None</td></tr> 360 <tr><td>None</td></tr>
335 </table> 361 </table>
336 <a NAME="ConfigurationWidget.__init__" ID="ConfigurationWidget.__init__"></a> 362 <a NAME="ConfigurationWidget.__init__" ID="ConfigurationWidget.__init__"></a>
337 <h4>ConfigurationWidget (Constructor)</h4> 363 <h4>ConfigurationWidget (Constructor)</h4>
338 <b>ConfigurationWidget</b>(<i>parent=None, fromEric=True, displayMode=DefaultMode</i>) 364 <b>ConfigurationWidget</b>(<i>parent=None, fromEric=True, displayMode=DefaultMode, expandedEntries=[]</i>)
339 <p> 365 <p>
340 Constructor 366 Constructor
341 </p><dl> 367 </p><dl>
342 <dt><i>parent</i></dt> 368 <dt><i>parent</i></dt>
343 <dd> 369 <dd>
348 eric6 ide (boolean) 374 eric6 ide (boolean)
349 </dd><dt><i>displayMode=</i></dt> 375 </dd><dt><i>displayMode=</i></dt>
350 <dd> 376 <dd>
351 mode of the configuration dialog 377 mode of the configuration dialog
352 (DefaultMode, HelpBrowserMode, TrayStarterMode) 378 (DefaultMode, HelpBrowserMode, TrayStarterMode)
379 </dd><dt><i>expandedEntries=</i></dt>
380 <dd>
381 list of entries to be shown expanded
382 (list of strings)
353 </dd> 383 </dd>
354 </dl><dl> 384 </dl><dl>
355 <dt>Raises <b>RuntimeError</b>:</dt> 385 <dt>Raises <b>RuntimeError</b>:</dt>
356 <dd> 386 <dd>
357 raised to indicate an invalid dialog mode 387 raised to indicate an invalid dialog mode
461 </p><dl> 491 </p><dl>
462 <dt>Returns:</dt> 492 <dt>Returns:</dt>
463 <dd> 493 <dd>
464 page name of the current page (string) 494 page name of the current page (string)
465 </dd> 495 </dd>
496 </dl><a NAME="ConfigurationWidget.getExpandedEntries" ID="ConfigurationWidget.getExpandedEntries"></a>
497 <h4>ConfigurationWidget.getExpandedEntries</h4>
498 <b>getExpandedEntries</b>(<i></i>)
499 <p>
500 Public method to get a list of expanded entries.
501 </p><dl>
502 <dt>Returns:</dt>
503 <dd>
504 list of expanded entries (list of string)
505 </dd>
466 </dl><a NAME="ConfigurationWidget.getLexers" ID="ConfigurationWidget.getLexers"></a> 506 </dl><a NAME="ConfigurationWidget.getLexers" ID="ConfigurationWidget.getLexers"></a>
467 <h4>ConfigurationWidget.getLexers</h4> 507 <h4>ConfigurationWidget.getLexers</h4>
468 <b>getLexers</b>(<i></i>) 508 <b>getLexers</b>(<i></i>)
469 <p> 509 <p>
470 Public method to get a reference to the lexers dictionary. 510 Public method to get a reference to the lexers dictionary.
501 Private slot called by a button of the button box clicked. 541 Private slot called by a button of the button box clicked.
502 </p><dl> 542 </p><dl>
503 <dt><i>button</i></dt> 543 <dt><i>button</i></dt>
504 <dd> 544 <dd>
505 button that was clicked (QAbstractButton) 545 button that was clicked (QAbstractButton)
546 </dd>
547 </dl><a NAME="ConfigurationWidget.on_configList_itemCollapsed" ID="ConfigurationWidget.on_configList_itemCollapsed"></a>
548 <h4>ConfigurationWidget.on_configList_itemCollapsed</h4>
549 <b>on_configList_itemCollapsed</b>(<i>item</i>)
550 <p>
551 Private slot handling a list entry being collapsed.
552 </p><dl>
553 <dt><i>item</i></dt>
554 <dd>
555 reference to the collapsed item (QTreeWidgetItem)
556 </dd>
557 </dl><a NAME="ConfigurationWidget.on_configList_itemExpanded" ID="ConfigurationWidget.on_configList_itemExpanded"></a>
558 <h4>ConfigurationWidget.on_configList_itemExpanded</h4>
559 <b>on_configList_itemExpanded</b>(<i>item</i>)
560 <p>
561 Private slot handling a list entry being expanded.
562 </p><dl>
563 <dt><i>item</i></dt>
564 <dd>
565 reference to the expanded item (QTreeWidgetItem)
506 </dd> 566 </dd>
507 </dl><a NAME="ConfigurationWidget.on_resetButton_clicked" ID="ConfigurationWidget.on_resetButton_clicked"></a> 567 </dl><a NAME="ConfigurationWidget.on_resetButton_clicked" ID="ConfigurationWidget.on_resetButton_clicked"></a>
508 <h4>ConfigurationWidget.on_resetButton_clicked</h4> 568 <h4>ConfigurationWidget.on_resetButton_clicked</h4>
509 <b>on_resetButton_clicked</b>(<i></i>) 569 <b>on_resetButton_clicked</b>(<i></i>)
510 <p> 570 <p>

eric ide

mercurial