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

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

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

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

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

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

<h3>Derived from</h3>
QDialog, Ui_GitFetchDialog
<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="#GitFetchDialog.__init__">GitFetchDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#GitFetchDialog.__okButtonEnable">__okButtonEnable</a></td>
<td>Private slot to set the enabled state of the OK button.</td>
</tr>
<tr>
<td><a href="#GitFetchDialog.__updateButtonEnable">__updateButtonEnable</a></td>
<td>Private slot to set the enabled state of the update button.</td>
</tr>
<tr>
<td><a href="#GitFetchDialog.getData">getData</a></td>
<td>Public method to get the entered data.</td>
</tr>
<tr>
<td><a href="#GitFetchDialog.on_remoteBranchesList_itemSelectionChanged">on_remoteBranchesList_itemSelectionChanged</a></td>
<td>Private slot to handle a change of selected remote branches.</td>
</tr>
<tr>
<td><a href="#GitFetchDialog.on_remoteEdit_textChanged">on_remoteEdit_textChanged</a></td>
<td>Private slot to handle changes of the URL edit.</td>
</tr>
<tr>
<td><a href="#GitFetchDialog.on_remotesComboBox_currentTextChanged">on_remotesComboBox_currentTextChanged</a></td>
<td>Private slot to handle changes of the selected repository.</td>
</tr>
<tr>
<td><a href="#GitFetchDialog.on_updateButton_clicked">on_updateButton_clicked</a></td>
<td>Private slot to update the list of remote branches.</td>
</tr>
</table>

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


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

<dl>

<dt><i>vcs</i> (Git)</dt>
<dd>
reference to the git object
</dd>
<dt><i>repodir</i> (str)</dt>
<dd>
directory name of the local repository
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="GitFetchDialog.__okButtonEnable" ID="GitFetchDialog.__okButtonEnable"></a>
<h4>GitFetchDialog.__okButtonEnable</h4>
<b>__okButtonEnable</b>(<i></i>)
<p>
        Private slot to set the enabled state of the OK button.
</p>

<a NAME="GitFetchDialog.__updateButtonEnable" ID="GitFetchDialog.__updateButtonEnable"></a>
<h4>GitFetchDialog.__updateButtonEnable</h4>
<b>__updateButtonEnable</b>(<i></i>)
<p>
        Private slot to set the enabled state of the update button.
</p>

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

<dl>
<dt>Return:</dt>
<dd>
tuple of remote name, remote url (for custom remotes),
            remote branches, local branch, a flag indicating to fetch from
            all repositories, a flag indicating to remove obsolete tracking
            references and a flag indicating to fetch tags as well
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, str, list of str, str, bool, bool, bool)
</dd>
</dl>
<a NAME="GitFetchDialog.on_remoteBranchesList_itemSelectionChanged" ID="GitFetchDialog.on_remoteBranchesList_itemSelectionChanged"></a>
<h4>GitFetchDialog.on_remoteBranchesList_itemSelectionChanged</h4>
<b>on_remoteBranchesList_itemSelectionChanged</b>(<i></i>)
<p>
        Private slot to handle a change of selected remote branches.
</p>

<a NAME="GitFetchDialog.on_remoteEdit_textChanged" ID="GitFetchDialog.on_remoteEdit_textChanged"></a>
<h4>GitFetchDialog.on_remoteEdit_textChanged</h4>
<b>on_remoteEdit_textChanged</b>(<i>txt</i>)
<p>
        Private slot to handle changes of the URL edit.
</p>

<dl>

<dt><i>txt</i> (str)</dt>
<dd>
current text of the URL edit
</dd>
</dl>
<a NAME="GitFetchDialog.on_remotesComboBox_currentTextChanged" ID="GitFetchDialog.on_remotesComboBox_currentTextChanged"></a>
<h4>GitFetchDialog.on_remotesComboBox_currentTextChanged</h4>
<b>on_remotesComboBox_currentTextChanged</b>(<i>txt</i>)
<p>
        Private slot to handle changes of the selected repository.
</p>

<dl>

<dt><i>txt</i> (str)</dt>
<dd>
current text of the combo box
</dd>
</dl>
<a NAME="GitFetchDialog.on_updateButton_clicked" ID="GitFetchDialog.on_updateButton_clicked"></a>
<h4>GitFetchDialog.on_updateButton_clicked</h4>
<b>on_updateButton_clicked</b>(<i></i>)
<p>
        Private slot to update the list of remote branches.
</p>

<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>