Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgArchiveDialog.html

<!DOCTYPE html>
<html><head>
<title>eric5.Plugins.VcsPlugins.vcsMercurial.HgArchiveDialog</title>
<meta charset="UTF-8">
<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.HgArchiveDialog</h1>
<p>
Module implementing a dialog to enter the archive data.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#HgArchiveDialog">HgArchiveDialog</a></td>
<td>Class implementing a dialog to enter the archive data.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="HgArchiveDialog" ID="HgArchiveDialog"></a>
<h2>HgArchiveDialog</h2>
<p>
    Class implementing a dialog to enter the archive data.
</p>
<h3>Derived from</h3>
QDialog, Ui_HgArchiveDialog
<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="#HgArchiveDialog.__init__">HgArchiveDialog</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#HgArchiveDialog.getData">getData</a></td>
<td>Public method to retrieve the data.</td>
</tr><tr>
<td><a href="#HgArchiveDialog.on_archiveButton_clicked">on_archiveButton_clicked</a></td>
<td>Private slot to select the archive name via a file selection dialog.</td>
</tr><tr>
<td><a href="#HgArchiveDialog.on_archiveEdit_textChanged">on_archiveEdit_textChanged</a></td>
<td>Private slot to handle changes of the archive name.</td>
</tr><tr>
<td><a href="#HgArchiveDialog.on_typeComboBox_activated">on_typeComboBox_activated</a></td>
<td>Private slot to react on changes of the selected archive type.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="HgArchiveDialog.__init__" ID="HgArchiveDialog.__init__"></a>
<h4>HgArchiveDialog (Constructor)</h4>
<b>HgArchiveDialog</b>(<i>vcs, parent=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>vcs</i></dt>
<dd>
reference to the Mercurial object (Hg)
</dd><dt><i>parent</i></dt>
<dd>
reference to the parent widget (QWidget)
</dd>
</dl><a NAME="HgArchiveDialog.getData" ID="HgArchiveDialog.getData"></a>
<h4>HgArchiveDialog.getData</h4>
<b>getData</b>(<i></i>)
<p>
        Public method to retrieve the data.
</p><dl>
<dt>Returns:</dt>
<dd>
tuple giving the archive name (string), the archive type
            (string), the directory prefix 8string) and a flag indicating
            to recurse into subrepositories (boolean)
</dd>
</dl><a NAME="HgArchiveDialog.on_archiveButton_clicked" ID="HgArchiveDialog.on_archiveButton_clicked"></a>
<h4>HgArchiveDialog.on_archiveButton_clicked</h4>
<b>on_archiveButton_clicked</b>(<i></i>)
<p>
        Private slot to select the archive name via a file selection dialog.
</p><a NAME="HgArchiveDialog.on_archiveEdit_textChanged" ID="HgArchiveDialog.on_archiveEdit_textChanged"></a>
<h4>HgArchiveDialog.on_archiveEdit_textChanged</h4>
<b>on_archiveEdit_textChanged</b>(<i>archive</i>)
<p>
        Private slot to handle changes of the archive name.
</p><dl>
<dt><i>archive</i></dt>
<dd>
name of the archive (string)
</dd>
</dl><a NAME="HgArchiveDialog.on_typeComboBox_activated" ID="HgArchiveDialog.on_typeComboBox_activated"></a>
<h4>HgArchiveDialog.on_typeComboBox_activated</h4>
<b>on_typeComboBox_activated</b>(<i>index</i>)
<p>
        Private slot to react on changes of the selected archive type.
</p><dl>
<dt><i>index</i></dt>
<dd>
index of the selected type (integer)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>