src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.UncommitExtension.uncommit.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsMercurial.UncommitExtension.uncommit</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsMercurial.UncommitExtension.uncommit</h1>
<p>
Module implementing the uncommit extension interface.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#Uncommit">Uncommit</a></td>
<td>Class implementing the uncommit extension interface.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>

<hr />
<hr />
<a NAME="Uncommit" ID="Uncommit"></a>
<h2>Uncommit</h2>
<p>
    Class implementing the uncommit extension interface.
</p>

<h3>Derived from</h3>
HgExtension
<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="#Uncommit.__init__">Uncommit</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#Uncommit.hgUncommit">hgUncommit</a></td>
<td>Public method to undo the effect of a local commit.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="Uncommit.__init__" ID="Uncommit.__init__"></a>
<h4>Uncommit (Constructor)</h4>
<b>Uncommit</b>(<i>vcs, ui=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>vcs</i> (Hg)</dt>
<dd>
reference to the Mercurial vcs object
</dd>
<dt><i>ui</i> (QWidget)</dt>
<dd>
reference to a UI widget (defaults to None)
</dd>
</dl>
<a NAME="Uncommit.hgUncommit" ID="Uncommit.hgUncommit"></a>
<h4>Uncommit.hgUncommit</h4>
<b>hgUncommit</b>(<i>names=None</i>)
<p>
        Public method to undo the effect of a local commit.
</p>

<dl>

<dt><i>names</i> (list of str)</dt>
<dd>
list of file or directory paths (defaults to None)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating that the project should be reread
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>