src/eric7/Documentation/Source/eric7.Preferences.ConfigurationDialog.html

branch
eric7
changeset 10428
a071d4065202
parent 10132
66c11ab8fefd
child 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationDialog.html	Wed Dec 20 11:06:38 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationDialog.html	Wed Dec 20 14:58:58 2023 +0100
@@ -200,7 +200,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-page name of the current page (string)
+page name of the current page
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ConfigurationDialog.getExpandedEntries" ID="ConfigurationDialog.getExpandedEntries"></a>
@@ -213,7 +219,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of expanded entries (list of string)
+list of expanded entries
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="ConfigurationDialog.setPreferences" ID="ConfigurationDialog.setPreferences"></a>
@@ -233,9 +245,9 @@
 </p>
 <dl>
 
-<dt><i>pageName</i></dt>
+<dt><i>pageName</i> (str)</dt>
 <dd>
-name of the configuration page to show (string)
+name of the configuration page to show
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -319,22 +331,21 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QTreeWidget or QTreeWidgetItem)</dt>
 <dd>
-parent widget of the item (QTreeWidget or
-            QTreeWidgetItem)
+parent widget of the item
 </dd>
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-text to be displayed (string)
+text to be displayed
 </dd>
-<dt><i>pageName</i></dt>
+<dt><i>pageName</i> (str)</dt>
 <dd>
-name of the configuration page (string)
+name of the configuration page
 </dd>
-<dt><i>iconFile</i></dt>
+<dt><i>iconFile</i> (str)</dt>
 <dd>
-file name of the icon to be shown (string)
+file name of the icon to be shown
 </dd>
 </dl>
 <a NAME="ConfigurationPageItem.getPageName" ID="ConfigurationPageItem.getPageName"></a>
@@ -347,7 +358,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-name of the configuration page (string)
+name of the configuration page
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -540,9 +557,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the configuration page module (string)
+name of the configuration page module
 </dd>
 </dl>
 <dl>
@@ -551,6 +568,12 @@
 reference to the configuration page module
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Module
+</dd>
+</dl>
 <a NAME="ConfigurationWidget.__initLexers" ID="ConfigurationWidget.__initLexers"></a>
 <h4>ConfigurationWidget.__initLexers</h4>
 <b>__initLexers</b>(<i></i>)
@@ -567,7 +590,7 @@
 </p>
 <dl>
 
-<dt><i>pageData</i></dt>
+<dt><i>pageData</i> (list)</dt>
 <dd>
 data structure for the page to initialize
 </dd>
@@ -578,6 +601,12 @@
 reference to the initialized page
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+ConfigurationPageBase
+</dd>
+</dl>
 <a NAME="ConfigurationWidget.__resizeConfigStack" ID="ConfigurationWidget.__resizeConfigStack"></a>
 <h4>ConfigurationWidget.__resizeConfigStack</h4>
 <b>__resizeConfigStack</b>(<i></i>)
@@ -594,19 +623,25 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QTreeWidgetItem)</dt>
 <dd>
-reference to the parent item (QTreeWidgetItem)
+reference to the parent item
 </dd>
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-text to search for (string)
+text to search for
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating an enabled child item (boolean)
+flag indicating an enabled child item
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="ConfigurationWidget.__searchTextChanged" ID="ConfigurationWidget.__searchTextChanged"></a>
@@ -618,9 +653,9 @@
 </p>
 <dl>
 
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-text to search for (string)
+text to search for
 </dd>
 </dl>
 <a NAME="ConfigurationWidget.__setupUi" ID="ConfigurationWidget.__setupUi"></a>
@@ -647,9 +682,9 @@
 </p>
 <dl>
 
-<dt><i>itm</i></dt>
+<dt><i>itm</i> (QTreeWidgetItem)</dt>
 <dd>
-reference to the selected item (QTreeWidgetItem)
+reference to the selected item
 </dd>
 </dl>
 <a NAME="ConfigurationWidget.accept" ID="ConfigurationWidget.accept"></a>
@@ -669,7 +704,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating invocation from within eric (boolean)
+flag indicating invocation from within eric
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="ConfigurationWidget.getConfigurationPageName" ID="ConfigurationWidget.getConfigurationPageName"></a>
@@ -682,7 +723,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-page name of the current page (string)
+page name of the current page
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ConfigurationWidget.getExpandedEntries" ID="ConfigurationWidget.getExpandedEntries"></a>
@@ -695,7 +742,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of expanded entries (list of string)
+list of expanded entries
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="ConfigurationWidget.getLexers" ID="ConfigurationWidget.getLexers"></a>
@@ -711,6 +764,12 @@
 reference to the lexers dictionary
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
 <a NAME="ConfigurationWidget.getPage" ID="ConfigurationWidget.getPage"></a>
 <h4>ConfigurationWidget.getPage</h4>
 <b>getPage</b>(<i>pageName</i>)
@@ -720,9 +779,9 @@
 </p>
 <dl>
 
-<dt><i>pageName</i></dt>
+<dt><i>pageName</i> (str)</dt>
 <dd>
-name of the configuration page (string)
+name of the configuration page
 </dd>
 </dl>
 <dl>
@@ -732,6 +791,12 @@
             not loaded yet
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+ConfigurationPageBase
+</dd>
+</dl>
 <a NAME="ConfigurationWidget.isUsingWebEngine" ID="ConfigurationWidget.isUsingWebEngine"></a>
 <h4>ConfigurationWidget.isUsingWebEngine</h4>
 <b>isUsingWebEngine</b>(<i></i>)
@@ -767,9 +832,9 @@
 </p>
 <dl>
 
-<dt><i>button</i></dt>
+<dt><i>button</i> (QAbstractButton)</dt>
 <dd>
-button that was clicked (QAbstractButton)
+button that was clicked
 </dd>
 </dl>
 <a NAME="ConfigurationWidget.on_configList_itemCollapsed" ID="ConfigurationWidget.on_configList_itemCollapsed"></a>
@@ -781,9 +846,9 @@
 </p>
 <dl>
 
-<dt><i>item</i></dt>
+<dt><i>item</i> (QTreeWidgetItem)</dt>
 <dd>
-reference to the collapsed item (QTreeWidgetItem)
+reference to the collapsed item
 </dd>
 </dl>
 <a NAME="ConfigurationWidget.on_configList_itemExpanded" ID="ConfigurationWidget.on_configList_itemExpanded"></a>
@@ -795,9 +860,9 @@
 </p>
 <dl>
 
-<dt><i>item</i></dt>
+<dt><i>item</i> (QTreeWidgetItem)</dt>
 <dd>
-reference to the expanded item (QTreeWidgetItem)
+reference to the expanded item
 </dd>
 </dl>
 <a NAME="ConfigurationWidget.on_resetButton_clicked" ID="ConfigurationWidget.on_resetButton_clicked"></a>
@@ -838,13 +903,13 @@
 </p>
 <dl>
 
-<dt><i>pageName</i></dt>
+<dt><i>pageName</i> (str)</dt>
 <dd>
-name of the configuration page to show (string)
+name of the configuration page to show
 </dd>
-<dt><i>setCurrent</i></dt>
+<dt><i>setCurrent</i> (bool)</dt>
 <dd>
-flag indicating to set the current item (boolean)
+flag indicating to set the current item
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -900,9 +965,9 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-reference to the parent widget (QWidget)
+reference to the parent widget
 </dd>
 </dl>
 <a NAME="ConfigurationWindow.accept" ID="ConfigurationWindow.accept"></a>
@@ -921,9 +986,9 @@
 </p>
 <dl>
 
-<dt><i>pageName</i></dt>
+<dt><i>pageName</i> (str)</dt>
 <dd>
-name of the configuration page to show (string)
+name of the configuration page to show
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial