--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnStatusDialog.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnStatusDialog.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,55 +7,52 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsSubversion.SvnStatusDialog</h1>
-
<p>
Module implementing a dialog to show the output of the svn status command
process.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#SvnStatusDialog">SvnStatusDialog</a></td>
<td>Class implementing a dialog to show the output of the svn status command process.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="SvnStatusDialog" ID="SvnStatusDialog"></a>
<h2>SvnStatusDialog</h2>
-
<p>
Class implementing a dialog to show the output of the svn status command
process.
</p>
+
<h3>Derived from</h3>
QWidget, Ui_SvnStatusDialog
<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="#SvnStatusDialog.__init__">SvnStatusDialog</a></td>
<td>Constructor</td>
@@ -261,19 +258,20 @@
<td>Public slot to start the svn status command.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="SvnStatusDialog.__init__" ID="SvnStatusDialog.__init__"></a>
<h4>SvnStatusDialog (Constructor)</h4>
<b>SvnStatusDialog</b>(<i>vcs, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>vcs</i> (Subversion)</dt>
@@ -288,45 +286,45 @@
<a NAME="SvnStatusDialog.__add" ID="SvnStatusDialog.__add"></a>
<h4>SvnStatusDialog.__add</h4>
<b>__add</b>(<i></i>)
-
<p>
Private slot to handle the Add context menu entry.
</p>
+
<a NAME="SvnStatusDialog.__addToChangelist" ID="SvnStatusDialog.__addToChangelist"></a>
<h4>SvnStatusDialog.__addToChangelist</h4>
<b>__addToChangelist</b>(<i></i>)
-
<p>
Private slot to add entries to a changelist.
</p>
+
<a NAME="SvnStatusDialog.__breakLock" ID="SvnStatusDialog.__breakLock"></a>
<h4>SvnStatusDialog.__breakLock</h4>
<b>__breakLock</b>(<i></i>)
-
<p>
Private slot to handle the Break Lock context menu entry.
</p>
+
<a NAME="SvnStatusDialog.__commit" ID="SvnStatusDialog.__commit"></a>
<h4>SvnStatusDialog.__commit</h4>
<b>__commit</b>(<i></i>)
-
<p>
Private slot to handle the Commit context menu entry.
</p>
+
<a NAME="SvnStatusDialog.__commitDeselectAll" ID="SvnStatusDialog.__commitDeselectAll"></a>
<h4>SvnStatusDialog.__commitDeselectAll</h4>
<b>__commitDeselectAll</b>(<i></i>)
-
<p>
Private slot to deselect all entries from commit.
</p>
+
<a NAME="SvnStatusDialog.__commitSelect" ID="SvnStatusDialog.__commitSelect"></a>
<h4>SvnStatusDialog.__commitSelect</h4>
<b>__commitSelect</b>(<i>selected</i>)
-
<p>
Private slot to select or deselect all entries.
</p>
+
<dl>
<dt><i>selected</i> (bool)</dt>
@@ -337,39 +335,39 @@
<a NAME="SvnStatusDialog.__commitSelectAll" ID="SvnStatusDialog.__commitSelectAll"></a>
<h4>SvnStatusDialog.__commitSelectAll</h4>
<b>__commitSelectAll</b>(<i></i>)
-
<p>
Private slot to select all entries for commit.
</p>
+
<a NAME="SvnStatusDialog.__committed" ID="SvnStatusDialog.__committed"></a>
<h4>SvnStatusDialog.__committed</h4>
<b>__committed</b>(<i></i>)
-
<p>
Private slot called after the commit has finished.
</p>
+
<a NAME="SvnStatusDialog.__diff" ID="SvnStatusDialog.__diff"></a>
<h4>SvnStatusDialog.__diff</h4>
<b>__diff</b>(<i></i>)
-
<p>
Private slot to handle the Diff context menu entry.
</p>
+
<a NAME="SvnStatusDialog.__finish" ID="SvnStatusDialog.__finish"></a>
<h4>SvnStatusDialog.__finish</h4>
<b>__finish</b>(<i></i>)
-
<p>
Private slot called when the process finished or the user pressed
the button.
</p>
+
<a NAME="SvnStatusDialog.__generateItem" ID="SvnStatusDialog.__generateItem"></a>
<h4>SvnStatusDialog.__generateItem</h4>
<b>__generateItem</b>(<i>status, propStatus, locked, history, switched, lockinfo, uptodate, revision, change, author, path, </i>)
-
<p>
Private method to generate a status item in the status list.
</p>
+
<dl>
<dt><i>status</i> (str)</dt>
@@ -420,11 +418,11 @@
<a NAME="SvnStatusDialog.__getChangelistItems" ID="SvnStatusDialog.__getChangelistItems"></a>
<h4>SvnStatusDialog.__getChangelistItems</h4>
<b>__getChangelistItems</b>(<i></i>)
-
<p>
Private method to retrieve all entries, that are members of
a changelist.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -440,10 +438,10 @@
<a NAME="SvnStatusDialog.__getCommitableItems" ID="SvnStatusDialog.__getCommitableItems"></a>
<h4>SvnStatusDialog.__getCommitableItems</h4>
<b>__getCommitableItems</b>(<i></i>)
-
<p>
Private method to retrieve all entries the user wants to commit.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -459,10 +457,10 @@
<a NAME="SvnStatusDialog.__getLockActionItems" ID="SvnStatusDialog.__getLockActionItems"></a>
<h4>SvnStatusDialog.__getLockActionItems</h4>
<b>__getLockActionItems</b>(<i>indicators</i>)
-
<p>
Private method to retrieve all emtries, that have a locked status.
</p>
+
<dl>
<dt><i>indicators</i> (list of str)</dt>
@@ -485,10 +483,10 @@
<a NAME="SvnStatusDialog.__getMissingItems" ID="SvnStatusDialog.__getMissingItems"></a>
<h4>SvnStatusDialog.__getMissingItems</h4>
<b>__getMissingItems</b>(<i></i>)
-
<p>
Private method to retrieve all entries, that have a missing status.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -504,10 +502,10 @@
<a NAME="SvnStatusDialog.__getModifiedItems" ID="SvnStatusDialog.__getModifiedItems"></a>
<h4>SvnStatusDialog.__getModifiedItems</h4>
<b>__getModifiedItems</b>(<i></i>)
-
<p>
Private method to retrieve all entries, that have a modified status.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -523,11 +521,11 @@
<a NAME="SvnStatusDialog.__getNonChangelistItems" ID="SvnStatusDialog.__getNonChangelistItems"></a>
<h4>SvnStatusDialog.__getNonChangelistItems</h4>
<b>__getNonChangelistItems</b>(<i></i>)
-
<p>
Private method to retrieve all entries, that are not members of
a changelist.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -543,11 +541,11 @@
<a NAME="SvnStatusDialog.__getUnversionedItems" ID="SvnStatusDialog.__getUnversionedItems"></a>
<h4>SvnStatusDialog.__getUnversionedItems</h4>
<b>__getUnversionedItems</b>(<i></i>)
-
<p>
Private method to retrieve all entries, that have an unversioned
status.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -563,17 +561,17 @@
<a NAME="SvnStatusDialog.__lock" ID="SvnStatusDialog.__lock"></a>
<h4>SvnStatusDialog.__lock</h4>
<b>__lock</b>(<i></i>)
-
<p>
Private slot to handle the Lock context menu entry.
</p>
+
<a NAME="SvnStatusDialog.__procFinished" ID="SvnStatusDialog.__procFinished"></a>
<h4>SvnStatusDialog.__procFinished</h4>
<b>__procFinished</b>(<i>exitCode, exitStatus</i>)
-
<p>
Private slot connected to the finished signal.
</p>
+
<dl>
<dt><i>exitCode</i> (int)</dt>
@@ -588,7 +586,6 @@
<a NAME="SvnStatusDialog.__readStderr" ID="SvnStatusDialog.__readStderr"></a>
<h4>SvnStatusDialog.__readStderr</h4>
<b>__readStderr</b>(<i></i>)
-
<p>
Private slot to handle the readyReadStandardError signal.
</p>
@@ -596,10 +593,10 @@
It reads the error output of the process and inserts it into the
error pane.
</p>
+
<a NAME="SvnStatusDialog.__readStdout" ID="SvnStatusDialog.__readStdout"></a>
<h4>SvnStatusDialog.__readStdout</h4>
<b>__readStdout</b>(<i></i>)
-
<p>
Private slot to handle the readyReadStandardOutput signal.
</p>
@@ -607,55 +604,56 @@
It reads the output of the process, formats it and inserts it into
the contents pane.
</p>
+
<a NAME="SvnStatusDialog.__removeFromChangelist" ID="SvnStatusDialog.__removeFromChangelist"></a>
<h4>SvnStatusDialog.__removeFromChangelist</h4>
<b>__removeFromChangelist</b>(<i></i>)
-
<p>
Private slot to remove entries from their change lists.
</p>
+
<a NAME="SvnStatusDialog.__resizeColumns" ID="SvnStatusDialog.__resizeColumns"></a>
<h4>SvnStatusDialog.__resizeColumns</h4>
<b>__resizeColumns</b>(<i></i>)
-
<p>
Private method to resize the list columns.
</p>
+
<a NAME="SvnStatusDialog.__resort" ID="SvnStatusDialog.__resort"></a>
<h4>SvnStatusDialog.__resort</h4>
<b>__resort</b>(<i></i>)
-
<p>
Private method to resort the tree.
</p>
+
<a NAME="SvnStatusDialog.__restoreMissing" ID="SvnStatusDialog.__restoreMissing"></a>
<h4>SvnStatusDialog.__restoreMissing</h4>
<b>__restoreMissing</b>(<i></i>)
-
<p>
Private slot to handle the Restore Missing context menu entry.
</p>
+
<a NAME="SvnStatusDialog.__revert" ID="SvnStatusDialog.__revert"></a>
<h4>SvnStatusDialog.__revert</h4>
<b>__revert</b>(<i></i>)
-
<p>
Private slot to handle the Revert context menu entry.
</p>
+
<a NAME="SvnStatusDialog.__sbsDiff" ID="SvnStatusDialog.__sbsDiff"></a>
<h4>SvnStatusDialog.__sbsDiff</h4>
<b>__sbsDiff</b>(<i></i>)
-
<p>
Private slot to handle the Side-by-Side Diff context menu entry.
</p>
+
<a NAME="SvnStatusDialog.__showContextMenu" ID="SvnStatusDialog.__showContextMenu"></a>
<h4>SvnStatusDialog.__showContextMenu</h4>
<b>__showContextMenu</b>(<i>coord</i>)
-
<p>
Private slot to show the context menu of the status list.
</p>
+
<dl>
<dt><i>coord</i> (QPoint)</dt>
@@ -666,38 +664,38 @@
<a NAME="SvnStatusDialog.__stealLock" ID="SvnStatusDialog.__stealLock"></a>
<h4>SvnStatusDialog.__stealLock</h4>
<b>__stealLock</b>(<i></i>)
-
<p>
Private slot to handle the Break Lock context menu entry.
</p>
+
<a NAME="SvnStatusDialog.__unlock" ID="SvnStatusDialog.__unlock"></a>
<h4>SvnStatusDialog.__unlock</h4>
<b>__unlock</b>(<i></i>)
-
<p>
Private slot to handle the Unlock context menu entry.
</p>
+
<a NAME="SvnStatusDialog.__updateButtons" ID="SvnStatusDialog.__updateButtons"></a>
<h4>SvnStatusDialog.__updateButtons</h4>
<b>__updateButtons</b>(<i></i>)
-
<p>
Private method to update the VCS buttons status.
</p>
+
<a NAME="SvnStatusDialog.__updateCommitButton" ID="SvnStatusDialog.__updateCommitButton"></a>
<h4>SvnStatusDialog.__updateCommitButton</h4>
<b>__updateCommitButton</b>(<i></i>)
-
<p>
Private method to update the Commit button status.
</p>
+
<a NAME="SvnStatusDialog.closeEvent" ID="SvnStatusDialog.closeEvent"></a>
<h4>SvnStatusDialog.closeEvent</h4>
<b>closeEvent</b>(<i>e</i>)
-
<p>
Protected slot implementing a close event handler.
</p>
+
<dl>
<dt><i>e</i> (QCloseEvent)</dt>
@@ -708,10 +706,10 @@
<a NAME="SvnStatusDialog.keyPressEvent" ID="SvnStatusDialog.keyPressEvent"></a>
<h4>SvnStatusDialog.keyPressEvent</h4>
<b>keyPressEvent</b>(<i>evt</i>)
-
<p>
Protected slot to handle a key press event.
</p>
+
<dl>
<dt><i>evt</i> (QKeyEvent)</dt>
@@ -722,17 +720,17 @@
<a NAME="SvnStatusDialog.on_addButton_clicked" ID="SvnStatusDialog.on_addButton_clicked"></a>
<h4>SvnStatusDialog.on_addButton_clicked</h4>
<b>on_addButton_clicked</b>(<i></i>)
-
<p>
Private slot to handle the press of the Add button.
</p>
+
<a NAME="SvnStatusDialog.on_buttonBox_clicked" ID="SvnStatusDialog.on_buttonBox_clicked"></a>
<h4>SvnStatusDialog.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>
@@ -743,31 +741,31 @@
<a NAME="SvnStatusDialog.on_commitButton_clicked" ID="SvnStatusDialog.on_commitButton_clicked"></a>
<h4>SvnStatusDialog.on_commitButton_clicked</h4>
<b>on_commitButton_clicked</b>(<i></i>)
-
<p>
Private slot to handle the press of the Commit button.
</p>
+
<a NAME="SvnStatusDialog.on_diffButton_clicked" ID="SvnStatusDialog.on_diffButton_clicked"></a>
<h4>SvnStatusDialog.on_diffButton_clicked</h4>
<b>on_diffButton_clicked</b>(<i></i>)
-
<p>
Private slot to handle the press of the Differences button.
</p>
+
<a NAME="SvnStatusDialog.on_input_returnPressed" ID="SvnStatusDialog.on_input_returnPressed"></a>
<h4>SvnStatusDialog.on_input_returnPressed</h4>
<b>on_input_returnPressed</b>(<i></i>)
-
<p>
Private slot to handle the press of the return key in the input field.
</p>
+
<a NAME="SvnStatusDialog.on_passwordCheckBox_toggled" ID="SvnStatusDialog.on_passwordCheckBox_toggled"></a>
<h4>SvnStatusDialog.on_passwordCheckBox_toggled</h4>
<b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
-
<p>
Private slot to handle the password checkbox toggled.
</p>
+
<dl>
<dt><i>isOn</i> (bool)</dt>
@@ -778,45 +776,45 @@
<a NAME="SvnStatusDialog.on_refreshButton_clicked" ID="SvnStatusDialog.on_refreshButton_clicked"></a>
<h4>SvnStatusDialog.on_refreshButton_clicked</h4>
<b>on_refreshButton_clicked</b>(<i></i>)
-
<p>
Private slot to refresh the status display.
</p>
+
<a NAME="SvnStatusDialog.on_restoreButton_clicked" ID="SvnStatusDialog.on_restoreButton_clicked"></a>
<h4>SvnStatusDialog.on_restoreButton_clicked</h4>
<b>on_restoreButton_clicked</b>(<i></i>)
-
<p>
Private slot to handle the press of the Restore button.
</p>
+
<a NAME="SvnStatusDialog.on_revertButton_clicked" ID="SvnStatusDialog.on_revertButton_clicked"></a>
<h4>SvnStatusDialog.on_revertButton_clicked</h4>
<b>on_revertButton_clicked</b>(<i></i>)
-
<p>
Private slot to handle the press of the Revert button.
</p>
+
<a NAME="SvnStatusDialog.on_sbsDiffButton_clicked" ID="SvnStatusDialog.on_sbsDiffButton_clicked"></a>
<h4>SvnStatusDialog.on_sbsDiffButton_clicked</h4>
<b>on_sbsDiffButton_clicked</b>(<i></i>)
-
<p>
Private slot to handle the press of the Side-by-Side Diff button.
</p>
+
<a NAME="SvnStatusDialog.on_sendButton_clicked" ID="SvnStatusDialog.on_sendButton_clicked"></a>
<h4>SvnStatusDialog.on_sendButton_clicked</h4>
<b>on_sendButton_clicked</b>(<i></i>)
-
<p>
Private slot to send the input to the subversion process.
</p>
+
<a NAME="SvnStatusDialog.on_statusFilterCombo_activated" ID="SvnStatusDialog.on_statusFilterCombo_activated"></a>
<h4>SvnStatusDialog.on_statusFilterCombo_activated</h4>
<b>on_statusFilterCombo_activated</b>(<i>index</i>)
-
<p>
Private slot to react to the selection of a status filter.
</p>
+
<dl>
<dt><i>index</i> (int)</dt>
@@ -827,10 +825,10 @@
<a NAME="SvnStatusDialog.on_statusList_itemChanged" ID="SvnStatusDialog.on_statusList_itemChanged"></a>
<h4>SvnStatusDialog.on_statusList_itemChanged</h4>
<b>on_statusList_itemChanged</b>(<i>item, column</i>)
-
<p>
Private slot to act upon item changes.
</p>
+
<dl>
<dt><i>item</i> (QTreeWidgetItem)</dt>
@@ -845,17 +843,17 @@
<a NAME="SvnStatusDialog.on_statusList_itemSelectionChanged" ID="SvnStatusDialog.on_statusList_itemSelectionChanged"></a>
<h4>SvnStatusDialog.on_statusList_itemSelectionChanged</h4>
<b>on_statusList_itemSelectionChanged</b>(<i></i>)
-
<p>
Private slot to act upon changes of selected items.
</p>
+
<a NAME="SvnStatusDialog.start" ID="SvnStatusDialog.start"></a>
<h4>SvnStatusDialog.start</h4>
<b>start</b>(<i>fn</i>)
-
<p>
Public slot to start the svn status command.
</p>
+
<dl>
<dt><i>fn</i> (str or list of str)</dt>
@@ -865,4 +863,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
