src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnBlameDialog.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.vcsSubversion.SvnBlameDialog.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,301 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Plugins.VcsPlugins.vcsSubversion.SvnBlameDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Plugins.VcsPlugins.vcsSubversion.SvnBlameDialog</h1>
+
+<p>
+Module implementing a dialog to show the output of the svn blame command.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#SvnBlameDialog">SvnBlameDialog</a></td>
+<td>Class implementing a dialog to show the output of the svn blame command.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="SvnBlameDialog" ID="SvnBlameDialog"></a>
+<h2>SvnBlameDialog</h2>
+
+<p>
+    Class implementing a dialog to show the output of the svn blame command.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_SvnBlameDialog
+<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="#SvnBlameDialog.__init__">SvnBlameDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#SvnBlameDialog.__finish">__finish</a></td>
+<td>Private slot called when the process finished or the user pressed the button.</td>
+</tr>
+<tr>
+<td><a href="#SvnBlameDialog.__generateItem">__generateItem</a></td>
+<td>Private method to generate a blame item in the blame list.</td>
+</tr>
+<tr>
+<td><a href="#SvnBlameDialog.__procFinished">__procFinished</a></td>
+<td>Private slot connected to the finished signal.</td>
+</tr>
+<tr>
+<td><a href="#SvnBlameDialog.__readStderr">__readStderr</a></td>
+<td>Private slot to handle the readyReadStderr signal.</td>
+</tr>
+<tr>
+<td><a href="#SvnBlameDialog.__readStdout">__readStdout</a></td>
+<td>Private slot to handle the readyReadStdout signal.</td>
+</tr>
+<tr>
+<td><a href="#SvnBlameDialog.__resizeColumns">__resizeColumns</a></td>
+<td>Private method to resize the list columns.</td>
+</tr>
+<tr>
+<td><a href="#SvnBlameDialog.closeEvent">closeEvent</a></td>
+<td>Protected slot implementing a close event handler.</td>
+</tr>
+<tr>
+<td><a href="#SvnBlameDialog.keyPressEvent">keyPressEvent</a></td>
+<td>Protected slot to handle a key press event.</td>
+</tr>
+<tr>
+<td><a href="#SvnBlameDialog.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="#SvnBlameDialog.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="#SvnBlameDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
+<td>Private slot to handle the password checkbox toggled.</td>
+</tr>
+<tr>
+<td><a href="#SvnBlameDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
+<td>Private slot to send the input to the subversion process.</td>
+</tr>
+<tr>
+<td><a href="#SvnBlameDialog.start">start</a></td>
+<td>Public slot to start the svn blame command.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="SvnBlameDialog.__init__" ID="SvnBlameDialog.__init__"></a>
+<h4>SvnBlameDialog (Constructor)</h4>
+<b>SvnBlameDialog</b>(<i>vcs, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>vcs</i></dt>
+<dd>
+reference to the vcs object
+</dd>
+<dt><i>parent</i></dt>
+<dd>
+parent widget (QWidget)
+</dd>
+</dl>
+<a NAME="SvnBlameDialog.__finish" ID="SvnBlameDialog.__finish"></a>
+<h4>SvnBlameDialog.__finish</h4>
+<b>__finish</b>(<i></i>)
+
+<p>
+        Private slot called when the process finished or the user pressed the
+        button.
+</p>
+<a NAME="SvnBlameDialog.__generateItem" ID="SvnBlameDialog.__generateItem"></a>
+<h4>SvnBlameDialog.__generateItem</h4>
+<b>__generateItem</b>(<i>revision, author, text</i>)
+
+<p>
+        Private method to generate a blame item in the blame list.
+</p>
+<dl>
+
+<dt><i>revision</i></dt>
+<dd>
+revision string (string)
+</dd>
+<dt><i>author</i></dt>
+<dd>
+author of the change (string)
+</dd>
+<dt><i>text</i></dt>
+<dd>
+line of text from the annotated file (string)
+</dd>
+</dl>
+<a NAME="SvnBlameDialog.__procFinished" ID="SvnBlameDialog.__procFinished"></a>
+<h4>SvnBlameDialog.__procFinished</h4>
+<b>__procFinished</b>(<i>exitCode, exitStatus</i>)
+
+<p>
+        Private slot connected to the finished signal.
+</p>
+<dl>
+
+<dt><i>exitCode</i></dt>
+<dd>
+exit code of the process (integer)
+</dd>
+<dt><i>exitStatus</i></dt>
+<dd>
+exit status of the process (QProcess.ExitStatus)
+</dd>
+</dl>
+<a NAME="SvnBlameDialog.__readStderr" ID="SvnBlameDialog.__readStderr"></a>
+<h4>SvnBlameDialog.__readStderr</h4>
+<b>__readStderr</b>(<i></i>)
+
+<p>
+        Private slot to handle the readyReadStderr signal.
+</p>
+<p>
+        It reads the error output of the process and inserts it into the
+        error pane.
+</p>
+<a NAME="SvnBlameDialog.__readStdout" ID="SvnBlameDialog.__readStdout"></a>
+<h4>SvnBlameDialog.__readStdout</h4>
+<b>__readStdout</b>(<i></i>)
+
+<p>
+        Private slot to handle the readyReadStdout signal.
+</p>
+<p>
+        It reads the output of the process, formats it and inserts it into
+        the contents pane.
+</p>
+<a NAME="SvnBlameDialog.__resizeColumns" ID="SvnBlameDialog.__resizeColumns"></a>
+<h4>SvnBlameDialog.__resizeColumns</h4>
+<b>__resizeColumns</b>(<i></i>)
+
+<p>
+        Private method to resize the list columns.
+</p>
+<a NAME="SvnBlameDialog.closeEvent" ID="SvnBlameDialog.closeEvent"></a>
+<h4>SvnBlameDialog.closeEvent</h4>
+<b>closeEvent</b>(<i>e</i>)
+
+<p>
+        Protected slot implementing a close event handler.
+</p>
+<dl>
+
+<dt><i>e</i></dt>
+<dd>
+close event (QCloseEvent)
+</dd>
+</dl>
+<a NAME="SvnBlameDialog.keyPressEvent" ID="SvnBlameDialog.keyPressEvent"></a>
+<h4>SvnBlameDialog.keyPressEvent</h4>
+<b>keyPressEvent</b>(<i>evt</i>)
+
+<p>
+        Protected slot to handle a key press event.
+</p>
+<dl>
+
+<dt><i>evt</i></dt>
+<dd>
+the key press event (QKeyEvent)
+</dd>
+</dl>
+<a NAME="SvnBlameDialog.on_buttonBox_clicked" ID="SvnBlameDialog.on_buttonBox_clicked"></a>
+<h4>SvnBlameDialog.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></dt>
+<dd>
+button that was clicked (QAbstractButton)
+</dd>
+</dl>
+<a NAME="SvnBlameDialog.on_input_returnPressed" ID="SvnBlameDialog.on_input_returnPressed"></a>
+<h4>SvnBlameDialog.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="SvnBlameDialog.on_passwordCheckBox_toggled" ID="SvnBlameDialog.on_passwordCheckBox_toggled"></a>
+<h4>SvnBlameDialog.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></dt>
+<dd>
+flag indicating the status of the check box (boolean)
+</dd>
+</dl>
+<a NAME="SvnBlameDialog.on_sendButton_clicked" ID="SvnBlameDialog.on_sendButton_clicked"></a>
+<h4>SvnBlameDialog.on_sendButton_clicked</h4>
+<b>on_sendButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to send the input to the subversion process.
+</p>
+<a NAME="SvnBlameDialog.start" ID="SvnBlameDialog.start"></a>
+<h4>SvnBlameDialog.start</h4>
+<b>start</b>(<i>fn</i>)
+
+<p>
+        Public slot to start the svn blame command.
+</p>
+<dl>
+
+<dt><i>fn</i></dt>
+<dd>
+filename to show the blame for (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial