--- a/src/eric7/Preferences/ConfigurationDialog.py Wed Dec 20 11:06:38 2023 +0100
+++ b/src/eric7/Preferences/ConfigurationDialog.py Wed Dec 20 14:58:58 2023 +0100
@@ -53,11 +53,14 @@
"""
Constructor
- @param parent parent widget of the item (QTreeWidget or
- QTreeWidgetItem)
- @param text text to be displayed (string)
- @param pageName name of the configuration page (string)
- @param iconFile file name of the icon to be shown (string)
+ @param parent parent widget of the item
+ @type QTreeWidget or QTreeWidgetItem
+ @param text text to be displayed
+ @type str
+ @param pageName name of the configuration page
+ @type str
+ @param iconFile file name of the icon to be shown
+ @type str
"""
super().__init__(parent, [text])
self.setIcon(0, EricPixmapCache.getIcon(iconFile))
@@ -68,7 +71,8 @@
"""
Public method to get the name of the associated configuration page.
- @return name of the configuration page (string)
+ @return name of the configuration page
+ @rtype str
"""
return self.__pageName
@@ -1253,7 +1257,8 @@
"""
Private slot to handle a change of the search text.
- @param text text to search for (string)
+ @param text text to search for
+ @type str
"""
self.__searchChildItems(self.configList.invisibleRootItem(), text)
@@ -1261,9 +1266,12 @@
"""
Private method to enable child items based on a search string.
- @param parent reference to the parent item (QTreeWidgetItem)
- @param text text to search for (string)
- @return flag indicating an enabled child item (boolean)
+ @param parent reference to the parent item
+ @type QTreeWidgetItem
+ @param text text to search for
+ @type str
+ @return flag indicating an enabled child item
+ @rtype bool
"""
childEnabled = False
text = text.lower()
@@ -1302,8 +1310,10 @@
"""
Private method to import a configuration page module.
- @param name name of the configuration page module (string)
+ @param name name of the configuration page module
+ @type str
@return reference to the configuration page module
+ @rtype Module
"""
try:
mod = importlib.import_module(
@@ -1326,7 +1336,8 @@
"""
Private slot to show a selected configuration page.
- @param itm reference to the selected item (QTreeWidgetItem)
+ @param itm reference to the selected item
+ @type QTreeWidgetItem
"""
pageName = itm.getPageName()
self.showConfigurationPageByName(pageName, setCurrent=False)
@@ -1336,7 +1347,9 @@
Private method to initialize a configuration page.
@param pageData data structure for the page to initialize
+ @type list
@return reference to the initialized page
+ @rtype ConfigurationPageBase
"""
page = None
if isinstance(pageData[2], types.FunctionType):
@@ -1356,8 +1369,10 @@
"""
Public slot to show a named configuration page.
- @param pageName name of the configuration page to show (string)
- @param setCurrent flag indicating to set the current item (boolean)
+ @param pageName name of the configuration page to show
+ @type str
+ @param setCurrent flag indicating to set the current item
+ @type bool
"""
if pageName == "empty" or pageName not in self.configItems:
page = self.emptyPage
@@ -1438,7 +1453,8 @@
"""
Public method to get the page name of the current page.
- @return page name of the current page (string)
+ @return page name of the current page
+ @rtype str
"""
return self.__currentConfigurationPageName
@@ -1446,7 +1462,8 @@
"""
Public method to check, if invoked from within eric.
- @return flag indicating invocation from within eric (boolean)
+ @return flag indicating invocation from within eric
+ @rtype bool
"""
return self.fromEric
@@ -1454,9 +1471,11 @@
"""
Public method to get a reference to the named page.
- @param pageName name of the configuration page (string)
+ @param pageName name of the configuration page
+ @type str
@return reference to the page or None, indicating page was
not loaded yet
+ @rtype ConfigurationPageBase
"""
return self.configItems[pageName][-1]
@@ -1465,6 +1484,7 @@
Public method to get a reference to the lexers dictionary.
@return reference to the lexers dictionary
+ @rtype dict
"""
return self.lexers
@@ -1486,7 +1506,8 @@
"""
Private slot called by a button of the button box clicked.
- @param button button that was clicked (QAbstractButton)
+ @param button button that was clicked
+ @type QAbstractButton
"""
if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Apply):
self.on_applyButton_clicked()
@@ -1529,7 +1550,8 @@
"""
Public method to get a list of expanded entries.
- @return list of expanded entries (list of string)
+ @return list of expanded entries
+ @rtype list of str
"""
return self.__expandedEntries
@@ -1538,7 +1560,8 @@
"""
Private slot handling a list entry being collapsed.
- @param item reference to the collapsed item (QTreeWidgetItem)
+ @param item reference to the collapsed item
+ @type QTreeWidgetItem
"""
pageName = item.data(0, Qt.ItemDataRole.UserRole)
if pageName in self.__expandedEntries:
@@ -1549,7 +1572,8 @@
"""
Private slot handling a list entry being expanded.
- @param item reference to the expanded item (QTreeWidgetItem)
+ @param item reference to the expanded item
+ @type QTreeWidgetItem
"""
pageName = item.data(0, Qt.ItemDataRole.UserRole)
if pageName not in self.__expandedEntries:
@@ -1652,7 +1676,8 @@
"""
Public slot to show a named configuration page.
- @param pageName name of the configuration page to show (string)
+ @param pageName name of the configuration page to show
+ @type str
"""
self.cw.showConfigurationPageByName(pageName)
@@ -1660,7 +1685,8 @@
"""
Public method to get the page name of the current page.
- @return page name of the current page (string)
+ @return page name of the current page
+ @rtype str
"""
return self.cw.getConfigurationPageName()
@@ -1668,7 +1694,8 @@
"""
Public method to get a list of expanded entries.
- @return list of expanded entries (list of string)
+ @return list of expanded entries
+ @rtype list of str
"""
return self.cw.getExpandedEntries()
@@ -1695,7 +1722,8 @@
"""
Constructor
- @param parent reference to the parent widget (QWidget)
+ @param parent reference to the parent widget
+ @type QWidget
"""
super().__init__(parent)
@@ -1717,7 +1745,8 @@
"""
Public slot to show a named configuration page.
- @param pageName name of the configuration page to show (string)
+ @param pageName name of the configuration page to show
+ @type str
"""
self.cw.showConfigurationPageByName(pageName)
