src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitBisectStartDialog.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.GitBisectStartDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsGit.GitBisectStartDialog</h1>
<p>
Module implementing a dialog to enter the data for an extended bisect start.
</p>

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#GitBisectStartDialog">GitBisectStartDialog</a></td>
<td>Class implementing a dialog to enter the data for an extended bisect start.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="GitBisectStartDialog" ID="GitBisectStartDialog"></a>
<h2>GitBisectStartDialog</h2>
<p>
    Class implementing a dialog to enter the data for an extended bisect start.
</p>

<h3>Derived from</h3>
QDialog, Ui_GitBisectStartDialog
<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="#GitBisectStartDialog.__init__">GitBisectStartDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#GitBisectStartDialog.__updateOK">__updateOK</a></td>
<td>Private method used to enable/disable the OK-button.</td>
</tr>
<tr>
<td><a href="#GitBisectStartDialog.getData">getData</a></td>
<td>Public method to get the entered data.</td>
</tr>
<tr>
<td><a href="#GitBisectStartDialog.on_badEdit_textChanged">on_badEdit_textChanged</a></td>
<td>Private slot to handle a change of the bad commit.</td>
</tr>
</table>

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


<a NAME="GitBisectStartDialog.__init__" ID="GitBisectStartDialog.__init__"></a>
<h4>GitBisectStartDialog (Constructor)</h4>
<b>GitBisectStartDialog</b>(<i>parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="GitBisectStartDialog.__updateOK" ID="GitBisectStartDialog.__updateOK"></a>
<h4>GitBisectStartDialog.__updateOK</h4>
<b>__updateOK</b>(<i></i>)
<p>
        Private method used to enable/disable the OK-button.
</p>

<a NAME="GitBisectStartDialog.getData" ID="GitBisectStartDialog.getData"></a>
<h4>GitBisectStartDialog.getData</h4>
<b>getData</b>(<i></i>)
<p>
        Public method to get the entered data.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple containing a bad commit, a list of good commits and
            a flag indicating to not checkout the working tree
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, list of str, bool)
</dd>
</dl>
<a NAME="GitBisectStartDialog.on_badEdit_textChanged" ID="GitBisectStartDialog.on_badEdit_textChanged"></a>
<h4>GitBisectStartDialog.on_badEdit_textChanged</h4>
<b>on_badEdit_textChanged</b>(<i>txt</i>)
<p>
        Private slot to handle a change of the bad commit.
</p>

<dl>

<dt><i>txt</i> (str)</dt>
<dd>
bad commit entered
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial