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

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

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#HgBranchInputDialog">HgBranchInputDialog</a></td>
<td>Class implementing a dialog to enter the data for a branch operation.</td>
</tr>
</table>

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

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

<h3>Derived from</h3>
QDialog, Ui_HgBranchInputDialog
<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="#HgBranchInputDialog.__init__">HgBranchInputDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HgBranchInputDialog.getData">getData</a></td>
<td>Public method to get the data.</td>
</tr>
<tr>
<td><a href="#HgBranchInputDialog.on_branchComboBox_editTextChanged">on_branchComboBox_editTextChanged</a></td>
<td>Private slot handling a change of the branch name.</td>
</tr>
</table>

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


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

<dl>

<dt><i>branches</i> (list of str)</dt>
<dd>
branch names to populate the branch list with
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="HgBranchInputDialog.getData" ID="HgBranchInputDialog.getData"></a>
<h4>HgBranchInputDialog.getData</h4>
<b>getData</b>(<i></i>)
<p>
        Public method to get the data.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple of branch name, a flag indicating to commit the branch
            and a flag indicating to force the branch creation
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, bool, bool)
</dd>
</dl>
<a NAME="HgBranchInputDialog.on_branchComboBox_editTextChanged" ID="HgBranchInputDialog.on_branchComboBox_editTextChanged"></a>
<h4>HgBranchInputDialog.on_branchComboBox_editTextChanged</h4>
<b>on_branchComboBox_editTextChanged</b>(<i>txt</i>)
<p>
        Private slot handling a change of the branch name.
</p>

<dl>

<dt><i>txt</i> (str)</dt>
<dd>
contents of the branch combo box
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>