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

Thu, 04 Jan 2024 18:02:25 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Thu, 04 Jan 2024 18:02:25 +0100
branch
eric7
changeset 10479
856476537696
parent 10438
4cd7e5a8b3cf
child 10690
fab36645aa7d
permissions
-rw-r--r--

Fine tuned the source code documentation template and regenerated the source code documentation.

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

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#GitCommandDialog">GitCommandDialog</a></td>
<td>Class implementing the Git command dialog.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="GitCommandDialog" ID="GitCommandDialog"></a>
<h2>GitCommandDialog</h2>
<p>
    Class implementing the Git command dialog.
</p>
<p>
    It implements a dialog that is used to enter an
    arbitrary Git command. It asks the user to enter
    the commandline parameters.
</p>

<h3>Derived from</h3>
QDialog, Ui_GitCommandDialog
<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="#GitCommandDialog.__init__">GitCommandDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#GitCommandDialog.getData">getData</a></td>
<td>Public method to retrieve the data entered into this dialog.</td>
</tr>
<tr>
<td><a href="#GitCommandDialog.on_commandCombo_editTextChanged">on_commandCombo_editTextChanged</a></td>
<td>Private method used to enable/disable the OK-button.</td>
</tr>
</table>

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


<a NAME="GitCommandDialog.__init__" ID="GitCommandDialog.__init__"></a>
<h4>GitCommandDialog (Constructor)</h4>
<b>GitCommandDialog</b>(<i>argvList, ppath, parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>argvList</i> (list of str)</dt>
<dd>
history list of commandline arguments
</dd>
<dt><i>ppath</i> (str)</dt>
<dd>
pathname of the project directory
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
parent widget of this dialog
</dd>
</dl>
<a NAME="GitCommandDialog.getData" ID="GitCommandDialog.getData"></a>
<h4>GitCommandDialog.getData</h4>
<b>getData</b>(<i></i>)
<p>
        Public method to retrieve the data entered into this dialog.
</p>

<dl>
<dt>Return:</dt>
<dd>
commandline parameters
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="GitCommandDialog.on_commandCombo_editTextChanged" ID="GitCommandDialog.on_commandCombo_editTextChanged"></a>
<h4>GitCommandDialog.on_commandCombo_editTextChanged</h4>
<b>on_commandCombo_editTextChanged</b>(<i>text</i>)
<p>
        Private method used to enable/disable the OK-button.
</p>

<dl>

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

eric ide

mercurial