--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.ProjectHelper.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,194 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.ProjectHelper</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.ProjectHelper</h1> + +<p> +Module implementing the histedit extension project helper. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#HisteditProjectHelper">HisteditProjectHelper</a></td> +<td>Class implementing the histedit extension project helper.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="HisteditProjectHelper" ID="HisteditProjectHelper"></a> +<h2>HisteditProjectHelper</h2> + +<p> + Class implementing the histedit 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="#HisteditProjectHelper.__init__">HisteditProjectHelper</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#HisteditProjectHelper.__hgHisteditAbort">__hgHisteditAbort</a></td> +<td>Private slot used to abort an interrupted history editing session.</td> +</tr> +<tr> +<td><a href="#HisteditProjectHelper.__hgHisteditContinue">__hgHisteditContinue</a></td> +<td>Private slot used to continue an interrupted history editing session.</td> +</tr> +<tr> +<td><a href="#HisteditProjectHelper.__hgHisteditEditPlan">__hgHisteditEditPlan</a></td> +<td>Private slot used to edit the remaining actions list of an interrupted history editing session.</td> +</tr> +<tr> +<td><a href="#HisteditProjectHelper.__hgHisteditStart">__hgHisteditStart</a></td> +<td>Private slot used to start a history editing session.</td> +</tr> +<tr> +<td><a href="#HisteditProjectHelper.initActions">initActions</a></td> +<td>Public method to generate the action objects.</td> +</tr> +<tr> +<td><a href="#HisteditProjectHelper.initMenu">initMenu</a></td> +<td>Public method to generate the extension menu.</td> +</tr> +<tr> +<td><a href="#HisteditProjectHelper.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="HisteditProjectHelper.__init__" ID="HisteditProjectHelper.__init__"></a> +<h4>HisteditProjectHelper (Constructor)</h4> +<b>HisteditProjectHelper</b>(<i></i>) + +<p> + Constructor +</p> +<a NAME="HisteditProjectHelper.__hgHisteditAbort" ID="HisteditProjectHelper.__hgHisteditAbort"></a> +<h4>HisteditProjectHelper.__hgHisteditAbort</h4> +<b>__hgHisteditAbort</b>(<i></i>) + +<p> + Private slot used to abort an interrupted history editing session. +</p> +<a NAME="HisteditProjectHelper.__hgHisteditContinue" ID="HisteditProjectHelper.__hgHisteditContinue"></a> +<h4>HisteditProjectHelper.__hgHisteditContinue</h4> +<b>__hgHisteditContinue</b>(<i></i>) + +<p> + Private slot used to continue an interrupted history editing session. +</p> +<a NAME="HisteditProjectHelper.__hgHisteditEditPlan" ID="HisteditProjectHelper.__hgHisteditEditPlan"></a> +<h4>HisteditProjectHelper.__hgHisteditEditPlan</h4> +<b>__hgHisteditEditPlan</b>(<i></i>) + +<p> + Private slot used to edit the remaining actions list of an interrupted + history editing session. +</p> +<a NAME="HisteditProjectHelper.__hgHisteditStart" ID="HisteditProjectHelper.__hgHisteditStart"></a> +<h4>HisteditProjectHelper.__hgHisteditStart</h4> +<b>__hgHisteditStart</b>(<i></i>) + +<p> + Private slot used to start a history editing session. +</p> +<a NAME="HisteditProjectHelper.initActions" ID="HisteditProjectHelper.initActions"></a> +<h4>HisteditProjectHelper.initActions</h4> +<b>initActions</b>(<i></i>) + +<p> + Public method to generate the action objects. +</p> +<a NAME="HisteditProjectHelper.initMenu" ID="HisteditProjectHelper.initMenu"></a> +<h4>HisteditProjectHelper.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 (QMenu) +</dd> +</dl> +<a NAME="HisteditProjectHelper.menuTitle" ID="HisteditProjectHelper.menuTitle"></a> +<h4>HisteditProjectHelper.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> \ No newline at end of file