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

Sat, 23 Dec 2023 15:40:23 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 23 Dec 2023 15:40:23 +0100
branch
eric7
changeset 10438
4cd7e5a8b3cf
parent 9209
b99e7fd55fd3
child 10479
856476537696
permissions
-rw-r--r--

Converted some source code documentation to the new style.

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

<p>
Module implementing a dialog to select the data for pushing a branch.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#GitBranchPushDialog">GitBranchPushDialog</a></td>
<td>Class implementing a dialog to select the data for pushing a branch.</td>
</tr>
</table>
<h3>Functions</h3>

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

<p>
    Class implementing a dialog to select the data for pushing a branch.
</p>
<h3>Derived from</h3>
QDialog, Ui_GitBranchPushDialog
<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="#GitBranchPushDialog.__init__">GitBranchPushDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#GitBranchPushDialog.getData">getData</a></td>
<td>Public method to get the selected data.</td>
</tr>
<tr>
<td><a href="#GitBranchPushDialog.on_branchComboBox_editTextChanged">on_branchComboBox_editTextChanged</a></td>
<td>Private slot to handle a change of the branch name.</td>
</tr>
</table>
<h3>Static Methods</h3>

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

<a NAME="GitBranchPushDialog.__init__" ID="GitBranchPushDialog.__init__"></a>
<h4>GitBranchPushDialog (Constructor)</h4>
<b>GitBranchPushDialog</b>(<i>branches, remotes, delete=False, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>branches</i> (list of str)</dt>
<dd>
list of branch names
</dd>
<dt><i>remotes</i> (list of str)</dt>
<dd>
list of remote names
</dd>
<dt><i>delete</i> (bool)</dt>
<dd>
flag indicating a delete branch action
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="GitBranchPushDialog.getData" ID="GitBranchPushDialog.getData"></a>
<h4>GitBranchPushDialog.getData</h4>
<b>getData</b>(<i></i>)

<p>
        Public method to get the selected data.
</p>
<dl>
<dt>Return:</dt>
<dd>
tuple of selected branch name, remote name and a flag
            indicating all branches
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, str, bool)
</dd>
</dl>
<a NAME="GitBranchPushDialog.on_branchComboBox_editTextChanged" ID="GitBranchPushDialog.on_branchComboBox_editTextChanged"></a>
<h4>GitBranchPushDialog.on_branchComboBox_editTextChanged</h4>
<b>on_branchComboBox_editTextChanged</b>(<i>txt</i>)

<p>
        Private slot to handle a change of the branch name.
</p>
<dl>

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

eric ide

mercurial