RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ExtractDialog.html

Mon, 02 Apr 2018 17:43:26 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Mon, 02 Apr 2018 17:43:26 +0200
changeset 252
8b30a1612f8c
parent 204
b4bf79b956bc
child 321
d51e810107ec
permissions
-rw-r--r--

Updated source docu.

44
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 24
diff changeset
1 <!DOCTYPE html>
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>Plugin_Refactoring_Rope.RefactoringRope.ExtractDialog</title>
44
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 24
diff changeset
4 <meta charset="UTF-8">
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 h1 { color: white; background: #85774A; }
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h2 { color: white; background: #85774A; }
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h3 { color: white; background: #9D936E; }
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h4 { color: white; background: #9D936E; }
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <body><a NAME="top" ID="top"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <h1>Plugin_Refactoring_Rope.RefactoringRope.ExtractDialog</h1>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 Module implementing the Extract dialog.
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 </p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 <h3>Global Attributes</h3>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <tr><td>None</td></tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 </table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <h3>Classes</h3>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <td><a href="#ExtractDialog">ExtractDialog</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 <td>Class implementing the Extract dialog.</td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 </tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 </table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <h3>Functions</h3>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <tr><td>None</td></tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 </table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 <hr /><hr />
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <a NAME="ExtractDialog" ID="ExtractDialog"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <h2>ExtractDialog</h2>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 Class implementing the Extract dialog.
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 </p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <h3>Derived from</h3>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 RefactoringDialogBase, Ui_ExtractDialog
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <h3>Class Attributes</h3>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 <tr><td>None</td></tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 </table>
44
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 24
diff changeset
53 <h3>Class Methods</h3>
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 24
diff changeset
54 <table>
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 24
diff changeset
55 <tr><td>None</td></tr>
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 24
diff changeset
56 </table>
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <h3>Methods</h3>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 <table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 <td><a href="#ExtractDialog.__init__">ExtractDialog</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 <td>Constructor</td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 </tr><tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 <td><a href="#ExtractDialog._calculateChanges">_calculateChanges</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <td>Protected method to calculate the changes.</td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 </tr><tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 <td><a href="#ExtractDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 <td>Private slot to act on the button pressed.</td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 </tr><tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 <td><a href="#ExtractDialog.on_newNameEdit_textChanged">on_newNameEdit_textChanged</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 <td>Private slot to react to changes of the new name.</td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 </tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 </table>
44
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 24
diff changeset
73 <h3>Static Methods</h3>
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 24
diff changeset
74 <table>
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 24
diff changeset
75 <tr><td>None</td></tr>
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 24
diff changeset
76 </table>
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 <a NAME="ExtractDialog.__init__" ID="ExtractDialog.__init__"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 <h4>ExtractDialog (Constructor)</h4>
204
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
79 <b>ExtractDialog</b>(<i>refactoring, title, filename, startOffset, endOffset, extractionType, parent=None</i>)
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 Constructor
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82 </p><dl>
204
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
83 <dt><i>refactoring</i> (RefactoringServer)</dt>
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 <dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 reference to the main refactoring object
204
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
86 </dd><dt><i>title</i> (str)</dt>
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <dd>
204
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
88 title of the dialog
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
89 </dd><dt><i>filename</i> (str)</dt>
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
90 <dd>
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
91 file name to be worked on
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
92 </dd><dt><i>startOffset</i> (int)</dt>
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 <dd>
204
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
94 offset within file to start extraction
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
95 </dd><dt><i>endOffset</i> (int)</dt>
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 <dd>
204
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
97 offset within file to end extraction
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
98 </dd><dt><i>extractionType</i> (str)</dt>
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
99 <dd>
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
100 type of extraction to be performed
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
101 </dd><dt><i>parent</i> (QWidget)</dt>
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
102 <dd>
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
103 reference to the parent widget
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 </dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 </dl><a NAME="ExtractDialog._calculateChanges" ID="ExtractDialog._calculateChanges"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 <h4>ExtractDialog._calculateChanges</h4>
204
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
107 <b>_calculateChanges</b>(<i></i>)
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 Protected method to calculate the changes.
204
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
110 </p><a NAME="ExtractDialog.on_buttonBox_clicked" ID="ExtractDialog.on_buttonBox_clicked"></a>
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 <h4>ExtractDialog.on_buttonBox_clicked</h4>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 <b>on_buttonBox_clicked</b>(<i>button</i>)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 Private slot to act on the button pressed.
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115 </p><dl>
204
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
116 <dt><i>button</i> (QAbstractButton)</dt>
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
117 <dd>
204
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
118 reference to the button pressed
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
119 </dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
120 </dl><a NAME="ExtractDialog.on_newNameEdit_textChanged" ID="ExtractDialog.on_newNameEdit_textChanged"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
121 <h4>ExtractDialog.on_newNameEdit_textChanged</h4>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
122 <b>on_newNameEdit_textChanged</b>(<i>text</i>)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
123 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
124 Private slot to react to changes of the new name.
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
125 </p><dl>
204
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
126 <dt><i>text</i> (str)</dt>
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
127 <dd>
204
b4bf79b956bc Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
128 text entered into the edit
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
129 </dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
130 </dl>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
131 <div align="right"><a href="#top">Up</a></div>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
132 <hr />
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
133 </body></html>

eric ide

mercurial