diff -r c38750e1bafd -r b4bf79b956bc RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.HistoryDialog.html
--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.HistoryDialog.html Fri Sep 29 10:23:35 2017 +0200
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.HistoryDialog.html Fri Sep 29 10:32:30 2017 +0200
@@ -45,7 +45,7 @@
Class implementing the History dialog.
</p>
<h3>Derived from</h3>
-PreviewDialogBase
+QDialog, Ui_HistoryDialog
<h3>Class Attributes</h3>
<table>
<tr><td>ChangeIDRole</td></tr>
@@ -60,11 +60,47 @@
<td><a href="#HistoryDialog.__init__">HistoryDialog</a></td>
<td>Constructor</td>
</tr><tr>
-<td><a href="#HistoryDialog.accept">accept</a></td>
-<td>Public slot to undo the selected set of changes.</td>
+<td><a href="#HistoryDialog.__appendText">__appendText</a></td>
+<td>Private method to append text to the end of the preview pane.</td>
+</tr><tr>
+<td><a href="#HistoryDialog.__clearHistory">__clearHistory</a></td>
+<td>Private method to clear the refactoring history.</td>
+</tr><tr>
+<td><a href="#HistoryDialog.__currentItemChanged">__currentItemChanged</a></td>
+<td>Private method to request change data of an item.</td>
+</tr><tr>
+<td><a href="#HistoryDialog.__redoChanges">__redoChanges</a></td>
+<td>Private method to redo the selected set of changes.</td>
+</tr><tr>
+<td><a href="#HistoryDialog.__refreshHistories">__refreshHistories</a></td>
+<td>Private method to refresh the undo and redo history lists.</td>
+</tr><tr>
+<td><a href="#HistoryDialog.__undoChanges">__undoChanges</a></td>
+<td>Private method to undo the selected set of changes.</td>
+</tr><tr>
+<td><a href="#HistoryDialog.closeEvent">closeEvent</a></td>
+<td>Protected method handling close events.</td>
</tr><tr>
-<td><a href="#HistoryDialog.on_changesList_currentItemChanged">on_changesList_currentItemChanged</a></td>
-<td>Private slot called when a change is selected.</td>
+<td><a href="#HistoryDialog.historyCleared">historyCleared</a></td>
+<td>Public method to indicate, that the refactoring history was cleared through the menu.</td>
+</tr><tr>
+<td><a href="#HistoryDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
+<td>Private slot handling the selection of a dialog button.</td>
+</tr><tr>
+<td><a href="#HistoryDialog.on_redoChangesList_currentItemChanged">on_redoChangesList_currentItemChanged</a></td>
+<td>Private slot handling a change of the current redo change.</td>
+</tr><tr>
+<td><a href="#HistoryDialog.on_redoChangesList_itemClicked">on_redoChangesList_itemClicked</a></td>
+<td>Private slot handling a click on a redo entry.</td>
+</tr><tr>
+<td><a href="#HistoryDialog.on_undoChangesList_currentItemChanged">on_undoChangesList_currentItemChanged</a></td>
+<td>Private slot handling a change of the current undo change.</td>
+</tr><tr>
+<td><a href="#HistoryDialog.on_undoChangesList_itemClicked">on_undoChangesList_itemClicked</a></td>
+<td>Private slot handling a click on an undo entry.</td>
+</tr><tr>
+<td><a href="#HistoryDialog.processHistoryCommand">processHistoryCommand</a></td>
+<td>Public method to process the data sent by the refactoring client.</td>
</tr>
</table>
<h3>Static Methods</h3>
@@ -73,42 +109,144 @@
</table>
<a NAME="HistoryDialog.__init__" ID="HistoryDialog.__init__"></a>
<h4>HistoryDialog (Constructor)</h4>
-<b>HistoryDialog</b>(<i>refactoring, changes, isUndo, parent=None</i>)
+<b>HistoryDialog</b>(<i>refactoring, filename="", parent=None</i>)
<p>
Constructor
</p><dl>
-<dt><i>refactoring</i></dt>
+<dt><i>refactoring</i> (RefactoringServer)</dt>
<dd>
reference to the main refactoring object
- (Refactoring)
-</dd><dt><i>changes</i></dt>
+</dd><dt><i>filename</i> (str)</dt>
+<dd>
+name of the file to show the history for
+</dd><dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl><a NAME="HistoryDialog.__appendText" ID="HistoryDialog.__appendText"></a>
+<h4>HistoryDialog.__appendText</h4>
+<b>__appendText</b>(<i>txt, charFormat</i>)
+<p>
+ Private method to append text to the end of the preview pane.
+</p><dl>
+<dt><i>txt</i> (str)</dt>
+<dd>
+text to insert
+</dd><dt><i>charFormat</i> (QTextCharFormat)</dt>
<dd>
-list of ChangeSet objects
- (list of rope.base.change.ChangeSet)
-</dd><dt><i>isUndo</i></dt>
+text format to be used
+</dd>
+</dl><a NAME="HistoryDialog.__clearHistory" ID="HistoryDialog.__clearHistory"></a>
+<h4>HistoryDialog.__clearHistory</h4>
+<b>__clearHistory</b>(<i></i>)
+<p>
+ Private method to clear the refactoring history.
+</p><a NAME="HistoryDialog.__currentItemChanged" ID="HistoryDialog.__currentItemChanged"></a>
+<h4>HistoryDialog.__currentItemChanged</h4>
+<b>__currentItemChanged</b>(<i>current</i>)
+<p>
+ Private method to request change data of an item.
+</p><dl>
+<dt><i>current</i> (QListWidgetItem)</dt>
<dd>
-flag indicating an undo history dialog (boolean)
-</dd><dt><i>parent</i></dt>
+reference to the item to get change data for
+</dd>
+</dl><a NAME="HistoryDialog.__redoChanges" ID="HistoryDialog.__redoChanges"></a>
+<h4>HistoryDialog.__redoChanges</h4>
+<b>__redoChanges</b>(<i></i>)
+<p>
+ Private method to redo the selected set of changes.
+</p><a NAME="HistoryDialog.__refreshHistories" ID="HistoryDialog.__refreshHistories"></a>
+<h4>HistoryDialog.__refreshHistories</h4>
+<b>__refreshHistories</b>(<i></i>)
+<p>
+ Private method to refresh the undo and redo history lists.
+</p><a NAME="HistoryDialog.__undoChanges" ID="HistoryDialog.__undoChanges"></a>
+<h4>HistoryDialog.__undoChanges</h4>
+<b>__undoChanges</b>(<i></i>)
+<p>
+ Private method to undo the selected set of changes.
+</p><a NAME="HistoryDialog.closeEvent" ID="HistoryDialog.closeEvent"></a>
+<h4>HistoryDialog.closeEvent</h4>
+<b>closeEvent</b>(<i>evt</i>)
+<p>
+ Protected method handling close events.
+</p><dl>
+<dt><i>evt</i> (QCloseEvent)</dt>
<dd>
-reference to the parent widget (QWidget)
+reference to the close event object
</dd>
-</dl><a NAME="HistoryDialog.accept" ID="HistoryDialog.accept"></a>
-<h4>HistoryDialog.accept</h4>
-<b>accept</b>(<i></i>)
+</dl><a NAME="HistoryDialog.historyCleared" ID="HistoryDialog.historyCleared"></a>
+<h4>HistoryDialog.historyCleared</h4>
+<b>historyCleared</b>(<i></i>)
+<p>
+ Public method to indicate, that the refactoring history was cleared
+ through the menu.
+</p><a NAME="HistoryDialog.on_buttonBox_clicked" ID="HistoryDialog.on_buttonBox_clicked"></a>
+<h4>HistoryDialog.on_buttonBox_clicked</h4>
+<b>on_buttonBox_clicked</b>(<i>button</i>)
<p>
- Public slot to undo the selected set of changes.
-</p><a NAME="HistoryDialog.on_changesList_currentItemChanged" ID="HistoryDialog.on_changesList_currentItemChanged"></a>
-<h4>HistoryDialog.on_changesList_currentItemChanged</h4>
-<b>on_changesList_currentItemChanged</b>(<i>current, previous</i>)
+ Private slot handling the selection of a dialog button.
+</p><dl>
+<dt><i>button</i> (QAbstractButton)</dt>
+<dd>
+reference to the button clicked
+</dd>
+</dl><a NAME="HistoryDialog.on_redoChangesList_currentItemChanged" ID="HistoryDialog.on_redoChangesList_currentItemChanged"></a>
+<h4>HistoryDialog.on_redoChangesList_currentItemChanged</h4>
+<b>on_redoChangesList_currentItemChanged</b>(<i>current, previous</i>)
+<p>
+ Private slot handling a change of the current redo change.
+</p><dl>
+<dt><i>current</i> (QListWidgetItem)</dt>
+<dd>
+reference to the new current redo item
+</dd><dt><i>previous</i> (QListWidgetItem)</dt>
+<dd>
+reference to the previous current redo item
+</dd>
+</dl><a NAME="HistoryDialog.on_redoChangesList_itemClicked" ID="HistoryDialog.on_redoChangesList_itemClicked"></a>
+<h4>HistoryDialog.on_redoChangesList_itemClicked</h4>
+<b>on_redoChangesList_itemClicked</b>(<i>item</i>)
<p>
- Private slot called when a change is selected.
+ Private slot handling a click on a redo entry.
</p><dl>
-<dt><i>current</i></dt>
+<dt><i>item</i> (QListWidgetItem)</dt>
+<dd>
+reference to the clicked item
+</dd>
+</dl><a NAME="HistoryDialog.on_undoChangesList_currentItemChanged" ID="HistoryDialog.on_undoChangesList_currentItemChanged"></a>
+<h4>HistoryDialog.on_undoChangesList_currentItemChanged</h4>
+<b>on_undoChangesList_currentItemChanged</b>(<i>current, previous</i>)
+<p>
+ Private slot handling a change of the current undo change.
+</p><dl>
+<dt><i>current</i> (QListWidgetItem)</dt>
+<dd>
+reference to the new current undo item
+</dd><dt><i>previous</i> (QListWidgetItem)</dt>
<dd>
-reference to the new current item (QListWidgetItem)
-</dd><dt><i>previous</i></dt>
+reference to the previous current undo item
+</dd>
+</dl><a NAME="HistoryDialog.on_undoChangesList_itemClicked" ID="HistoryDialog.on_undoChangesList_itemClicked"></a>
+<h4>HistoryDialog.on_undoChangesList_itemClicked</h4>
+<b>on_undoChangesList_itemClicked</b>(<i>item</i>)
+<p>
+ Private slot handling a click on an undo entry.
+</p><dl>
+<dt><i>item</i> (QListWidgetItem)</dt>
<dd>
-reference to the old current item (QListWidgetItem)
+reference to the clicked item
+</dd>
+</dl><a NAME="HistoryDialog.processHistoryCommand" ID="HistoryDialog.processHistoryCommand"></a>
+<h4>HistoryDialog.processHistoryCommand</h4>
+<b>processHistoryCommand</b>(<i>data</i>)
+<p>
+ Public method to process the data sent by the refactoring client.
+</p><dl>
+<dt><i>data</i> (dict)</dt>
+<dd>
+dictionary containing the history data
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
