--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.UncommitExtension.ProjectHelper.html Wed Dec 04 11:30:17 2024 +0100 @@ -0,0 +1,173 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.VcsPlugins.vcsMercurial.UncommitExtension.ProjectHelper</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.ProjectHelper</h1> +<p> +Module implementing the uncommit extension project helper. +</p> + +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Classes</h3> +<table> +<tr> +<td><a href="#UncommitProjectHelper">UncommitProjectHelper</a></td> +<td>Class implementing the uncommit extension project helper.</td> +</tr> +</table> + +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> + +<hr /> +<hr /> +<a NAME="UncommitProjectHelper" ID="UncommitProjectHelper"></a> +<h2>UncommitProjectHelper</h2> +<p> + Class implementing the uncommit extension project helper. +</p> + +<h3>Derived from</h3> +HgExtensionProjectHelper +<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="#UncommitProjectHelper.__init__">UncommitProjectHelper</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#UncommitProjectHelper.__hgUncommit">__hgUncommit</a></td> +<td>Private slot to undo a local commit.</td> +</tr> +<tr> +<td><a href="#UncommitProjectHelper.__reopenProject">__reopenProject</a></td> +<td>Private method to reopen the project if needed and wanted.</td> +</tr> +<tr> +<td><a href="#UncommitProjectHelper.initActions">initActions</a></td> +<td>Public method to generate the action objects.</td> +</tr> +<tr> +<td><a href="#UncommitProjectHelper.initMenu">initMenu</a></td> +<td>Public method to generate the extension menu.</td> +</tr> +<tr> +<td><a href="#UncommitProjectHelper.menuTitle">menuTitle</a></td> +<td>Public method to get the menu title.</td> +</tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + +<a NAME="UncommitProjectHelper.__init__" ID="UncommitProjectHelper.__init__"></a> +<h4>UncommitProjectHelper (Constructor)</h4> +<b>UncommitProjectHelper</b>(<i></i>) +<p> + Constructor +</p> + +<a NAME="UncommitProjectHelper.__hgUncommit" ID="UncommitProjectHelper.__hgUncommit"></a> +<h4>UncommitProjectHelper.__hgUncommit</h4> +<b>__hgUncommit</b>(<i></i>) +<p> + Private slot to undo a local commit. +</p> + +<a NAME="UncommitProjectHelper.__reopenProject" ID="UncommitProjectHelper.__reopenProject"></a> +<h4>UncommitProjectHelper.__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="UncommitProjectHelper.initActions" ID="UncommitProjectHelper.initActions"></a> +<h4>UncommitProjectHelper.initActions</h4> +<b>initActions</b>(<i></i>) +<p> + Public method to generate the action objects. +</p> + +<a NAME="UncommitProjectHelper.initMenu" ID="UncommitProjectHelper.initMenu"></a> +<h4>UncommitProjectHelper.initMenu</h4> +<b>initMenu</b>(<i>mainMenu</i>) +<p> + Public method to generate the extension menu. +</p> + +<dl> + +<dt><i>mainMenu</i> (QMenu)</dt> +<dd> +reference to the main menu +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +populated menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu +</dd> +</dl> +<a NAME="UncommitProjectHelper.menuTitle" ID="UncommitProjectHelper.menuTitle"></a> +<h4>UncommitProjectHelper.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> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html>