src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.FastexportExtension.HgFastexportConfigDialog.html

Wed, 04 Dec 2024 11:30:17 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Wed, 04 Dec 2024 11:30:17 +0100
branch
eric7
changeset 11084
adbb5d1944ea
permissions
-rw-r--r--

Updated source code documentation.

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

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#HgFastexportConfigDialog">HgFastexportConfigDialog</a></td>
<td>Class implementing the fastexport configuration dialog.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="HgFastexportConfigDialog" ID="HgFastexportConfigDialog"></a>
<h2>HgFastexportConfigDialog</h2>
<p>
    Class implementing the fastexport configuration dialog.
</p>

<h3>Derived from</h3>
QDialog, Ui_HgFastexportConfigDialog
<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="#HgFastexportConfigDialog.__init__">HgFastexportConfigDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HgFastexportConfigDialog.__updateOK">__updateOK</a></td>
<td>Private slot to updated the enabled state of the OK button.</td>
</tr>
<tr>
<td><a href="#HgFastexportConfigDialog.getData">getData</a></td>
<td>Public method to get the entered fastexport configuration data.</td>
</tr>
</table>

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


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

<dl>

<dt><i>revisions</i> (list of str (optional))</dt>
<dd>
list of revisions, tags or branches to be exported
            (defaults to None)
</dd>
<dt><i>parent</i> (QWidget (optional))</dt>
<dd>
reference to the parent widget (defaults to None)
</dd>
</dl>
<a NAME="HgFastexportConfigDialog.__updateOK" ID="HgFastexportConfigDialog.__updateOK"></a>
<h4>HgFastexportConfigDialog.__updateOK</h4>
<b>__updateOK</b>(<i></i>)
<p>
        Private slot to updated the enabled state of the OK button.
</p>

<a NAME="HgFastexportConfigDialog.getData" ID="HgFastexportConfigDialog.getData"></a>
<h4>HgFastexportConfigDialog.getData</h4>
<b>getData</b>(<i></i>)
<p>
        Public method to get the entered fastexport configuration data.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple containing the fastexport configuration (output file,
            list of revisions, author map file, import marks file, export marks
            file)
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, list of str, str, str, str)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial