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

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsGit.GitReflogBrowserDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsGit.GitReflogBrowserDialog</h1>
<p>
Module implementing a dialog to browse the reflog history.
</p>

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#GitReflogBrowserDialog">GitReflogBrowserDialog</a></td>
<td>Class implementing a dialog to browse the reflog history.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="GitReflogBrowserDialog" ID="GitReflogBrowserDialog"></a>
<h2>GitReflogBrowserDialog</h2>
<p>
    Class implementing a dialog to browse the reflog history.
</p>

<h3>Derived from</h3>
QWidget, Ui_GitReflogBrowserDialog
<h3>Class Attributes</h3>
<table>
<tr><td>CommitIdColumn</td></tr>
<tr><td>NameColumn</td></tr>
<tr><td>OperationColumn</td></tr>
<tr><td>SelectorColumn</td></tr>
<tr><td>SubjectColumn</td></tr>
</table>

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

<h3>Methods</h3>
<table>
<tr>
<td><a href="#GitReflogBrowserDialog.__init__">GitReflogBrowserDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#GitReflogBrowserDialog.__finish">__finish</a></td>
<td>Private slot called when the process finished or the user pressed the button.</td>
</tr>
<tr>
<td><a href="#GitReflogBrowserDialog.__generateReflogItem">__generateReflogItem</a></td>
<td>Private method to generate a reflog tree entry.</td>
</tr>
<tr>
<td><a href="#GitReflogBrowserDialog.__getReflogEntries">__getReflogEntries</a></td>
<td>Private method to retrieve reflog entries from the repository.</td>
</tr>
<tr>
<td><a href="#GitReflogBrowserDialog.__initData">__initData</a></td>
<td>Private method to (re-)initialize some data.</td>
</tr>
<tr>
<td><a href="#GitReflogBrowserDialog.__procFinished">__procFinished</a></td>
<td>Private slot connected to the finished signal.</td>
</tr>
<tr>
<td><a href="#GitReflogBrowserDialog.__processBuffer">__processBuffer</a></td>
<td>Private method to process the buffered output of the git log command.</td>
</tr>
<tr>
<td><a href="#GitReflogBrowserDialog.__readStderr">__readStderr</a></td>
<td>Private slot to handle the readyReadStandardError signal.</td>
</tr>
<tr>
<td><a href="#GitReflogBrowserDialog.__readStdout">__readStdout</a></td>
<td>Private slot to handle the readyReadStandardOutput signal.</td>
</tr>
<tr>
<td><a href="#GitReflogBrowserDialog.__resetUI">__resetUI</a></td>
<td>Private method to reset the user interface.</td>
</tr>
<tr>
<td><a href="#GitReflogBrowserDialog.__resizeColumnsLog">__resizeColumnsLog</a></td>
<td>Private method to resize the log tree columns.</td>
</tr>
<tr>
<td><a href="#GitReflogBrowserDialog.__showError">__showError</a></td>
<td>Private slot to show some error.</td>
</tr>
<tr>
<td><a href="#GitReflogBrowserDialog.closeEvent">closeEvent</a></td>
<td>Protected slot implementing a close event handler.</td>
</tr>
<tr>
<td><a href="#GitReflogBrowserDialog.keyPressEvent">keyPressEvent</a></td>
<td>Protected slot to handle a key press event.</td>
</tr>
<tr>
<td><a href="#GitReflogBrowserDialog.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="#GitReflogBrowserDialog.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="#GitReflogBrowserDialog.on_nextButton_clicked">on_nextButton_clicked</a></td>
<td>Private slot to handle the Next button.</td>
</tr>
<tr>
<td><a href="#GitReflogBrowserDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
<td>Private slot to handle the password checkbox toggled.</td>
</tr>
<tr>
<td><a href="#GitReflogBrowserDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
<td>Private slot to refresh the log.</td>
</tr>
<tr>
<td><a href="#GitReflogBrowserDialog.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="#GitReflogBrowserDialog.show">show</a></td>
<td>Public slot to show the dialog.</td>
</tr>
<tr>
<td><a href="#GitReflogBrowserDialog.start">start</a></td>
<td>Public slot to start the git log command.</td>
</tr>
</table>

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


<a NAME="GitReflogBrowserDialog.__init__" ID="GitReflogBrowserDialog.__init__"></a>
<h4>GitReflogBrowserDialog (Constructor)</h4>
<b>GitReflogBrowserDialog</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>
reference to the parent widget
</dd>
</dl>
<a NAME="GitReflogBrowserDialog.__finish" ID="GitReflogBrowserDialog.__finish"></a>
<h4>GitReflogBrowserDialog.__finish</h4>
<b>__finish</b>(<i></i>)
<p>
        Private slot called when the process finished or the user pressed
        the button.
</p>

<a NAME="GitReflogBrowserDialog.__generateReflogItem" ID="GitReflogBrowserDialog.__generateReflogItem"></a>
<h4>GitReflogBrowserDialog.__generateReflogItem</h4>
<b>__generateReflogItem</b>(<i>commitId, selector, name, subject</i>)
<p>
        Private method to generate a reflog tree entry.
</p>

<dl>

<dt><i>commitId</i> (str)</dt>
<dd>
commit id info
</dd>
<dt><i>selector</i> (str)</dt>
<dd>
selector info
</dd>
<dt><i>name</i> (str)</dt>
<dd>
name info
</dd>
<dt><i>subject</i> (str)</dt>
<dd>
subject of the reflog entry
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the generated item
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QTreeWidgetItem
</dd>
</dl>
<a NAME="GitReflogBrowserDialog.__getReflogEntries" ID="GitReflogBrowserDialog.__getReflogEntries"></a>
<h4>GitReflogBrowserDialog.__getReflogEntries</h4>
<b>__getReflogEntries</b>(<i>skip=0</i>)
<p>
        Private method to retrieve reflog entries from the repository.
</p>

<dl>

<dt><i>skip</i> (int)</dt>
<dd>
number of reflog entries to skip
</dd>
</dl>
<a NAME="GitReflogBrowserDialog.__initData" ID="GitReflogBrowserDialog.__initData"></a>
<h4>GitReflogBrowserDialog.__initData</h4>
<b>__initData</b>(<i></i>)
<p>
        Private method to (re-)initialize some data.
</p>

<a NAME="GitReflogBrowserDialog.__procFinished" ID="GitReflogBrowserDialog.__procFinished"></a>
<h4>GitReflogBrowserDialog.__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 (unused)
</dd>
<dt><i>_exitStatus</i> (QProcess.ExitStatus)</dt>
<dd>
exit status of the process (unused)
</dd>
</dl>
<a NAME="GitReflogBrowserDialog.__processBuffer" ID="GitReflogBrowserDialog.__processBuffer"></a>
<h4>GitReflogBrowserDialog.__processBuffer</h4>
<b>__processBuffer</b>(<i></i>)
<p>
        Private method to process the buffered output of the git log command.
</p>

<a NAME="GitReflogBrowserDialog.__readStderr" ID="GitReflogBrowserDialog.__readStderr"></a>
<h4>GitReflogBrowserDialog.__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="GitReflogBrowserDialog.__readStdout" ID="GitReflogBrowserDialog.__readStdout"></a>
<h4>GitReflogBrowserDialog.__readStdout</h4>
<b>__readStdout</b>(<i></i>)
<p>
        Private slot to handle the readyReadStandardOutput signal.
</p>
<p>
        It reads the output of the process and inserts it into a buffer.
</p>

<a NAME="GitReflogBrowserDialog.__resetUI" ID="GitReflogBrowserDialog.__resetUI"></a>
<h4>GitReflogBrowserDialog.__resetUI</h4>
<b>__resetUI</b>(<i></i>)
<p>
        Private method to reset the user interface.
</p>

<a NAME="GitReflogBrowserDialog.__resizeColumnsLog" ID="GitReflogBrowserDialog.__resizeColumnsLog"></a>
<h4>GitReflogBrowserDialog.__resizeColumnsLog</h4>
<b>__resizeColumnsLog</b>(<i></i>)
<p>
        Private method to resize the log tree columns.
</p>

<a NAME="GitReflogBrowserDialog.__showError" ID="GitReflogBrowserDialog.__showError"></a>
<h4>GitReflogBrowserDialog.__showError</h4>
<b>__showError</b>(<i>out</i>)
<p>
        Private slot to show some error.
</p>

<dl>

<dt><i>out</i> (str)</dt>
<dd>
error to be shown
</dd>
</dl>
<a NAME="GitReflogBrowserDialog.closeEvent" ID="GitReflogBrowserDialog.closeEvent"></a>
<h4>GitReflogBrowserDialog.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="GitReflogBrowserDialog.keyPressEvent" ID="GitReflogBrowserDialog.keyPressEvent"></a>
<h4>GitReflogBrowserDialog.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="GitReflogBrowserDialog.on_buttonBox_clicked" ID="GitReflogBrowserDialog.on_buttonBox_clicked"></a>
<h4>GitReflogBrowserDialog.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="GitReflogBrowserDialog.on_input_returnPressed" ID="GitReflogBrowserDialog.on_input_returnPressed"></a>
<h4>GitReflogBrowserDialog.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="GitReflogBrowserDialog.on_nextButton_clicked" ID="GitReflogBrowserDialog.on_nextButton_clicked"></a>
<h4>GitReflogBrowserDialog.on_nextButton_clicked</h4>
<b>on_nextButton_clicked</b>(<i></i>)
<p>
        Private slot to handle the Next button.
</p>

<a NAME="GitReflogBrowserDialog.on_passwordCheckBox_toggled" ID="GitReflogBrowserDialog.on_passwordCheckBox_toggled"></a>
<h4>GitReflogBrowserDialog.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="GitReflogBrowserDialog.on_refreshButton_clicked" ID="GitReflogBrowserDialog.on_refreshButton_clicked"></a>
<h4>GitReflogBrowserDialog.on_refreshButton_clicked</h4>
<b>on_refreshButton_clicked</b>(<i></i>)
<p>
        Private slot to refresh the log.
</p>

<a NAME="GitReflogBrowserDialog.on_sendButton_clicked" ID="GitReflogBrowserDialog.on_sendButton_clicked"></a>
<h4>GitReflogBrowserDialog.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="GitReflogBrowserDialog.show" ID="GitReflogBrowserDialog.show"></a>
<h4>GitReflogBrowserDialog.show</h4>
<b>show</b>(<i></i>)
<p>
        Public slot to show the dialog.
</p>

<a NAME="GitReflogBrowserDialog.start" ID="GitReflogBrowserDialog.start"></a>
<h4>GitReflogBrowserDialog.start</h4>
<b>start</b>(<i>projectdir</i>)
<p>
        Public slot to start the git log command.
</p>

<dl>

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