RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.MoveDialog.html

branch
server_client_variant
changeset 204
b4bf79b956bc
child 321
d51e810107ec
equal deleted inserted replaced
203:c38750e1bafd 204:b4bf79b956bc
1 <!DOCTYPE html>
2 <html><head>
3 <title>Plugin_Refactoring_Rope.RefactoringRope.MoveDialog</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>Plugin_Refactoring_Rope.RefactoringRope.MoveDialog</h1>
23 <p>
24 Module implementing the Move Method or Module dialog.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#MoveDialog">MoveDialog</a></td>
34 <td>Class implementing the Move Method or Module dialog.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="MoveDialog" ID="MoveDialog"></a>
43 <h2>MoveDialog</h2>
44 <p>
45 Class implementing the Move Method or Module dialog.
46 </p>
47 <h3>Derived from</h3>
48 RefactoringDialogBase, Ui_MoveDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#MoveDialog.__init__">MoveDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#MoveDialog.__checkDestination">__checkDestination</a></td>
64 <td>Private method to check the destination entered.</td>
65 </tr><tr>
66 <td><a href="#MoveDialog.__processMoveType">__processMoveType</a></td>
67 <td>Private method to process the move type data sent by the refactoring client in order to polish the dialog.</td>
68 </tr><tr>
69 <td><a href="#MoveDialog.__updateUI">__updateUI</a></td>
70 <td>Private method to perform various UI updates.</td>
71 </tr><tr>
72 <td><a href="#MoveDialog._calculateChanges">_calculateChanges</a></td>
73 <td>Protected method to initiate the calculation of the changes.</td>
74 </tr><tr>
75 <td><a href="#MoveDialog.on_attributeEdit_textChanged">on_attributeEdit_textChanged</a></td>
76 <td>Private slot to react to changes of the attribute.</td>
77 </tr><tr>
78 <td><a href="#MoveDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
79 <td>Private slot to act on the button pressed.</td>
80 </tr><tr>
81 <td><a href="#MoveDialog.on_destinationEdit_textChanged">on_destinationEdit_textChanged</a></td>
82 <td>Private slot to react to changes of the destination module.</td>
83 </tr><tr>
84 <td><a href="#MoveDialog.on_methodEdit_textChanged">on_methodEdit_textChanged</a></td>
85 <td>Private slot to react to changes of the method.</td>
86 </tr><tr>
87 <td><a href="#MoveDialog.on_selectButton_clicked">on_selectButton_clicked</a></td>
88 <td>Private slot called to select the destination module via a file selection dialog.</td>
89 </tr><tr>
90 <td><a href="#MoveDialog.processChangeData">processChangeData</a></td>
91 <td>Public method to process the change data sent by the refactoring client.</td>
92 </tr>
93 </table>
94 <h3>Static Methods</h3>
95 <table>
96 <tr><td>None</td></tr>
97 </table>
98 <a NAME="MoveDialog.__init__" ID="MoveDialog.__init__"></a>
99 <h4>MoveDialog (Constructor)</h4>
100 <b>MoveDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>)
101 <p>
102 Constructor
103 </p><dl>
104 <dt><i>refactoring</i> (RefactoringServer)</dt>
105 <dd>
106 reference to the main refactoring object
107 </dd><dt><i>title</i> (str)</dt>
108 <dd>
109 title of the dialog
110 </dd><dt><i>filename</i> (str)</dt>
111 <dd>
112 file name to be worked on
113 </dd><dt><i>offset</i> (int or None)</dt>
114 <dd>
115 offset within file
116 </dd><dt><i>parent</i> (QWidget)</dt>
117 <dd>
118 reference to the parent widget
119 </dd>
120 </dl><a NAME="MoveDialog.__checkDestination" ID="MoveDialog.__checkDestination"></a>
121 <h4>MoveDialog.__checkDestination</h4>
122 <b>__checkDestination</b>(<i></i>)
123 <p>
124 Private method to check the destination entered.
125 </p><dl>
126 <dt>Returns:</dt>
127 <dd>
128 flag indicating a valid entry
129 </dd>
130 </dl><dl>
131 <dt>Return Type:</dt>
132 <dd>
133 bool
134 </dd>
135 </dl><a NAME="MoveDialog.__processMoveType" ID="MoveDialog.__processMoveType"></a>
136 <h4>MoveDialog.__processMoveType</h4>
137 <b>__processMoveType</b>(<i>data</i>)
138 <p>
139 Private method to process the move type data sent by the refactoring
140 client in order to polish the dialog.
141 </p><dl>
142 <dt><i>data</i> (dict)</dt>
143 <dd>
144 dictionary containing the move type data
145 </dd>
146 </dl><a NAME="MoveDialog.__updateUI" ID="MoveDialog.__updateUI"></a>
147 <h4>MoveDialog.__updateUI</h4>
148 <b>__updateUI</b>(<i></i>)
149 <p>
150 Private method to perform various UI updates.
151 </p><a NAME="MoveDialog._calculateChanges" ID="MoveDialog._calculateChanges"></a>
152 <h4>MoveDialog._calculateChanges</h4>
153 <b>_calculateChanges</b>(<i></i>)
154 <p>
155 Protected method to initiate the calculation of the changes.
156 </p><a NAME="MoveDialog.on_attributeEdit_textChanged" ID="MoveDialog.on_attributeEdit_textChanged"></a>
157 <h4>MoveDialog.on_attributeEdit_textChanged</h4>
158 <b>on_attributeEdit_textChanged</b>(<i>text</i>)
159 <p>
160 Private slot to react to changes of the attribute.
161 </p><dl>
162 <dt><i>text</i> (str)</dt>
163 <dd>
164 text entered into the edit
165 </dd>
166 </dl><a NAME="MoveDialog.on_buttonBox_clicked" ID="MoveDialog.on_buttonBox_clicked"></a>
167 <h4>MoveDialog.on_buttonBox_clicked</h4>
168 <b>on_buttonBox_clicked</b>(<i>button</i>)
169 <p>
170 Private slot to act on the button pressed.
171 </p><dl>
172 <dt><i>button</i> (QAbstractButton)</dt>
173 <dd>
174 reference to the button pressed
175 </dd>
176 </dl><a NAME="MoveDialog.on_destinationEdit_textChanged" ID="MoveDialog.on_destinationEdit_textChanged"></a>
177 <h4>MoveDialog.on_destinationEdit_textChanged</h4>
178 <b>on_destinationEdit_textChanged</b>(<i>text</i>)
179 <p>
180 Private slot to react to changes of the destination module.
181 </p><dl>
182 <dt><i>text</i> (str)</dt>
183 <dd>
184 text entered into the edit
185 </dd>
186 </dl><a NAME="MoveDialog.on_methodEdit_textChanged" ID="MoveDialog.on_methodEdit_textChanged"></a>
187 <h4>MoveDialog.on_methodEdit_textChanged</h4>
188 <b>on_methodEdit_textChanged</b>(<i>text</i>)
189 <p>
190 Private slot to react to changes of the method.
191 </p><dl>
192 <dt><i>text</i> (str)</dt>
193 <dd>
194 text entered into the edit
195 </dd>
196 </dl><a NAME="MoveDialog.on_selectButton_clicked" ID="MoveDialog.on_selectButton_clicked"></a>
197 <h4>MoveDialog.on_selectButton_clicked</h4>
198 <b>on_selectButton_clicked</b>(<i></i>)
199 <p>
200 Private slot called to select the destination module via a file
201 selection dialog.
202 </p><a NAME="MoveDialog.processChangeData" ID="MoveDialog.processChangeData"></a>
203 <h4>MoveDialog.processChangeData</h4>
204 <b>processChangeData</b>(<i>data</i>)
205 <p>
206 Public method to process the change data sent by the refactoring
207 client.
208 </p><dl>
209 <dt><i>data</i> (dict)</dt>
210 <dd>
211 dictionary containing the change data
212 </dd>
213 </dl>
214 <div align="right"><a href="#top">Up</a></div>
215 <hr />
216 </body></html>

eric ide

mercurial