--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDialog.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDialog.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,34 +7,32 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsGit.GitDialog</h1>
-
<p>
Module implementing a dialog starting a process and showing its output.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#GitDialog">GitDialog</a></td>
<td>Class implementing a dialog starting a process and showing its output.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="GitDialog" ID="GitDialog"></a>
<h2>GitDialog</h2>
-
<p>
Class implementing a dialog starting a process and showing its output.
</p>
@@ -43,22 +41,21 @@
shows the output of the process. The dialog is modal,
which causes a synchronized execution of the process.
</p>
+
<h3>Derived from</h3>
QDialog, Ui_GitDialog
<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="#GitDialog.__init__">GitDialog</a></td>
<td>Constructor</td>
@@ -124,19 +121,20 @@
<td>Public slot used to start the process.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="GitDialog.__init__" ID="GitDialog.__init__"></a>
<h4>GitDialog (Constructor)</h4>
<b>GitDialog</b>(<i>text, git=None, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -155,18 +153,18 @@
<a NAME="GitDialog.__finish" ID="GitDialog.__finish"></a>
<h4>GitDialog.__finish</h4>
<b>__finish</b>(<i></i>)
-
<p>
Private slot called when the process finished or the user pressed
the button.
</p>
+
<a NAME="GitDialog.__procFinished" ID="GitDialog.__procFinished"></a>
<h4>GitDialog.__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>
@@ -181,7 +179,6 @@
<a NAME="GitDialog.__readStderr" ID="GitDialog.__readStderr"></a>
<h4>GitDialog.__readStderr</h4>
<b>__readStderr</b>(<i></i>)
-
<p>
Private slot to handle the readyReadStandardError signal.
</p>
@@ -189,10 +186,10 @@
It reads the error output of the process and inserts it into the
error pane.
</p>
+
<a NAME="GitDialog.__readStdout" ID="GitDialog.__readStdout"></a>
<h4>GitDialog.__readStdout</h4>
<b>__readStdout</b>(<i></i>)
-
<p>
Private slot to handle the readyReadStandardOutput signal.
</p>
@@ -200,13 +197,14 @@
It reads the output of the process, formats it and inserts it into
the contents pane.
</p>
+
<a NAME="GitDialog.__showError" ID="GitDialog.__showError"></a>
<h4>GitDialog.__showError</h4>
<b>__showError</b>(<i>out</i>)
-
<p>
Private slot to show some error.
</p>
+
<dl>
<dt><i>out</i> (str)</dt>
@@ -217,10 +215,10 @@
<a NAME="GitDialog.__showOutput" ID="GitDialog.__showOutput"></a>
<h4>GitDialog.__showOutput</h4>
<b>__showOutput</b>(<i>out</i>)
-
<p>
Private slot to show some output.
</p>
+
<dl>
<dt><i>out</i> (str)</dt>
@@ -231,10 +229,10 @@
<a NAME="GitDialog.hasAddOrDelete" ID="GitDialog.hasAddOrDelete"></a>
<h4>GitDialog.hasAddOrDelete</h4>
<b>hasAddOrDelete</b>(<i></i>)
-
<p>
Public method to check, if the last action contained an add or delete.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -250,10 +248,10 @@
<a NAME="GitDialog.keyPressEvent" ID="GitDialog.keyPressEvent"></a>
<h4>GitDialog.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>
@@ -264,10 +262,10 @@
<a NAME="GitDialog.normalExit" ID="GitDialog.normalExit"></a>
<h4>GitDialog.normalExit</h4>
<b>normalExit</b>(<i></i>)
-
<p>
Public method to check for a normal process termination.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -283,11 +281,11 @@
<a NAME="GitDialog.normalExitWithoutErrors" ID="GitDialog.normalExitWithoutErrors"></a>
<h4>GitDialog.normalExitWithoutErrors</h4>
<b>normalExitWithoutErrors</b>(<i></i>)
-
<p>
Public method to check for a normal process termination without
error messages.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -303,10 +301,10 @@
<a NAME="GitDialog.on_buttonBox_clicked" ID="GitDialog.on_buttonBox_clicked"></a>
<h4>GitDialog.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>
@@ -317,17 +315,17 @@
<a NAME="GitDialog.on_input_returnPressed" ID="GitDialog.on_input_returnPressed"></a>
<h4>GitDialog.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="GitDialog.on_passwordCheckBox_toggled" ID="GitDialog.on_passwordCheckBox_toggled"></a>
<h4>GitDialog.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>
@@ -338,17 +336,17 @@
<a NAME="GitDialog.on_sendButton_clicked" ID="GitDialog.on_sendButton_clicked"></a>
<h4>GitDialog.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="GitDialog.startProcess" ID="GitDialog.startProcess"></a>
<h4>GitDialog.startProcess</h4>
<b>startProcess</b>(<i>args, workingDir=None, showArgs=True, environment=None</i>)
-
<p>
Public slot used to start the process.
</p>
+
<dl>
<dt><i>args</i> (list of str)</dt>
@@ -383,4 +381,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
