src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitOptionsDialog.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.GitOptionsDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsGit.GitOptionsDialog</h1>
<p>
Module implementing a dialog to enter options used to start a project in
the VCS.
</p>

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#GitOptionsDialog">GitOptionsDialog</a></td>
<td>Class implementing a dialog to enter options used to start a project in the repository.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="GitOptionsDialog" ID="GitOptionsDialog"></a>
<h2>GitOptionsDialog</h2>
<p>
    Class implementing a dialog to enter options used to start a project in the
    repository.
</p>

<h3>Derived from</h3>
QDialog, Ui_GitOptionsDialog
<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="#GitOptionsDialog.__init__">GitOptionsDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#GitOptionsDialog.getData">getData</a></td>
<td>Public slot to retrieve the data entered into the dialog.</td>
</tr>
</table>

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


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

<dl>

<dt><i>vcs</i> (Git)</dt>
<dd>
reference to the version control object
</dd>
<dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
parent widget
</dd>
</dl>
<a NAME="GitOptionsDialog.getData" ID="GitOptionsDialog.getData"></a>
<h4>GitOptionsDialog.getData</h4>
<b>getData</b>(<i></i>)
<p>
        Public slot to retrieve the data entered into the dialog.
</p>

<dl>
<dt>Return:</dt>
<dd>
a dictionary containing the data entered
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial