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
- 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.HistoryDialog</h1> | 9 <h1>Plugin_Refactoring_Rope.RefactoringRope.HistoryDialog</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing the History dialog. | 11 Module implementing the History dialog. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>None</td></tr> | 16 <tr><td>None</td></tr> |
| 18 </table> | 17 </table> |
| 18 | |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | 20 <table> |
| 21 <table> | |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#HistoryDialog">HistoryDialog</a></td> | 22 <td><a href="#HistoryDialog">HistoryDialog</a></td> |
| 25 <td>Class implementing the History dialog.</td> | 23 <td>Class implementing the History dialog.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | |
| 30 <table> | 28 <table> |
| 31 <tr><td>None</td></tr> | 29 <tr><td>None</td></tr> |
| 32 </table> | 30 </table> |
| 31 | |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="HistoryDialog" ID="HistoryDialog"></a> | 34 <a NAME="HistoryDialog" ID="HistoryDialog"></a> |
| 36 <h2>HistoryDialog</h2> | 35 <h2>HistoryDialog</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class implementing the History dialog. | 37 Class implementing the History dialog. |
| 40 </p> | 38 </p> |
| 39 | |
| 41 <h3>Derived from</h3> | 40 <h3>Derived from</h3> |
| 42 QDialog, Ui_HistoryDialog | 41 QDialog, Ui_HistoryDialog |
| 43 <h3>Class Attributes</h3> | 42 <h3>Class Attributes</h3> |
| 44 | |
| 45 <table> | 43 <table> |
| 46 <tr><td>ChangeIDRole</td></tr> | 44 <tr><td>ChangeIDRole</td></tr> |
| 47 </table> | 45 </table> |
| 46 | |
| 48 <h3>Class Methods</h3> | 47 <h3>Class Methods</h3> |
| 49 | |
| 50 <table> | 48 <table> |
| 51 <tr><td>None</td></tr> | 49 <tr><td>None</td></tr> |
| 52 </table> | 50 </table> |
| 51 | |
| 53 <h3>Methods</h3> | 52 <h3>Methods</h3> |
| 54 | 53 <table> |
| 55 <table> | |
| 56 | |
| 57 <tr> | 54 <tr> |
| 58 <td><a href="#HistoryDialog.__init__">HistoryDialog</a></td> | 55 <td><a href="#HistoryDialog.__init__">HistoryDialog</a></td> |
| 59 <td>Constructor</td> | 56 <td>Constructor</td> |
| 60 </tr> | 57 </tr> |
| 61 <tr> | 58 <tr> |
| 113 <tr> | 110 <tr> |
| 114 <td><a href="#HistoryDialog.processHistoryCommand">processHistoryCommand</a></td> | 111 <td><a href="#HistoryDialog.processHistoryCommand">processHistoryCommand</a></td> |
| 115 <td>Public method to process the data sent by the refactoring client.</td> | 112 <td>Public method to process the data sent by the refactoring client.</td> |
| 116 </tr> | 113 </tr> |
| 117 </table> | 114 </table> |
| 115 | |
| 118 <h3>Static Methods</h3> | 116 <h3>Static Methods</h3> |
| 119 | |
| 120 <table> | 117 <table> |
| 121 <tr><td>None</td></tr> | 118 <tr><td>None</td></tr> |
| 122 </table> | 119 </table> |
| 120 | |
| 123 | 121 |
| 124 <a NAME="HistoryDialog.__init__" ID="HistoryDialog.__init__"></a> | 122 <a NAME="HistoryDialog.__init__" ID="HistoryDialog.__init__"></a> |
| 125 <h4>HistoryDialog (Constructor)</h4> | 123 <h4>HistoryDialog (Constructor)</h4> |
| 126 <b>HistoryDialog</b>(<i>refactoring, filename="", parent=None</i>) | 124 <b>HistoryDialog</b>(<i>refactoring, filename="", parent=None</i>) |
| 127 | |
| 128 <p> | 125 <p> |
| 129 Constructor | 126 Constructor |
| 130 </p> | 127 </p> |
| 128 | |
| 131 <dl> | 129 <dl> |
| 132 | 130 |
| 133 <dt><i>refactoring</i> (RefactoringServer)</dt> | 131 <dt><i>refactoring</i> (RefactoringServer)</dt> |
| 134 <dd> | 132 <dd> |
| 135 reference to the main refactoring object | 133 reference to the main refactoring object |
| 144 </dd> | 142 </dd> |
| 145 </dl> | 143 </dl> |
| 146 <a NAME="HistoryDialog.__appendText" ID="HistoryDialog.__appendText"></a> | 144 <a NAME="HistoryDialog.__appendText" ID="HistoryDialog.__appendText"></a> |
| 147 <h4>HistoryDialog.__appendText</h4> | 145 <h4>HistoryDialog.__appendText</h4> |
| 148 <b>__appendText</b>(<i>txt, charFormat</i>) | 146 <b>__appendText</b>(<i>txt, charFormat</i>) |
| 149 | |
| 150 <p> | 147 <p> |
| 151 Private method to append text to the end of the preview pane. | 148 Private method to append text to the end of the preview pane. |
| 152 </p> | 149 </p> |
| 150 | |
| 153 <dl> | 151 <dl> |
| 154 | 152 |
| 155 <dt><i>txt</i> (str)</dt> | 153 <dt><i>txt</i> (str)</dt> |
| 156 <dd> | 154 <dd> |
| 157 text to insert | 155 text to insert |
| 162 </dd> | 160 </dd> |
| 163 </dl> | 161 </dl> |
| 164 <a NAME="HistoryDialog.__clearHistory" ID="HistoryDialog.__clearHistory"></a> | 162 <a NAME="HistoryDialog.__clearHistory" ID="HistoryDialog.__clearHistory"></a> |
| 165 <h4>HistoryDialog.__clearHistory</h4> | 163 <h4>HistoryDialog.__clearHistory</h4> |
| 166 <b>__clearHistory</b>(<i></i>) | 164 <b>__clearHistory</b>(<i></i>) |
| 167 | |
| 168 <p> | 165 <p> |
| 169 Private method to clear the refactoring history. | 166 Private method to clear the refactoring history. |
| 170 </p> | 167 </p> |
| 168 | |
| 171 <a NAME="HistoryDialog.__currentItemChanged" ID="HistoryDialog.__currentItemChanged"></a> | 169 <a NAME="HistoryDialog.__currentItemChanged" ID="HistoryDialog.__currentItemChanged"></a> |
| 172 <h4>HistoryDialog.__currentItemChanged</h4> | 170 <h4>HistoryDialog.__currentItemChanged</h4> |
| 173 <b>__currentItemChanged</b>(<i>current</i>) | 171 <b>__currentItemChanged</b>(<i>current</i>) |
| 174 | |
| 175 <p> | 172 <p> |
| 176 Private method to request change data of an item. | 173 Private method to request change data of an item. |
| 177 </p> | 174 </p> |
| 175 | |
| 178 <dl> | 176 <dl> |
| 179 | 177 |
| 180 <dt><i>current</i> (QListWidgetItem)</dt> | 178 <dt><i>current</i> (QListWidgetItem)</dt> |
| 181 <dd> | 179 <dd> |
| 182 reference to the item to get change data for | 180 reference to the item to get change data for |
| 183 </dd> | 181 </dd> |
| 184 </dl> | 182 </dl> |
| 185 <a NAME="HistoryDialog.__redoChanges" ID="HistoryDialog.__redoChanges"></a> | 183 <a NAME="HistoryDialog.__redoChanges" ID="HistoryDialog.__redoChanges"></a> |
| 186 <h4>HistoryDialog.__redoChanges</h4> | 184 <h4>HistoryDialog.__redoChanges</h4> |
| 187 <b>__redoChanges</b>(<i></i>) | 185 <b>__redoChanges</b>(<i></i>) |
| 188 | |
| 189 <p> | 186 <p> |
| 190 Private method to redo the selected set of changes. | 187 Private method to redo the selected set of changes. |
| 191 </p> | 188 </p> |
| 189 | |
| 192 <a NAME="HistoryDialog.__refreshHistories" ID="HistoryDialog.__refreshHistories"></a> | 190 <a NAME="HistoryDialog.__refreshHistories" ID="HistoryDialog.__refreshHistories"></a> |
| 193 <h4>HistoryDialog.__refreshHistories</h4> | 191 <h4>HistoryDialog.__refreshHistories</h4> |
| 194 <b>__refreshHistories</b>(<i></i>) | 192 <b>__refreshHistories</b>(<i></i>) |
| 195 | |
| 196 <p> | 193 <p> |
| 197 Private method to refresh the undo and redo history lists. | 194 Private method to refresh the undo and redo history lists. |
| 198 </p> | 195 </p> |
| 196 | |
| 199 <a NAME="HistoryDialog.__undoChanges" ID="HistoryDialog.__undoChanges"></a> | 197 <a NAME="HistoryDialog.__undoChanges" ID="HistoryDialog.__undoChanges"></a> |
| 200 <h4>HistoryDialog.__undoChanges</h4> | 198 <h4>HistoryDialog.__undoChanges</h4> |
| 201 <b>__undoChanges</b>(<i></i>) | 199 <b>__undoChanges</b>(<i></i>) |
| 202 | |
| 203 <p> | 200 <p> |
| 204 Private method to undo the selected set of changes. | 201 Private method to undo the selected set of changes. |
| 205 </p> | 202 </p> |
| 203 | |
| 206 <a NAME="HistoryDialog.closeEvent" ID="HistoryDialog.closeEvent"></a> | 204 <a NAME="HistoryDialog.closeEvent" ID="HistoryDialog.closeEvent"></a> |
| 207 <h4>HistoryDialog.closeEvent</h4> | 205 <h4>HistoryDialog.closeEvent</h4> |
| 208 <b>closeEvent</b>(<i>evt</i>) | 206 <b>closeEvent</b>(<i>evt</i>) |
| 209 | |
| 210 <p> | 207 <p> |
| 211 Protected method handling close events. | 208 Protected method handling close events. |
| 212 </p> | 209 </p> |
| 210 | |
| 213 <dl> | 211 <dl> |
| 214 | 212 |
| 215 <dt><i>evt</i> (QCloseEvent)</dt> | 213 <dt><i>evt</i> (QCloseEvent)</dt> |
| 216 <dd> | 214 <dd> |
| 217 reference to the close event object | 215 reference to the close event object |
| 218 </dd> | 216 </dd> |
| 219 </dl> | 217 </dl> |
| 220 <a NAME="HistoryDialog.historyCleared" ID="HistoryDialog.historyCleared"></a> | 218 <a NAME="HistoryDialog.historyCleared" ID="HistoryDialog.historyCleared"></a> |
| 221 <h4>HistoryDialog.historyCleared</h4> | 219 <h4>HistoryDialog.historyCleared</h4> |
| 222 <b>historyCleared</b>(<i></i>) | 220 <b>historyCleared</b>(<i></i>) |
| 223 | |
| 224 <p> | 221 <p> |
| 225 Public method to indicate, that the refactoring history was cleared | 222 Public method to indicate, that the refactoring history was cleared |
| 226 through the menu. | 223 through the menu. |
| 227 </p> | 224 </p> |
| 225 | |
| 228 <a NAME="HistoryDialog.on_buttonBox_clicked" ID="HistoryDialog.on_buttonBox_clicked"></a> | 226 <a NAME="HistoryDialog.on_buttonBox_clicked" ID="HistoryDialog.on_buttonBox_clicked"></a> |
| 229 <h4>HistoryDialog.on_buttonBox_clicked</h4> | 227 <h4>HistoryDialog.on_buttonBox_clicked</h4> |
| 230 <b>on_buttonBox_clicked</b>(<i>button</i>) | 228 <b>on_buttonBox_clicked</b>(<i>button</i>) |
| 231 | |
| 232 <p> | 229 <p> |
| 233 Private slot handling the selection of a dialog button. | 230 Private slot handling the selection of a dialog button. |
| 234 </p> | 231 </p> |
| 232 | |
| 235 <dl> | 233 <dl> |
| 236 | 234 |
| 237 <dt><i>button</i> (QAbstractButton)</dt> | 235 <dt><i>button</i> (QAbstractButton)</dt> |
| 238 <dd> | 236 <dd> |
| 239 reference to the button clicked | 237 reference to the button clicked |
| 240 </dd> | 238 </dd> |
| 241 </dl> | 239 </dl> |
| 242 <a NAME="HistoryDialog.on_redoChangesList_currentItemChanged" ID="HistoryDialog.on_redoChangesList_currentItemChanged"></a> | 240 <a NAME="HistoryDialog.on_redoChangesList_currentItemChanged" ID="HistoryDialog.on_redoChangesList_currentItemChanged"></a> |
| 243 <h4>HistoryDialog.on_redoChangesList_currentItemChanged</h4> | 241 <h4>HistoryDialog.on_redoChangesList_currentItemChanged</h4> |
| 244 <b>on_redoChangesList_currentItemChanged</b>(<i>current, previous</i>) | 242 <b>on_redoChangesList_currentItemChanged</b>(<i>current, previous</i>) |
| 245 | |
| 246 <p> | 243 <p> |
| 247 Private slot handling a change of the current redo change. | 244 Private slot handling a change of the current redo change. |
| 248 </p> | 245 </p> |
| 246 | |
| 249 <dl> | 247 <dl> |
| 250 | 248 |
| 251 <dt><i>current</i> (QListWidgetItem)</dt> | 249 <dt><i>current</i> (QListWidgetItem)</dt> |
| 252 <dd> | 250 <dd> |
| 253 reference to the new current redo item | 251 reference to the new current redo item |
| 258 </dd> | 256 </dd> |
| 259 </dl> | 257 </dl> |
| 260 <a NAME="HistoryDialog.on_redoChangesList_itemClicked" ID="HistoryDialog.on_redoChangesList_itemClicked"></a> | 258 <a NAME="HistoryDialog.on_redoChangesList_itemClicked" ID="HistoryDialog.on_redoChangesList_itemClicked"></a> |
| 261 <h4>HistoryDialog.on_redoChangesList_itemClicked</h4> | 259 <h4>HistoryDialog.on_redoChangesList_itemClicked</h4> |
| 262 <b>on_redoChangesList_itemClicked</b>(<i>item</i>) | 260 <b>on_redoChangesList_itemClicked</b>(<i>item</i>) |
| 263 | |
| 264 <p> | 261 <p> |
| 265 Private slot handling a click on a redo entry. | 262 Private slot handling a click on a redo entry. |
| 266 </p> | 263 </p> |
| 264 | |
| 267 <dl> | 265 <dl> |
| 268 | 266 |
| 269 <dt><i>item</i> (QListWidgetItem)</dt> | 267 <dt><i>item</i> (QListWidgetItem)</dt> |
| 270 <dd> | 268 <dd> |
| 271 reference to the clicked item | 269 reference to the clicked item |
| 272 </dd> | 270 </dd> |
| 273 </dl> | 271 </dl> |
| 274 <a NAME="HistoryDialog.on_undoChangesList_currentItemChanged" ID="HistoryDialog.on_undoChangesList_currentItemChanged"></a> | 272 <a NAME="HistoryDialog.on_undoChangesList_currentItemChanged" ID="HistoryDialog.on_undoChangesList_currentItemChanged"></a> |
| 275 <h4>HistoryDialog.on_undoChangesList_currentItemChanged</h4> | 273 <h4>HistoryDialog.on_undoChangesList_currentItemChanged</h4> |
| 276 <b>on_undoChangesList_currentItemChanged</b>(<i>current, previous</i>) | 274 <b>on_undoChangesList_currentItemChanged</b>(<i>current, previous</i>) |
| 277 | |
| 278 <p> | 275 <p> |
| 279 Private slot handling a change of the current undo change. | 276 Private slot handling a change of the current undo change. |
| 280 </p> | 277 </p> |
| 278 | |
| 281 <dl> | 279 <dl> |
| 282 | 280 |
| 283 <dt><i>current</i> (QListWidgetItem)</dt> | 281 <dt><i>current</i> (QListWidgetItem)</dt> |
| 284 <dd> | 282 <dd> |
| 285 reference to the new current undo item | 283 reference to the new current undo item |
| 290 </dd> | 288 </dd> |
| 291 </dl> | 289 </dl> |
| 292 <a NAME="HistoryDialog.on_undoChangesList_itemClicked" ID="HistoryDialog.on_undoChangesList_itemClicked"></a> | 290 <a NAME="HistoryDialog.on_undoChangesList_itemClicked" ID="HistoryDialog.on_undoChangesList_itemClicked"></a> |
| 293 <h4>HistoryDialog.on_undoChangesList_itemClicked</h4> | 291 <h4>HistoryDialog.on_undoChangesList_itemClicked</h4> |
| 294 <b>on_undoChangesList_itemClicked</b>(<i>item</i>) | 292 <b>on_undoChangesList_itemClicked</b>(<i>item</i>) |
| 295 | |
| 296 <p> | 293 <p> |
| 297 Private slot handling a click on an undo entry. | 294 Private slot handling a click on an undo entry. |
| 298 </p> | 295 </p> |
| 296 | |
| 299 <dl> | 297 <dl> |
| 300 | 298 |
| 301 <dt><i>item</i> (QListWidgetItem)</dt> | 299 <dt><i>item</i> (QListWidgetItem)</dt> |
| 302 <dd> | 300 <dd> |
| 303 reference to the clicked item | 301 reference to the clicked item |
| 304 </dd> | 302 </dd> |
| 305 </dl> | 303 </dl> |
| 306 <a NAME="HistoryDialog.processHistoryCommand" ID="HistoryDialog.processHistoryCommand"></a> | 304 <a NAME="HistoryDialog.processHistoryCommand" ID="HistoryDialog.processHistoryCommand"></a> |
| 307 <h4>HistoryDialog.processHistoryCommand</h4> | 305 <h4>HistoryDialog.processHistoryCommand</h4> |
| 308 <b>processHistoryCommand</b>(<i>data</i>) | 306 <b>processHistoryCommand</b>(<i>data</i>) |
| 309 | |
| 310 <p> | 307 <p> |
| 311 Public method to process the data sent by the refactoring client. | 308 Public method to process the data sent by the refactoring client. |
| 312 </p> | 309 </p> |
| 310 | |
| 313 <dl> | 311 <dl> |
| 314 | 312 |
| 315 <dt><i>data</i> (dict)</dt> | 313 <dt><i>data</i> (dict)</dt> |
| 316 <dd> | 314 <dd> |
| 317 dictionary containing the history data | 315 dictionary containing the history data |
