--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitFetchDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitFetchDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,106 +18,139 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.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 /> +<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> +</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> +</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> +</tr> +<tr> <td><a href="#GitFetchDialog.getData">getData</a></td> <td>Public method to get the entered data.</td> -</tr><tr> +</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> +</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> +</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> +</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> +</p> +<dl> + <dt><i>vcs</i></dt> <dd> reference to the git object -</dd><dt><i>repodir</i></dt> +</dd> +<dt><i>repodir</i></dt> <dd> directory name of the local repository (string) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> -</dl><a NAME="GitFetchDialog.__okButtonEnable" ID="GitFetchDialog.__okButtonEnable"></a> +</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> +</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> +</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> +</p> +<dl> <dt>Returns:</dt> <dd> tuple of remote name, remote url (for custom remotes), @@ -127,34 +160,46 @@ (string, string, list of strings, string, boolean, boolean, boolean) </dd> -</dl><a NAME="GitFetchDialog.on_remoteBranchesList_itemSelectionChanged" ID="GitFetchDialog.on_remoteBranchesList_itemSelectionChanged"></a> +</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> +</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> +</p> +<dl> + <dt><i>txt</i></dt> <dd> current text of the URL edit (string) </dd> -</dl><a NAME="GitFetchDialog.on_remotesComboBox_currentTextChanged" ID="GitFetchDialog.on_remotesComboBox_currentTextChanged"></a> +</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> +</p> +<dl> + <dt><i>txt</i></dt> <dd> current text of the combo box (string) </dd> -</dl><a NAME="GitFetchDialog.on_updateButton_clicked" ID="GitFetchDialog.on_updateButton_clicked"></a> +</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>