--- a/src/eric7/Plugins/DocumentationPlugins/Ericdoc/EricdocConfigDialog.py Wed Jul 13 11:16:20 2022 +0200
+++ b/src/eric7/Plugins/DocumentationPlugins/Ericdoc/EricdocConfigDialog.py Wed Jul 13 14:55:47 2022 +0200
@@ -17,9 +17,7 @@
from EricWidgets.EricPathPicker import EricPathPickerModes
from .Ui_EricdocConfigDialog import Ui_EricdocConfigDialog
-from DocumentationTools.Config import (
- eric7docDefaultColors, eric7docColorParameterNames
-)
+from DocumentationTools.Config import eric7docDefaultColors, eric7docColorParameterNames
import Globals
import Utilities
@@ -31,63 +29,64 @@
"""
Class implementing a dialog to enter the parameters for eric7_doc.
"""
+
def __init__(self, project, parms=None, parent=None):
"""
Constructor
-
+
@param project reference to the project object (Project.Project)
@param parms parameters to set in the dialog
@param parent parent widget of this dialog
"""
super().__init__(parent)
self.setupUi(self)
-
+
self.startDirPicker.setMode(EricPathPickerModes.DIRECTORY_MODE)
self.startDirPicker.setDefaultDirectory(project.getProjectPath())
-
+
self.outputDirPicker.setMode(EricPathPickerModes.DIRECTORY_MODE)
self.outputDirPicker.setDefaultDirectory(project.getProjectPath())
-
+
self.ignoreDirPicker.setMode(EricPathPickerModes.DIRECTORY_MODE)
self.ignoreDirPicker.setDefaultDirectory(project.getProjectPath())
-
+
self.cssPicker.setMode(EricPathPickerModes.OPEN_FILE_MODE)
- self.cssPicker.setDefaultDirectory(getConfig('ericCSSDir'))
- self.cssPicker.setFilters(self.tr(
- "Cascading Style Sheets (*.css);;All files (*)"))
-
+ self.cssPicker.setDefaultDirectory(getConfig("ericCSSDir"))
+ self.cssPicker.setFilters(
+ self.tr("Cascading Style Sheets (*.css);;All files (*)")
+ )
+
self.qtHelpDirPicker.setMode(EricPathPickerModes.DIRECTORY_MODE)
self.qtHelpDirPicker.setDefaultDirectory(project.getProjectPath())
-
- self.__okButton = self.buttonBox.button(
- QDialogButtonBox.StandardButton.Ok)
-
+
+ self.__okButton = self.buttonBox.button(QDialogButtonBox.StandardButton.Ok)
+
self.__initializeDefaults()
-
+
self.sampleText = self.tr(
- '''<!DOCTYPE html'''
- '''<html><head>'''
- '''<title></title>'''
- '''</head>'''
- '''<body style="background-color:{BodyBgColor};'''
- '''color:{BodyColor}">'''
- '''<h1 style="background-color:{Level1HeaderBgColor};'''
- '''color:{Level1HeaderColor}">'''
- '''Level 1 Header</h1>'''
- '''<h3 style="background-color:{Level2HeaderBgColor};'''
- '''color:{Level2HeaderColor}">'''
- '''Level 2 Header</h3>'''
- '''<h2 style="background-color:{CFBgColor};color:{CFColor}">'''
- '''Class and Function Header</h2>'''
- '''Standard body text with '''
- '''<a style="color:{LinkColor}">some links</a> embedded.'''
- '''</body></html>'''
+ """<!DOCTYPE html"""
+ """<html><head>"""
+ """<title></title>"""
+ """</head>"""
+ """<body style="background-color:{BodyBgColor};"""
+ """color:{BodyColor}">"""
+ """<h1 style="background-color:{Level1HeaderBgColor};"""
+ """color:{Level1HeaderColor}">"""
+ """Level 1 Header</h1>"""
+ """<h3 style="background-color:{Level2HeaderBgColor};"""
+ """color:{Level2HeaderColor}">"""
+ """Level 2 Header</h3>"""
+ """<h2 style="background-color:{CFBgColor};color:{CFColor}">"""
+ """Class and Function Header</h2>"""
+ """Standard body text with """
+ """<a style="color:{LinkColor}">some links</a> embedded."""
+ """</body></html>"""
)
-
+
# get a copy of the defaults to store the user settings
self.parameters = copy.deepcopy(self.defaults)
self.colors = eric7docDefaultColors.copy()
-
+
# combine it with the values of parms
if parms is not None:
for key in parms:
@@ -96,256 +95,239 @@
else:
self.parameters[key] = parms[key]
self.parameters["startDirectory"] = Utilities.toNativeSeparators(
- self.parameters['startDirectory']
+ self.parameters["startDirectory"]
)
- self.parameters['outputDirectory'] = Utilities.toNativeSeparators(
- self.parameters['outputDirectory']
+ self.parameters["outputDirectory"] = Utilities.toNativeSeparators(
+ self.parameters["outputDirectory"]
+ )
+ self.parameters["qtHelpOutputDirectory"] = Utilities.toNativeSeparators(
+ self.parameters["qtHelpOutputDirectory"]
)
- self.parameters['qtHelpOutputDirectory'] = (
- Utilities.toNativeSeparators(
- self.parameters['qtHelpOutputDirectory'])
+ self.parameters["cssFile"] = Utilities.toNativeSeparators(
+ self.parameters["cssFile"]
)
- self.parameters['cssFile'] = Utilities.toNativeSeparators(
- self.parameters['cssFile']
- )
- if self.parameters['cssFile'].startswith("%PYTHON%"):
- self.parameters['cssFile'] = self.parameters['cssFile'].replace(
- "%PYTHON%", Utilities.getPythonLibraryDirectory())
-
+ if self.parameters["cssFile"].startswith("%PYTHON%"):
+ self.parameters["cssFile"] = self.parameters["cssFile"].replace(
+ "%PYTHON%", Utilities.getPythonLibraryDirectory()
+ )
+
self.ppath = project.getProjectPath()
self.project = project
-
- self.recursionCheckBox.setChecked(self.parameters['useRecursion'])
- self.noindexCheckBox.setChecked(self.parameters['noindex'])
- self.noemptyCheckBox.setChecked(self.parameters['noempty'])
- self.startDirPicker.setText(self.parameters['startDirectory'])
- self.outputDirPicker.setText(self.parameters['outputDirectory'])
+
+ self.recursionCheckBox.setChecked(self.parameters["useRecursion"])
+ self.noindexCheckBox.setChecked(self.parameters["noindex"])
+ self.noemptyCheckBox.setChecked(self.parameters["noempty"])
+ self.startDirPicker.setText(self.parameters["startDirectory"])
+ self.outputDirPicker.setText(self.parameters["outputDirectory"])
self.ignoreDirsList.clear()
- for d in self.parameters['ignoreDirectories']:
+ for d in self.parameters["ignoreDirectories"]:
self.ignoreDirsList.addItem(d)
- self.cssPicker.setText(self.parameters['cssFile'])
- self.sourceExtEdit.setText(
- ", ".join(self.parameters['sourceExtensions']))
- self.excludeFilesEdit.setText(
- ", ".join(self.parameters['ignoreFilePatterns']))
+ self.cssPicker.setText(self.parameters["cssFile"])
+ self.sourceExtEdit.setText(", ".join(self.parameters["sourceExtensions"]))
+ self.excludeFilesEdit.setText(", ".join(self.parameters["ignoreFilePatterns"]))
self.sample.setHtml(self.sampleText.format(**self.colors))
-
- self.qtHelpGroup.setChecked(self.parameters['qtHelpEnabled'])
- self.qtHelpDirPicker.setText(self.parameters['qtHelpOutputDirectory'])
- self.qtHelpNamespaceEdit.setText(self.parameters['qtHelpNamespace'])
- self.qtHelpFolderEdit.setText(self.parameters['qtHelpVirtualFolder'])
- self.qtHelpFilterNameEdit.setText(self.parameters['qtHelpFilterName'])
+
+ self.qtHelpGroup.setChecked(self.parameters["qtHelpEnabled"])
+ self.qtHelpDirPicker.setText(self.parameters["qtHelpOutputDirectory"])
+ self.qtHelpNamespaceEdit.setText(self.parameters["qtHelpNamespace"])
+ self.qtHelpFolderEdit.setText(self.parameters["qtHelpVirtualFolder"])
+ self.qtHelpFilterNameEdit.setText(self.parameters["qtHelpFilterName"])
self.qtHelpFilterAttributesEdit.setText(
- self.parameters['qtHelpFilterAttributes'])
- self.qtHelpTitleEdit.setText(self.parameters['qtHelpTitle'])
+ self.parameters["qtHelpFilterAttributes"]
+ )
+ self.qtHelpTitleEdit.setText(self.parameters["qtHelpTitle"])
self.qtHelpGenerateCollectionCheckBox.setChecked(
- self.parameters['qtHelpCreateCollection'])
-
+ self.parameters["qtHelpCreateCollection"]
+ )
+
def __initializeDefaults(self):
"""
Private method to set the default values.
-
+
These are needed later on to generate the commandline
parameters.
"""
self.defaults = {
- 'useRecursion': False,
- 'noindex': False,
- 'noempty': False,
- 'startDirectory': '',
- 'outputDirectory': '',
- 'ignoreDirectories': [],
- 'ignoreFilePatterns': [],
- 'cssFile': '',
- 'sourceExtensions': [],
-
- 'qtHelpEnabled': False,
- 'qtHelpOutputDirectory': '',
- 'qtHelpNamespace': '',
- 'qtHelpVirtualFolder': 'source',
- 'qtHelpFilterName': 'unknown',
- 'qtHelpFilterAttributes': '',
- 'qtHelpTitle': '',
- 'qtHelpCreateCollection': False,
+ "useRecursion": False,
+ "noindex": False,
+ "noempty": False,
+ "startDirectory": "",
+ "outputDirectory": "",
+ "ignoreDirectories": [],
+ "ignoreFilePatterns": [],
+ "cssFile": "",
+ "sourceExtensions": [],
+ "qtHelpEnabled": False,
+ "qtHelpOutputDirectory": "",
+ "qtHelpNamespace": "",
+ "qtHelpVirtualFolder": "source",
+ "qtHelpFilterName": "unknown",
+ "qtHelpFilterAttributes": "",
+ "qtHelpTitle": "",
+ "qtHelpCreateCollection": False,
}
-
+
def generateParameters(self):
"""
Public method that generates the commandline parameters.
-
+
It generates a list of strings to be used
to set the QProcess arguments for the ericdoc call and
a dictionary containing the non default parameters. This
dictionary can be passed back upon object generation to overwrite
the default settings.
-
+
@return a tuple containing the commandline parameters, non default
parameters and the start directory
@rtype tuple of (list of str, dict, str)
"""
parms = {}
args = []
-
+
# 1. the program name
args.append(Globals.getPythonExecutable())
- args.append(
- Utilities.normabsjoinpath(getConfig('ericDir'), "eric7_doc.py"))
-
+ args.append(Utilities.normabsjoinpath(getConfig("ericDir"), "eric7_doc.py"))
+
# 2. the commandline options
# 2a. general commandline options
- if self.parameters['startDirectory'] != self.defaults['startDirectory']:
- parms['startDirectory'] = self.project.getRelativeUniversalPath(
- self.parameters['startDirectory']
+ if self.parameters["startDirectory"] != self.defaults["startDirectory"]:
+ parms["startDirectory"] = self.project.getRelativeUniversalPath(
+ self.parameters["startDirectory"]
)
else:
- self.parameters['startDirectory'] = self.defaults['startDirectory']
- parms['startDirectory'] = self.parameters['startDirectory']
- if self.parameters['outputDirectory'] != self.defaults['outputDirectory']:
- parms['outputDirectory'] = self.project.getRelativeUniversalPath(
- self.parameters['outputDirectory']
+ self.parameters["startDirectory"] = self.defaults["startDirectory"]
+ parms["startDirectory"] = self.parameters["startDirectory"]
+ if self.parameters["outputDirectory"] != self.defaults["outputDirectory"]:
+ parms["outputDirectory"] = self.project.getRelativeUniversalPath(
+ self.parameters["outputDirectory"]
)
- args.append('-o')
+ args.append("-o")
args.append(
- self.project.getAbsolutePath(self.parameters['outputDirectory'])
+ self.project.getAbsolutePath(self.parameters["outputDirectory"])
)
else:
- self.parameters['outputDirectory'] = self.defaults['outputDirectory']
- parms['outputDirectory'] = self.parameters['outputDirectory']
- if (
- self.parameters['ignoreDirectories'] !=
- self.defaults['ignoreDirectories']
- ):
- parms['ignoreDirectories'] = (
- self.parameters['ignoreDirectories'][:]
- )
- for d in self.parameters['ignoreDirectories']:
- args.append('-x')
+ self.parameters["outputDirectory"] = self.defaults["outputDirectory"]
+ parms["outputDirectory"] = self.parameters["outputDirectory"]
+ if self.parameters["ignoreDirectories"] != self.defaults["ignoreDirectories"]:
+ parms["ignoreDirectories"] = self.parameters["ignoreDirectories"][:]
+ for d in self.parameters["ignoreDirectories"]:
+ args.append("-x")
args.append(d)
- if (
- self.parameters['ignoreFilePatterns'] !=
- self.defaults['ignoreFilePatterns']
- ):
- parms['ignoreFilePatterns'] = (
- self.parameters['ignoreFilePatterns'][:]
- )
- for pattern in self.parameters['ignoreFilePatterns']:
+ if self.parameters["ignoreFilePatterns"] != self.defaults["ignoreFilePatterns"]:
+ parms["ignoreFilePatterns"] = self.parameters["ignoreFilePatterns"][:]
+ for pattern in self.parameters["ignoreFilePatterns"]:
if pattern.strip():
args.append("--exclude-file={0}".format(pattern.strip()))
- if self.parameters['useRecursion'] != self.defaults['useRecursion']:
- parms['useRecursion'] = self.parameters['useRecursion']
- args.append('-r')
- if self.parameters['noindex'] != self.defaults['noindex']:
- parms['noindex'] = self.parameters['noindex']
- args.append('-i')
- if self.parameters['noempty'] != self.defaults['noempty']:
- parms['noempty'] = self.parameters['noempty']
- args.append('-e')
- if (
- self.parameters['sourceExtensions'] !=
- self.defaults['sourceExtensions']
- ):
- parms['sourceExtensions'] = self.parameters['sourceExtensions'][:]
- for ext in self.parameters['sourceExtensions']:
+ if self.parameters["useRecursion"] != self.defaults["useRecursion"]:
+ parms["useRecursion"] = self.parameters["useRecursion"]
+ args.append("-r")
+ if self.parameters["noindex"] != self.defaults["noindex"]:
+ parms["noindex"] = self.parameters["noindex"]
+ args.append("-i")
+ if self.parameters["noempty"] != self.defaults["noempty"]:
+ parms["noempty"] = self.parameters["noempty"]
+ args.append("-e")
+ if self.parameters["sourceExtensions"] != self.defaults["sourceExtensions"]:
+ parms["sourceExtensions"] = self.parameters["sourceExtensions"][:]
+ for ext in self.parameters["sourceExtensions"]:
if ext.strip():
args.append("--extension={0}".format(ext.strip()))
-
+
# 2b. style commandline options
- if self.parameters['cssFile'] != self.defaults['cssFile']:
- cssFile = self.project.getRelativePath(self.parameters['cssFile'])
+ if self.parameters["cssFile"] != self.defaults["cssFile"]:
+ cssFile = self.project.getRelativePath(self.parameters["cssFile"])
if cssFile.startswith(Utilities.getPythonLibraryDirectory()):
cssFile = cssFile.replace(
- Utilities.getPythonLibraryDirectory(), "%PYTHON%")
- parms['cssFile'] = Utilities.fromNativeSeparators(cssFile)
- args.append('-c')
- if os.path.isabs(self.parameters['cssFile']):
- args.append(self.parameters['cssFile'])
+ Utilities.getPythonLibraryDirectory(), "%PYTHON%"
+ )
+ parms["cssFile"] = Utilities.fromNativeSeparators(cssFile)
+ args.append("-c")
+ if os.path.isabs(self.parameters["cssFile"]):
+ args.append(self.parameters["cssFile"])
else:
- args.append(
- os.path.join(self.ppath, self.parameters['cssFile']))
+ args.append(os.path.join(self.ppath, self.parameters["cssFile"]))
for key in self.colors:
if self.colors[key] != eric7docDefaultColors[key]:
parms[key] = self.colors[key]
- args.append("--{0}={1}".format(
- eric7docColorParameterNames[key], self.colors[key]))
-
+ args.append(
+ "--{0}={1}".format(
+ eric7docColorParameterNames[key], self.colors[key]
+ )
+ )
+
# 2c. QtHelp commandline options
- parms['qtHelpEnabled'] = self.parameters['qtHelpEnabled']
- if self.parameters['qtHelpEnabled']:
- args.append('--create-qhp')
+ parms["qtHelpEnabled"] = self.parameters["qtHelpEnabled"]
+ if self.parameters["qtHelpEnabled"]:
+ args.append("--create-qhp")
if (
- self.parameters['qtHelpOutputDirectory'] !=
- self.defaults['qtHelpOutputDirectory']
+ self.parameters["qtHelpOutputDirectory"]
+ != self.defaults["qtHelpOutputDirectory"]
):
- parms['qtHelpOutputDirectory'] = self.project.getRelativeUniversalPath(
- self.parameters['qtHelpOutputDirectory']
+ parms["qtHelpOutputDirectory"] = self.project.getRelativeUniversalPath(
+ self.parameters["qtHelpOutputDirectory"]
)
- if os.path.isabs(self.parameters['outputDirectory']):
- args.append("--qhp-outdir={0}".format(
- self.parameters['qtHelpOutputDirectory'])
+ if os.path.isabs(self.parameters["outputDirectory"]):
+ args.append(
+ "--qhp-outdir={0}".format(self.parameters["qtHelpOutputDirectory"])
)
else:
- args.append("--qhp-outdir={0}".format(
- self.project.getAbsolutePath(
- self.parameters['qtHelpOutputDirectory']
+ args.append(
+ "--qhp-outdir={0}".format(
+ self.project.getAbsolutePath(
+ self.parameters["qtHelpOutputDirectory"]
+ )
)
- ))
+ )
+ if self.parameters["qtHelpNamespace"] != self.defaults["qtHelpNamespace"]:
+ parms["qtHelpNamespace"] = self.parameters["qtHelpNamespace"]
+ args.append(
+ "--qhp-namespace={0}".format(self.parameters["qtHelpNamespace"])
+ )
if (
- self.parameters['qtHelpNamespace'] !=
- self.defaults['qtHelpNamespace']
- ):
- parms['qtHelpNamespace'] = self.parameters['qtHelpNamespace']
- args.append("--qhp-namespace={0}".format(
- self.parameters['qtHelpNamespace']))
- if (
- self.parameters['qtHelpVirtualFolder'] !=
- self.defaults['qtHelpVirtualFolder']
- ):
- parms['qtHelpVirtualFolder'] = (
- self.parameters['qtHelpVirtualFolder']
- )
- args.append("--qhp-virtualfolder={0}".format(
- self.parameters['qtHelpVirtualFolder']))
- if (
- self.parameters['qtHelpFilterName'] !=
- self.defaults['qtHelpFilterName']
+ self.parameters["qtHelpVirtualFolder"]
+ != self.defaults["qtHelpVirtualFolder"]
):
- parms['qtHelpFilterName'] = self.parameters['qtHelpFilterName']
- args.append("--qhp-filtername={0}".format(
- self.parameters['qtHelpFilterName']))
- if (
- self.parameters['qtHelpFilterAttributes'] !=
- self.defaults['qtHelpFilterAttributes']
- ):
- parms['qtHelpFilterAttributes'] = (
- self.parameters['qtHelpFilterAttributes']
+ parms["qtHelpVirtualFolder"] = self.parameters["qtHelpVirtualFolder"]
+ args.append(
+ "--qhp-virtualfolder={0}".format(self.parameters["qtHelpVirtualFolder"])
+ )
+ if self.parameters["qtHelpFilterName"] != self.defaults["qtHelpFilterName"]:
+ parms["qtHelpFilterName"] = self.parameters["qtHelpFilterName"]
+ args.append(
+ "--qhp-filtername={0}".format(self.parameters["qtHelpFilterName"])
)
- args.append("--qhp-filterattribs={0}".format(
- self.parameters['qtHelpFilterAttributes']))
- if self.parameters['qtHelpTitle'] != self.defaults['qtHelpTitle']:
- parms['qtHelpTitle'] = self.parameters['qtHelpTitle']
- args.append("--qhp-title={0}".format(
- self.parameters['qtHelpTitle']))
if (
- self.parameters['qtHelpCreateCollection'] !=
- self.defaults['qtHelpCreateCollection']
+ self.parameters["qtHelpFilterAttributes"]
+ != self.defaults["qtHelpFilterAttributes"]
):
- parms['qtHelpCreateCollection'] = (
- self.parameters['qtHelpCreateCollection']
+ parms["qtHelpFilterAttributes"] = self.parameters["qtHelpFilterAttributes"]
+ args.append(
+ "--qhp-filterattribs={0}".format(
+ self.parameters["qtHelpFilterAttributes"]
+ )
)
- args.append('--create-qhc')
-
+ if self.parameters["qtHelpTitle"] != self.defaults["qtHelpTitle"]:
+ parms["qtHelpTitle"] = self.parameters["qtHelpTitle"]
+ args.append("--qhp-title={0}".format(self.parameters["qtHelpTitle"]))
+ if (
+ self.parameters["qtHelpCreateCollection"]
+ != self.defaults["qtHelpCreateCollection"]
+ ):
+ parms["qtHelpCreateCollection"] = self.parameters["qtHelpCreateCollection"]
+ args.append("--create-qhc")
+
startDir = (
- self.project.getAbsolutePath(self.parameters['startDirectory'])
- if self.parameters['startDirectory'] else
- ""
+ self.project.getAbsolutePath(self.parameters["startDirectory"])
+ if self.parameters["startDirectory"]
+ else ""
)
return args, parms, startDir
-
+
@pyqtSlot(str)
def on_startDirPicker_pathSelected(self, path):
"""
Private slot handling the selection of a start directory.
-
+
@param path path of the start directory
@type str
"""
@@ -354,12 +336,12 @@
while dn.endswith(os.sep):
dn = dn[:-1]
self.startDirPicker.setText(dn)
-
+
@pyqtSlot(str)
def on_outputDirPicker_pathSelected(self, path):
"""
Private slot handling the selection of an output directory.
-
+
@param path path of the output directory
@type str
"""
@@ -368,12 +350,12 @@
while dn.endswith(os.sep):
dn = dn[:-1]
self.outputDirPicker.setText(dn)
-
+
@pyqtSlot(str)
def on_ignoreDirPicker_pathSelected(self, path):
"""
Private slot handling the selection of a directory to be ignored.
-
+
@param path path of the directory to be ignored
@type str
"""
@@ -387,7 +369,7 @@
def on_addButton_clicked(self):
"""
Private slot to add the directory displayed to the listview.
-
+
The directory in the ignore directories
line edit is moved to the listbox above and the edit is cleared.
"""
@@ -403,12 +385,12 @@
"""
itm = self.ignoreDirsList.takeItem(self.ignoreDirsList.currentRow())
del itm
-
+
@pyqtSlot(str)
def on_cssPicker_pathSelected(self, path):
"""
Private slot handling the selection of a css style sheet.
-
+
@param path path of the css style sheet
@type str
"""
@@ -419,7 +401,7 @@
def __selectColor(self, colorKey):
"""
Private method to select a color.
-
+
@param colorKey key of the color to select (string)
"""
color = QColorDialog.getColor(QColor(self.colors[colorKey]))
@@ -432,64 +414,64 @@
"""
Private slot to select the body foreground color.
"""
- self.__selectColor('BodyColor')
-
+ self.__selectColor("BodyColor")
+
@pyqtSlot()
def on_bodyBgButton_clicked(self):
"""
Private slot to select the body background color.
"""
- self.__selectColor('BodyBgColor')
-
+ self.__selectColor("BodyBgColor")
+
@pyqtSlot()
def on_l1FgButton_clicked(self):
"""
Private slot to select the level 1 header foreground color.
"""
- self.__selectColor('Level1HeaderColor')
-
+ self.__selectColor("Level1HeaderColor")
+
@pyqtSlot()
def on_l1BgButton_clicked(self):
"""
Private slot to select the level 1 header background color.
"""
- self.__selectColor('Level1HeaderBgColor')
-
+ self.__selectColor("Level1HeaderBgColor")
+
@pyqtSlot()
def on_l2FgButton_clicked(self):
"""
Private slot to select the level 2 header foreground color.
"""
- self.__selectColor('Level2HeaderColor')
-
+ self.__selectColor("Level2HeaderColor")
+
@pyqtSlot()
def on_l2BgButton_clicked(self):
"""
Private slot to select the level 2 header background color.
"""
- self.__selectColor('Level2HeaderBgColor')
-
+ self.__selectColor("Level2HeaderBgColor")
+
@pyqtSlot()
def on_cfFgButton_clicked(self):
"""
Private slot to select the class/function header foreground color.
"""
- self.__selectColor('CFColor')
-
+ self.__selectColor("CFColor")
+
@pyqtSlot()
def on_cfBgButton_clicked(self):
"""
Private slot to select the class/function header background color.
"""
- self.__selectColor('CFBgColor')
-
+ self.__selectColor("CFBgColor")
+
@pyqtSlot()
def on_linkFgButton_clicked(self):
"""
Private slot to select the foreground color of links.
"""
- self.__selectColor('LinkColor')
-
+ self.__selectColor("LinkColor")
+
def __checkQtHelpOptions(self):
"""
Private slot to check the QtHelp options and set the ok button
@@ -502,55 +484,55 @@
if not self.qtHelpFolderEdit.text():
setOn = False
else:
- if '/' in self.qtHelpFolderEdit.text():
+ if "/" in self.qtHelpFolderEdit.text():
setOn = False
if not self.qtHelpTitleEdit.text():
setOn = False
-
+
self.__okButton.setEnabled(setOn)
-
+
@pyqtSlot(bool)
def on_qtHelpGroup_toggled(self, enabled):
"""
Private slot to toggle the generation of QtHelp files.
-
+
@param enabled flag indicating the state (boolean)
"""
self.__checkQtHelpOptions()
-
+
@pyqtSlot(str)
def on_qtHelpNamespaceEdit_textChanged(self, txt):
"""
Private slot to check the namespace.
-
+
@param txt text of the line edit (string)
"""
self.__checkQtHelpOptions()
-
+
@pyqtSlot(str)
def on_qtHelpFolderEdit_textChanged(self, txt):
"""
Private slot to check the virtual folder.
-
+
@param txt text of the line edit (string)
"""
self.__checkQtHelpOptions()
-
+
@pyqtSlot(str)
def on_qtHelpTitleEdit_textChanged(self, txt):
"""
Private slot to check the title.
-
+
@param txt text of the line edit (string)
"""
self.__checkQtHelpOptions()
-
+
@pyqtSlot(str)
def on_qtHelpDirPicker_pathSelected(self, path):
"""
Private slot handling the selection of the output directory for the
QtHelp files.
-
+
@param path path of the the output directory for the QtHelp files
@type str
"""
@@ -559,61 +541,60 @@
while dn.endswith(os.sep):
dn = dn[:-1]
self.qtHelpDirPicker.setText(dn)
-
+
def accept(self):
"""
Public slot called by the Ok button.
-
+
It saves the values in the parameters dictionary.
"""
- self.parameters['useRecursion'] = self.recursionCheckBox.isChecked()
- self.parameters['noindex'] = self.noindexCheckBox.isChecked()
- self.parameters['noempty'] = self.noemptyCheckBox.isChecked()
-
+ self.parameters["useRecursion"] = self.recursionCheckBox.isChecked()
+ self.parameters["noindex"] = self.noindexCheckBox.isChecked()
+ self.parameters["noempty"] = self.noemptyCheckBox.isChecked()
+
startdir = self.startDirPicker.text()
if startdir:
startdir = os.path.normpath(startdir)
if startdir.endswith(os.sep):
startdir = startdir[:-1]
self.parameters["startDirectory"] = startdir
-
+
outdir = self.outputDirPicker.text()
if outdir:
outdir = os.path.normpath(outdir)
if outdir.endswith(os.sep):
outdir = outdir[:-1]
- self.parameters['outputDirectory'] = outdir
-
- self.parameters['ignoreDirectories'] = []
+ self.parameters["outputDirectory"] = outdir
+
+ self.parameters["ignoreDirectories"] = []
for row in range(0, self.ignoreDirsList.count()):
itm = self.ignoreDirsList.item(row)
- self.parameters['ignoreDirectories'].append(
- os.path.normpath(itm.text()))
+ self.parameters["ignoreDirectories"].append(os.path.normpath(itm.text()))
cssFile = self.cssPicker.text()
- if cssFile != '':
+ if cssFile != "":
cssFile = os.path.normpath(cssFile)
- self.parameters['cssFile'] = cssFile
- extensions = self.sourceExtEdit.text().split(',')
- self.parameters['sourceExtensions'] = [
+ self.parameters["cssFile"] = cssFile
+ extensions = self.sourceExtEdit.text().split(",")
+ self.parameters["sourceExtensions"] = [
ext.strip() for ext in extensions if ext.strip()
]
- patterns = self.excludeFilesEdit.text().split(',')
- self.parameters['ignoreFilePatterns'] = [
+ patterns = self.excludeFilesEdit.text().split(",")
+ self.parameters["ignoreFilePatterns"] = [
pattern.strip() for pattern in patterns if pattern.strip()
]
-
- self.parameters['qtHelpEnabled'] = self.qtHelpGroup.isChecked()
- self.parameters['qtHelpOutputDirectory'] = self.qtHelpDirPicker.text()
- self.parameters['qtHelpNamespace'] = self.qtHelpNamespaceEdit.text()
- self.parameters['qtHelpVirtualFolder'] = self.qtHelpFolderEdit.text()
- self.parameters['qtHelpFilterName'] = self.qtHelpFilterNameEdit.text()
- self.parameters['qtHelpFilterAttributes'] = (
- self.qtHelpFilterAttributesEdit.text()
- )
- self.parameters['qtHelpTitle'] = self.qtHelpTitleEdit.text()
- self.parameters['qtHelpCreateCollection'] = (
- self.qtHelpGenerateCollectionCheckBox.isChecked()
- )
-
+
+ self.parameters["qtHelpEnabled"] = self.qtHelpGroup.isChecked()
+ self.parameters["qtHelpOutputDirectory"] = self.qtHelpDirPicker.text()
+ self.parameters["qtHelpNamespace"] = self.qtHelpNamespaceEdit.text()
+ self.parameters["qtHelpVirtualFolder"] = self.qtHelpFolderEdit.text()
+ self.parameters["qtHelpFilterName"] = self.qtHelpFilterNameEdit.text()
+ self.parameters[
+ "qtHelpFilterAttributes"
+ ] = self.qtHelpFilterAttributesEdit.text()
+ self.parameters["qtHelpTitle"] = self.qtHelpTitleEdit.text()
+ self.parameters[
+ "qtHelpCreateCollection"
+ ] = self.qtHelpGenerateCollectionCheckBox.isChecked()
+
# call the accept slot of the base class
super().accept()
