src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitTagDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsGit.GitTagDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsGit.GitTagDialog</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="#GitTagDialog">GitTagDialog</a></td>
<td>Class implementing a dialog to enter the data for a tagging operation.</td>
</tr>
<tr>
<td><a href="#GitTagOperation">GitTagOperation</a></td>
<td>Class defining the supported git tag operations.</td>
</tr>
<tr>
<td><a href="#GitTagType">GitTagType</a></td>
<td>Class defining the supported git tag types.</td>
</tr>
</table>

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

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

<h3>Derived from</h3>
QDialog, Ui_GitTagDialog
<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="#GitTagDialog.__init__">GitTagDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#GitTagDialog.getParameters">getParameters</a></td>
<td>Public method to retrieve the tag data.</td>
</tr>
<tr>
<td><a href="#GitTagDialog.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="GitTagDialog.__init__" ID="GitTagDialog.__init__"></a>
<h4>GitTagDialog (Constructor)</h4>
<b>GitTagDialog</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="GitTagDialog.getParameters" ID="GitTagDialog.getParameters"></a>
<h4>GitTagDialog.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, tag type,
            and a flag indicating to enforce the operation
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, str, GitTagOperation, GitTagType, bool)
</dd>
</dl>
<a NAME="GitTagDialog.on_tagCombo_editTextChanged" ID="GitTagDialog.on_tagCombo_editTextChanged"></a>
<h4>GitTagDialog.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="GitTagOperation" ID="GitTagOperation"></a>
<h2>GitTagOperation</h2>
<p>
    Class defining the supported git tag operations.
</p>

<h3>Derived from</h3>
enum.Enum
<h3>Class Attributes</h3>
<table>
<tr><td>Create</td></tr>
<tr><td>Delete</td></tr>
<tr><td>Verify</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 />
<hr />
<a NAME="GitTagType" ID="GitTagType"></a>
<h2>GitTagType</h2>
<p>
    Class defining the supported git tag types.
</p>

<h3>Derived from</h3>
enum.Enum
<h3>Class Attributes</h3>
<table>
<tr><td>Annotated</td></tr>
<tr><td>Local</td></tr>
<tr><td>Signed</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>