Mercurial Repositories > Rope Refactoring / file comparison

comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase.html

RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase.html

branch
eric7
changeset 416
45159308166f
parent 375
c61a2f18ed78
equal deleted inserted replaced
415:78af27bb8201 416:45159308166f
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase</h1> 9 <h1>Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase</h1>
10
11 <p> 10 <p>
12 Module implementing the Refactoring dialog base class. 11 Module implementing the Refactoring dialog base class.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#RefactoringDialogBase">RefactoringDialogBase</a></td> 22 <td><a href="#RefactoringDialogBase">RefactoringDialogBase</a></td>
25 <td>Class implementing the Refactoring dialog base class.</td> 23 <td>Class implementing the Refactoring dialog base class.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="RefactoringDialogBase" ID="RefactoringDialogBase"></a> 34 <a NAME="RefactoringDialogBase" ID="RefactoringDialogBase"></a>
36 <h2>RefactoringDialogBase</h2> 35 <h2>RefactoringDialogBase</h2>
37
38 <p> 36 <p>
39 Class implementing the Refactoring dialog base class. 37 Class implementing the Refactoring dialog base class.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QDialog 41 QDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>None</td></tr>
46 <tr><td>None</td></tr> 45 </table>
47 </table> 46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#RefactoringDialogBase.__init__">RefactoringDialogBase</a></td> 55 <td><a href="#RefactoringDialogBase.__init__">RefactoringDialogBase</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
85 <tr> 82 <tr>
86 <td><a href="#RefactoringDialogBase.requestPreview">requestPreview</a></td> 83 <td><a href="#RefactoringDialogBase.requestPreview">requestPreview</a></td>
87 <td>Public method to request a preview of the calculated changes.</td> 84 <td>Public method to request a preview of the calculated changes.</td>
88 </tr> 85 </tr>
89 </table> 86 </table>
87
90 <h3>Static Methods</h3> 88 <h3>Static Methods</h3>
91 89 <table>
92 <table> 90 <tr><td>None</td></tr>
93 <tr><td>None</td></tr> 91 </table>
94 </table> 92
95 93
96 <a NAME="RefactoringDialogBase.__init__" ID="RefactoringDialogBase.__init__"></a> 94 <a NAME="RefactoringDialogBase.__init__" ID="RefactoringDialogBase.__init__"></a>
97 <h4>RefactoringDialogBase (Constructor)</h4> 95 <h4>RefactoringDialogBase (Constructor)</h4>
98 <b>RefactoringDialogBase</b>(<i>refactoring, title, parent=None</i>) 96 <b>RefactoringDialogBase</b>(<i>refactoring, title, parent=None</i>)
99
100 <p> 97 <p>
101 Constructor 98 Constructor
102 </p> 99 </p>
100
103 <dl> 101 <dl>
104 102
105 <dt><i>refactoring</i> (RefactoringServer)</dt> 103 <dt><i>refactoring</i> (RefactoringServer)</dt>
106 <dd> 104 <dd>
107 reference to the main refactoring object 105 reference to the main refactoring object
116 </dd> 114 </dd>
117 </dl> 115 </dl>
118 <a NAME="RefactoringDialogBase._calculateChanges" ID="RefactoringDialogBase._calculateChanges"></a> 116 <a NAME="RefactoringDialogBase._calculateChanges" ID="RefactoringDialogBase._calculateChanges"></a>
119 <h4>RefactoringDialogBase._calculateChanges</h4> 117 <h4>RefactoringDialogBase._calculateChanges</h4>
120 <b>_calculateChanges</b>(<i></i>) 118 <b>_calculateChanges</b>(<i></i>)
121
122 <p> 119 <p>
123 Protected method to initiate the calculation of changes. 120 Protected method to initiate the calculation of changes.
124 </p> 121 </p>
122
125 <dl> 123 <dl>
126 124
127 <dt>Raises <b>NotImplementedError</b>:</dt> 125 <dt>Raises <b>NotImplementedError</b>:</dt>
128 <dd> 126 <dd>
129 raised to indicate that this method must 127 raised to indicate that this method must
131 </dd> 129 </dd>
132 </dl> 130 </dl>
133 <a NAME="RefactoringDialogBase.applyChanges" ID="RefactoringDialogBase.applyChanges"></a> 131 <a NAME="RefactoringDialogBase.applyChanges" ID="RefactoringDialogBase.applyChanges"></a>
134 <h4>RefactoringDialogBase.applyChanges</h4> 132 <h4>RefactoringDialogBase.applyChanges</h4>
135 <b>applyChanges</b>(<i></i>) 133 <b>applyChanges</b>(<i></i>)
136
137 <p> 134 <p>
138 Public method to apply the changes. 135 Public method to apply the changes.
139 </p> 136 </p>
137
140 <a NAME="RefactoringDialogBase.closeEvent" ID="RefactoringDialogBase.closeEvent"></a> 138 <a NAME="RefactoringDialogBase.closeEvent" ID="RefactoringDialogBase.closeEvent"></a>
141 <h4>RefactoringDialogBase.closeEvent</h4> 139 <h4>RefactoringDialogBase.closeEvent</h4>
142 <b>closeEvent</b>(<i>evt</i>) 140 <b>closeEvent</b>(<i>evt</i>)
143
144 <p> 141 <p>
145 Protected method handling close events. 142 Protected method handling close events.
146 </p> 143 </p>
144
147 <dl> 145 <dl>
148 146
149 <dt><i>evt</i> (QCloseEvent)</dt> 147 <dt><i>evt</i> (QCloseEvent)</dt>
150 <dd> 148 <dd>
151 reference to the close event object 149 reference to the close event object
152 </dd> 150 </dd>
153 </dl> 151 </dl>
154 <a NAME="RefactoringDialogBase.getChangeGroupName" ID="RefactoringDialogBase.getChangeGroupName"></a> 152 <a NAME="RefactoringDialogBase.getChangeGroupName" ID="RefactoringDialogBase.getChangeGroupName"></a>
155 <h4>RefactoringDialogBase.getChangeGroupName</h4> 153 <h4>RefactoringDialogBase.getChangeGroupName</h4>
156 <b>getChangeGroupName</b>(<i></i>) 154 <b>getChangeGroupName</b>(<i></i>)
157
158 <p> 155 <p>
159 Public method to get the name of the change group. 156 Public method to get the name of the change group.
160 </p> 157 </p>
158
161 <dl> 159 <dl>
162 <dt>Return:</dt> 160 <dt>Return:</dt>
163 <dd> 161 <dd>
164 name of the associated change group 162 name of the associated change group
165 </dd> 163 </dd>
171 </dd> 169 </dd>
172 </dl> 170 </dl>
173 <a NAME="RefactoringDialogBase.previewChanges" ID="RefactoringDialogBase.previewChanges"></a> 171 <a NAME="RefactoringDialogBase.previewChanges" ID="RefactoringDialogBase.previewChanges"></a>
174 <h4>RefactoringDialogBase.previewChanges</h4> 172 <h4>RefactoringDialogBase.previewChanges</h4>
175 <b>previewChanges</b>(<i>data</i>) 173 <b>previewChanges</b>(<i>data</i>)
176
177 <p> 174 <p>
178 Public method to preview the changes. 175 Public method to preview the changes.
179 </p> 176 </p>
177
180 <dl> 178 <dl>
181 179
182 <dt><i>data</i> (dict)</dt> 180 <dt><i>data</i> (dict)</dt>
183 <dd> 181 <dd>
184 dictionary containing the change data 182 dictionary containing the change data
185 </dd> 183 </dd>
186 </dl> 184 </dl>
187 <a NAME="RefactoringDialogBase.processChangeData" ID="RefactoringDialogBase.processChangeData"></a> 185 <a NAME="RefactoringDialogBase.processChangeData" ID="RefactoringDialogBase.processChangeData"></a>
188 <h4>RefactoringDialogBase.processChangeData</h4> 186 <h4>RefactoringDialogBase.processChangeData</h4>
189 <b>processChangeData</b>(<i>data</i>) 187 <b>processChangeData</b>(<i>data</i>)
190
191 <p> 188 <p>
192 Public method to process the change data sent by the refactoring 189 Public method to process the change data sent by the refactoring
193 client. 190 client.
194 </p> 191 </p>
192
195 <dl> 193 <dl>
196 194
197 <dt><i>data</i> (dict)</dt> 195 <dt><i>data</i> (dict)</dt>
198 <dd> 196 <dd>
199 dictionary containing the change data 197 dictionary containing the change data
200 </dd> 198 </dd>
201 </dl> 199 </dl>
202 <a NAME="RefactoringDialogBase.requestPreview" ID="RefactoringDialogBase.requestPreview"></a> 200 <a NAME="RefactoringDialogBase.requestPreview" ID="RefactoringDialogBase.requestPreview"></a>
203 <h4>RefactoringDialogBase.requestPreview</h4> 201 <h4>RefactoringDialogBase.requestPreview</h4>
204 <b>requestPreview</b>(<i></i>) 202 <b>requestPreview</b>(<i></i>)
205
206 <p> 203 <p>
207 Public method to request a preview of the calculated changes. 204 Public method to request a preview of the calculated changes.
208 </p> 205 </p>
206
209 <div align="right"><a href="#top">Up</a></div> 207 <div align="right"><a href="#top">Up</a></div>
210 <hr /> 208 <hr />
211 </body></html> 209 </body></html>

Mercurial Repository: Rope Refactoring

eric ide

mercurial