src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgTagDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsMercurial.HgTagDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgTagDialog</h1>
<p>
Module implementing a dialog to enter the data for a tagging operation.
</p>

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#HgTagDialog">HgTagDialog</a></td>
<td>Class implementing a dialog to enter the data for a tagging operation.</td>
</tr>
<tr>
<td><a href="#HgTagOperation">HgTagOperation</a></td>
<td>Class defining the supported tagging operations.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="HgTagDialog" ID="HgTagDialog"></a>
<h2>HgTagDialog</h2>
<p>
    Class implementing a dialog to enter the data for a tagging operation.
</p>

<h3>Derived from</h3>
QDialog, Ui_HgTagDialog
<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="#HgTagDialog.__init__">HgTagDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HgTagDialog.getParameters">getParameters</a></td>
<td>Public method to retrieve the tag data.</td>
</tr>
<tr>
<td><a href="#HgTagDialog.on_tagCombo_currentIndexChanged">on_tagCombo_currentIndexChanged</a></td>
<td>Private slot setting the local status of the selected entry.</td>
</tr>
<tr>
<td><a href="#HgTagDialog.on_tagCombo_editTextChanged">on_tagCombo_editTextChanged</a></td>
<td>Private method used to enable/disable the OK-button.</td>
</tr>
</table>

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


<a NAME="HgTagDialog.__init__" ID="HgTagDialog.__init__"></a>
<h4>HgTagDialog (Constructor)</h4>
<b>HgTagDialog</b>(<i>taglist, revision=None, tagName=None, parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>taglist</i> (list of str)</dt>
<dd>
list of previously entered tags
</dd>
<dt><i>revision</i> (str)</dt>
<dd>
revision to set tag for
</dd>
<dt><i>tagName</i> (str)</dt>
<dd>
name of the tag
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
parent widget
</dd>
</dl>
<a NAME="HgTagDialog.getParameters" ID="HgTagDialog.getParameters"></a>
<h4>HgTagDialog.getParameters</h4>
<b>getParameters</b>(<i></i>)
<p>
        Public method to retrieve the tag data.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple containing the tag, revision, tag operation and a flag
            indicating to enforce the operation
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of str, str, HgTagOperation, bool
</dd>
</dl>
<a NAME="HgTagDialog.on_tagCombo_currentIndexChanged" ID="HgTagDialog.on_tagCombo_currentIndexChanged"></a>
<h4>HgTagDialog.on_tagCombo_currentIndexChanged</h4>
<b>on_tagCombo_currentIndexChanged</b>(<i>index</i>)
<p>
        Private slot setting the local status of the selected entry.
</p>

<dl>

<dt><i>index</i> (int)</dt>
<dd>
index of the selected entrie
</dd>
</dl>
<a NAME="HgTagDialog.on_tagCombo_editTextChanged" ID="HgTagDialog.on_tagCombo_editTextChanged"></a>
<h4>HgTagDialog.on_tagCombo_editTextChanged</h4>
<b>on_tagCombo_editTextChanged</b>(<i>text</i>)
<p>
        Private method used to enable/disable the OK-button.
</p>

<dl>

<dt><i>text</i> (str)</dt>
<dd>
tag name entered in the combo
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="HgTagOperation" ID="HgTagOperation"></a>
<h2>HgTagOperation</h2>
<p>
    Class defining the supported tagging operations.
</p>

<h3>Derived from</h3>
enum.Enum
<h3>Class Attributes</h3>
<table>
<tr><td>CreateGlobal</td></tr>
<tr><td>CreateLocal</td></tr>
<tr><td>DeleteGlobal</td></tr>
<tr><td>DeleteLocal</td></tr>
</table>

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

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

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


<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>