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

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

<p>
Module implementing a dialog to show available remote repositories.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#GitRemoteRepositoriesDialog">GitRemoteRepositoriesDialog</a></td>
<td>Class implementing a dialog to show available remote repositories.</td>
</tr>
</table>
<h3>Functions</h3>

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

<p>
    Class implementing a dialog to show available remote repositories.
</p>
<h3>Derived from</h3>
QWidget, Ui_GitRemoteRepositoriesDialog
<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="#GitRemoteRepositoriesDialog.__init__">GitRemoteRepositoriesDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.__finish">__finish</a></td>
<td>Private slot called when the process finished or the user pressed the button.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.__generateItem">__generateItem</a></td>
<td>Private method to generate a status item in the status list.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.__procFinished">__procFinished</a></td>
<td>Private slot connected to the finished signal.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.__readStderr">__readStderr</a></td>
<td>Private slot to handle the readyReadStandardError signal.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.__readStdout">__readStdout</a></td>
<td>Private slot to handle the readyReadStandardOutput signal.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.__resizeColumns">__resizeColumns</a></td>
<td>Private method to resize the list columns.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.__resort">__resort</a></td>
<td>Private method to resort the list.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.__updateButtons">__updateButtons</a></td>
<td>Private method to update the buttons status.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.closeEvent">closeEvent</a></td>
<td>Protected slot implementing a close event handler.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.keyPressEvent">keyPressEvent</a></td>
<td>Protected slot to handle a key press event.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.on_addButton_clicked">on_addButton_clicked</a></td>
<td>Private slot to add a remote repository.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
<td>Private slot called by a button of the button box clicked.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.on_changeUrlButton_clicked">on_changeUrlButton_clicked</a></td>
<td>Private slot to change the URL of a remote repository.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.on_credentialsButton_clicked">on_credentialsButton_clicked</a></td>
<td>Private slot to change the credentials of a remote repository.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.on_input_returnPressed">on_input_returnPressed</a></td>
<td>Private slot to handle the press of the return key in the input field.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
<td>Private slot to handle the password checkbox toggled.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.on_pruneButton_clicked">on_pruneButton_clicked</a></td>
<td>Private slot to prune all stale remote-tracking branches.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
<td>Private slot to refresh the status display.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.on_removeButton_clicked">on_removeButton_clicked</a></td>
<td>Private slot to remove a remote repository.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.on_renameButton_clicked">on_renameButton_clicked</a></td>
<td>Private slot to rename a remote repository.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged">on_repolist_itemSelectionChanged</a></td>
<td>Private slot to act upon changes of selected items.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
<td>Private slot to send the input to the git process.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.on_showInfoButton_clicked">on_showInfoButton_clicked</a></td>
<td>Private slot to show information about a remote repository.</td>
</tr>
<tr>
<td><a href="#GitRemoteRepositoriesDialog.start">start</a></td>
<td>Public slot to start the git remote command.</td>
</tr>
</table>
<h3>Static Methods</h3>

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

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

<p>
        Constructor
</p>
<dl>

<dt><i>vcs</i> (Git)</dt>
<dd>
reference to the vcs object
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
parent widget
</dd>
</dl>
<a NAME="GitRemoteRepositoriesDialog.__finish" ID="GitRemoteRepositoriesDialog.__finish"></a>
<h4>GitRemoteRepositoriesDialog.__finish</h4>
<b>__finish</b>(<i></i>)

<p>
        Private slot called when the process finished or the user pressed
        the button.
</p>
<a NAME="GitRemoteRepositoriesDialog.__generateItem" ID="GitRemoteRepositoriesDialog.__generateItem"></a>
<h4>GitRemoteRepositoriesDialog.__generateItem</h4>
<b>__generateItem</b>(<i>name, url, oper</i>)

<p>
        Private method to generate a status item in the status list.
</p>
<dl>

<dt><i>name</i> (str)</dt>
<dd>
name of the remote repository
</dd>
<dt><i>url</i> (str)</dt>
<dd>
URL of the remote repository
</dd>
<dt><i>oper</i> (str)</dt>
<dd>
operation the remote repository may be used for
</dd>
</dl>
<a NAME="GitRemoteRepositoriesDialog.__procFinished" ID="GitRemoteRepositoriesDialog.__procFinished"></a>
<h4>GitRemoteRepositoriesDialog.__procFinished</h4>
<b>__procFinished</b>(<i>exitCode, exitStatus</i>)

<p>
        Private slot connected to the finished signal.
</p>
<dl>

<dt><i>exitCode</i> (int)</dt>
<dd>
exit code of the process
</dd>
<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
<dd>
exit status of the process
</dd>
</dl>
<a NAME="GitRemoteRepositoriesDialog.__readStderr" ID="GitRemoteRepositoriesDialog.__readStderr"></a>
<h4>GitRemoteRepositoriesDialog.__readStderr</h4>
<b>__readStderr</b>(<i></i>)

<p>
        Private slot to handle the readyReadStandardError signal.
</p>
<p>
        It reads the error output of the process and inserts it into the
        error pane.
</p>
<a NAME="GitRemoteRepositoriesDialog.__readStdout" ID="GitRemoteRepositoriesDialog.__readStdout"></a>
<h4>GitRemoteRepositoriesDialog.__readStdout</h4>
<b>__readStdout</b>(<i></i>)

<p>
        Private slot to handle the readyReadStandardOutput signal.
</p>
<p>
        It reads the output of the process, formats it and inserts it into
        the contents pane.
</p>
<a NAME="GitRemoteRepositoriesDialog.__resizeColumns" ID="GitRemoteRepositoriesDialog.__resizeColumns"></a>
<h4>GitRemoteRepositoriesDialog.__resizeColumns</h4>
<b>__resizeColumns</b>(<i></i>)

<p>
        Private method to resize the list columns.
</p>
<a NAME="GitRemoteRepositoriesDialog.__resort" ID="GitRemoteRepositoriesDialog.__resort"></a>
<h4>GitRemoteRepositoriesDialog.__resort</h4>
<b>__resort</b>(<i></i>)

<p>
        Private method to resort the list.
</p>
<a NAME="GitRemoteRepositoriesDialog.__updateButtons" ID="GitRemoteRepositoriesDialog.__updateButtons"></a>
<h4>GitRemoteRepositoriesDialog.__updateButtons</h4>
<b>__updateButtons</b>(<i></i>)

<p>
        Private method to update the buttons status.
</p>
<a NAME="GitRemoteRepositoriesDialog.closeEvent" ID="GitRemoteRepositoriesDialog.closeEvent"></a>
<h4>GitRemoteRepositoriesDialog.closeEvent</h4>
<b>closeEvent</b>(<i>e</i>)

<p>
        Protected slot implementing a close event handler.
</p>
<dl>

<dt><i>e</i> (QCloseEvent)</dt>
<dd>
close event
</dd>
</dl>
<a NAME="GitRemoteRepositoriesDialog.keyPressEvent" ID="GitRemoteRepositoriesDialog.keyPressEvent"></a>
<h4>GitRemoteRepositoriesDialog.keyPressEvent</h4>
<b>keyPressEvent</b>(<i>evt</i>)

<p>
        Protected slot to handle a key press event.
</p>
<dl>

<dt><i>evt</i> (QKeyEvent)</dt>
<dd>
the key press event
</dd>
</dl>
<a NAME="GitRemoteRepositoriesDialog.on_addButton_clicked" ID="GitRemoteRepositoriesDialog.on_addButton_clicked"></a>
<h4>GitRemoteRepositoriesDialog.on_addButton_clicked</h4>
<b>on_addButton_clicked</b>(<i></i>)

<p>
        Private slot to add a remote repository.
</p>
<a NAME="GitRemoteRepositoriesDialog.on_buttonBox_clicked" ID="GitRemoteRepositoriesDialog.on_buttonBox_clicked"></a>
<h4>GitRemoteRepositoriesDialog.on_buttonBox_clicked</h4>
<b>on_buttonBox_clicked</b>(<i>button</i>)

<p>
        Private slot called by a button of the button box clicked.
</p>
<dl>

<dt><i>button</i> (QAbstractButton)</dt>
<dd>
button that was clicked
</dd>
</dl>
<a NAME="GitRemoteRepositoriesDialog.on_changeUrlButton_clicked" ID="GitRemoteRepositoriesDialog.on_changeUrlButton_clicked"></a>
<h4>GitRemoteRepositoriesDialog.on_changeUrlButton_clicked</h4>
<b>on_changeUrlButton_clicked</b>(<i></i>)

<p>
        Private slot to change the URL of a remote repository.
</p>
<a NAME="GitRemoteRepositoriesDialog.on_credentialsButton_clicked" ID="GitRemoteRepositoriesDialog.on_credentialsButton_clicked"></a>
<h4>GitRemoteRepositoriesDialog.on_credentialsButton_clicked</h4>
<b>on_credentialsButton_clicked</b>(<i></i>)

<p>
        Private slot to change the credentials of a remote repository.
</p>
<a NAME="GitRemoteRepositoriesDialog.on_input_returnPressed" ID="GitRemoteRepositoriesDialog.on_input_returnPressed"></a>
<h4>GitRemoteRepositoriesDialog.on_input_returnPressed</h4>
<b>on_input_returnPressed</b>(<i></i>)

<p>
        Private slot to handle the press of the return key in the input field.
</p>
<a NAME="GitRemoteRepositoriesDialog.on_passwordCheckBox_toggled" ID="GitRemoteRepositoriesDialog.on_passwordCheckBox_toggled"></a>
<h4>GitRemoteRepositoriesDialog.on_passwordCheckBox_toggled</h4>
<b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)

<p>
        Private slot to handle the password checkbox toggled.
</p>
<dl>

<dt><i>isOn</i> (bool)</dt>
<dd>
flag indicating the status of the check box
</dd>
</dl>
<a NAME="GitRemoteRepositoriesDialog.on_pruneButton_clicked" ID="GitRemoteRepositoriesDialog.on_pruneButton_clicked"></a>
<h4>GitRemoteRepositoriesDialog.on_pruneButton_clicked</h4>
<b>on_pruneButton_clicked</b>(<i></i>)

<p>
        Private slot to prune all stale remote-tracking branches.
</p>
<a NAME="GitRemoteRepositoriesDialog.on_refreshButton_clicked" ID="GitRemoteRepositoriesDialog.on_refreshButton_clicked"></a>
<h4>GitRemoteRepositoriesDialog.on_refreshButton_clicked</h4>
<b>on_refreshButton_clicked</b>(<i></i>)

<p>
        Private slot to refresh the status display.
</p>
<a NAME="GitRemoteRepositoriesDialog.on_removeButton_clicked" ID="GitRemoteRepositoriesDialog.on_removeButton_clicked"></a>
<h4>GitRemoteRepositoriesDialog.on_removeButton_clicked</h4>
<b>on_removeButton_clicked</b>(<i></i>)

<p>
        Private slot to remove a remote repository.
</p>
<a NAME="GitRemoteRepositoriesDialog.on_renameButton_clicked" ID="GitRemoteRepositoriesDialog.on_renameButton_clicked"></a>
<h4>GitRemoteRepositoriesDialog.on_renameButton_clicked</h4>
<b>on_renameButton_clicked</b>(<i></i>)

<p>
        Private slot to rename a remote repository.
</p>
<a NAME="GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged" ID="GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged"></a>
<h4>GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged</h4>
<b>on_repolist_itemSelectionChanged</b>(<i></i>)

<p>
        Private slot to act upon changes of selected items.
</p>
<a NAME="GitRemoteRepositoriesDialog.on_sendButton_clicked" ID="GitRemoteRepositoriesDialog.on_sendButton_clicked"></a>
<h4>GitRemoteRepositoriesDialog.on_sendButton_clicked</h4>
<b>on_sendButton_clicked</b>(<i></i>)

<p>
        Private slot to send the input to the git process.
</p>
<a NAME="GitRemoteRepositoriesDialog.on_showInfoButton_clicked" ID="GitRemoteRepositoriesDialog.on_showInfoButton_clicked"></a>
<h4>GitRemoteRepositoriesDialog.on_showInfoButton_clicked</h4>
<b>on_showInfoButton_clicked</b>(<i></i>)

<p>
        Private slot to show information about a remote repository.
</p>
<a NAME="GitRemoteRepositoriesDialog.start" ID="GitRemoteRepositoriesDialog.start"></a>
<h4>GitRemoteRepositoriesDialog.start</h4>
<b>start</b>(<i>projectDir</i>)

<p>
        Public slot to start the git remote command.
</p>
<dl>

<dt><i>projectDir</i> (str)</dt>
<dd>
name of the project directory
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>