--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.UncommitExtension.ProjectBrowserHelper.html	Wed Dec 04 11:30:17 2024 +0100
@@ -0,0 +1,195 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Plugins.VcsPlugins.vcsMercurial.UncommitExtension.ProjectBrowserHelper</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Plugins.VcsPlugins.vcsMercurial.UncommitExtension.ProjectBrowserHelper</h1>
+<p>
+Module implementing the uncommit extension project browser helper.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#UncommitProjectBrowserHelper">UncommitProjectBrowserHelper</a></td>
+<td>Class implementing the uncommit extension project browser helper.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="UncommitProjectBrowserHelper" ID="UncommitProjectBrowserHelper"></a>
+<h2>UncommitProjectBrowserHelper</h2>
+<p>
+    Class implementing the uncommit extension project browser helper.
+</p>
+
+<h3>Derived from</h3>
+HgExtensionProjectBrowserHelper
+<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="#UncommitProjectBrowserHelper.__init__">UncommitProjectBrowserHelper</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#UncommitProjectBrowserHelper.__hgUncommit">__hgUncommit</a></td>
+<td>Private slot to undo the effect of a local commit.</td>
+</tr>
+<tr>
+<td><a href="#UncommitProjectBrowserHelper.__reopenProject">__reopenProject</a></td>
+<td>Private method to reopen the project if needed and wanted.</td>
+</tr>
+<tr>
+<td><a href="#UncommitProjectBrowserHelper.initMenus">initMenus</a></td>
+<td>Public method to generate the extension menus.</td>
+</tr>
+<tr>
+<td><a href="#UncommitProjectBrowserHelper.menuTitle">menuTitle</a></td>
+<td>Public method to get the menu title.</td>
+</tr>
+<tr>
+<td><a href="#UncommitProjectBrowserHelper.showMenu">showMenu</a></td>
+<td>Public method to prepare the extension menu for display.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="UncommitProjectBrowserHelper.__init__" ID="UncommitProjectBrowserHelper.__init__"></a>
+<h4>UncommitProjectBrowserHelper (Constructor)</h4>
+<b>UncommitProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>vcsObject</i> (Hg)</dt>
+<dd>
+reference to the vcs object
+</dd>
+<dt><i>browserObject</i> (ProjectBaseBrowser)</dt>
+<dd>
+reference to the project browser object
+</dd>
+<dt><i>projectObject</i> (Project)</dt>
+<dd>
+reference to the project object
+</dd>
+</dl>
+<a NAME="UncommitProjectBrowserHelper.__hgUncommit" ID="UncommitProjectBrowserHelper.__hgUncommit"></a>
+<h4>UncommitProjectBrowserHelper.__hgUncommit</h4>
+<b>__hgUncommit</b>(<i></i>)
+<p>
+        Private slot to undo the effect of a local commit.
+</p>
+
+<a NAME="UncommitProjectBrowserHelper.__reopenProject" ID="UncommitProjectBrowserHelper.__reopenProject"></a>
+<h4>UncommitProjectBrowserHelper.__reopenProject</h4>
+<b>__reopenProject</b>(<i>shouldReopen, title</i>)
+<p>
+        Private method to reopen the project if needed and wanted.
+</p>
+
+<dl>
+
+<dt><i>shouldReopen</i> (bool)</dt>
+<dd>
+flag indicating that the project should
+            be reopened
+</dd>
+<dt><i>title</i> (str)</dt>
+<dd>
+title of the message box
+</dd>
+</dl>
+<a NAME="UncommitProjectBrowserHelper.initMenus" ID="UncommitProjectBrowserHelper.initMenus"></a>
+<h4>UncommitProjectBrowserHelper.initMenus</h4>
+<b>initMenus</b>(<i></i>)
+<p>
+        Public method to generate the extension menus.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary of populated menu. The dict must have the keys 'mainMenu',
+            'multiMenu', 'backMenu', 'dirMenu' and 'dirMultiMenu'.
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict of QMenu
+</dd>
+</dl>
+<a NAME="UncommitProjectBrowserHelper.menuTitle" ID="UncommitProjectBrowserHelper.menuTitle"></a>
+<h4>UncommitProjectBrowserHelper.menuTitle</h4>
+<b>menuTitle</b>(<i></i>)
+<p>
+        Public method to get the menu title.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+title of the menu
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="UncommitProjectBrowserHelper.showMenu" ID="UncommitProjectBrowserHelper.showMenu"></a>
+<h4>UncommitProjectBrowserHelper.showMenu</h4>
+<b>showMenu</b>(<i>key, controlled</i>)
+<p>
+        Public method to prepare the extension menu for display.
+</p>
+
+<dl>
+
+<dt><i>key</i> (str)</dt>
+<dd>
+menu key (one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu'
+            or 'dirMultiMenu')
+</dd>
+<dt><i>controlled</i> (bool)</dt>
+<dd>
+flag indicating to prepare the menu for a
+            version controlled entry or a non-version controlled entry
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>