--- a/src/eric7/Documentation/Source/eric7.VCS.ProjectBrowserHelper.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.VCS.ProjectBrowserHelper.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,50 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.VCS.ProjectBrowserHelper</h1>
-
<p>
Module implementing the base class of the VCS project browser helper.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#VcsProjectBrowserHelper">VcsProjectBrowserHelper</a></td>
<td>Class implementing the base class of the VCS project browser helper.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="VcsProjectBrowserHelper" ID="VcsProjectBrowserHelper"></a>
<h2>VcsProjectBrowserHelper</h2>
-
<p>
Class implementing the base class of the VCS project browser helper.
</p>
+
<h3>Derived from</h3>
QObject
<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="#VcsProjectBrowserHelper.__init__">VcsProjectBrowserHelper</a></td>
<td>Constructor</td>
@@ -127,19 +124,20 @@
<td>Public slot called before the context menu (multiple selections) is shown.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="VcsProjectBrowserHelper.__init__" ID="VcsProjectBrowserHelper.__init__"></a>
<h4>VcsProjectBrowserHelper (Constructor)</h4>
<b>VcsProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject, isTranslationsBrowser, parent=None, name=None, </i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>vcsObject</i> (VersionControl)</dt>
@@ -171,15 +169,14 @@
<a NAME="VcsProjectBrowserHelper._VCSAdd" ID="VcsProjectBrowserHelper._VCSAdd"></a>
<h4>VcsProjectBrowserHelper._VCSAdd</h4>
<b>_VCSAdd</b>(<i></i>)
-
<p>
Protected slot called by the context menu to add the selected file to
the VCS repository.
</p>
+
<a NAME="VcsProjectBrowserHelper._VCSAddTree" ID="VcsProjectBrowserHelper._VCSAddTree"></a>
<h4>VcsProjectBrowserHelper._VCSAddTree</h4>
<b>_VCSAddTree</b>(<i></i>)
-
<p>
Protected slot called by the context menu.
</p>
@@ -187,83 +184,84 @@
It is used to add the selected
directory tree to the VCS repository.
</p>
+
<a NAME="VcsProjectBrowserHelper._VCSCommit" ID="VcsProjectBrowserHelper._VCSCommit"></a>
<h4>VcsProjectBrowserHelper._VCSCommit</h4>
<b>_VCSCommit</b>(<i></i>)
-
<p>
Protected slot called by the context menu to commit the changes to the
VCS repository.
</p>
+
<a NAME="VcsProjectBrowserHelper._VCSDiff" ID="VcsProjectBrowserHelper._VCSDiff"></a>
<h4>VcsProjectBrowserHelper._VCSDiff</h4>
<b>_VCSDiff</b>(<i></i>)
-
<p>
Protected slot called by the context menu to show the difference of a
file/directory to the repository.
</p>
+
<a NAME="VcsProjectBrowserHelper._VCSInfoDisplay" ID="VcsProjectBrowserHelper._VCSInfoDisplay"></a>
<h4>VcsProjectBrowserHelper._VCSInfoDisplay</h4>
<b>_VCSInfoDisplay</b>(<i></i>)
-
<p>
Protected slot called to show some vcs information.
</p>
+
<a NAME="VcsProjectBrowserHelper._VCSLogBrowser" ID="VcsProjectBrowserHelper._VCSLogBrowser"></a>
<h4>VcsProjectBrowserHelper._VCSLogBrowser</h4>
<b>_VCSLogBrowser</b>(<i></i>)
-
<p>
Protected slot called by the context menu to show the log browser for a
file.
</p>
+
<a NAME="VcsProjectBrowserHelper._VCSMerge" ID="VcsProjectBrowserHelper._VCSMerge"></a>
<h4>VcsProjectBrowserHelper._VCSMerge</h4>
<b>_VCSMerge</b>(<i></i>)
-
<p>
Protected slot called by the context menu to merge changes into to a
file.
</p>
+
<a NAME="VcsProjectBrowserHelper._VCSRemove" ID="VcsProjectBrowserHelper._VCSRemove"></a>
<h4>VcsProjectBrowserHelper._VCSRemove</h4>
<b>_VCSRemove</b>(<i></i>)
-
<p>
Protected slot called by the context menu to remove the selected file
from the VCS repository.
</p>
+
<a NAME="VcsProjectBrowserHelper._VCSRevert" ID="VcsProjectBrowserHelper._VCSRevert"></a>
<h4>VcsProjectBrowserHelper._VCSRevert</h4>
<b>_VCSRevert</b>(<i></i>)
-
<p>
Protected slot called by the context menu to revert changes made to a
file.
</p>
+
<a NAME="VcsProjectBrowserHelper._VCSStatus" ID="VcsProjectBrowserHelper._VCSStatus"></a>
<h4>VcsProjectBrowserHelper._VCSStatus</h4>
<b>_VCSStatus</b>(<i></i>)
-
<p>
Protected slot called by the context menu to show the status of a file.
</p>
+
<a NAME="VcsProjectBrowserHelper._VCSUpdate" ID="VcsProjectBrowserHelper._VCSUpdate"></a>
<h4>VcsProjectBrowserHelper._VCSUpdate</h4>
<b>_VCSUpdate</b>(<i></i>)
-
<p>
Protected slot called by the context menu to update a file from the
VCS repository.
</p>
+
<a NAME="VcsProjectBrowserHelper._updateVCSStatus" ID="VcsProjectBrowserHelper._updateVCSStatus"></a>
<h4>VcsProjectBrowserHelper._updateVCSStatus</h4>
<b>_updateVCSStatus</b>(<i>name</i>)
-
<p>
Protected method to update the VCS status of an item.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -274,11 +272,11 @@
<a NAME="VcsProjectBrowserHelper.addVCSMenus" ID="VcsProjectBrowserHelper.addVCSMenus"></a>
<h4>VcsProjectBrowserHelper.addVCSMenus</h4>
<b>addVCSMenus</b>(<i>mainMenu, multiMenu, backMenu, dirMenu, dirMultiMenu</i>)
-
<p>
Public method to add the VCS entries to the various project browser
menus.
</p>
+
<dl>
<dt><i>mainMenu</i> (QMenu)</dt>
@@ -305,7 +303,6 @@
<a NAME="VcsProjectBrowserHelper.showContextMenu" ID="VcsProjectBrowserHelper.showContextMenu"></a>
<h4>VcsProjectBrowserHelper.showContextMenu</h4>
<b>showContextMenu</b>(<i>menu, standardItems</i>)
-
<p>
Public slot called before the context menu is shown.
</p>
@@ -313,6 +310,7 @@
It enables/disables the VCS menu entries depending on the overall
VCS status and the file status.
</p>
+
<dl>
<dt><i>menu</i> (QMenu)</dt>
@@ -336,7 +334,6 @@
<a NAME="VcsProjectBrowserHelper.showContextMenuDir" ID="VcsProjectBrowserHelper.showContextMenuDir"></a>
<h4>VcsProjectBrowserHelper.showContextMenuDir</h4>
<b>showContextMenuDir</b>(<i>menu, standardItems</i>)
-
<p>
Public slot called before the context menu is shown.
</p>
@@ -344,6 +341,7 @@
It enables/disables the VCS menu entries depending on the overall
VCS status and the directory status.
</p>
+
<dl>
<dt><i>menu</i> (QMenu)</dt>
@@ -367,7 +365,6 @@
<a NAME="VcsProjectBrowserHelper.showContextMenuDirMulti" ID="VcsProjectBrowserHelper.showContextMenuDirMulti"></a>
<h4>VcsProjectBrowserHelper.showContextMenuDirMulti</h4>
<b>showContextMenuDirMulti</b>(<i>menu, standardItems</i>)
-
<p>
Public slot called before the context menu is shown.
</p>
@@ -375,6 +372,7 @@
It enables/disables the VCS menu entries depending on the overall
VCS status and the directory status.
</p>
+
<dl>
<dt><i>menu</i> (QMenu)</dt>
@@ -398,7 +396,6 @@
<a NAME="VcsProjectBrowserHelper.showContextMenuMulti" ID="VcsProjectBrowserHelper.showContextMenuMulti"></a>
<h4>VcsProjectBrowserHelper.showContextMenuMulti</h4>
<b>showContextMenuMulti</b>(<i>menu, standardItems</i>)
-
<p>
Public slot called before the context menu (multiple selections) is
shown.
@@ -407,6 +404,7 @@
It enables/disables the VCS menu entries depending on the overall
VCS status and the files status.
</p>
+
<dl>
<dt><i>menu</i> (QMenu)</dt>
@@ -429,4 +427,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
