diff -r 0f4e3c9670f5 -r ac0f74c0b870 Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.ProjectHelper.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.ProjectHelper.html Sat May 28 15:41:12 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.PurgeExtension.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.PurgeExtension.ProjectHelper</h1>
+<p>
+Module implementing the purge extension project helper.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#PurgeProjectHelper">PurgeProjectHelper</a></td>
+<td>Class implementing the purge extension project helper.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="PurgeProjectHelper" ID="PurgeProjectHelper"></a>
+<h2>PurgeProjectHelper</h2>
+<p>
+ Class implementing the purge 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="#PurgeProjectHelper.__init__">PurgeProjectHelper</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#PurgeProjectHelper.__hgPurge">__hgPurge</a></td>
+<td>Private slot used to remove files not tracked by Mercurial.</td>
+</tr><tr>
+<td><a href="#PurgeProjectHelper.__hgPurgeAll">__hgPurgeAll</a></td>
+<td>Private slot used to remove all files not tracked by Mercurial.</td>
+</tr><tr>
+<td><a href="#PurgeProjectHelper.__hgPurgeAllList">__hgPurgeAllList</a></td>
+<td>Private slot used to list all files not tracked by Mercurial.</td>
+</tr><tr>
+<td><a href="#PurgeProjectHelper.__hgPurgeList">__hgPurgeList</a></td>
+<td>Private slot used to list files not tracked by Mercurial.</td>
+</tr><tr>
+<td><a href="#PurgeProjectHelper.getActions">getActions</a></td>
+<td>Public method to get a list of all actions.</td>
+</tr><tr>
+<td><a href="#PurgeProjectHelper.initActions">initActions</a></td>
+<td>Public method to generate the action objects.</td>
+</tr><tr>
+<td><a href="#PurgeProjectHelper.initMenu">initMenu</a></td>
+<td>Public method to generate the extension menu.</td>
+</tr><tr>
+<td><a href="#PurgeProjectHelper.setObjects">setObjects</a></td>
+<td>Public method to set references to the vcs and project objects.</td>
+</tr>
+</table>
+<a NAME="PurgeProjectHelper.__init__" ID="PurgeProjectHelper.__init__"></a>
+<h4>PurgeProjectHelper (Constructor)</h4>
+<b>PurgeProjectHelper</b>(<i></i>)
+<p>
+ Constructor
+</p><a NAME="PurgeProjectHelper.__hgPurge" ID="PurgeProjectHelper.__hgPurge"></a>
+<h4>PurgeProjectHelper.__hgPurge</h4>
+<b>__hgPurge</b>(<i></i>)
+<p>
+ Private slot used to remove files not tracked by Mercurial.
+</p><a NAME="PurgeProjectHelper.__hgPurgeAll" ID="PurgeProjectHelper.__hgPurgeAll"></a>
+<h4>PurgeProjectHelper.__hgPurgeAll</h4>
+<b>__hgPurgeAll</b>(<i></i>)
+<p>
+ Private slot used to remove all files not tracked by Mercurial.
+</p><a NAME="PurgeProjectHelper.__hgPurgeAllList" ID="PurgeProjectHelper.__hgPurgeAllList"></a>
+<h4>PurgeProjectHelper.__hgPurgeAllList</h4>
+<b>__hgPurgeAllList</b>(<i></i>)
+<p>
+ Private slot used to list all files not tracked by Mercurial.
+</p><a NAME="PurgeProjectHelper.__hgPurgeList" ID="PurgeProjectHelper.__hgPurgeList"></a>
+<h4>PurgeProjectHelper.__hgPurgeList</h4>
+<b>__hgPurgeList</b>(<i></i>)
+<p>
+ Private slot used to list files not tracked by Mercurial.
+</p><a NAME="PurgeProjectHelper.getActions" ID="PurgeProjectHelper.getActions"></a>
+<h4>PurgeProjectHelper.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="PurgeProjectHelper.initActions" ID="PurgeProjectHelper.initActions"></a>
+<h4>PurgeProjectHelper.initActions</h4>
+<b>initActions</b>(<i></i>)
+<p>
+ Public method to generate the action objects.
+</p><a NAME="PurgeProjectHelper.initMenu" ID="PurgeProjectHelper.initMenu"></a>
+<h4>PurgeProjectHelper.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="PurgeProjectHelper.setObjects" ID="PurgeProjectHelper.setObjects"></a>
+<h4>PurgeProjectHelper.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
