--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationDialog.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationDialog.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Preferences.ConfigurationDialog</h1>
-
<p>
Module implementing a dialog for the configuration of eric.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#ConfigurationDialog">ConfigurationDialog</a></td>
<td>Class for the dialog variant.</td>
@@ -41,19 +39,20 @@
<td>Main window class for the standalone dialog.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="ConfigurationDialog" ID="ConfigurationDialog"></a>
<h2>ConfigurationDialog</h2>
-
<p>
Class for the dialog variant.
</p>
+
<h3>Signals</h3>
<dl>
@@ -70,19 +69,17 @@
<h3>Derived from</h3>
QDialog
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#ConfigurationDialog.__init__">ConfigurationDialog</a></td>
<td>Constructor</td>
@@ -116,19 +113,20 @@
<td>Public slot to show a named configuration page.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="ConfigurationDialog.__init__" ID="ConfigurationDialog.__init__"></a>
<h4>ConfigurationDialog (Constructor)</h4>
<b>ConfigurationDialog</b>(<i>parent=None, name=None, modal=False, fromEric=True, displayMode=ConfigurationMode.DEFAULTMODE, expandedEntries=None, </i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget (optional))</dt>
@@ -161,10 +159,10 @@
<a NAME="ConfigurationDialog.__mainPasswordChanged" ID="ConfigurationDialog.__mainPasswordChanged"></a>
<h4>ConfigurationDialog.__mainPasswordChanged</h4>
<b>__mainPasswordChanged</b>(<i>oldPassword, newPassword</i>)
-
<p>
Private slot to handle the change of the main password.
</p>
+
<dl>
<dt><i>oldPassword</i> (str)</dt>
@@ -179,24 +177,24 @@
<a NAME="ConfigurationDialog.__preferencesChanged" ID="ConfigurationDialog.__preferencesChanged"></a>
<h4>ConfigurationDialog.__preferencesChanged</h4>
<b>__preferencesChanged</b>(<i></i>)
-
<p>
Private slot to handle a change of the preferences.
</p>
+
<a NAME="ConfigurationDialog.accept" ID="ConfigurationDialog.accept"></a>
<h4>ConfigurationDialog.accept</h4>
<b>accept</b>(<i></i>)
-
<p>
Public method to accept the dialog.
</p>
+
<a NAME="ConfigurationDialog.getConfigurationPageName" ID="ConfigurationDialog.getConfigurationPageName"></a>
<h4>ConfigurationDialog.getConfigurationPageName</h4>
<b>getConfigurationPageName</b>(<i></i>)
-
<p>
Public method to get the page name of the current page.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -212,10 +210,10 @@
<a NAME="ConfigurationDialog.getExpandedEntries" ID="ConfigurationDialog.getExpandedEntries"></a>
<h4>ConfigurationDialog.getExpandedEntries</h4>
<b>getExpandedEntries</b>(<i></i>)
-
<p>
Public method to get a list of expanded entries.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -231,18 +229,18 @@
<a NAME="ConfigurationDialog.setPreferences" ID="ConfigurationDialog.setPreferences"></a>
<h4>ConfigurationDialog.setPreferences</h4>
<b>setPreferences</b>(<i></i>)
-
<p>
Public method called to store the selected values into the preferences
storage.
</p>
+
<a NAME="ConfigurationDialog.showConfigurationPageByName" ID="ConfigurationDialog.showConfigurationPageByName"></a>
<h4>ConfigurationDialog.showConfigurationPageByName</h4>
<b>showConfigurationPageByName</b>(<i>pageName</i>)
-
<p>
Public slot to show a named configuration page.
</p>
+
<dl>
<dt><i>pageName</i> (str)</dt>
@@ -255,58 +253,63 @@
<hr />
<a NAME="ConfigurationMode" ID="ConfigurationMode"></a>
<h2>ConfigurationMode</h2>
-
<p>
Class defining the various modes of the configuration widget.
</p>
+
<h3>Derived from</h3>
enum.Enum
<h3>Class Attributes</h3>
+<table>
+<tr><td>DEFAULTMODE</td></tr>
+<tr><td>EDITORMODE</td></tr>
+<tr><td>HEXEDITORMODE</td></tr>
+<tr><td>PDFVIEWERMODE</td></tr>
+<tr><td>PIPMANAGERMODE</td></tr>
+<tr><td>SHELLMODE</td></tr>
+<tr><td>TRAYSTARTERMODE</td></tr>
+<tr><td>WEBBROWSERMODE</td></tr>
+</table>
-<table>
-<tr><td>DEFAULTMODE</td></tr><tr><td>EDITORMODE</td></tr><tr><td>HEXEDITORMODE</td></tr><tr><td>PDFVIEWERMODE</td></tr><tr><td>PIPMANAGERMODE</td></tr><tr><td>SHELLMODE</td></tr><tr><td>TRAYSTARTERMODE</td></tr><tr><td>WEBBROWSERMODE</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="ConfigurationPageItem" ID="ConfigurationPageItem"></a>
<h2>ConfigurationPageItem</h2>
-
<p>
Class implementing a QTreeWidgetItem holding the configuration page data.
</p>
+
<h3>Derived from</h3>
QTreeWidgetItem
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#ConfigurationPageItem.__init__">ConfigurationPageItem</a></td>
<td>Constructor</td>
@@ -316,19 +319,20 @@
<td>Public method to get the name of the associated configuration page.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="ConfigurationPageItem.__init__" ID="ConfigurationPageItem.__init__"></a>
<h4>ConfigurationPageItem (Constructor)</h4>
<b>ConfigurationPageItem</b>(<i>parent, text, pageName, iconFile</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QTreeWidget or QTreeWidgetItem)</dt>
@@ -351,10 +355,10 @@
<a NAME="ConfigurationPageItem.getPageName" ID="ConfigurationPageItem.getPageName"></a>
<h4>ConfigurationPageItem.getPageName</h4>
<b>getPageName</b>(<i></i>)
-
<p>
Public method to get the name of the associated configuration page.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -372,10 +376,10 @@
<hr />
<a NAME="ConfigurationWidget" ID="ConfigurationWidget"></a>
<h2>ConfigurationWidget</h2>
-
<p>
Class implementing a dialog for the configuration of eric.
</p>
+
<h3>Signals</h3>
<dl>
@@ -400,19 +404,17 @@
<h3>Derived from</h3>
QWidget
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#ConfigurationWidget.__init__">ConfigurationWidget</a></td>
<td>Constructor</td>
@@ -510,19 +512,20 @@
<td>Public slot to show a named configuration page.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="ConfigurationWidget.__init__" ID="ConfigurationWidget.__init__"></a>
<h4>ConfigurationWidget (Constructor)</h4>
<b>ConfigurationWidget</b>(<i>parent=None, fromEric=True, displayMode=ConfigurationMode.DEFAULTMODE, expandedEntries=None, withApply=True, </i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget (optional))</dt>
@@ -551,10 +554,10 @@
<a NAME="ConfigurationWidget.__importConfigurationPage" ID="ConfigurationWidget.__importConfigurationPage"></a>
<h4>ConfigurationWidget.__importConfigurationPage</h4>
<b>__importConfigurationPage</b>(<i>name</i>)
-
<p>
Private method to import a configuration page module.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -577,17 +580,17 @@
<a NAME="ConfigurationWidget.__initLexers" ID="ConfigurationWidget.__initLexers"></a>
<h4>ConfigurationWidget.__initLexers</h4>
<b>__initLexers</b>(<i></i>)
-
<p>
Private method to initialize the dictionary of preferences lexers.
</p>
+
<a NAME="ConfigurationWidget.__initPage" ID="ConfigurationWidget.__initPage"></a>
<h4>ConfigurationWidget.__initPage</h4>
<b>__initPage</b>(<i>pageData</i>)
-
<p>
Private method to initialize a configuration page.
</p>
+
<dl>
<dt><i>pageData</i> (list)</dt>
@@ -610,17 +613,17 @@
<a NAME="ConfigurationWidget.__resizeConfigStack" ID="ConfigurationWidget.__resizeConfigStack"></a>
<h4>ConfigurationWidget.__resizeConfigStack</h4>
<b>__resizeConfigStack</b>(<i></i>)
-
<p>
Private method to resize the stack of configuration pages.
</p>
+
<a NAME="ConfigurationWidget.__searchChildItems" ID="ConfigurationWidget.__searchChildItems"></a>
<h4>ConfigurationWidget.__searchChildItems</h4>
<b>__searchChildItems</b>(<i>parent, text</i>)
-
<p>
Private method to enable child items based on a search string.
</p>
+
<dl>
<dt><i>parent</i> (QTreeWidgetItem)</dt>
@@ -647,10 +650,10 @@
<a NAME="ConfigurationWidget.__searchTextChanged" ID="ConfigurationWidget.__searchTextChanged"></a>
<h4>ConfigurationWidget.__searchTextChanged</h4>
<b>__searchTextChanged</b>(<i>text</i>)
-
<p>
Private slot to handle a change of the search text.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -661,11 +664,11 @@
<a NAME="ConfigurationWidget.__setupUi" ID="ConfigurationWidget.__setupUi"></a>
<h4>ConfigurationWidget.__setupUi</h4>
<b>__setupUi</b>(<i>withApply=True</i>)
-
<p>
Private method to perform the general setup of the configuration
widget.
</p>
+
<dl>
<dt><i>withApply</i> (bool (optional))</dt>
@@ -676,10 +679,10 @@
<a NAME="ConfigurationWidget.__showConfigurationPage" ID="ConfigurationWidget.__showConfigurationPage"></a>
<h4>ConfigurationWidget.__showConfigurationPage</h4>
<b>__showConfigurationPage</b>(<i>itm</i>)
-
<p>
Private slot to show a selected configuration page.
</p>
+
<dl>
<dt><i>itm</i> (QTreeWidgetItem)</dt>
@@ -690,17 +693,17 @@
<a NAME="ConfigurationWidget.accept" ID="ConfigurationWidget.accept"></a>
<h4>ConfigurationWidget.accept</h4>
<b>accept</b>(<i></i>)
-
<p>
Public slot to accept the buttonBox accept signal.
</p>
+
<a NAME="ConfigurationWidget.calledFromEric" ID="ConfigurationWidget.calledFromEric"></a>
<h4>ConfigurationWidget.calledFromEric</h4>
<b>calledFromEric</b>(<i></i>)
-
<p>
Public method to check, if invoked from within eric.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -716,10 +719,10 @@
<a NAME="ConfigurationWidget.getConfigurationPageName" ID="ConfigurationWidget.getConfigurationPageName"></a>
<h4>ConfigurationWidget.getConfigurationPageName</h4>
<b>getConfigurationPageName</b>(<i></i>)
-
<p>
Public method to get the page name of the current page.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -735,10 +738,10 @@
<a NAME="ConfigurationWidget.getExpandedEntries" ID="ConfigurationWidget.getExpandedEntries"></a>
<h4>ConfigurationWidget.getExpandedEntries</h4>
<b>getExpandedEntries</b>(<i></i>)
-
<p>
Public method to get a list of expanded entries.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -754,10 +757,10 @@
<a NAME="ConfigurationWidget.getLexers" ID="ConfigurationWidget.getLexers"></a>
<h4>ConfigurationWidget.getLexers</h4>
<b>getLexers</b>(<i></i>)
-
<p>
Public method to get a reference to the lexers dictionary.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -773,10 +776,10 @@
<a NAME="ConfigurationWidget.getPage" ID="ConfigurationWidget.getPage"></a>
<h4>ConfigurationWidget.getPage</h4>
<b>getPage</b>(<i>pageName</i>)
-
<p>
Public method to get a reference to the named page.
</p>
+
<dl>
<dt><i>pageName</i> (str)</dt>
@@ -800,10 +803,10 @@
<a NAME="ConfigurationWidget.isUsingWebEngine" ID="ConfigurationWidget.isUsingWebEngine"></a>
<h4>ConfigurationWidget.isUsingWebEngine</h4>
<b>isUsingWebEngine</b>(<i></i>)
-
<p>
Public method to get an indication, if QtWebEngine is being used.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -819,17 +822,17 @@
<a NAME="ConfigurationWidget.on_applyButton_clicked" ID="ConfigurationWidget.on_applyButton_clicked"></a>
<h4>ConfigurationWidget.on_applyButton_clicked</h4>
<b>on_applyButton_clicked</b>(<i></i>)
-
<p>
Private slot called to apply the settings of the current page.
</p>
+
<a NAME="ConfigurationWidget.on_buttonBox_clicked" ID="ConfigurationWidget.on_buttonBox_clicked"></a>
<h4>ConfigurationWidget.on_buttonBox_clicked</h4>
<b>on_buttonBox_clicked</b>(<i>button</i>)
-
<p>
Private slot called by a button of the button box clicked.
</p>
+
<dl>
<dt><i>button</i> (QAbstractButton)</dt>
@@ -840,10 +843,10 @@
<a NAME="ConfigurationWidget.on_configList_itemCollapsed" ID="ConfigurationWidget.on_configList_itemCollapsed"></a>
<h4>ConfigurationWidget.on_configList_itemCollapsed</h4>
<b>on_configList_itemCollapsed</b>(<i>item</i>)
-
<p>
Private slot handling a list entry being collapsed.
</p>
+
<dl>
<dt><i>item</i> (QTreeWidgetItem)</dt>
@@ -854,10 +857,10 @@
<a NAME="ConfigurationWidget.on_configList_itemExpanded" ID="ConfigurationWidget.on_configList_itemExpanded"></a>
<h4>ConfigurationWidget.on_configList_itemExpanded</h4>
<b>on_configList_itemExpanded</b>(<i>item</i>)
-
<p>
Private slot handling a list entry being expanded.
</p>
+
<dl>
<dt><i>item</i> (QTreeWidgetItem)</dt>
@@ -868,17 +871,17 @@
<a NAME="ConfigurationWidget.on_resetButton_clicked" ID="ConfigurationWidget.on_resetButton_clicked"></a>
<h4>ConfigurationWidget.on_resetButton_clicked</h4>
<b>on_resetButton_clicked</b>(<i></i>)
-
<p>
Private slot called to reset the settings of the current page.
</p>
+
<a NAME="ConfigurationWidget.resizeEvent" ID="ConfigurationWidget.resizeEvent"></a>
<h4>ConfigurationWidget.resizeEvent</h4>
<b>resizeEvent</b>(<i>evt</i>)
-
<p>
Protected method to handle the resizing of the widget.
</p>
+
<dl>
<dt><i>evt</i> (QResizeEvent)</dt>
@@ -889,18 +892,18 @@
<a NAME="ConfigurationWidget.setPreferences" ID="ConfigurationWidget.setPreferences"></a>
<h4>ConfigurationWidget.setPreferences</h4>
<b>setPreferences</b>(<i></i>)
-
<p>
Public method called to store the selected values into the preferences
storage.
</p>
+
<a NAME="ConfigurationWidget.showConfigurationPageByName" ID="ConfigurationWidget.showConfigurationPageByName"></a>
<h4>ConfigurationWidget.showConfigurationPageByName</h4>
<b>showConfigurationPageByName</b>(<i>pageName, setCurrent=True</i>)
-
<p>
Public slot to show a named configuration page.
</p>
+
<dl>
<dt><i>pageName</i> (str)</dt>
@@ -917,26 +920,24 @@
<hr />
<a NAME="ConfigurationWindow" ID="ConfigurationWindow"></a>
<h2>ConfigurationWindow</h2>
-
<p>
Main window class for the standalone dialog.
</p>
+
<h3>Derived from</h3>
EricMainWindow
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#ConfigurationWindow.__init__">ConfigurationWindow</a></td>
<td>Constructor</td>
@@ -950,19 +951,20 @@
<td>Public slot to show a named configuration page.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="ConfigurationWindow.__init__" ID="ConfigurationWindow.__init__"></a>
<h4>ConfigurationWindow (Constructor)</h4>
<b>ConfigurationWindow</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -973,17 +975,17 @@
<a NAME="ConfigurationWindow.accept" ID="ConfigurationWindow.accept"></a>
<h4>ConfigurationWindow.accept</h4>
<b>accept</b>(<i></i>)
-
<p>
Public slot called by the Ok button.
</p>
+
<a NAME="ConfigurationWindow.showConfigurationPageByName" ID="ConfigurationWindow.showConfigurationPageByName"></a>
<h4>ConfigurationWindow.showConfigurationPageByName</h4>
<b>showConfigurationPageByName</b>(<i>pageName</i>)
-
<p>
Public slot to show a named configuration page.
</p>
+
<dl>
<dt><i>pageName</i> (str)</dt>
@@ -993,4 +995,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
