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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10438
4cd7e5a8b3cf
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitPullDialog.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,181 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Plugins.VcsPlugins.vcsGit.GitPullDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Plugins.VcsPlugins.vcsGit.GitPullDialog</h1>
+
+<p>
+Module implementing a dialog to enter data for a Pull operation.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#GitPullDialog">GitPullDialog</a></td>
+<td>Class implementing a dialog to enter data for a Pull operation.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="GitPullDialog" ID="GitPullDialog"></a>
+<h2>GitPullDialog</h2>
+
+<p>
+    Class implementing a dialog to enter data for a Pull operation.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_GitPullDialog
+<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="#GitPullDialog.__init__">GitPullDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#GitPullDialog.__okButtonEnable">__okButtonEnable</a></td>
+<td>Private slot to set the enabled state of the OK button.</td>
+</tr>
+<tr>
+<td><a href="#GitPullDialog.__updateButtonEnable">__updateButtonEnable</a></td>
+<td>Private slot to set the enabled state of the update button.</td>
+</tr>
+<tr>
+<td><a href="#GitPullDialog.getData">getData</a></td>
+<td>Public method to get the entered data.</td>
+</tr>
+<tr>
+<td><a href="#GitPullDialog.on_remoteEdit_textChanged">on_remoteEdit_textChanged</a></td>
+<td>Private slot to handle changes of the URL edit.</td>
+</tr>
+<tr>
+<td><a href="#GitPullDialog.on_remotesComboBox_currentTextChanged">on_remotesComboBox_currentTextChanged</a></td>
+<td>Private slot to handle changes of the selected repository.</td>
+</tr>
+<tr>
+<td><a href="#GitPullDialog.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="GitPullDialog.__init__" ID="GitPullDialog.__init__"></a>
+<h4>GitPullDialog (Constructor)</h4>
+<b>GitPullDialog</b>(<i>vcs, repodir, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>vcs</i></dt>
+<dd>
+reference to the git object
+</dd>
+<dt><i>repodir</i></dt>
+<dd>
+directory name of the local repository (string)
+</dd>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl>
+<a NAME="GitPullDialog.__okButtonEnable" ID="GitPullDialog.__okButtonEnable"></a>
+<h4>GitPullDialog.__okButtonEnable</h4>
+<b>__okButtonEnable</b>(<i></i>)
+
+<p>
+        Private slot to set the enabled state of the OK button.
+</p>
+<a NAME="GitPullDialog.__updateButtonEnable" ID="GitPullDialog.__updateButtonEnable"></a>
+<h4>GitPullDialog.__updateButtonEnable</h4>
+<b>__updateButtonEnable</b>(<i></i>)
+
+<p>
+        Private slot to set the enabled state of the update button.
+</p>
+<a NAME="GitPullDialog.getData" ID="GitPullDialog.getData"></a>
+<h4>GitPullDialog.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, a flag indicating to pull from all repositories
+            and a flag indicating to remove obsolete tracking references
+            (string, string, list of strings, boolean, boolean)
+</dd>
+</dl>
+<a NAME="GitPullDialog.on_remoteEdit_textChanged" ID="GitPullDialog.on_remoteEdit_textChanged"></a>
+<h4>GitPullDialog.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></dt>
+<dd>
+current text of the URL edit (string)
+</dd>
+</dl>
+<a NAME="GitPullDialog.on_remotesComboBox_currentTextChanged" ID="GitPullDialog.on_remotesComboBox_currentTextChanged"></a>
+<h4>GitPullDialog.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></dt>
+<dd>
+current text of the combo box (string)
+</dd>
+</dl>
+<a NAME="GitPullDialog.on_updateButton_clicked" ID="GitPullDialog.on_updateButton_clicked"></a>
+<h4>GitPullDialog.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>
\ No newline at end of file

eric ide

mercurial