eric: comparison eric6/Preferences/ConfigurationDialog.py

-:f95dde35d0ab
+:0090cfa83159
 """
 Module implementing a dialog for the configuration of eric.
 """
+import contextlib
+import enum
 import os
 import types
-import contextlib
 from PyQt5.QtCore import pyqtSignal, pyqtSlot, Qt, QMetaObject, QRect
 from PyQt5.QtGui import QPixmap
 from PyQt5.QtWidgets import (
 QSizePolicy, QSpacerItem, QWidget, QTreeWidget, QStackedWidget, QDialog,
 Public method to get the name of the associated configuration page.
 @return name of the configuration page (string)
 """
 return self.__pageName
+class ConfigurationMode(enum.Enum):
+"""
+Class defining the various modes of the configuration widget.
+"""
+DEFAULTMODE = 0
+TRAYSTARTERMODE = 1
+HEXEDITORMODE = 2
+WEBBROWSERMODE = 3
 class ConfigurationWidget(QWidget):
 """
 Class implementing a dialog for the configuration of eric.
 preferencesChanged = pyqtSignal()
 masterPasswordChanged = pyqtSignal(str, str)
 accepted = pyqtSignal()
 rejected = pyqtSignal()
-# TODO: convert this to 'enum'
+def __init__(self, parent=None, fromEric=True,
-DefaultMode = 0
+displayMode=ConfigurationMode.DEFAULTMODE,
-TrayStarterMode = 1
-HexEditorMode = 2
-WebBrowserMode = 3
-def __init__(self, parent=None, fromEric=True, displayMode=DefaultMode,
 expandedEntries=None):
 """
 Constructor
-@param parent The parent widget of this dialog. (QWidget)
+@param parent reference to the parent widget
+@type QWidget
 @param fromEric flag indicating a dialog generation from within the
-eric ide (boolean)
+eric IDE
+@type bool
 @param displayMode mode of the configuration dialog
-(DefaultMode, TrayStarterMode, HexEditorMode, WebBrowserMode)
+@type ConfigurationMode
-@exception RuntimeError raised to indicate an invalid dialog mode
 @param expandedEntries list of entries to be shown expanded
-(list of strings)
+@type list of str
 """
 super().__init__(parent)
-if displayMode not in (
-ConfigurationWidget.DefaultMode,
-ConfigurationWidget.WebBrowserMode,
-ConfigurationWidget.TrayStarterMode,
-ConfigurationWidget.HexEditorMode,
-):
-raise RuntimeError("Illegal mode value: {0}".format(displayMode))
 self.fromEric = fromEric
 self.displayMode = displayMode
 self.__webEngine = getWebBrowserSupport() == "QtWebEngine"
 expandedEntries = [] if expandedEntries is None else expandedEntries[:]
 except KeyError:
 self.virtualenvManager = VirtualenvManager(self)
 e5App().registerObject("VirtualEnvManager",
 self.virtualenvManager)
-if displayMode == ConfigurationWidget.DefaultMode:
+if displayMode == ConfigurationMode.DEFAULTMODE:
 self.configItems = {
 # key : [display string, pixmap name, dialog module name or
 #        page creation function, parent key,
 #        reference to configuration page (must always be last)]
 # The dialog module must have the module function 'create' to
 })
 self.configItems.update(
 e5App().getObject("PluginManager").getPluginConfigData())
-elif displayMode == ConfigurationWidget.WebBrowserMode:
+elif displayMode == ConfigurationMode.WEBBROWSERMODE:
 self.configItems = {
 # key : [display string, pixmap name, dialog module name or
 #        page creation function, parent key,
 #        reference to configuration page (must always be last)]
 # The dialog module must have the module function 'create' to
 [self.tr("Spell checking"),
 "preferences-spellchecking",
 "WebBrowserSpellCheckingPage", None, None],
 }
-elif displayMode == ConfigurationWidget.TrayStarterMode:
+elif displayMode == ConfigurationMode.TRAYSTARTERMODE:
 self.configItems = {
 # key : [display string, pixmap name, dialog module name or
 #        page creation function, parent key,
 #        reference to configuration page (must always be last)]
 # The dialog module must have the module function 'create' to
 "trayStarterPage":
 [self.tr("Tray Starter"), "erict",
 "TrayStarterPage", None, None],
 }
-elif displayMode == ConfigurationWidget.HexEditorMode:
+elif displayMode == ConfigurationMode.HEXEDITORMODE:
 self.configItems = {
 # key : [display string, pixmap name, dialog module name or
 #        page creation function, parent key,
 #        reference to configuration page (must always be last)]
 # The dialog module must have the module function 'create' to
 else:
 pitm = self.configList
 self.itmDict[key] = ConfigurationPageItem(pitm, pageData[0], key,
 pageData[1])
 self.itmDict[key].setData(0, Qt.ItemDataRole.UserRole, key)
-if (not self.fromEric or
+if (
-displayMode != ConfigurationWidget.DefaultMode or
+not self.fromEric or
-key in expandedEntries):
+displayMode != ConfigurationMode.DEFAULTMODE or
+key in expandedEntries
+):
 self.itmDict[key].setExpanded(True)
 self.configList.sortByColumn(0, Qt.SortOrder.AscendingOrder)
 # set the initial size of the splitter
 self.configSplitter.setSizes([200, 600])
 self.configList.itemActivated.connect(self.__showConfigurationPage)
 self.configList.itemClicked.connect(self.__showConfigurationPage)
 self.buttonBox.accepted.connect(self.accept)
 self.buttonBox.rejected.connect(self.rejected)
-if displayMode in [ConfigurationWidget.TrayStarterMode,
+if displayMode in [ConfigurationMode.TRAYSTARTERMODE,
-ConfigurationWidget.HexEditorMode,
+ConfigurationMode.HEXEDITORMODE,
-ConfigurationWidget.WebBrowserMode]:
+ConfigurationMode.WEBBROWSERMODE]:
 self.configListSearch.hide()
-if displayMode not in [ConfigurationWidget.TrayStarterMode,
+if displayMode not in [ConfigurationMode.TRAYSTARTERMODE,
-ConfigurationWidget.HexEditorMode]:
+ConfigurationMode.HEXEDITORMODE]:
 self.__initLexers()
 def accept(self):
 """
 Public slot to accept the buttonBox accept signal.
 QDialogButtonBox.StandardButton.Reset
 )
 self.buttonBox.setObjectName("buttonBox")
 if (
 not self.fromEric and
-self.displayMode == ConfigurationWidget.DefaultMode
+self.displayMode == ConfigurationMode.DEFAULTMODE
 ):
 self.buttonBox.button(QDialogButtonBox.StandardButton.Apply).hide()
 self.buttonBox.button(
 QDialogButtonBox.StandardButton.Apply).setEnabled(False)
 self.buttonBox.button(
 @return flag indicating the use of QtWebEngine
 @rtype bool
 """
 return (
 self.__webEngine or
-self.displayMode == ConfigurationWidget.WebBrowserMode
+self.displayMode == ConfigurationMode.WEBBROWSERMODE
 )
 class ConfigurationDialog(QDialog):
 """
 password has been changed with the old and the new password
 """
 preferencesChanged = pyqtSignal()
 masterPasswordChanged = pyqtSignal(str, str)
-DefaultMode = ConfigurationWidget.DefaultMode
-TrayStarterMode = ConfigurationWidget.TrayStarterMode
-HexEditorMode = ConfigurationWidget.HexEditorMode
-WebBrowserMode = ConfigurationWidget.WebBrowserMode
 def __init__(self, parent=None, name=None, modal=False,
-fromEric=True, displayMode=ConfigurationWidget.DefaultMode,
+fromEric=True,
+displayMode=ConfigurationMode.DEFAULTMODE,
 expandedEntries=None):
 """
 Constructor
-@param parent The parent widget of this dialog. (QWidget)
+@param parent reference to the parent widget
-@param name The name of this dialog. string
+@type QWidget
-@param modal Flag indicating a modal dialog. (boolean)
+@param name name of the dialog
+@type str
+@param modal flag indicating a modal dialog
+@type bool
 @param fromEric flag indicating a dialog generation from within the
-eric ide (boolean)
+eric IDE
+@type bool
 @param displayMode mode of the configuration dialog
-(DefaultMode, TrayStarterMode, HexEditorMode, WebBrowserMode)
+@type ConfigurationMode
 @param expandedEntries list of entries to be shown expanded
-(list of strings)
+@type list of str
 """
 super().__init__(parent)
 if name:
 self.setObjectName(name)
 self.setModal(modal)

Mercurial Repositories > eric / file comparison

comparison: eric6/Preferences/ConfigurationDialog.py

eric6/Preferences/ConfigurationDialog.py