--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,220 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper</h1> + +<p> +Module implementing the project helper base for Mercurial extension interfaces. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#HgExtensionProjectHelper">HgExtensionProjectHelper</a></td> +<td>Class implementing the project helper base for Mercurial extension interfaces.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="HgExtensionProjectHelper" ID="HgExtensionProjectHelper"></a> +<h2>HgExtensionProjectHelper</h2> + +<p> + Class implementing the project helper base for Mercurial extension + interfaces. +</p> +<p> + Note: The methods initActions(), initMenu(mainMenu) and menuTitle() have + to be reimplemented by derived classes. +</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="#HgExtensionProjectHelper.__init__">HgExtensionProjectHelper</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#HgExtensionProjectHelper.getActions">getActions</a></td> +<td>Public method to get a list of all actions.</td> +</tr> +<tr> +<td><a href="#HgExtensionProjectHelper.initActions">initActions</a></td> +<td>Public method to generate the action objects.</td> +</tr> +<tr> +<td><a href="#HgExtensionProjectHelper.initMenu">initMenu</a></td> +<td>Public method to generate the extension menu.</td> +</tr> +<tr> +<td><a href="#HgExtensionProjectHelper.menuTitle">menuTitle</a></td> +<td>Public method to get the menu title.</td> +</tr> +<tr> +<td><a href="#HgExtensionProjectHelper.setObjects">setObjects</a></td> +<td>Public method to set references to the vcs and project objects.</td> +</tr> +<tr> +<td><a href="#HgExtensionProjectHelper.shutdown">shutdown</a></td> +<td>Public method to perform shutdown actions.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="HgExtensionProjectHelper.__init__" ID="HgExtensionProjectHelper.__init__"></a> +<h4>HgExtensionProjectHelper (Constructor)</h4> +<b>HgExtensionProjectHelper</b>(<i></i>) + +<p> + Constructor +</p> +<a NAME="HgExtensionProjectHelper.getActions" ID="HgExtensionProjectHelper.getActions"></a> +<h4>HgExtensionProjectHelper.getActions</h4> +<b>getActions</b>(<i></i>) + +<p> + Public method to get a list of all actions. +</p> +<dl> +<dt>Return:</dt> +<dd> +list of all actions (list of EricAction) +</dd> +</dl> +<a NAME="HgExtensionProjectHelper.initActions" ID="HgExtensionProjectHelper.initActions"></a> +<h4>HgExtensionProjectHelper.initActions</h4> +<b>initActions</b>(<i></i>) + +<p> + Public method to generate the action objects. +</p> +<p> + Note: Derived class must implement this method. +</p> +<dl> + +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised if the class has not been + reimplemented +</dd> +</dl> +<a NAME="HgExtensionProjectHelper.initMenu" ID="HgExtensionProjectHelper.initMenu"></a> +<h4>HgExtensionProjectHelper.initMenu</h4> +<b>initMenu</b>(<i>mainMenu</i>) + +<p> + Public method to generate the extension menu. +</p> +<p> + Note: Derived class must implement this method. +</p> +<dl> + +<dt><i>mainMenu</i></dt> +<dd> +reference to the main menu (QMenu) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +populated menu (QMenu) +</dd> +</dl> +<dl> + +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised if the class has not been + reimplemented +</dd> +</dl> +<a NAME="HgExtensionProjectHelper.menuTitle" ID="HgExtensionProjectHelper.menuTitle"></a> +<h4>HgExtensionProjectHelper.menuTitle</h4> +<b>menuTitle</b>(<i></i>) + +<p> + Public method to get the menu title. +</p> +<p> + Note: Derived class must implement this method. +</p> +<dl> +<dt>Return:</dt> +<dd> +title of the menu (string) +</dd> +</dl> +<dl> + +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised if the class has not been + reimplemented +</dd> +</dl> +<a NAME="HgExtensionProjectHelper.setObjects" ID="HgExtensionProjectHelper.setObjects"></a> +<h4>HgExtensionProjectHelper.setObjects</h4> +<b>setObjects</b>(<i>vcsObject, projectObject</i>) + +<p> + Public method to set references to the vcs and project objects. +</p> +<dl> + +<dt><i>vcsObject</i></dt> +<dd> +reference to the vcs object +</dd> +<dt><i>projectObject</i></dt> +<dd> +reference to the project object +</dd> +</dl> +<a NAME="HgExtensionProjectHelper.shutdown" ID="HgExtensionProjectHelper.shutdown"></a> +<h4>HgExtensionProjectHelper.shutdown</h4> +<b>shutdown</b>(<i></i>) + +<p> + Public method to perform shutdown actions. +</p> +<p> + Note: Derived class may implement this method if needed. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file