Fri, 29 Sep 2017 10:32:30 +0200
Regenerated source documentation.
5
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1 | # -*- coding: utf-8 -*- |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
2 | |
147
3f8a995f6e49
Updated copyright for 2017.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
144
diff
changeset
|
3 | # Copyright (c) 2010 - 2017 Detlev Offenbach <detlev@die-offenbachs.de> |
5
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
4 | # |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
5 | |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
6 | """ |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
7 | Module implementing the Extract dialog. |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
8 | """ |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
9 | |
76 | 10 | from __future__ import unicode_literals |
50
a29c3d2e6dc0
rope for Python2 projects enabled, if running on Python2
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
43
diff
changeset
|
11 | |
87
1fbf5fdbe721
Ported to PyQt5 and eric6.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
76
diff
changeset
|
12 | from PyQt5.QtCore import pyqtSlot |
1fbf5fdbe721
Ported to PyQt5 and eric6.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
76
diff
changeset
|
13 | from PyQt5.QtWidgets import QDialogButtonBox, QAbstractButton |
5
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
14 | |
203
c38750e1bafd
Performed some code cleanup actions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
189
diff
changeset
|
15 | from .Ui_ExtractDialog import Ui_ExtractDialog |
c38750e1bafd
Performed some code cleanup actions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
189
diff
changeset
|
16 | from .RefactoringDialogBase import RefactoringDialogBase |
5
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
17 | |
20
83b71483e198
Made the code PEP-8 compliant.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9
diff
changeset
|
18 | |
5
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
19 | class ExtractDialog(RefactoringDialogBase, Ui_ExtractDialog): |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
20 | """ |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
21 | Class implementing the Extract dialog. |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
22 | """ |
175
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
23 | def __init__(self, refactoring, title, filename, startOffset, endOffset, |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
24 | extractionType, parent=None): |
5
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25 | """ |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
26 | Constructor |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
27 | |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
28 | @param refactoring reference to the main refactoring object |
189
2711fdd91925
Renamed the 'Refactoring' module and class 'RefactoringServer'.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
177
diff
changeset
|
29 | @type RefactoringServer |
175
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
30 | @param title title of the dialog |
204
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
203
diff
changeset
|
31 | @type str |
175
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
32 | @param filename file name to be worked on |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
33 | @type str |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
34 | @param startOffset offset within file to start extraction |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
35 | @type int |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
36 | @param endOffset offset within file to end extraction |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
37 | @type int |
203
c38750e1bafd
Performed some code cleanup actions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
189
diff
changeset
|
38 | @param extractionType type of extraction to be performed |
c38750e1bafd
Performed some code cleanup actions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
189
diff
changeset
|
39 | @type str |
175
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
40 | @param parent reference to the parent widget |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
41 | @type QWidget |
5
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
42 | """ |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
43 | RefactoringDialogBase.__init__(self, refactoring, title, parent) |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
44 | self.setupUi(self) |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
45 | |
175
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
46 | self._changeGroupName = "Extract" |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
47 | |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
48 | self.__filename = filename |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
49 | self.__startOffset = startOffset |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
50 | self.__endOffset = endOffset |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
51 | self.__extractionType = extractionType |
5
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
52 | |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
53 | self.__okButton = self.buttonBox.button(QDialogButtonBox.Ok) |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
54 | self.__okButton.setEnabled(False) |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
55 | self.__previewButton = self.buttonBox.addButton( |
87
1fbf5fdbe721
Ported to PyQt5 and eric6.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
76
diff
changeset
|
56 | self.tr("Preview"), QDialogButtonBox.ActionRole) |
5
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
57 | self.__previewButton.setDefault(True) |
177
963fc1b0ba6e
Fixed an issue related to the enable state of the Preview button and some code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
175
diff
changeset
|
58 | self.__previewButton.setEnabled(False) |
74
0973b175e2ad
Fixed a window sizing issue.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
62
diff
changeset
|
59 | |
0973b175e2ad
Fixed a window sizing issue.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
62
diff
changeset
|
60 | msh = self.minimumSizeHint() |
0973b175e2ad
Fixed a window sizing issue.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
62
diff
changeset
|
61 | self.resize(max(self.width(), msh.width()), msh.height()) |
5
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
62 | |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
63 | @pyqtSlot(str) |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
64 | def on_newNameEdit_textChanged(self, text): |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
65 | """ |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
66 | Private slot to react to changes of the new name. |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
67 | |
175
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
68 | @param text text entered into the edit |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
69 | @type str |
5
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
70 | """ |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
71 | self.__okButton.setEnabled(text != "") |
177
963fc1b0ba6e
Fixed an issue related to the enable state of the Preview button and some code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
175
diff
changeset
|
72 | self.__previewButton.setEnabled(text != "") |
5
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
73 | |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
74 | @pyqtSlot(QAbstractButton) |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
75 | def on_buttonBox_clicked(self, button): |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
76 | """ |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
77 | Private slot to act on the button pressed. |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
78 | |
175
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
79 | @param button reference to the button pressed |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
80 | @type QAbstractButton |
5
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
81 | """ |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
82 | if button == self.__previewButton: |
175
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
83 | self.requestPreview() |
5
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
84 | elif button == self.__okButton: |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
85 | self.applyChanges() |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
86 | |
175
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
87 | def _calculateChanges(self): |
5
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
88 | """ |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
89 | Protected method to calculate the changes. |
49a4abfc1f89
Added the extract refactoring functions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
90 | """ |
175
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
91 | self._refactoring.sendJson("CalculateExtractChanges", { |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
92 | "ChangeGroup": self._changeGroupName, |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
93 | "Title": self._title, |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
94 | "FileName": self.__filename, |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
95 | "StartOffset": self.__startOffset, |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
96 | "EndOffset": self.__endOffset, |
203
c38750e1bafd
Performed some code cleanup actions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
189
diff
changeset
|
97 | "Kind": self.__extractionType, |
175
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
98 | "NewName": self.newNameEdit.text(), |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
99 | "Similar": self.similarCheckBox.isChecked(), |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
100 | "Global": self.globalCheckBox.isChecked(), |
72a1d9030d67
Implemented the distributed "Extract" method.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
147
diff
changeset
|
101 | }) |