eric6/Documentation/Source/eric6.Preferences.ConfigurationDialog.html

changeset 8266
560547c2b6ec
parent 8215
fc5d68a6889e
--- a/eric6/Documentation/Source/eric6.Preferences.ConfigurationDialog.html	Tue Apr 27 17:25:06 2021 +0200
+++ b/eric6/Documentation/Source/eric6.Preferences.ConfigurationDialog.html	Tue Apr 27 17:25:30 2021 +0200
@@ -39,6 +39,10 @@
 <td>Class for the dialog variant.</td>
 </tr>
 <tr>
+<td><a href="#ConfigurationMode">ConfigurationMode</a></td>
+<td>Class defining the various modes of the configuration widget.</td>
+</tr>
+<tr>
 <td><a href="#ConfigurationPageItem">ConfigurationPageItem</a></td>
 <td>Class implementing a QTreeWidgetItem holding the configuration page data.</td>
 </tr>
@@ -82,7 +86,7 @@
 <h3>Class Attributes</h3>
 
 <table>
-<tr><td>DefaultMode</td></tr><tr><td>HexEditorMode</td></tr><tr><td>TrayStarterMode</td></tr><tr><td>WebBrowserMode</td></tr>
+<tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
 
@@ -134,39 +138,37 @@
 
 <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=ConfigurationWidget.DefaultMode, expandedEntries=None</i>)
+<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></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-The parent widget of this dialog. (QWidget)
+reference to the parent widget
 </dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-The name of this dialog. string
+name of the dialog
 </dd>
-<dt><i>modal</i></dt>
+<dt><i>modal</i> (bool)</dt>
 <dd>
-Flag indicating a modal dialog. (boolean)
+flag indicating a modal dialog
 </dd>
-<dt><i>fromEric</i></dt>
+<dt><i>fromEric</i> (bool)</dt>
 <dd>
 flag indicating a dialog generation from within the
-            eric ide (boolean)
+            eric IDE
 </dd>
-<dt><i>displayMode</i></dt>
+<dt><i>displayMode</i> (ConfigurationMode)</dt>
 <dd>
 mode of the configuration dialog
-            (DefaultMode, TrayStarterMode, HexEditorMode, WebBrowserMode)
 </dd>
-<dt><i>expandedEntries</i></dt>
+<dt><i>expandedEntries</i> (list of str)</dt>
 <dd>
 list of entries to be shown expanded
-            (list of strings)
 </dd>
 </dl>
 <a NAME="ConfigurationDialog.__masterPasswordChanged" ID="ConfigurationDialog.__masterPasswordChanged"></a>
@@ -252,6 +254,38 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <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>HEXEDITORMODE</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>
 
@@ -364,7 +398,7 @@
 <h3>Class Attributes</h3>
 
 <table>
-<tr><td>DefaultMode</td></tr><tr><td>HexEditorMode</td></tr><tr><td>TrayStarterMode</td></tr><tr><td>WebBrowserMode</td></tr>
+<tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
 
@@ -480,38 +514,29 @@
 
 <a NAME="ConfigurationWidget.__init__" ID="ConfigurationWidget.__init__"></a>
 <h4>ConfigurationWidget (Constructor)</h4>
-<b>ConfigurationWidget</b>(<i>parent=None, fromEric=True, displayMode=DefaultMode, expandedEntries=None</i>)
+<b>ConfigurationWidget</b>(<i>parent=None, fromEric=True, displayMode=ConfigurationMode.DEFAULTMODE, expandedEntries=None</i>)
 
 <p>
         Constructor
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-The parent widget of this dialog. (QWidget)
+reference to the parent widget
 </dd>
-<dt><i>fromEric</i></dt>
+<dt><i>fromEric</i> (bool)</dt>
 <dd>
 flag indicating a dialog generation from within the
-            eric ide (boolean)
+            eric IDE
 </dd>
-<dt><i>displayMode</i></dt>
+<dt><i>displayMode</i> (ConfigurationMode)</dt>
 <dd>
 mode of the configuration dialog
-            (DefaultMode, TrayStarterMode, HexEditorMode, WebBrowserMode)
 </dd>
-<dt><i>expandedEntries</i></dt>
+<dt><i>expandedEntries</i> (list of str)</dt>
 <dd>
 list of entries to be shown expanded
-            (list of strings)
-</dd>
-</dl>
-<dl>
-
-<dt>Raises <b>RuntimeError</b>:</dt>
-<dd>
-raised to indicate an invalid dialog mode
 </dd>
 </dl>
 <a NAME="ConfigurationWidget.__importConfigurationPage" ID="ConfigurationWidget.__importConfigurationPage"></a>

eric ide

mercurial