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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10438
4cd7e5a8b3cf
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitCommitDialog.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,256 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Plugins.VcsPlugins.vcsGit.GitCommitDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Plugins.VcsPlugins.vcsGit.GitCommitDialog</h1>
+
+<p>
+Module implementing a dialog to enter the commit message.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#GitCommitDialog">GitCommitDialog</a></td>
+<td>Class implementing a dialog to enter the commit message.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="GitCommitDialog" ID="GitCommitDialog"></a>
+<h2>GitCommitDialog</h2>
+
+<p>
+    Class implementing a dialog to enter the commit message.
+</p>
+<h3>Signals</h3>
+<dl>
+
+<dt>accepted()</dt>
+<dd>
+emitted, if the dialog was accepted
+</dd>
+<dt>rejected()</dt>
+<dd>
+emitted, if the dialog was rejected
+</dd>
+</dl>
+<h3>Derived from</h3>
+QWidget, Ui_GitCommitDialog
+<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="#GitCommitDialog.__init__">GitCommitDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#GitCommitDialog.amend">amend</a></td>
+<td>Public method to retrieve the state of the amend flag.</td>
+</tr>
+<tr>
+<td><a href="#GitCommitDialog.logMessage">logMessage</a></td>
+<td>Public method to retrieve the log message.</td>
+</tr>
+<tr>
+<td><a href="#GitCommitDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td>
+<td>Private slot called by the buttonBox accepted signal.</td>
+</tr>
+<tr>
+<td><a href="#GitCommitDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
+<td>Private slot called by a button of the button box clicked.</td>
+</tr>
+<tr>
+<td><a href="#GitCommitDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td>
+<td>Private slot called by the buttonBox rejected signal.</td>
+</tr>
+<tr>
+<td><a href="#GitCommitDialog.on_recentComboBox_activated">on_recentComboBox_activated</a></td>
+<td>Private slot to select a commit message from recent ones.</td>
+</tr>
+<tr>
+<td><a href="#GitCommitDialog.resetAuthor">resetAuthor</a></td>
+<td>Public method to retrieve the state of the reset author flag.</td>
+</tr>
+<tr>
+<td><a href="#GitCommitDialog.showEvent">showEvent</a></td>
+<td>Protected method called when the dialog is about to be shown.</td>
+</tr>
+<tr>
+<td><a href="#GitCommitDialog.stagedOnly">stagedOnly</a></td>
+<td>Public method to retrieve the state of the staged only flag.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="GitCommitDialog.__init__" ID="GitCommitDialog.__init__"></a>
+<h4>GitCommitDialog (Constructor)</h4>
+<b>GitCommitDialog</b>(<i>vcs, msg, amend, commitAll, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>vcs</i></dt>
+<dd>
+reference to the vcs object
+</dd>
+<dt><i>msg</i></dt>
+<dd>
+initial message (string)
+</dd>
+<dt><i>amend</i></dt>
+<dd>
+flag indicating to amend the HEAD commit (boolean)
+</dd>
+<dt><i>commitAll</i></dt>
+<dd>
+flag indicating to commit all local changes (boolean)
+</dd>
+<dt><i>parent</i></dt>
+<dd>
+parent widget (QWidget)
+</dd>
+</dl>
+<a NAME="GitCommitDialog.amend" ID="GitCommitDialog.amend"></a>
+<h4>GitCommitDialog.amend</h4>
+<b>amend</b>(<i></i>)
+
+<p>
+        Public method to retrieve the state of the amend flag.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+state of the amend flag (boolean)
+</dd>
+</dl>
+<a NAME="GitCommitDialog.logMessage" ID="GitCommitDialog.logMessage"></a>
+<h4>GitCommitDialog.logMessage</h4>
+<b>logMessage</b>(<i></i>)
+
+<p>
+        Public method to retrieve the log message.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+the log message (string)
+</dd>
+</dl>
+<a NAME="GitCommitDialog.on_buttonBox_accepted" ID="GitCommitDialog.on_buttonBox_accepted"></a>
+<h4>GitCommitDialog.on_buttonBox_accepted</h4>
+<b>on_buttonBox_accepted</b>(<i></i>)
+
+<p>
+        Private slot called by the buttonBox accepted signal.
+</p>
+<a NAME="GitCommitDialog.on_buttonBox_clicked" ID="GitCommitDialog.on_buttonBox_clicked"></a>
+<h4>GitCommitDialog.on_buttonBox_clicked</h4>
+<b>on_buttonBox_clicked</b>(<i>button</i>)
+
+<p>
+        Private slot called by a button of the button box clicked.
+</p>
+<dl>
+
+<dt><i>button</i></dt>
+<dd>
+button that was clicked (QAbstractButton)
+</dd>
+</dl>
+<a NAME="GitCommitDialog.on_buttonBox_rejected" ID="GitCommitDialog.on_buttonBox_rejected"></a>
+<h4>GitCommitDialog.on_buttonBox_rejected</h4>
+<b>on_buttonBox_rejected</b>(<i></i>)
+
+<p>
+        Private slot called by the buttonBox rejected signal.
+</p>
+<a NAME="GitCommitDialog.on_recentComboBox_activated" ID="GitCommitDialog.on_recentComboBox_activated"></a>
+<h4>GitCommitDialog.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>
+<a NAME="GitCommitDialog.resetAuthor" ID="GitCommitDialog.resetAuthor"></a>
+<h4>GitCommitDialog.resetAuthor</h4>
+<b>resetAuthor</b>(<i></i>)
+
+<p>
+        Public method to retrieve the state of the reset author flag.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+state of the reset author flag (boolean)
+</dd>
+</dl>
+<a NAME="GitCommitDialog.showEvent" ID="GitCommitDialog.showEvent"></a>
+<h4>GitCommitDialog.showEvent</h4>
+<b>showEvent</b>(<i>evt</i>)
+
+<p>
+        Protected method called when the dialog is about to be shown.
+</p>
+<dl>
+
+<dt><i>evt</i></dt>
+<dd>
+the event (QShowEvent)
+</dd>
+</dl>
+<a NAME="GitCommitDialog.stagedOnly" ID="GitCommitDialog.stagedOnly"></a>
+<h4>GitCommitDialog.stagedOnly</h4>
+<b>stagedOnly</b>(<i></i>)
+
+<p>
+        Public method to retrieve the state of the staged only flag.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+state of the staged only flag (boolean)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial