tip/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.HgHisteditCommitEditor.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.HgHisteditCommitEditor</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.HgHisteditCommitEditor</h1>
<p>
Module implementing a dialog to edit the commit message of a revision.
</p>

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#HgHisteditCommitEditor">HgHisteditCommitEditor</a></td>
<td>Class implementing a dialog to edit the commit message of a revision.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="HgHisteditCommitEditor" ID="HgHisteditCommitEditor"></a>
<h2>HgHisteditCommitEditor</h2>
<p>
    Class implementing a dialog to edit the commit message of a revision.
</p>

<h3>Derived from</h3>
QDialog, Ui_HgHisteditCommitEditor
<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="#HgHisteditCommitEditor.__init__">HgHisteditCommitEditor</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HgHisteditCommitEditor.__readFile">__readFile</a></td>
<td>Private method to read the file containing the commit message and populate the dialog.</td>
</tr>
<tr>
<td><a href="#HgHisteditCommitEditor.on_buttonBox_accepted">on_buttonBox_accepted</a></td>
<td>Private slot called by the buttonBox accepted signal.</td>
</tr>
<tr>
<td><a href="#HgHisteditCommitEditor.on_buttonBox_rejected">on_buttonBox_rejected</a></td>
<td>Private slot called by the buttonBox rejected signal.</td>
</tr>
<tr>
<td><a href="#HgHisteditCommitEditor.on_recentComboBox_activated">on_recentComboBox_activated</a></td>
<td>Private slot to select a commit message from recent ones.</td>
</tr>
</table>

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


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

<dl>

<dt><i>fileName</i> (str)</dt>
<dd>
name of the file containing the commit message
            to be edited
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="HgHisteditCommitEditor.__readFile" ID="HgHisteditCommitEditor.__readFile"></a>
<h4>HgHisteditCommitEditor.__readFile</h4>
<b>__readFile</b>(<i></i>)
<p>
        Private method to read the file containing the commit message and
        populate the dialog.
</p>

<a NAME="HgHisteditCommitEditor.on_buttonBox_accepted" ID="HgHisteditCommitEditor.on_buttonBox_accepted"></a>
<h4>HgHisteditCommitEditor.on_buttonBox_accepted</h4>
<b>on_buttonBox_accepted</b>(<i></i>)
<p>
        Private slot called by the buttonBox accepted signal.
</p>

<a NAME="HgHisteditCommitEditor.on_buttonBox_rejected" ID="HgHisteditCommitEditor.on_buttonBox_rejected"></a>
<h4>HgHisteditCommitEditor.on_buttonBox_rejected</h4>
<b>on_buttonBox_rejected</b>(<i></i>)
<p>
        Private slot called by the buttonBox rejected signal.
</p>

<a NAME="HgHisteditCommitEditor.on_recentComboBox_activated" ID="HgHisteditCommitEditor.on_recentComboBox_activated"></a>
<h4>HgHisteditCommitEditor.on_recentComboBox_activated</h4>
<b>on_recentComboBox_activated</b>(<i>index</i>)
<p>
        Private slot to select a commit message from recent ones.
</p>

<dl>

<dt><i>index</i> (int)</dt>
<dd>
index of the selected entry
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>