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

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsGit.GitMergeDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsGit.GitMergeDialog</h1>

<p>
Module implementing a dialog to enter the merge data.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#GitMergeDialog">GitMergeDialog</a></td>
<td>Class implementing a dialog to enter the merge data.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="GitMergeDialog" ID="GitMergeDialog"></a>
<h2>GitMergeDialog</h2>

<p>
    Class implementing a dialog to enter the merge data.
</p>
<h3>Derived from</h3>
QDialog, Ui_GitMergeDialog
<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="#GitMergeDialog.__init__">GitMergeDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#GitMergeDialog.__generateDefaultCommitMessage">__generateDefaultCommitMessage</a></td>
<td>Private slot to generate a default commit message based on the data entered.</td>
</tr>
<tr>
<td><a href="#GitMergeDialog.__updateOK">__updateOK</a></td>
<td>Private slot to update the OK button.</td>
</tr>
<tr>
<td><a href="#GitMergeDialog.getParameters">getParameters</a></td>
<td>Public method to retrieve the merge data.</td>
</tr>
<tr>
<td><a href="#GitMergeDialog.on_branchButton_toggled">on_branchButton_toggled</a></td>
<td>Private slot to handle changes of the Branch select button.</td>
</tr>
<tr>
<td><a href="#GitMergeDialog.on_branchCombo_editTextChanged">on_branchCombo_editTextChanged</a></td>
<td>Private slot to handle changes of the Branch combo.</td>
</tr>
<tr>
<td><a href="#GitMergeDialog.on_commitGroupBox_toggled">on_commitGroupBox_toggled</a></td>
<td>Private slot to handle changes of the Commit select group.</td>
</tr>
<tr>
<td><a href="#GitMergeDialog.on_commitMessageEdit_textChanged">on_commitMessageEdit_textChanged</a></td>
<td>Private slot to handle changes of the commit message edit.</td>
</tr>
<tr>
<td><a href="#GitMergeDialog.on_idButton_toggled">on_idButton_toggled</a></td>
<td>Private slot to handle changes of the ID select button.</td>
</tr>
<tr>
<td><a href="#GitMergeDialog.on_idEdit_textChanged">on_idEdit_textChanged</a></td>
<td>Private slot to handle changes of the Commit edit.</td>
</tr>
<tr>
<td><a href="#GitMergeDialog.on_noneButton_toggled">on_noneButton_toggled</a></td>
<td>Private slot to handle changes of the None select button.</td>
</tr>
<tr>
<td><a href="#GitMergeDialog.on_remoteBranchButton_toggled">on_remoteBranchButton_toggled</a></td>
<td>Private slot to handle changes of the Remote Branch select button.</td>
</tr>
<tr>
<td><a href="#GitMergeDialog.on_remoteBranchCombo_editTextChanged">on_remoteBranchCombo_editTextChanged</a></td>
<td>Private slot to handle changes of the Remote Branch combo.</td>
</tr>
<tr>
<td><a href="#GitMergeDialog.on_tagButton_toggled">on_tagButton_toggled</a></td>
<td>Private slot to handle changes of the Tag select button.</td>
</tr>
<tr>
<td><a href="#GitMergeDialog.on_tagCombo_editTextChanged">on_tagCombo_editTextChanged</a></td>
<td>Private slot to handle changes of the Tag combo.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="GitMergeDialog.__init__" ID="GitMergeDialog.__init__"></a>
<h4>GitMergeDialog (Constructor)</h4>
<b>GitMergeDialog</b>(<i>tagsList, branchesList, currentBranch, remoteBranchesList, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>tagsList</i> (list of str)</dt>
<dd>
list of tags
</dd>
<dt><i>branchesList</i> (list of str)</dt>
<dd>
list of branches
</dd>
<dt><i>currentBranch</i> (str)</dt>
<dd>
name of the current branch
</dd>
<dt><i>remoteBranchesList</i> (list of str)</dt>
<dd>
list of remote branches
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="GitMergeDialog.__generateDefaultCommitMessage" ID="GitMergeDialog.__generateDefaultCommitMessage"></a>
<h4>GitMergeDialog.__generateDefaultCommitMessage</h4>
<b>__generateDefaultCommitMessage</b>(<i></i>)

<p>
        Private slot to generate a default commit message based on the
        data entered.
</p>
<a NAME="GitMergeDialog.__updateOK" ID="GitMergeDialog.__updateOK"></a>
<h4>GitMergeDialog.__updateOK</h4>
<b>__updateOK</b>(<i></i>)

<p>
        Private slot to update the OK button.
</p>
<a NAME="GitMergeDialog.getParameters" ID="GitMergeDialog.getParameters"></a>
<h4>GitMergeDialog.getParameters</h4>
<b>getParameters</b>(<i></i>)

<p>
        Public method to retrieve the merge data.
</p>
<dl>
<dt>Return:</dt>
<dd>
tuple naming the revision, a flag indicating that the merge
            shall be committed, the commit message, a flag indicating that a
            log summary shall be appended and a flag indicating to show diff
            statistics at the end of the merge
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, bool, str, bool, bool)
</dd>
</dl>
<a NAME="GitMergeDialog.on_branchButton_toggled" ID="GitMergeDialog.on_branchButton_toggled"></a>
<h4>GitMergeDialog.on_branchButton_toggled</h4>
<b>on_branchButton_toggled</b>(<i>checked</i>)

<p>
        Private slot to handle changes of the Branch select button.
</p>
<dl>

<dt><i>checked</i> (bool)</dt>
<dd>
state of the button
</dd>
</dl>
<a NAME="GitMergeDialog.on_branchCombo_editTextChanged" ID="GitMergeDialog.on_branchCombo_editTextChanged"></a>
<h4>GitMergeDialog.on_branchCombo_editTextChanged</h4>
<b>on_branchCombo_editTextChanged</b>(<i>txt</i>)

<p>
        Private slot to handle changes of the Branch combo.
</p>
<dl>

<dt><i>txt</i> (str)</dt>
<dd>
text of the combo
</dd>
</dl>
<a NAME="GitMergeDialog.on_commitGroupBox_toggled" ID="GitMergeDialog.on_commitGroupBox_toggled"></a>
<h4>GitMergeDialog.on_commitGroupBox_toggled</h4>
<b>on_commitGroupBox_toggled</b>(<i>checked</i>)

<p>
        Private slot to handle changes of the Commit select group.
</p>
<dl>

<dt><i>checked</i> (bool)</dt>
<dd>
state of the group
</dd>
</dl>
<a NAME="GitMergeDialog.on_commitMessageEdit_textChanged" ID="GitMergeDialog.on_commitMessageEdit_textChanged"></a>
<h4>GitMergeDialog.on_commitMessageEdit_textChanged</h4>
<b>on_commitMessageEdit_textChanged</b>(<i></i>)

<p>
        Private slot to handle changes of the commit message edit.
</p>
<a NAME="GitMergeDialog.on_idButton_toggled" ID="GitMergeDialog.on_idButton_toggled"></a>
<h4>GitMergeDialog.on_idButton_toggled</h4>
<b>on_idButton_toggled</b>(<i>checked</i>)

<p>
        Private slot to handle changes of the ID select button.
</p>
<dl>

<dt><i>checked</i> (bool)</dt>
<dd>
state of the button
</dd>
</dl>
<a NAME="GitMergeDialog.on_idEdit_textChanged" ID="GitMergeDialog.on_idEdit_textChanged"></a>
<h4>GitMergeDialog.on_idEdit_textChanged</h4>
<b>on_idEdit_textChanged</b>(<i>txt</i>)

<p>
        Private slot to handle changes of the Commit edit.
</p>
<dl>

<dt><i>txt</i> (str)</dt>
<dd>
text of the edit
</dd>
</dl>
<a NAME="GitMergeDialog.on_noneButton_toggled" ID="GitMergeDialog.on_noneButton_toggled"></a>
<h4>GitMergeDialog.on_noneButton_toggled</h4>
<b>on_noneButton_toggled</b>(<i>checked</i>)

<p>
        Private slot to handle changes of the None select button.
</p>
<dl>

<dt><i>checked</i> (bool)</dt>
<dd>
state of the button
</dd>
</dl>
<a NAME="GitMergeDialog.on_remoteBranchButton_toggled" ID="GitMergeDialog.on_remoteBranchButton_toggled"></a>
<h4>GitMergeDialog.on_remoteBranchButton_toggled</h4>
<b>on_remoteBranchButton_toggled</b>(<i>checked</i>)

<p>
        Private slot to handle changes of the Remote Branch select button.
</p>
<dl>

<dt><i>checked</i> (bool)</dt>
<dd>
state of the button
</dd>
</dl>
<a NAME="GitMergeDialog.on_remoteBranchCombo_editTextChanged" ID="GitMergeDialog.on_remoteBranchCombo_editTextChanged"></a>
<h4>GitMergeDialog.on_remoteBranchCombo_editTextChanged</h4>
<b>on_remoteBranchCombo_editTextChanged</b>(<i>txt</i>)

<p>
        Private slot to handle changes of the Remote Branch combo.
</p>
<dl>

<dt><i>txt</i> (str)</dt>
<dd>
text of the combo
</dd>
</dl>
<a NAME="GitMergeDialog.on_tagButton_toggled" ID="GitMergeDialog.on_tagButton_toggled"></a>
<h4>GitMergeDialog.on_tagButton_toggled</h4>
<b>on_tagButton_toggled</b>(<i>checked</i>)

<p>
        Private slot to handle changes of the Tag select button.
</p>
<dl>

<dt><i>checked</i> (bool)</dt>
<dd>
state of the button
</dd>
</dl>
<a NAME="GitMergeDialog.on_tagCombo_editTextChanged" ID="GitMergeDialog.on_tagCombo_editTextChanged"></a>
<h4>GitMergeDialog.on_tagCombo_editTextChanged</h4>
<b>on_tagCombo_editTextChanged</b>(<i>txt</i>)

<p>
        Private slot to handle changes of the Tag combo.
</p>
<dl>

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