Mercurial Repositories > Rope Refactoring / file comparison

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

RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.HistoryDialog.html

changeset 321
d51e810107ec
parent 204
b4bf79b956bc
child 375
c61a2f18ed78
equal deleted inserted replaced
320:91b171fdd85f 321:d51e810107ec
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>Plugin_Refactoring_Rope.RefactoringRope.HistoryDialog</h1> 23 <h1>Plugin_Refactoring_Rope.RefactoringRope.HistoryDialog</h1>
24
23 <p> 25 <p>
24 Module implementing the History dialog. 26 Module implementing the History dialog.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#HistoryDialog">HistoryDialog</a></td> 38 <td><a href="#HistoryDialog">HistoryDialog</a></td>
34 <td>Class implementing the History dialog.</td> 39 <td>Class implementing the History dialog.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="HistoryDialog" ID="HistoryDialog"></a> 49 <a NAME="HistoryDialog" ID="HistoryDialog"></a>
43 <h2>HistoryDialog</h2> 50 <h2>HistoryDialog</h2>
51
44 <p> 52 <p>
45 Class implementing the History dialog. 53 Class implementing the History dialog.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QDialog, Ui_HistoryDialog 56 QDialog, Ui_HistoryDialog
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>ChangeIDRole</td></tr> 60 <tr><td>ChangeIDRole</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#HistoryDialog.__init__">HistoryDialog</a></td> 72 <td><a href="#HistoryDialog.__init__">HistoryDialog</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#HistoryDialog.__appendText">__appendText</a></td> 76 <td><a href="#HistoryDialog.__appendText">__appendText</a></td>
64 <td>Private method to append text to the end of the preview pane.</td> 77 <td>Private method to append text to the end of the preview pane.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#HistoryDialog.__clearHistory">__clearHistory</a></td> 80 <td><a href="#HistoryDialog.__clearHistory">__clearHistory</a></td>
67 <td>Private method to clear the refactoring history.</td> 81 <td>Private method to clear the refactoring history.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#HistoryDialog.__currentItemChanged">__currentItemChanged</a></td> 84 <td><a href="#HistoryDialog.__currentItemChanged">__currentItemChanged</a></td>
70 <td>Private method to request change data of an item.</td> 85 <td>Private method to request change data of an item.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#HistoryDialog.__redoChanges">__redoChanges</a></td> 88 <td><a href="#HistoryDialog.__redoChanges">__redoChanges</a></td>
73 <td>Private method to redo the selected set of changes.</td> 89 <td>Private method to redo the selected set of changes.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#HistoryDialog.__refreshHistories">__refreshHistories</a></td> 92 <td><a href="#HistoryDialog.__refreshHistories">__refreshHistories</a></td>
76 <td>Private method to refresh the undo and redo history lists.</td> 93 <td>Private method to refresh the undo and redo history lists.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#HistoryDialog.__undoChanges">__undoChanges</a></td> 96 <td><a href="#HistoryDialog.__undoChanges">__undoChanges</a></td>
79 <td>Private method to undo the selected set of changes.</td> 97 <td>Private method to undo the selected set of changes.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#HistoryDialog.closeEvent">closeEvent</a></td> 100 <td><a href="#HistoryDialog.closeEvent">closeEvent</a></td>
82 <td>Protected method handling close events.</td> 101 <td>Protected method handling close events.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#HistoryDialog.historyCleared">historyCleared</a></td> 104 <td><a href="#HistoryDialog.historyCleared">historyCleared</a></td>
85 <td>Public method to indicate, that the refactoring history was cleared through the menu.</td> 105 <td>Public method to indicate, that the refactoring history was cleared through the menu.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#HistoryDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 108 <td><a href="#HistoryDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
88 <td>Private slot handling the selection of a dialog button.</td> 109 <td>Private slot handling the selection of a dialog button.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#HistoryDialog.on_redoChangesList_currentItemChanged">on_redoChangesList_currentItemChanged</a></td> 112 <td><a href="#HistoryDialog.on_redoChangesList_currentItemChanged">on_redoChangesList_currentItemChanged</a></td>
91 <td>Private slot handling a change of the current redo change.</td> 113 <td>Private slot handling a change of the current redo change.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#HistoryDialog.on_redoChangesList_itemClicked">on_redoChangesList_itemClicked</a></td> 116 <td><a href="#HistoryDialog.on_redoChangesList_itemClicked">on_redoChangesList_itemClicked</a></td>
94 <td>Private slot handling a click on a redo entry.</td> 117 <td>Private slot handling a click on a redo entry.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#HistoryDialog.on_undoChangesList_currentItemChanged">on_undoChangesList_currentItemChanged</a></td> 120 <td><a href="#HistoryDialog.on_undoChangesList_currentItemChanged">on_undoChangesList_currentItemChanged</a></td>
97 <td>Private slot handling a change of the current undo change.</td> 121 <td>Private slot handling a change of the current undo change.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#HistoryDialog.on_undoChangesList_itemClicked">on_undoChangesList_itemClicked</a></td> 124 <td><a href="#HistoryDialog.on_undoChangesList_itemClicked">on_undoChangesList_itemClicked</a></td>
100 <td>Private slot handling a click on an undo entry.</td> 125 <td>Private slot handling a click on an undo entry.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#HistoryDialog.processHistoryCommand">processHistoryCommand</a></td> 128 <td><a href="#HistoryDialog.processHistoryCommand">processHistoryCommand</a></td>
103 <td>Public method to process the data sent by the refactoring client.</td> 129 <td>Public method to process the data sent by the refactoring client.</td>
104 </tr> 130 </tr>
105 </table> 131 </table>
106 <h3>Static Methods</h3> 132 <h3>Static Methods</h3>
133
107 <table> 134 <table>
108 <tr><td>None</td></tr> 135 <tr><td>None</td></tr>
109 </table> 136 </table>
137
110 <a NAME="HistoryDialog.__init__" ID="HistoryDialog.__init__"></a> 138 <a NAME="HistoryDialog.__init__" ID="HistoryDialog.__init__"></a>
111 <h4>HistoryDialog (Constructor)</h4> 139 <h4>HistoryDialog (Constructor)</h4>
112 <b>HistoryDialog</b>(<i>refactoring, filename="", parent=None</i>) 140 <b>HistoryDialog</b>(<i>refactoring, filename="", parent=None</i>)
141
113 <p> 142 <p>
114 Constructor 143 Constructor
115 </p><dl> 144 </p>
145 <dl>
146
116 <dt><i>refactoring</i> (RefactoringServer)</dt> 147 <dt><i>refactoring</i> (RefactoringServer)</dt>
117 <dd> 148 <dd>
118 reference to the main refactoring object 149 reference to the main refactoring object
119 </dd><dt><i>filename</i> (str)</dt> 150 </dd>
151 <dt><i>filename</i> (str)</dt>
120 <dd> 152 <dd>
121 name of the file to show the history for 153 name of the file to show the history for
122 </dd><dt><i>parent</i> (QWidget)</dt> 154 </dd>
155 <dt><i>parent</i> (QWidget)</dt>
123 <dd> 156 <dd>
124 reference to the parent widget 157 reference to the parent widget
125 </dd> 158 </dd>
126 </dl><a NAME="HistoryDialog.__appendText" ID="HistoryDialog.__appendText"></a> 159 </dl>
160 <a NAME="HistoryDialog.__appendText" ID="HistoryDialog.__appendText"></a>
127 <h4>HistoryDialog.__appendText</h4> 161 <h4>HistoryDialog.__appendText</h4>
128 <b>__appendText</b>(<i>txt, charFormat</i>) 162 <b>__appendText</b>(<i>txt, charFormat</i>)
163
129 <p> 164 <p>
130 Private method to append text to the end of the preview pane. 165 Private method to append text to the end of the preview pane.
131 </p><dl> 166 </p>
167 <dl>
168
132 <dt><i>txt</i> (str)</dt> 169 <dt><i>txt</i> (str)</dt>
133 <dd> 170 <dd>
134 text to insert 171 text to insert
135 </dd><dt><i>charFormat</i> (QTextCharFormat)</dt> 172 </dd>
173 <dt><i>charFormat</i> (QTextCharFormat)</dt>
136 <dd> 174 <dd>
137 text format to be used 175 text format to be used
138 </dd> 176 </dd>
139 </dl><a NAME="HistoryDialog.__clearHistory" ID="HistoryDialog.__clearHistory"></a> 177 </dl>
178 <a NAME="HistoryDialog.__clearHistory" ID="HistoryDialog.__clearHistory"></a>
140 <h4>HistoryDialog.__clearHistory</h4> 179 <h4>HistoryDialog.__clearHistory</h4>
141 <b>__clearHistory</b>(<i></i>) 180 <b>__clearHistory</b>(<i></i>)
181
142 <p> 182 <p>
143 Private method to clear the refactoring history. 183 Private method to clear the refactoring history.
144 </p><a NAME="HistoryDialog.__currentItemChanged" ID="HistoryDialog.__currentItemChanged"></a> 184 </p>
185 <a NAME="HistoryDialog.__currentItemChanged" ID="HistoryDialog.__currentItemChanged"></a>
145 <h4>HistoryDialog.__currentItemChanged</h4> 186 <h4>HistoryDialog.__currentItemChanged</h4>
146 <b>__currentItemChanged</b>(<i>current</i>) 187 <b>__currentItemChanged</b>(<i>current</i>)
188
147 <p> 189 <p>
148 Private method to request change data of an item. 190 Private method to request change data of an item.
149 </p><dl> 191 </p>
192 <dl>
193
150 <dt><i>current</i> (QListWidgetItem)</dt> 194 <dt><i>current</i> (QListWidgetItem)</dt>
151 <dd> 195 <dd>
152 reference to the item to get change data for 196 reference to the item to get change data for
153 </dd> 197 </dd>
154 </dl><a NAME="HistoryDialog.__redoChanges" ID="HistoryDialog.__redoChanges"></a> 198 </dl>
199 <a NAME="HistoryDialog.__redoChanges" ID="HistoryDialog.__redoChanges"></a>
155 <h4>HistoryDialog.__redoChanges</h4> 200 <h4>HistoryDialog.__redoChanges</h4>
156 <b>__redoChanges</b>(<i></i>) 201 <b>__redoChanges</b>(<i></i>)
202
157 <p> 203 <p>
158 Private method to redo the selected set of changes. 204 Private method to redo the selected set of changes.
159 </p><a NAME="HistoryDialog.__refreshHistories" ID="HistoryDialog.__refreshHistories"></a> 205 </p>
206 <a NAME="HistoryDialog.__refreshHistories" ID="HistoryDialog.__refreshHistories"></a>
160 <h4>HistoryDialog.__refreshHistories</h4> 207 <h4>HistoryDialog.__refreshHistories</h4>
161 <b>__refreshHistories</b>(<i></i>) 208 <b>__refreshHistories</b>(<i></i>)
209
162 <p> 210 <p>
163 Private method to refresh the undo and redo history lists. 211 Private method to refresh the undo and redo history lists.
164 </p><a NAME="HistoryDialog.__undoChanges" ID="HistoryDialog.__undoChanges"></a> 212 </p>
213 <a NAME="HistoryDialog.__undoChanges" ID="HistoryDialog.__undoChanges"></a>
165 <h4>HistoryDialog.__undoChanges</h4> 214 <h4>HistoryDialog.__undoChanges</h4>
166 <b>__undoChanges</b>(<i></i>) 215 <b>__undoChanges</b>(<i></i>)
216
167 <p> 217 <p>
168 Private method to undo the selected set of changes. 218 Private method to undo the selected set of changes.
169 </p><a NAME="HistoryDialog.closeEvent" ID="HistoryDialog.closeEvent"></a> 219 </p>
220 <a NAME="HistoryDialog.closeEvent" ID="HistoryDialog.closeEvent"></a>
170 <h4>HistoryDialog.closeEvent</h4> 221 <h4>HistoryDialog.closeEvent</h4>
171 <b>closeEvent</b>(<i>evt</i>) 222 <b>closeEvent</b>(<i>evt</i>)
223
172 <p> 224 <p>
173 Protected method handling close events. 225 Protected method handling close events.
174 </p><dl> 226 </p>
227 <dl>
228
175 <dt><i>evt</i> (QCloseEvent)</dt> 229 <dt><i>evt</i> (QCloseEvent)</dt>
176 <dd> 230 <dd>
177 reference to the close event object 231 reference to the close event object
178 </dd> 232 </dd>
179 </dl><a NAME="HistoryDialog.historyCleared" ID="HistoryDialog.historyCleared"></a> 233 </dl>
234 <a NAME="HistoryDialog.historyCleared" ID="HistoryDialog.historyCleared"></a>
180 <h4>HistoryDialog.historyCleared</h4> 235 <h4>HistoryDialog.historyCleared</h4>
181 <b>historyCleared</b>(<i></i>) 236 <b>historyCleared</b>(<i></i>)
237
182 <p> 238 <p>
183 Public method to indicate, that the refactoring history was cleared 239 Public method to indicate, that the refactoring history was cleared
184 through the menu. 240 through the menu.
185 </p><a NAME="HistoryDialog.on_buttonBox_clicked" ID="HistoryDialog.on_buttonBox_clicked"></a> 241 </p>
242 <a NAME="HistoryDialog.on_buttonBox_clicked" ID="HistoryDialog.on_buttonBox_clicked"></a>
186 <h4>HistoryDialog.on_buttonBox_clicked</h4> 243 <h4>HistoryDialog.on_buttonBox_clicked</h4>
187 <b>on_buttonBox_clicked</b>(<i>button</i>) 244 <b>on_buttonBox_clicked</b>(<i>button</i>)
245
188 <p> 246 <p>
189 Private slot handling the selection of a dialog button. 247 Private slot handling the selection of a dialog button.
190 </p><dl> 248 </p>
249 <dl>
250
191 <dt><i>button</i> (QAbstractButton)</dt> 251 <dt><i>button</i> (QAbstractButton)</dt>
192 <dd> 252 <dd>
193 reference to the button clicked 253 reference to the button clicked
194 </dd> 254 </dd>
195 </dl><a NAME="HistoryDialog.on_redoChangesList_currentItemChanged" ID="HistoryDialog.on_redoChangesList_currentItemChanged"></a> 255 </dl>
256 <a NAME="HistoryDialog.on_redoChangesList_currentItemChanged" ID="HistoryDialog.on_redoChangesList_currentItemChanged"></a>
196 <h4>HistoryDialog.on_redoChangesList_currentItemChanged</h4> 257 <h4>HistoryDialog.on_redoChangesList_currentItemChanged</h4>
197 <b>on_redoChangesList_currentItemChanged</b>(<i>current, previous</i>) 258 <b>on_redoChangesList_currentItemChanged</b>(<i>current, previous</i>)
259
198 <p> 260 <p>
199 Private slot handling a change of the current redo change. 261 Private slot handling a change of the current redo change.
200 </p><dl> 262 </p>
263 <dl>
264
201 <dt><i>current</i> (QListWidgetItem)</dt> 265 <dt><i>current</i> (QListWidgetItem)</dt>
202 <dd> 266 <dd>
203 reference to the new current redo item 267 reference to the new current redo item
204 </dd><dt><i>previous</i> (QListWidgetItem)</dt> 268 </dd>
269 <dt><i>previous</i> (QListWidgetItem)</dt>
205 <dd> 270 <dd>
206 reference to the previous current redo item 271 reference to the previous current redo item
207 </dd> 272 </dd>
208 </dl><a NAME="HistoryDialog.on_redoChangesList_itemClicked" ID="HistoryDialog.on_redoChangesList_itemClicked"></a> 273 </dl>
274 <a NAME="HistoryDialog.on_redoChangesList_itemClicked" ID="HistoryDialog.on_redoChangesList_itemClicked"></a>
209 <h4>HistoryDialog.on_redoChangesList_itemClicked</h4> 275 <h4>HistoryDialog.on_redoChangesList_itemClicked</h4>
210 <b>on_redoChangesList_itemClicked</b>(<i>item</i>) 276 <b>on_redoChangesList_itemClicked</b>(<i>item</i>)
277
211 <p> 278 <p>
212 Private slot handling a click on a redo entry. 279 Private slot handling a click on a redo entry.
213 </p><dl> 280 </p>
281 <dl>
282
214 <dt><i>item</i> (QListWidgetItem)</dt> 283 <dt><i>item</i> (QListWidgetItem)</dt>
215 <dd> 284 <dd>
216 reference to the clicked item 285 reference to the clicked item
217 </dd> 286 </dd>
218 </dl><a NAME="HistoryDialog.on_undoChangesList_currentItemChanged" ID="HistoryDialog.on_undoChangesList_currentItemChanged"></a> 287 </dl>
288 <a NAME="HistoryDialog.on_undoChangesList_currentItemChanged" ID="HistoryDialog.on_undoChangesList_currentItemChanged"></a>
219 <h4>HistoryDialog.on_undoChangesList_currentItemChanged</h4> 289 <h4>HistoryDialog.on_undoChangesList_currentItemChanged</h4>
220 <b>on_undoChangesList_currentItemChanged</b>(<i>current, previous</i>) 290 <b>on_undoChangesList_currentItemChanged</b>(<i>current, previous</i>)
291
221 <p> 292 <p>
222 Private slot handling a change of the current undo change. 293 Private slot handling a change of the current undo change.
223 </p><dl> 294 </p>
295 <dl>
296
224 <dt><i>current</i> (QListWidgetItem)</dt> 297 <dt><i>current</i> (QListWidgetItem)</dt>
225 <dd> 298 <dd>
226 reference to the new current undo item 299 reference to the new current undo item
227 </dd><dt><i>previous</i> (QListWidgetItem)</dt> 300 </dd>
301 <dt><i>previous</i> (QListWidgetItem)</dt>
228 <dd> 302 <dd>
229 reference to the previous current undo item 303 reference to the previous current undo item
230 </dd> 304 </dd>
231 </dl><a NAME="HistoryDialog.on_undoChangesList_itemClicked" ID="HistoryDialog.on_undoChangesList_itemClicked"></a> 305 </dl>
306 <a NAME="HistoryDialog.on_undoChangesList_itemClicked" ID="HistoryDialog.on_undoChangesList_itemClicked"></a>
232 <h4>HistoryDialog.on_undoChangesList_itemClicked</h4> 307 <h4>HistoryDialog.on_undoChangesList_itemClicked</h4>
233 <b>on_undoChangesList_itemClicked</b>(<i>item</i>) 308 <b>on_undoChangesList_itemClicked</b>(<i>item</i>)
309
234 <p> 310 <p>
235 Private slot handling a click on an undo entry. 311 Private slot handling a click on an undo entry.
236 </p><dl> 312 </p>
313 <dl>
314
237 <dt><i>item</i> (QListWidgetItem)</dt> 315 <dt><i>item</i> (QListWidgetItem)</dt>
238 <dd> 316 <dd>
239 reference to the clicked item 317 reference to the clicked item
240 </dd> 318 </dd>
241 </dl><a NAME="HistoryDialog.processHistoryCommand" ID="HistoryDialog.processHistoryCommand"></a> 319 </dl>
320 <a NAME="HistoryDialog.processHistoryCommand" ID="HistoryDialog.processHistoryCommand"></a>
242 <h4>HistoryDialog.processHistoryCommand</h4> 321 <h4>HistoryDialog.processHistoryCommand</h4>
243 <b>processHistoryCommand</b>(<i>data</i>) 322 <b>processHistoryCommand</b>(<i>data</i>)
323
244 <p> 324 <p>
245 Public method to process the data sent by the refactoring client. 325 Public method to process the data sent by the refactoring client.
246 </p><dl> 326 </p>
327 <dl>
328
247 <dt><i>data</i> (dict)</dt> 329 <dt><i>data</i> (dict)</dt>
248 <dd> 330 <dd>
249 dictionary containing the history data 331 dictionary containing the history data
250 </dd> 332 </dd>
251 </dl> 333 </dl>

Mercurial Repository: Rope Refactoring

eric ide

mercurial