--- a/src/eric7/Documentation/Source/eric7.UI.CompareDialog.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.UI.CompareDialog.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,20 +7,18 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.UI.CompareDialog</h1>
-
<p>
Module implementing a dialog to compare two files and show the result side by
side.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#CompareDialog">CompareDialog</a></td>
<td>Class implementing a dialog to compare two files and show the result side by side.</td>
@@ -30,10 +28,9 @@
<td>Main window class for the standalone dialog.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#removeMarkers">removeMarkers</a></td>
<td>Internal function to remove all diff markers.</td>
@@ -43,31 +40,30 @@
<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>
Class implementing a dialog to compare two files and show the result side
by side.
</p>
+
<h3>Derived from</h3>
QWidget, Ui_CompareDialog
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#CompareDialog.__init__">CompareDialog</a></td>
<td>Constructor</td>
@@ -133,19 +129,20 @@
<td>Public slot to show the dialog.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="CompareDialog.__init__" ID="CompareDialog.__init__"></a>
<h4>CompareDialog (Constructor)</h4>
<b>CompareDialog</b>(<i>files=None, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>files</i> (list of tuples of (str, str))</dt>
@@ -160,10 +157,10 @@
<a NAME="CompareDialog.__appendText" ID="CompareDialog.__appendText"></a>
<h4>CompareDialog.__appendText</h4>
<b>__appendText</b>(<i>pane, linenumber, line, charFormat, interLine=False</i>)
-
<p>
Private method to append text to the end of the contents pane.
</p>
+
<dl>
<dt><i>pane</i> (QTextedit)</dt>
@@ -190,10 +187,10 @@
<a NAME="CompareDialog.__compare" ID="CompareDialog.__compare"></a>
<h4>CompareDialog.__compare</h4>
<b>__compare</b>(<i>lines1, lines2</i>)
-
<p>
Private method to compare two lists of text.
</p>
+
<dl>
<dt><i>lines1</i> (list of str)</dt>
@@ -208,32 +205,32 @@
<a NAME="CompareDialog.__fileChanged" ID="CompareDialog.__fileChanged"></a>
<h4>CompareDialog.__fileChanged</h4>
<b>__fileChanged</b>(<i></i>)
-
<p>
Private slot to enable/disable the Compare button.
</p>
+
<a NAME="CompareDialog.__generateFormats" ID="CompareDialog.__generateFormats"></a>
<h4>CompareDialog.__generateFormats</h4>
<b>__generateFormats</b>(<i></i>)
-
<p>
Private method to generate the various text formats.
</p>
+
<a NAME="CompareDialog.__moveTextToCurrentDiffPos" ID="CompareDialog.__moveTextToCurrentDiffPos"></a>
<h4>CompareDialog.__moveTextToCurrentDiffPos</h4>
<b>__moveTextToCurrentDiffPos</b>(<i></i>)
-
<p>
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>
Private slot to enable the buttons and set the current diff position
depending on scrollbar position.
</p>
+
<dl>
<dt><i>value</i> (int)</dt>
@@ -244,10 +241,10 @@
<a NAME="CompareDialog.compare" ID="CompareDialog.compare"></a>
<h4>CompareDialog.compare</h4>
<b>compare</b>(<i>lines1, lines2, name1="", name2=""</i>)
-
<p>
Public method to compare two lists of text.
</p>
+
<dl>
<dt><i>lines1</i> (str or list of str)</dt>
@@ -270,10 +267,10 @@
<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>
Private slot called by a button of the button box clicked.
</p>
+
<dl>
<dt><i>button</i> (QAbstractButton)</dt>
@@ -284,38 +281,38 @@
<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>
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>
Private slot to go to the next difference.
</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>
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>
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>
Private slot to connect or disconnect the scrollbars of the displays.
</p>
+
<dl>
<dt><i>sync</i> (bool)</dt>
@@ -326,17 +323,17 @@
<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>
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>
Public slot to show the dialog.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -349,26 +346,24 @@
<hr />
<a NAME="CompareWindow" ID="CompareWindow"></a>
<h2>CompareWindow</h2>
-
<p>
Main window class for the standalone dialog.
</p>
+
<h3>Derived from</h3>
EricMainWindow
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#CompareWindow.__init__">CompareWindow</a></td>
<td>Constructor</td>
@@ -378,19 +373,20 @@
<td>Public method to filter events.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="CompareWindow.__init__" ID="CompareWindow.__init__"></a>
<h4>CompareWindow (Constructor)</h4>
<b>CompareWindow</b>(<i>files=None, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>files</i> (list of [(str, str), (str, str)])</dt>
@@ -405,10 +401,10 @@
<a NAME="CompareWindow.eventFilter" ID="CompareWindow.eventFilter"></a>
<h4>CompareWindow.eventFilter</h4>
<b>eventFilter</b>(<i>obj, event</i>)
-
<p>
Public method to filter events.
</p>
+
<dl>
<dt><i>obj</i> (QObject)</dt>
@@ -438,10 +434,10 @@
<a NAME="removeMarkers" ID="removeMarkers"></a>
<h2>removeMarkers</h2>
<b>removeMarkers</b>(<i>line</i>)
-
<p>
Internal function to remove all diff markers.
</p>
+
<dl>
<dt><i>line</i> (str)</dt>
@@ -467,11 +463,11 @@
<a NAME="sbsdiff" ID="sbsdiff"></a>
<h2>sbsdiff</h2>
<b>sbsdiff</b>(<i>a, b, linenumberwidth=4</i>)
-
<p>
Compare two sequences of lines; generate the delta for display side by
side.
</p>
+
<dl>
<dt><i>a</i> (list of str)</dt>
@@ -509,4 +505,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
