diff -r 0f4e3c9670f5 -r ac0f74c0b870 Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge.html Sat May 28 15:41:12 2011 +0200
@@ -0,0 +1,135 @@
+<?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.purge</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.purge</h1>
+<p>
+Module implementing the purge extension interface.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#Purge">Purge</a></td>
+<td>Class implementing the purge extension interface.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="Purge" ID="Purge"></a>
+<h2>Purge</h2>
+<p>
+ Class implementing the purge extension interface.
+</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="#Purge.__init__">Purge</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#Purge.__getEntries">__getEntries</a></td>
+<td>Public method to get a list of files/directories being purged.</td>
+</tr><tr>
+<td><a href="#Purge.hgPurge">hgPurge</a></td>
+<td>Public method to purge files and directories not tracked by Mercurial.</td>
+</tr><tr>
+<td><a href="#Purge.hgPurgeList">hgPurgeList</a></td>
+<td>Public method to list files and directories not tracked by Mercurial.</td>
+</tr><tr>
+<td><a href="#Purge.shutdown">shutdown</a></td>
+<td>Public method used to shutdown the purge interface.</td>
+</tr>
+</table>
+<a NAME="Purge.__init__" ID="Purge.__init__"></a>
+<h4>Purge (Constructor)</h4>
+<b>Purge</b>(<i>vcs</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>vcs</i></dt>
+<dd>
+reference to the Mercurial vcs object
+</dd>
+</dl><a NAME="Purge.__getEntries" ID="Purge.__getEntries"></a>
+<h4>Purge.__getEntries</h4>
+<b>__getEntries</b>(<i>repodir, all</i>)
+<p>
+ Public method to get a list of files/directories being purged.
+</p><dl>
+<dt><i>repodir</i></dt>
+<dd>
+directory name of the repository (string)
+</dd><dt><i>all</i></dt>
+<dd>
+flag indicating to delete all files including ignored ones (boolean)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+name of the current patch (string)
+</dd>
+</dl><a NAME="Purge.hgPurge" ID="Purge.hgPurge"></a>
+<h4>Purge.hgPurge</h4>
+<b>hgPurge</b>(<i>name, all=False</i>)
+<p>
+ Public method to purge files and directories not tracked by Mercurial.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+file/directory name (string)
+</dd><dt><i>all</i></dt>
+<dd>
+flag indicating to delete all files including ignored ones (boolean)
+</dd>
+</dl><a NAME="Purge.hgPurgeList" ID="Purge.hgPurgeList"></a>
+<h4>Purge.hgPurgeList</h4>
+<b>hgPurgeList</b>(<i>name, all=False</i>)
+<p>
+ Public method to list files and directories not tracked by Mercurial.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+file/directory name (string)
+</dd><dt><i>all</i></dt>
+<dd>
+flag indicating to list all files including ignored ones (boolean)
+</dd>
+</dl><a NAME="Purge.shutdown" ID="Purge.shutdown"></a>
+<h4>Purge.shutdown</h4>
+<b>shutdown</b>(<i></i>)
+<p>
+ Public method used to shutdown the purge interface.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
