src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.RebaseExtension.HgRebaseDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsMercurial.RebaseExtension.HgRebaseDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsMercurial.RebaseExtension.HgRebaseDialog</h1>

<p>
Module implementing a dialog to enter the data for a rebase session.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#HgRebaseDialog">HgRebaseDialog</a></td>
<td>Class implementing a dialog to enter the data for a rebase session.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="HgRebaseDialog" ID="HgRebaseDialog"></a>
<h2>HgRebaseDialog</h2>

<p>
    Class implementing a dialog to enter the data for a rebase session.
</p>
<h3>Derived from</h3>
QDialog, Ui_HgRebaseDialog
<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="#HgRebaseDialog.__init__">HgRebaseDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HgRebaseDialog.__getRevision">__getRevision</a></td>
<td>Private method to generate the revision.</td>
</tr>
<tr>
<td><a href="#HgRebaseDialog.__updateOK">__updateOK</a></td>
<td>Private slot to update the OK button.</td>
</tr>
<tr>
<td><a href="#HgRebaseDialog.getData">getData</a></td>
<td>Public method to retrieve the data for the rebase session.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="HgRebaseDialog.__init__" ID="HgRebaseDialog.__init__"></a>
<h4>HgRebaseDialog (Constructor)</h4>
<b>HgRebaseDialog</b>(<i>tagsList, branchesList, bookmarksList, version, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>tagsList</i> (list of str)</dt>
<dd>
list of tags
</dd>
<dt><i>branchesList</i> (list of str)</dt>
<dd>
list of branches
</dd>
<dt><i>bookmarksList</i> (list of str)</dt>
<dd>
list of bookmarks
</dd>
<dt><i>version</i> (tuple of int)</dt>
<dd>
tuple giving the Mercurial version
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="HgRebaseDialog.__getRevision" ID="HgRebaseDialog.__getRevision"></a>
<h4>HgRebaseDialog.__getRevision</h4>
<b>__getRevision</b>(<i>no</i>)

<p>
        Private method to generate the revision.
</p>
<dl>

<dt><i>no</i> (int)</dt>
<dd>
revision number to generate (1 or 2)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
revision
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="HgRebaseDialog.__updateOK" ID="HgRebaseDialog.__updateOK"></a>
<h4>HgRebaseDialog.__updateOK</h4>
<b>__updateOK</b>(<i></i>)

<p>
        Private slot to update the OK button.
</p>
<a NAME="HgRebaseDialog.getData" ID="HgRebaseDialog.getData"></a>
<h4>HgRebaseDialog.getData</h4>
<b>getData</b>(<i></i>)

<p>
        Public method to retrieve the data for the rebase session.
</p>
<dl>
<dt>Return:</dt>
<dd>
tuple with a source indicator of "S" or "B", the source
            revision, the destination revision, a flag indicating to collapse,
            a flag indicating to keep the original changesets, a flag
            indicating to keep the original branch name, a flag indicating
            to detach the source, a flag indicating to perform a dry-run only
            and a flag indicating to perform a dry-run first, than ask for
            confirmation
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, str, str, bool, bool, bool, bool, bool, bool)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>