eric: diff Documentation/Source/eric5.UI.CompareDialog.html

diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.UI.CompareDialog.html
--- a/Documentation/Source/eric5.UI.CompareDialog.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.UI.CompareDialog.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.UI.CompareDialog</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#99;&#111;&#109;&#112;&#97;&#114;&#101; &#116;w&#111; &#102;&#105;&#108;&#101;&#115; &#97;&#110;&#100; &#115;&#104;&#111;w &#116;&#104;&#101; &#114;&#101;&#115;&#117;&#108;&#116; &#115;&#105;&#100;&#101; &#98;y &#115;&#105;&#100;&#101;.
+Module implementing a dialog to compare two files and show the result side by side.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,27 +32,27 @@
 <table>
 <tr>
 <td><a href="#CompareDialog">CompareDialog</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#99;&#111;&#109;&#112;&#97;&#114;&#101; &#116;w&#111; &#102;&#105;&#108;&#101;&#115; &#97;&#110;&#100; &#115;&#104;&#111;w &#116;&#104;&#101; &#114;&#101;&#115;&#117;&#108;&#116; &#115;&#105;&#100;&#101; &#98;y &#115;&#105;&#100;&#101;.</td>
+<td>Class implementing a dialog to compare two files and show the result side by side.</td>
 </tr><tr>
 <td><a href="#CompareWindow">CompareWindow</a></td>
-<td>&#77;&#97;&#105;&#110; w&#105;&#110;&#100;&#111;w &#99;&#108;&#97;&#115;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#115;&#116;&#97;&#110;&#100;&#97;&#108;&#111;&#110;&#101; &#100;&#105;&#97;&#108;&#111;&#103;.</td>
+<td>Main window class for the standalone dialog.</td>
 </tr>
 </table>
 <h3>Functions</h3>
 <table>
 <tr>
 <td><a href="#removeMarkers">removeMarkers</a></td>
-<td>&#73;&#110;&#116;&#101;&#114;&#110;&#97;&#108; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#114;&#101;&#109;&#111;v&#101; &#97;&#108;&#108; &#100;&#105;&#102;&#102; &#109;&#97;&#114;&#107;&#101;&#114;&#115;.</td>
+<td>Internal function to remove all diff markers.</td>
 </tr><tr>
 <td><a href="#sbsdiff">sbsdiff</a></td>
-<td>&#67;&#111;&#109;&#112;&#97;&#114;&#101; &#116;w&#111; &#115;&#101;&#113;&#117;&#101;&#110;&#99;&#101;&#115; &#111;&#102; &#108;&#105;&#110;&#101;&#115;&#59; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#100;&#101;&#108;&#116;&#97; &#102;&#111;&#114; &#100;&#105;&#115;&#112;&#108;&#97;y &#115;&#105;&#100;&#101; &#98;y &#115;&#105;&#100;&#101;.</td>
+<td>Compare two sequences of lines; generate the delta for display side by side.</td>
 </tr>
 </table>
 <hr /><hr />
 <a NAME="CompareDialog" ID="CompareDialog"></a>
 <h2>CompareDialog</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#99;&#111;&#109;&#112;&#97;&#114;&#101; &#116;w&#111; &#102;&#105;&#108;&#101;&#115; &#97;&#110;&#100; &#115;&#104;&#111;w &#116;&#104;&#101; &#114;&#101;&#115;&#117;&#108;&#116; &#115;&#105;&#100;&#101; &#98;y &#115;&#105;&#100;&#101;.
+    Class implementing a dialog to compare two files and show the result side by side.
 </p>
 <h3>Derived from</h3>
 QWidget, Ui_CompareDialog
@@ -64,186 +64,186 @@
 <table>
 <tr>
 <td><a href="#CompareDialog.__init__">CompareDialog</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#CompareDialog.__appendText">__appendText</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#112;&#112;&#101;&#110;&#100; &#116;&#101;x&#116; &#116;&#111; &#116;&#104;&#101; &#101;&#110;&#100; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115; &#112;&#97;&#110;&#101;.</td>
+<td>Private method to append text to the end of the contents pane.</td>
 </tr><tr>
 <td><a href="#CompareDialog.__fileChanged">__fileChanged</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#101;&#110;&#97;&#98;&#108;&#101;/&#100;&#105;&#115;&#97;&#98;&#108;&#101; &#116;&#104;&#101; &#67;&#111;&#109;&#112;&#97;&#114;&#101; &#98;&#117;&#116;&#116;&#111;&#110;.</td>
+<td>Private slot to enable/disable the Compare button.</td>
 </tr><tr>
 <td><a href="#CompareDialog.__moveTextToCurrentDiffPos">__moveTextToCurrentDiffPos</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#109;&#111;v&#101; &#116;&#104;&#101; &#116;&#101;x&#116; &#100;&#105;&#115;&#112;&#108;&#97;y &#116;&#111; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#100;&#105;&#102;&#102; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110;.</td>
+<td>Private slot to move the text display to the current diff position.</td>
 </tr><tr>
 <td><a href="#CompareDialog.__scrollBarMoved">__scrollBarMoved</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#101;&#110;&#97;&#98;&#108;&#101; &#116;&#104;&#101; &#98;&#117;&#116;&#116;&#111;&#110;&#115; &#97;&#110;&#100; &#115;&#101;&#116; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#100;&#105;&#102;&#102; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#100;&#101;&#112;&#101;&#110;&#100;&#105;&#110;&#103; &#111;&#110; &#115;&#99;&#114;&#111;&#108;&#108;&#98;&#97;&#114; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110;.</td>
+<td>Private slot to enable the buttons and set the current diff position depending on scrollbar position.</td>
 </tr><tr>
 <td><a href="#CompareDialog.__selectFile">__selectFile</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#100;&#105;&#115;&#112;&#108;&#97;y &#97; &#102;&#105;&#108;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103;.</td>
+<td>Private slot to display a file selection dialog.</td>
 </tr><tr>
 <td><a href="#CompareDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#97; &#98;&#117;&#116;&#116;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#98;&#117;&#116;&#116;&#111;&#110; &#98;&#111;x &#99;&#108;&#105;&#99;&#107;&#101;&#100;.</td>
+<td>Private slot called by a button of the button box clicked.</td>
 </tr><tr>
 <td><a href="#CompareDialog.on_diffButton_clicked">on_diffButton_clicked</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#67;&#111;&#109;&#112;&#97;&#114;&#101; &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;.</td>
+<td>Private slot to handle the Compare button press.</td>
 </tr><tr>
 <td><a href="#CompareDialog.on_downButton_clicked">on_downButton_clicked</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#103;&#111; &#116;&#111; &#116;&#104;&#101; &#110;&#101;x&#116; &#100;&#105;&#102;&#102;&#101;&#114;&#101;&#110;&#99;&#101;.</td>
+<td>Private slot to go to the next difference.</td>
 </tr><tr>
 <td><a href="#CompareDialog.on_file1Button_clicked">on_file1Button_clicked</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#49; &#102;&#105;&#108;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;.</td>
+<td>Private slot to handle the file 1 file selection button press.</td>
 </tr><tr>
 <td><a href="#CompareDialog.on_file2Button_clicked">on_file2Button_clicked</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#50; &#102;&#105;&#108;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;.</td>
+<td>Private slot to handle the file 2 file selection button press.</td>
 </tr><tr>
 <td><a href="#CompareDialog.on_firstButton_clicked">on_firstButton_clicked</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#103;&#111; &#116;&#111; &#116;&#104;&#101; &#102;&#105;&#114;&#115;&#116; &#100;&#105;&#102;&#102;&#101;&#114;&#101;&#110;&#99;&#101;.</td>
+<td>Private slot to go to the first difference.</td>
 </tr><tr>
 <td><a href="#CompareDialog.on_lastButton_clicked">on_lastButton_clicked</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#103;&#111; &#116;&#111; &#116;&#104;&#101; &#108;&#97;&#115;&#116; &#100;&#105;&#102;&#102;&#101;&#114;&#101;&#110;&#99;&#101;.</td>
+<td>Private slot to go to the last difference.</td>
 </tr><tr>
 <td><a href="#CompareDialog.on_synchronizeCheckBox_toggled">on_synchronizeCheckBox_toggled</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#99;&#111;&#110;&#110;&#101;&#99;&#116; &#111;&#114; &#100;&#105;&#115;&#99;&#111;&#110;&#110;&#101;&#99;&#116; &#116;&#104;&#101; &#115;&#99;&#114;&#111;&#108;&#108;&#98;&#97;&#114;&#115; &#111;&#102; &#116;&#104;&#101; &#100;&#105;&#115;&#112;&#108;&#97;y&#115;.</td>
+<td>Private slot to connect or disconnect the scrollbars of the displays.</td>
 </tr><tr>
 <td><a href="#CompareDialog.on_upButton_clicked">on_upButton_clicked</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#103;&#111; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#101;v&#105;&#111;&#117;&#115; &#100;&#105;&#102;&#102;&#101;&#114;&#101;&#110;&#99;&#101;.</td>
+<td>Private slot to go to the previous difference.</td>
 </tr><tr>
 <td><a href="#CompareDialog.show">show</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#100;&#105;&#97;&#108;&#111;&#103;.</td>
+<td>Public slot to show the dialog.</td>
 </tr>
 </table>
 <a NAME="CompareDialog.__init__" ID="CompareDialog.__init__"></a>
 <h4>CompareDialog (Constructor)</h4>
 <b>CompareDialog</b>(<i>files = [], parent = None</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>files</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#102;&#105;&#108;&#101;&#115; &#116;&#111; &#99;&#111;&#109;&#112;&#97;&#114;&#101; &#97;&#110;&#100; &#116;&#104;&#101;&#105;&#114; &#108;&#97;&#98;&#101;&#108;
-            (&#108;&#105;&#115;&#116; &#111;&#102; &#116;w&#111; &#116;&#117;&#112;&#108;&#101;&#115; &#111;&#102; &#116;w&#111; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+list of files to compare and their label
+            (list of two tuples of two strings)
 </dd><dt><i>parent</i></dt>
 <dd>
-&#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+parent widget (QWidget)
 </dd>
 </dl><a NAME="CompareDialog.__appendText" ID="CompareDialog.__appendText"></a>
 <h4>CompareDialog.__appendText</h4>
 <b>__appendText</b>(<i>pane, linenumber, line, format, interLine = False</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#112;&#112;&#101;&#110;&#100; &#116;&#101;x&#116; &#116;&#111; &#116;&#104;&#101; &#101;&#110;&#100; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115; &#112;&#97;&#110;&#101;.
+        Private method to append text to the end of the contents pane.
 </p><dl>
 <dt><i>pane</i></dt>
 <dd>
-&#116;&#101;x&#116; &#101;&#100;&#105;&#116; w&#105;&#100;&#103;&#101;&#116; &#116;&#111; &#97;&#112;&#112;&#101;&#110;&#100; &#116;&#101;x&#116; &#116;&#111; (&#81;&#84;&#101;x&#116;&#101;&#100;&#105;&#116;)
+text edit widget to append text to (QTextedit)
 </dd><dt><i>linenumber</i></dt>
 <dd>
-&#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#108;&#105;&#110;&#101; &#116;&#111; &#105;&#110;&#115;&#101;&#114;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;)
+number of line to insert (string)
 </dd><dt><i>line</i></dt>
 <dd>
-&#116;&#101;x&#116; &#116;&#111; &#105;&#110;&#115;&#101;&#114;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;)
+text to insert (string)
 </dd><dt><i>format</i></dt>
 <dd>
-&#116;&#101;x&#116; &#102;&#111;&#114;&#109;&#97;&#116; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; (&#81;&#84;&#101;x&#116;&#67;&#104;&#97;&#114;&#70;&#111;&#114;&#109;&#97;&#116;)
+text format to be used (QTextCharFormat)
 </dd><dt><i>interLine</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#105;&#110;&#116;&#101;&#114;&#108;&#105;&#110;&#101; &#99;&#104;&#97;&#110;&#103;&#101;&#115; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating interline changes (boolean)
 </dd>
 </dl><a NAME="CompareDialog.__fileChanged" ID="CompareDialog.__fileChanged"></a>
 <h4>CompareDialog.__fileChanged</h4>
 <b>__fileChanged</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#101;&#110;&#97;&#98;&#108;&#101;/&#100;&#105;&#115;&#97;&#98;&#108;&#101; &#116;&#104;&#101; &#67;&#111;&#109;&#112;&#97;&#114;&#101; &#98;&#117;&#116;&#116;&#111;&#110;.
+        Private slot to enable/disable the Compare button.
 </p><a NAME="CompareDialog.__moveTextToCurrentDiffPos" ID="CompareDialog.__moveTextToCurrentDiffPos"></a>
 <h4>CompareDialog.__moveTextToCurrentDiffPos</h4>
 <b>__moveTextToCurrentDiffPos</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#109;&#111;v&#101; &#116;&#104;&#101; &#116;&#101;x&#116; &#100;&#105;&#115;&#112;&#108;&#97;y &#116;&#111; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#100;&#105;&#102;&#102; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110;.
+        Private slot to move the text display to the current diff position.
 </p><a NAME="CompareDialog.__scrollBarMoved" ID="CompareDialog.__scrollBarMoved"></a>
 <h4>CompareDialog.__scrollBarMoved</h4>
 <b>__scrollBarMoved</b>(<i>value</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#101;&#110;&#97;&#98;&#108;&#101; &#116;&#104;&#101; &#98;&#117;&#116;&#116;&#111;&#110;&#115; &#97;&#110;&#100; &#115;&#101;&#116; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#100;&#105;&#102;&#102; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110;
-        &#100;&#101;&#112;&#101;&#110;&#100;&#105;&#110;&#103; &#111;&#110; &#115;&#99;&#114;&#111;&#108;&#108;&#98;&#97;&#114; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110;.
+        Private slot to enable the buttons and set the current diff position
+        depending on scrollbar position.
 </p><dl>
 <dt><i>value</i></dt>
 <dd>
-&#115;&#99;&#114;&#111;&#108;&#108;&#98;&#97;&#114; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+scrollbar position (integer)
 </dd>
 </dl><a NAME="CompareDialog.__selectFile" ID="CompareDialog.__selectFile"></a>
 <h4>CompareDialog.__selectFile</h4>
 <b>__selectFile</b>(<i>lineEdit</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#100;&#105;&#115;&#112;&#108;&#97;y &#97; &#102;&#105;&#108;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103;.
+        Private slot to display a file selection dialog.
 </p><dl>
 <dt><i>lineEdit</i></dt>
 <dd>
-&#102;&#105;&#101;&#108;&#100; &#102;&#111;&#114; &#116;&#104;&#101; &#100;&#105;&#115;&#112;&#108;&#97;y &#111;&#102; &#116;&#104;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#101;&#100; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101;
-                (&#81;&#76;&#105;&#110;&#101;&#69;&#100;&#105;&#116;)
+field for the display of the selected filename
+                (QLineEdit)
 </dd>
 </dl><a NAME="CompareDialog.on_buttonBox_clicked" ID="CompareDialog.on_buttonBox_clicked"></a>
 <h4>CompareDialog.on_buttonBox_clicked</h4>
 <b>on_buttonBox_clicked</b>(<i>button</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#97; &#98;&#117;&#116;&#116;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#98;&#117;&#116;&#116;&#111;&#110; &#98;&#111;x &#99;&#108;&#105;&#99;&#107;&#101;&#100;.
+        Private slot called by a button of the button box clicked.
 </p><dl>
 <dt><i>button</i></dt>
 <dd>
-&#98;&#117;&#116;&#116;&#111;&#110; &#116;&#104;&#97;&#116; w&#97;&#115; &#99;&#108;&#105;&#99;&#107;&#101;&#100; (&#81;&#65;&#98;&#115;&#116;&#114;&#97;&#99;&#116;&#66;&#117;&#116;&#116;&#111;&#110;)
+button that was clicked (QAbstractButton)
 </dd>
 </dl><a NAME="CompareDialog.on_diffButton_clicked" ID="CompareDialog.on_diffButton_clicked"></a>
 <h4>CompareDialog.on_diffButton_clicked</h4>
 <b>on_diffButton_clicked</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#67;&#111;&#109;&#112;&#97;&#114;&#101; &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;.
+        Private slot to handle the Compare button press.
 </p><a NAME="CompareDialog.on_downButton_clicked" ID="CompareDialog.on_downButton_clicked"></a>
 <h4>CompareDialog.on_downButton_clicked</h4>
 <b>on_downButton_clicked</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#103;&#111; &#116;&#111; &#116;&#104;&#101; &#110;&#101;x&#116; &#100;&#105;&#102;&#102;&#101;&#114;&#101;&#110;&#99;&#101;.
+        Private slot to go to the next difference.
 </p><a NAME="CompareDialog.on_file1Button_clicked" ID="CompareDialog.on_file1Button_clicked"></a>
 <h4>CompareDialog.on_file1Button_clicked</h4>
 <b>on_file1Button_clicked</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#49; &#102;&#105;&#108;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;.
+        Private slot to handle the file 1 file selection button press.
 </p><a NAME="CompareDialog.on_file2Button_clicked" ID="CompareDialog.on_file2Button_clicked"></a>
 <h4>CompareDialog.on_file2Button_clicked</h4>
 <b>on_file2Button_clicked</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#50; &#102;&#105;&#108;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;.
+        Private slot to handle the file 2 file selection button press.
 </p><a NAME="CompareDialog.on_firstButton_clicked" ID="CompareDialog.on_firstButton_clicked"></a>
 <h4>CompareDialog.on_firstButton_clicked</h4>
 <b>on_firstButton_clicked</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#103;&#111; &#116;&#111; &#116;&#104;&#101; &#102;&#105;&#114;&#115;&#116; &#100;&#105;&#102;&#102;&#101;&#114;&#101;&#110;&#99;&#101;.
+        Private slot to go to the first difference.
 </p><a NAME="CompareDialog.on_lastButton_clicked" ID="CompareDialog.on_lastButton_clicked"></a>
 <h4>CompareDialog.on_lastButton_clicked</h4>
 <b>on_lastButton_clicked</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#103;&#111; &#116;&#111; &#116;&#104;&#101; &#108;&#97;&#115;&#116; &#100;&#105;&#102;&#102;&#101;&#114;&#101;&#110;&#99;&#101;.
+        Private slot to go to the last difference.
 </p><a NAME="CompareDialog.on_synchronizeCheckBox_toggled" ID="CompareDialog.on_synchronizeCheckBox_toggled"></a>
 <h4>CompareDialog.on_synchronizeCheckBox_toggled</h4>
 <b>on_synchronizeCheckBox_toggled</b>(<i>sync</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#99;&#111;&#110;&#110;&#101;&#99;&#116; &#111;&#114; &#100;&#105;&#115;&#99;&#111;&#110;&#110;&#101;&#99;&#116; &#116;&#104;&#101; &#115;&#99;&#114;&#111;&#108;&#108;&#98;&#97;&#114;&#115; &#111;&#102; &#116;&#104;&#101; &#100;&#105;&#115;&#112;&#108;&#97;y&#115;.
+        Private slot to connect or disconnect the scrollbars of the displays.
 </p><dl>
 <dt><i>sync</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#115;y&#110;&#99;&#104;&#114;&#111;&#110;&#105;&#115;&#97;&#116;&#105;&#111;&#110; &#115;&#116;&#97;&#116;&#117;&#115; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating synchronisation status (boolean)
 </dd>
 </dl><a NAME="CompareDialog.on_upButton_clicked" ID="CompareDialog.on_upButton_clicked"></a>
 <h4>CompareDialog.on_upButton_clicked</h4>
 <b>on_upButton_clicked</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#103;&#111; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#101;v&#105;&#111;&#117;&#115; &#100;&#105;&#102;&#102;&#101;&#114;&#101;&#110;&#99;&#101;.
+        Private slot to go to the previous difference.
 </p><a NAME="CompareDialog.show" ID="CompareDialog.show"></a>
 <h4>CompareDialog.show</h4>
 <b>show</b>(<i>filename = None</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#100;&#105;&#97;&#108;&#111;&#103;.
+        Public slot to show the dialog.
 </p><dl>
 <dt><i>filename</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#97; &#102;&#105;&#108;&#101; &#116;&#111; &#117;&#115;&#101; &#97;&#115; &#116;&#104;&#101; &#102;&#105;&#114;&#115;&#116; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of a file to use as the first file (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -251,7 +251,7 @@
 <a NAME="CompareWindow" ID="CompareWindow"></a>
 <h2>CompareWindow</h2>
 <p>
-    &#77;&#97;&#105;&#110; w&#105;&#110;&#100;&#111;w &#99;&#108;&#97;&#115;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#115;&#116;&#97;&#110;&#100;&#97;&#108;&#111;&#110;&#101; &#100;&#105;&#97;&#108;&#111;&#103;.
+    Main window class for the standalone dialog.
 </p>
 <h3>Derived from</h3>
 QMainWindow
@@ -263,43 +263,43 @@
 <table>
 <tr>
 <td><a href="#CompareWindow.__init__">CompareWindow</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#CompareWindow.eventFilter">eventFilter</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#102;&#105;&#108;&#116;&#101;&#114; &#101;v&#101;&#110;&#116;&#115;.</td>
+<td>Public method to filter events.</td>
 </tr>
 </table>
 <a NAME="CompareWindow.__init__" ID="CompareWindow.__init__"></a>
 <h4>CompareWindow (Constructor)</h4>
 <b>CompareWindow</b>(<i>files = [], parent = None</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>files</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#102;&#105;&#108;&#101;&#115; &#116;&#111; &#99;&#111;&#109;&#112;&#97;&#114;&#101; &#97;&#110;&#100; &#116;&#104;&#101;&#105;&#114; &#108;&#97;&#98;&#101;&#108;
-            (&#108;&#105;&#115;&#116; &#111;&#102; &#116;w&#111; &#116;&#117;&#112;&#108;&#101;&#115; &#111;&#102; &#116;w&#111; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+list of files to compare and their label
+            (list of two tuples of two strings)
 </dd><dt><i>parent</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+reference to the parent widget (QWidget)
 </dd>
 </dl><a NAME="CompareWindow.eventFilter" ID="CompareWindow.eventFilter"></a>
 <h4>CompareWindow.eventFilter</h4>
 <b>eventFilter</b>(<i>obj, event</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#102;&#105;&#108;&#116;&#101;&#114; &#101;v&#101;&#110;&#116;&#115;.
+        Public method to filter events.
 </p><dl>
 <dt><i>obj</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#111;&#98;&#106;&#101;&#99;&#116; &#116;&#104;&#101; &#101;v&#101;&#110;&#116; &#105;&#115; &#109;&#101;&#97;&#110;&#116; &#102;&#111;&#114; (&#81;&#79;&#98;&#106;&#101;&#99;&#116;)
+reference to the object the event is meant for (QObject)
 </dd><dt><i>event</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#101;v&#101;&#110;&#116; &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#69;v&#101;&#110;&#116;)
+reference to the event object (QEvent)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103;, w&#104;&#101;&#116;&#104;&#101;&#114; &#116;&#104;&#101; &#101;v&#101;&#110;&#116; w&#97;&#115; &#104;&#97;&#110;&#100;&#108;&#101;&#100; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating, whether the event was handled (boolean)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -308,16 +308,16 @@
 <h2>removeMarkers</h2>
 <b>removeMarkers</b>(<i>line</i>)
 <p>
-        &#73;&#110;&#116;&#101;&#114;&#110;&#97;&#108; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#114;&#101;&#109;&#111;v&#101; &#97;&#108;&#108; &#100;&#105;&#102;&#102; &#109;&#97;&#114;&#107;&#101;&#114;&#115;.
+        Internal function to remove all diff markers.
 </p><dl>
 <dt><i>line</i></dt>
 <dd>
-&#108;&#105;&#110;&#101; &#116;&#111; w&#111;&#114;&#107; &#111;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+line to work on (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#108;&#105;&#110;&#101; w&#105;&#116;&#104;&#111;&#117;&#116; &#100;&#105;&#102;&#102; &#109;&#97;&#114;&#107;&#101;&#114;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;)
+line without diff markers (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -326,30 +326,30 @@
 <h2>sbsdiff</h2>
 <b>sbsdiff</b>(<i>a, b, linenumberwidth = 4</i>)
 <p>
-    &#67;&#111;&#109;&#112;&#97;&#114;&#101; &#116;w&#111; &#115;&#101;&#113;&#117;&#101;&#110;&#99;&#101;&#115; &#111;&#102; &#108;&#105;&#110;&#101;&#115;&#59; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#100;&#101;&#108;&#116;&#97; &#102;&#111;&#114; &#100;&#105;&#115;&#112;&#108;&#97;y &#115;&#105;&#100;&#101; &#98;y &#115;&#105;&#100;&#101;.
+    Compare two sequences of lines; generate the delta for display side by side.
 </p><dl>
 <dt><i>a</i></dt>
 <dd>
-&#102;&#105;&#114;&#115;&#116; &#115;&#101;&#113;&#117;&#101;&#110;&#99;&#101; &#111;&#102; &#108;&#105;&#110;&#101;&#115; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+first sequence of lines (list of strings)
 </dd><dt><i>b</i></dt>
 <dd>
-&#115;&#101;&#99;&#111;&#110;&#100; &#115;&#101;&#113;&#117;&#101;&#110;&#99;&#101; &#111;&#102; &#108;&#105;&#110;&#101;&#115; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+second sequence of lines (list of strings)
 </dd><dt><i>linenumberwidth</i></dt>
 <dd>
-w&#105;&#100;&#116;&#104; (&#105;&#110; &#99;&#104;&#97;&#114;&#97;&#99;&#116;&#101;&#114;&#115;) &#111;&#102; &#116;&#104;&#101; &#108;&#105;&#110;&#101;&#110;&#117;&#109;&#98;&#101;&#114;&#115; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+width (in characters) of the linenumbers (integer)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#97; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114; y&#105;&#101;&#108;&#100;&#105;&#110;&#103; &#116;&#117;&#112;&#108;&#101;&#115; &#111;&#102; &#100;&#105;&#102;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115;. &#84;&#104;&#101; &#116;&#117;&#112;&#108;&#101; &#105;&#115; &#99;&#111;&#109;&#112;&#111;&#115;&#101;&#100;
-        &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115; &#97;&#115; &#102;&#111;&#108;&#108;&#111;w&#115;.
-        &#60;&#117;&#108;&#62;
-            &#60;&#108;&#105;&#62;&#111;&#112;&#99;&#111;&#100;&#101; -- &#111;&#110;&#101; &#111;&#102; &#101;, &#100;, &#105;, &#114; &#102;&#111;&#114; &#101;&#113;&#117;&#97;&#108;, &#100;&#101;&#108;&#101;&#116;&#101;, &#105;&#110;&#115;&#101;&#114;&#116;, &#114;&#101;&#112;&#108;&#97;&#99;&#101;&#60;/&#108;&#105;&#62;
-            &#60;&#108;&#105;&#62;&#108;&#105;&#110;&#101;&#110;&#111; &#97; -- &#108;&#105;&#110;&#101;&#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#115;&#101;&#113;&#117;&#101;&#110;&#99;&#101; &#97;&#60;/&#108;&#105;&#62;
-            &#60;&#108;&#105;&#62;&#108;&#105;&#110;&#101; &#97; -- &#108;&#105;&#110;&#101; &#111;&#102; &#115;&#101;&#113;&#117;&#101;&#110;&#99;&#101; &#97;&#60;/&#108;&#105;&#62;
-            &#60;&#108;&#105;&#62;&#108;&#105;&#110;&#101;&#110;&#111; &#98; -- &#108;&#105;&#110;&#101;&#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#115;&#101;&#113;&#117;&#101;&#110;&#99;&#101; &#98;&#60;/&#108;&#105;&#62;
-            &#60;&#108;&#105;&#62;&#108;&#105;&#110;&#101; &#98; -- &#108;&#105;&#110;&#101; &#111;&#102; &#115;&#101;&#113;&#117;&#101;&#110;&#99;&#101; &#98;&#60;/&#108;&#105;&#62;
-        &#60;/&#117;&#108;&#62;
+a generator yielding tuples of differences. The tuple is composed
+        of strings as follows.
+        <ul>
+            <li>opcode -- one of e, d, i, r for equal, delete, insert, replace</li>
+            <li>lineno a -- linenumber of sequence a</li>
+            <li>line a -- line of sequence a</li>
+            <li>lineno b -- linenumber of sequence b</li>
+            <li>line b -- line of sequence b</li>
+        </ul>
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>