Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper.html

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric5.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper</title>
<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>eric5.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>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>
</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>Returns:</dt>
<dd>
list of all actions (list of E5Action)
</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 reimplemente
</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>Returns:</dt>
<dd>
populated menu (QMenu)
</dd>
</dl><dl>
<dt>Raises <b>NotImplementedError</b>:</dt>
<dd>
raised if the class has not been reimplemente
</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>Returns:</dt>
<dd>
title of the menu (string)
</dd>
</dl><dl>
<dt>Raises <b>NotImplementedError</b>:</dt>
<dd>
raised if the class has not been reimplemente
</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>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>