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

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsMercurial.UncommitExtension.HgUncommitDialog</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.HgUncommitDialog</h1>
<p>
Module implementing a dialog to enter the uncommit data.
</p>

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#HgUncommitDialog">HgUncommitDialog</a></td>
<td>Class implementing a dialog to enter the uncommit data.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="HgUncommitDialog" ID="HgUncommitDialog"></a>
<h2>HgUncommitDialog</h2>
<p>
    Class implementing a dialog to enter the uncommit data.
</p>

<h3>Derived from</h3>
QDialog, Ui_HgUncommitDialog
<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="#HgUncommitDialog.__init__">HgUncommitDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HgUncommitDialog.getUncommitData">getUncommitData</a></td>
<td>Public method to retrieve the entered uncommit data.</td>
</tr>
<tr>
<td><a href="#HgUncommitDialog.on_recentComboBox_activated">on_recentComboBox_activated</a></td>
<td>Private slot to select a commit message from recent ones.</td>
</tr>
</table>

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


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

<dl>

<dt><i>vcs</i> (Hg)</dt>
<dd>
reference to the version control object
</dd>
<dt><i>parent</i> (QWidget (optional))</dt>
<dd>
reference to the parent widget (defaults to None)
</dd>
</dl>
<a NAME="HgUncommitDialog.getUncommitData" ID="HgUncommitDialog.getUncommitData"></a>
<h4>HgUncommitDialog.getUncommitData</h4>
<b>getUncommitData</b>(<i></i>)
<p>
        Public method to retrieve the entered uncommit data.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple containing the commit message, a flag indicating to
            allow an empty commit, a flag indicating to allow an uncommit
            with outstanding changes, name of the author and date/time of
            the commit
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, bool, bool, str, str)
</dd>
</dl>
<a NAME="HgUncommitDialog.on_recentComboBox_activated" ID="HgUncommitDialog.on_recentComboBox_activated"></a>
<h4>HgUncommitDialog.on_recentComboBox_activated</h4>
<b>on_recentComboBox_activated</b>(<i>index</i>)
<p>
        Private slot to select a commit message from recent ones.
</p>

<dl>

<dt><i>index</i> (int)</dt>
<dd>
index of the selected entry
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>