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
- server_client_variant
- changeset 204
- b4bf79b956bc
- parent 44
- 8aa985c8dee5
- child 321
- d51e810107ec
equal
deleted
inserted
replaced
| 203:c38750e1bafd | 204:b4bf79b956bc |
|---|---|
| 43 <h2>HistoryDialog</h2> | 43 <h2>HistoryDialog</h2> |
| 44 <p> | 44 <p> |
| 45 Class implementing the History dialog. | 45 Class implementing the History dialog. |
| 46 </p> | 46 </p> |
| 47 <h3>Derived from</h3> | 47 <h3>Derived from</h3> |
| 48 PreviewDialogBase | 48 QDialog, Ui_HistoryDialog |
| 49 <h3>Class Attributes</h3> | 49 <h3>Class Attributes</h3> |
| 50 <table> | 50 <table> |
| 51 <tr><td>ChangeIDRole</td></tr> | 51 <tr><td>ChangeIDRole</td></tr> |
| 52 </table> | 52 </table> |
| 53 <h3>Class Methods</h3> | 53 <h3>Class Methods</h3> |
| 58 <table> | 58 <table> |
| 59 <tr> | 59 <tr> |
| 60 <td><a href="#HistoryDialog.__init__">HistoryDialog</a></td> | 60 <td><a href="#HistoryDialog.__init__">HistoryDialog</a></td> |
| 61 <td>Constructor</td> | 61 <td>Constructor</td> |
| 62 </tr><tr> | 62 </tr><tr> |
| 63 <td><a href="#HistoryDialog.accept">accept</a></td> | 63 <td><a href="#HistoryDialog.__appendText">__appendText</a></td> |
| 64 <td>Public slot to undo the selected set of changes.</td> | 64 <td>Private method to append text to the end of the preview pane.</td> |
| 65 </tr><tr> | 65 </tr><tr> |
| 66 <td><a href="#HistoryDialog.on_changesList_currentItemChanged">on_changesList_currentItemChanged</a></td> | 66 <td><a href="#HistoryDialog.__clearHistory">__clearHistory</a></td> |
| 67 <td>Private slot called when a change is selected.</td> | 67 <td>Private method to clear the refactoring history.</td> |
| 68 </tr><tr> | |
| 69 <td><a href="#HistoryDialog.__currentItemChanged">__currentItemChanged</a></td> | |
| 70 <td>Private method to request change data of an item.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#HistoryDialog.__redoChanges">__redoChanges</a></td> | |
| 73 <td>Private method to redo the selected set of changes.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#HistoryDialog.__refreshHistories">__refreshHistories</a></td> | |
| 76 <td>Private method to refresh the undo and redo history lists.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#HistoryDialog.__undoChanges">__undoChanges</a></td> | |
| 79 <td>Private method to undo the selected set of changes.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#HistoryDialog.closeEvent">closeEvent</a></td> | |
| 82 <td>Protected method handling close events.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#HistoryDialog.historyCleared">historyCleared</a></td> | |
| 85 <td>Public method to indicate, that the refactoring history was cleared through the menu.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#HistoryDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 88 <td>Private slot handling the selection of a dialog button.</td> | |
| 89 </tr><tr> | |
| 90 <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> | |
| 92 </tr><tr> | |
| 93 <td><a href="#HistoryDialog.on_redoChangesList_itemClicked">on_redoChangesList_itemClicked</a></td> | |
| 94 <td>Private slot handling a click on a redo entry.</td> | |
| 95 </tr><tr> | |
| 96 <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> | |
| 98 </tr><tr> | |
| 99 <td><a href="#HistoryDialog.on_undoChangesList_itemClicked">on_undoChangesList_itemClicked</a></td> | |
| 100 <td>Private slot handling a click on an undo entry.</td> | |
| 101 </tr><tr> | |
| 102 <td><a href="#HistoryDialog.processHistoryCommand">processHistoryCommand</a></td> | |
| 103 <td>Public method to process the data sent by the refactoring client.</td> | |
| 68 </tr> | 104 </tr> |
| 69 </table> | 105 </table> |
| 70 <h3>Static Methods</h3> | 106 <h3>Static Methods</h3> |
| 71 <table> | 107 <table> |
| 72 <tr><td>None</td></tr> | 108 <tr><td>None</td></tr> |
| 73 </table> | 109 </table> |
| 74 <a NAME="HistoryDialog.__init__" ID="HistoryDialog.__init__"></a> | 110 <a NAME="HistoryDialog.__init__" ID="HistoryDialog.__init__"></a> |
| 75 <h4>HistoryDialog (Constructor)</h4> | 111 <h4>HistoryDialog (Constructor)</h4> |
| 76 <b>HistoryDialog</b>(<i>refactoring, changes, isUndo, parent=None</i>) | 112 <b>HistoryDialog</b>(<i>refactoring, filename="", parent=None</i>) |
| 77 <p> | 113 <p> |
| 78 Constructor | 114 Constructor |
| 79 </p><dl> | 115 </p><dl> |
| 80 <dt><i>refactoring</i></dt> | 116 <dt><i>refactoring</i> (RefactoringServer)</dt> |
| 81 <dd> | 117 <dd> |
| 82 reference to the main refactoring object | 118 reference to the main refactoring object |
| 83 (Refactoring) | 119 </dd><dt><i>filename</i> (str)</dt> |
| 84 </dd><dt><i>changes</i></dt> | 120 <dd> |
| 85 <dd> | 121 name of the file to show the history for |
| 86 list of ChangeSet objects | 122 </dd><dt><i>parent</i> (QWidget)</dt> |
| 87 (list of rope.base.change.ChangeSet) | 123 <dd> |
| 88 </dd><dt><i>isUndo</i></dt> | 124 reference to the parent widget |
| 89 <dd> | 125 </dd> |
| 90 flag indicating an undo history dialog (boolean) | 126 </dl><a NAME="HistoryDialog.__appendText" ID="HistoryDialog.__appendText"></a> |
| 91 </dd><dt><i>parent</i></dt> | 127 <h4>HistoryDialog.__appendText</h4> |
| 92 <dd> | 128 <b>__appendText</b>(<i>txt, charFormat</i>) |
| 93 reference to the parent widget (QWidget) | 129 <p> |
| 94 </dd> | 130 Private method to append text to the end of the preview pane. |
| 95 </dl><a NAME="HistoryDialog.accept" ID="HistoryDialog.accept"></a> | 131 </p><dl> |
| 96 <h4>HistoryDialog.accept</h4> | 132 <dt><i>txt</i> (str)</dt> |
| 97 <b>accept</b>(<i></i>) | 133 <dd> |
| 98 <p> | 134 text to insert |
| 99 Public slot to undo the selected set of changes. | 135 </dd><dt><i>charFormat</i> (QTextCharFormat)</dt> |
| 100 </p><a NAME="HistoryDialog.on_changesList_currentItemChanged" ID="HistoryDialog.on_changesList_currentItemChanged"></a> | 136 <dd> |
| 101 <h4>HistoryDialog.on_changesList_currentItemChanged</h4> | 137 text format to be used |
| 102 <b>on_changesList_currentItemChanged</b>(<i>current, previous</i>) | 138 </dd> |
| 103 <p> | 139 </dl><a NAME="HistoryDialog.__clearHistory" ID="HistoryDialog.__clearHistory"></a> |
| 104 Private slot called when a change is selected. | 140 <h4>HistoryDialog.__clearHistory</h4> |
| 105 </p><dl> | 141 <b>__clearHistory</b>(<i></i>) |
| 106 <dt><i>current</i></dt> | 142 <p> |
| 107 <dd> | 143 Private method to clear the refactoring history. |
| 108 reference to the new current item (QListWidgetItem) | 144 </p><a NAME="HistoryDialog.__currentItemChanged" ID="HistoryDialog.__currentItemChanged"></a> |
| 109 </dd><dt><i>previous</i></dt> | 145 <h4>HistoryDialog.__currentItemChanged</h4> |
| 110 <dd> | 146 <b>__currentItemChanged</b>(<i>current</i>) |
| 111 reference to the old current item (QListWidgetItem) | 147 <p> |
| 148 Private method to request change data of an item. | |
| 149 </p><dl> | |
| 150 <dt><i>current</i> (QListWidgetItem)</dt> | |
| 151 <dd> | |
| 152 reference to the item to get change data for | |
| 153 </dd> | |
| 154 </dl><a NAME="HistoryDialog.__redoChanges" ID="HistoryDialog.__redoChanges"></a> | |
| 155 <h4>HistoryDialog.__redoChanges</h4> | |
| 156 <b>__redoChanges</b>(<i></i>) | |
| 157 <p> | |
| 158 Private method to redo the selected set of changes. | |
| 159 </p><a NAME="HistoryDialog.__refreshHistories" ID="HistoryDialog.__refreshHistories"></a> | |
| 160 <h4>HistoryDialog.__refreshHistories</h4> | |
| 161 <b>__refreshHistories</b>(<i></i>) | |
| 162 <p> | |
| 163 Private method to refresh the undo and redo history lists. | |
| 164 </p><a NAME="HistoryDialog.__undoChanges" ID="HistoryDialog.__undoChanges"></a> | |
| 165 <h4>HistoryDialog.__undoChanges</h4> | |
| 166 <b>__undoChanges</b>(<i></i>) | |
| 167 <p> | |
| 168 Private method to undo the selected set of changes. | |
| 169 </p><a NAME="HistoryDialog.closeEvent" ID="HistoryDialog.closeEvent"></a> | |
| 170 <h4>HistoryDialog.closeEvent</h4> | |
| 171 <b>closeEvent</b>(<i>evt</i>) | |
| 172 <p> | |
| 173 Protected method handling close events. | |
| 174 </p><dl> | |
| 175 <dt><i>evt</i> (QCloseEvent)</dt> | |
| 176 <dd> | |
| 177 reference to the close event object | |
| 178 </dd> | |
| 179 </dl><a NAME="HistoryDialog.historyCleared" ID="HistoryDialog.historyCleared"></a> | |
| 180 <h4>HistoryDialog.historyCleared</h4> | |
| 181 <b>historyCleared</b>(<i></i>) | |
| 182 <p> | |
| 183 Public method to indicate, that the refactoring history was cleared | |
| 184 through the menu. | |
| 185 </p><a NAME="HistoryDialog.on_buttonBox_clicked" ID="HistoryDialog.on_buttonBox_clicked"></a> | |
| 186 <h4>HistoryDialog.on_buttonBox_clicked</h4> | |
| 187 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 188 <p> | |
| 189 Private slot handling the selection of a dialog button. | |
| 190 </p><dl> | |
| 191 <dt><i>button</i> (QAbstractButton)</dt> | |
| 192 <dd> | |
| 193 reference to the button clicked | |
| 194 </dd> | |
| 195 </dl><a NAME="HistoryDialog.on_redoChangesList_currentItemChanged" ID="HistoryDialog.on_redoChangesList_currentItemChanged"></a> | |
| 196 <h4>HistoryDialog.on_redoChangesList_currentItemChanged</h4> | |
| 197 <b>on_redoChangesList_currentItemChanged</b>(<i>current, previous</i>) | |
| 198 <p> | |
| 199 Private slot handling a change of the current redo change. | |
| 200 </p><dl> | |
| 201 <dt><i>current</i> (QListWidgetItem)</dt> | |
| 202 <dd> | |
| 203 reference to the new current redo item | |
| 204 </dd><dt><i>previous</i> (QListWidgetItem)</dt> | |
| 205 <dd> | |
| 206 reference to the previous current redo item | |
| 207 </dd> | |
| 208 </dl><a NAME="HistoryDialog.on_redoChangesList_itemClicked" ID="HistoryDialog.on_redoChangesList_itemClicked"></a> | |
| 209 <h4>HistoryDialog.on_redoChangesList_itemClicked</h4> | |
| 210 <b>on_redoChangesList_itemClicked</b>(<i>item</i>) | |
| 211 <p> | |
| 212 Private slot handling a click on a redo entry. | |
| 213 </p><dl> | |
| 214 <dt><i>item</i> (QListWidgetItem)</dt> | |
| 215 <dd> | |
| 216 reference to the clicked item | |
| 217 </dd> | |
| 218 </dl><a NAME="HistoryDialog.on_undoChangesList_currentItemChanged" ID="HistoryDialog.on_undoChangesList_currentItemChanged"></a> | |
| 219 <h4>HistoryDialog.on_undoChangesList_currentItemChanged</h4> | |
| 220 <b>on_undoChangesList_currentItemChanged</b>(<i>current, previous</i>) | |
| 221 <p> | |
| 222 Private slot handling a change of the current undo change. | |
| 223 </p><dl> | |
| 224 <dt><i>current</i> (QListWidgetItem)</dt> | |
| 225 <dd> | |
| 226 reference to the new current undo item | |
| 227 </dd><dt><i>previous</i> (QListWidgetItem)</dt> | |
| 228 <dd> | |
| 229 reference to the previous current undo item | |
| 230 </dd> | |
| 231 </dl><a NAME="HistoryDialog.on_undoChangesList_itemClicked" ID="HistoryDialog.on_undoChangesList_itemClicked"></a> | |
| 232 <h4>HistoryDialog.on_undoChangesList_itemClicked</h4> | |
| 233 <b>on_undoChangesList_itemClicked</b>(<i>item</i>) | |
| 234 <p> | |
| 235 Private slot handling a click on an undo entry. | |
| 236 </p><dl> | |
| 237 <dt><i>item</i> (QListWidgetItem)</dt> | |
| 238 <dd> | |
| 239 reference to the clicked item | |
| 240 </dd> | |
| 241 </dl><a NAME="HistoryDialog.processHistoryCommand" ID="HistoryDialog.processHistoryCommand"></a> | |
| 242 <h4>HistoryDialog.processHistoryCommand</h4> | |
| 243 <b>processHistoryCommand</b>(<i>data</i>) | |
| 244 <p> | |
| 245 Public method to process the data sent by the refactoring client. | |
| 246 </p><dl> | |
| 247 <dt><i>data</i> (dict)</dt> | |
| 248 <dd> | |
| 249 dictionary containing the history data | |
| 112 </dd> | 250 </dd> |
| 113 </dl> | 251 </dl> |
| 114 <div align="right"><a href="#top">Up</a></div> | 252 <div align="right"><a href="#top">Up</a></div> |
| 115 <hr /> | 253 <hr /> |
| 116 </body></html> | 254 </body></html> |
