--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.GpgExtension.ProjectHelper.html Sun May 29 15:25:28 2011 +0200 @@ -0,0 +1,156 @@ +<?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.GpgExtension.ProjectHelper</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.GpgExtension.ProjectHelper</h1> +<p> +Module implementing the gpg extension project helper. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#GpgProjectHelper">GpgProjectHelper</a></td> +<td>Class implementing the gpg extension project helper.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="GpgProjectHelper" ID="GpgProjectHelper"></a> +<h2>GpgProjectHelper</h2> +<p> + Class implementing the gpg extension project helper. +</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="#GpgProjectHelper.__init__">GpgProjectHelper</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#GpgProjectHelper.__hgGpgSign">__hgGpgSign</a></td> +<td>Private slot used to sign a revision.</td> +</tr><tr> +<td><a href="#GpgProjectHelper.__hgGpgSignatures">__hgGpgSignatures</a></td> +<td>Private slot used to list all signed changesets.</td> +</tr><tr> +<td><a href="#GpgProjectHelper.__hgGpgVerifySignatures">__hgGpgVerifySignatures</a></td> +<td>Private slot used to verify the signatures of a revision.</td> +</tr><tr> +<td><a href="#GpgProjectHelper.getActions">getActions</a></td> +<td>Public method to get a list of all actions.</td> +</tr><tr> +<td><a href="#GpgProjectHelper.initActions">initActions</a></td> +<td>Public method to generate the action objects.</td> +</tr><tr> +<td><a href="#GpgProjectHelper.initMenu">initMenu</a></td> +<td>Public method to generate the extension menu.</td> +</tr><tr> +<td><a href="#GpgProjectHelper.menuTitle">menuTitle</a></td> +<td>Public method to get the menu title.</td> +</tr><tr> +<td><a href="#GpgProjectHelper.setObjects">setObjects</a></td> +<td>Public method to set references to the vcs and project objects.</td> +</tr> +</table> +<a NAME="GpgProjectHelper.__init__" ID="GpgProjectHelper.__init__"></a> +<h4>GpgProjectHelper (Constructor)</h4> +<b>GpgProjectHelper</b>(<i></i>) +<p> + Constructor +</p><a NAME="GpgProjectHelper.__hgGpgSign" ID="GpgProjectHelper.__hgGpgSign"></a> +<h4>GpgProjectHelper.__hgGpgSign</h4> +<b>__hgGpgSign</b>(<i></i>) +<p> + Private slot used to sign a revision. +</p><a NAME="GpgProjectHelper.__hgGpgSignatures" ID="GpgProjectHelper.__hgGpgSignatures"></a> +<h4>GpgProjectHelper.__hgGpgSignatures</h4> +<b>__hgGpgSignatures</b>(<i></i>) +<p> + Private slot used to list all signed changesets. +</p><a NAME="GpgProjectHelper.__hgGpgVerifySignatures" ID="GpgProjectHelper.__hgGpgVerifySignatures"></a> +<h4>GpgProjectHelper.__hgGpgVerifySignatures</h4> +<b>__hgGpgVerifySignatures</b>(<i></i>) +<p> + Private slot used to verify the signatures of a revision. +</p><a NAME="GpgProjectHelper.getActions" ID="GpgProjectHelper.getActions"></a> +<h4>GpgProjectHelper.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="GpgProjectHelper.initActions" ID="GpgProjectHelper.initActions"></a> +<h4>GpgProjectHelper.initActions</h4> +<b>initActions</b>(<i></i>) +<p> + Public method to generate the action objects. +</p><a NAME="GpgProjectHelper.initMenu" ID="GpgProjectHelper.initMenu"></a> +<h4>GpgProjectHelper.initMenu</h4> +<b>initMenu</b>(<i>mainMenu</i>) +<p> + Public method to generate the extension menu. +</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><a NAME="GpgProjectHelper.menuTitle" ID="GpgProjectHelper.menuTitle"></a> +<h4>GpgProjectHelper.menuTitle</h4> +<b>menuTitle</b>(<i></i>) +<p> + Public method to get the menu title. +</p><a NAME="GpgProjectHelper.setObjects" ID="GpgProjectHelper.setObjects"></a> +<h4>GpgProjectHelper.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> \ No newline at end of file