--- a/src/eric7/Plugins/WizardPlugins/QRegularExpressionWizard/QRegularExpressionWizardDialog.py Fri Dec 22 17:24:07 2023 +0100
+++ b/src/eric7/Plugins/WizardPlugins/QRegularExpressionWizard/QRegularExpressionWizardDialog.py Fri Dec 22 19:45:17 2023 +0100
@@ -42,8 +42,10 @@
"""
Constructor
- @param parent parent widget (QWidget)
+ @param parent parent widget
+ @type QWidget
@param fromEric flag indicating a call from within eric
+ @type bool
"""
super().__init__(parent)
self.setupUi(self)
@@ -142,10 +144,12 @@
"""
Private method to send a command to the server.
- @param command dictionary with command string and related
- data (dict)
+ @param command dictionary with command string and related data
+ @type dict
@keyparam kw parameters for the command
- @return flag indicating a successful transmission (boolean)
+ @type dict
+ @return flag indicating a successful transmission
+ @rtype bool
"""
result = False
if command:
@@ -161,7 +165,8 @@
"""
Private method to receive a response from the server.
- @return response dictionary (dict)
+ @return response dictionary
+ @rtype dict
"""
responseDict = {}
if self.__pyqt6Server.waitForReadyRead(10000):
@@ -192,9 +197,10 @@
Private method to insert a string into line edit and move cursor.
@param s string to be inserted into the regexp line edit
- (string)
- @param steps number of characters to move the cursor (integer).
- Negative steps moves cursor back, positives forward.
+ @type str
+ @param steps number of characters to move the cursor. Negative steps
+ move cursor back, positive steps forward.
+ @type int
"""
self.regexpTextEdit.insertPlainText(s)
tc = self.regexpTextEdit.textCursor()
@@ -388,7 +394,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.validateButton:
self.on_validateButton_clicked()
@@ -569,6 +576,7 @@
test data and will display the result in the table part of the dialog.
@param startpos starting position for the QRegularExpression matching
+ @type int
"""
if not self.__pyqt6Available:
# only available for PyQt6
@@ -756,9 +764,12 @@
"""
Public method to get the source code.
- @param indLevel indentation level (int)
- @param indString string used for indentation (space or tab) (string)
- @return generated code (string)
+ @param indLevel indentation level
+ @type int
+ @param indString string used for indentation (space or tab)
+ @type str
+ @return generated code
+ @rtype str
"""
# calculate the indentation string
i1string = (indLevel + 1) * indString
@@ -815,8 +826,10 @@
"""
Constructor
- @param parent parent widget (QWidget)
+ @param parent parent widget
+ @type QWidget
@param fromEric flag indicating a call from within eric
+ @type bool
"""
super().__init__(parent)
self.setModal(fromEric)
@@ -839,9 +852,12 @@
"""
Public method to get the source code.
- @param indLevel indentation level (int)
- @param indString string used for indentation (space or tab) (string)
- @return generated code (string)
+ @param indLevel indentation level
+ @type int
+ @param indString string used for indentation (space or tab)
+ @type str
+ @return generated code
+ @rtype str
"""
return self.cw.getCode(indLevel, indString)
@@ -869,7 +885,8 @@
"""
Constructor
- @param parent reference to the parent widget (QWidget)
+ @param parent reference to the parent widget
+ @type QWidget
"""
super().__init__(parent)
self.cw = QRegularExpressionWizardWidget(self, fromEric=False)
@@ -887,7 +904,8 @@
"""
Protected method handling the close event.
- @param evt close event (QCloseEvent)
+ @param evt close event
+ @type QCloseEvent
"""
self.cw.shutdown()
super().closeEvent(evt)
