--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgCommitDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgCommitDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,37 +18,48 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgCommitDialog</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="#HgCommitDialog">HgCommitDialog</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 /> +<hr /> +<hr /> <a NAME="HgCommitDialog" ID="HgCommitDialog"></a> <h2>HgCommitDialog</h2> + <p> Class implementing a dialog to enter the commit message. -</p><h3>Signals</h3> +</p> +<h3>Signals</h3> <dl> + <dt>accepted()</dt> <dd> emitted, if the dialog was accepted -</dd><dt>rejected()</dt> +</dd> +<dt>rejected()</dt> <dd> emitted, if the dialog was rejected </dd> @@ -56,117 +67,156 @@ <h3>Derived from</h3> QWidget, Ui_HgCommitDialog <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="#HgCommitDialog.__init__">HgCommitDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgCommitDialog.getCommitData">getCommitData</a></td> <td>Public method to retrieve the entered data for the commit.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgCommitDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td> <td>Private slot called by the buttonBox accepted signal.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgCommitDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> <td>Private slot called by a button of the button box clicked.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgCommitDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td> <td>Private slot called by the buttonBox rejected signal.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgCommitDialog.on_recentComboBox_activated">on_recentComboBox_activated</a></td> <td>Private slot to select a commit message from recent ones.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgCommitDialog.showEvent">showEvent</a></td> <td>Protected method called when the dialog is about to be shown.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="HgCommitDialog.__init__" ID="HgCommitDialog.__init__"></a> <h4>HgCommitDialog (Constructor)</h4> <b>HgCommitDialog</b>(<i>vcs, msg, mq, merge, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>vcs</i></dt> <dd> reference to the vcs object -</dd><dt><i>msg</i></dt> +</dd> +<dt><i>msg</i></dt> <dd> initial message (string) -</dd><dt><i>mq</i></dt> +</dd> +<dt><i>mq</i></dt> <dd> flag indicating a queue commit (boolean) -</dd><dt><i>merge</i></dt> +</dd> +<dt><i>merge</i></dt> <dd> flag indicating a merge commit (boolean) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> parent widget (QWidget) </dd> -</dl><a NAME="HgCommitDialog.getCommitData" ID="HgCommitDialog.getCommitData"></a> +</dl> +<a NAME="HgCommitDialog.getCommitData" ID="HgCommitDialog.getCommitData"></a> <h4>HgCommitDialog.getCommitData</h4> <b>getCommitData</b>(<i></i>) + <p> Public method to retrieve the entered data for the commit. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> tuple containing the log message, a flag indicating to amend the last commit, a flag indicating to commit subrepositories as well, name of the author and date/time of the commit </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> tuple of str, bool, bool, str, str </dd> -</dl><a NAME="HgCommitDialog.on_buttonBox_accepted" ID="HgCommitDialog.on_buttonBox_accepted"></a> +</dl> +<a NAME="HgCommitDialog.on_buttonBox_accepted" ID="HgCommitDialog.on_buttonBox_accepted"></a> <h4>HgCommitDialog.on_buttonBox_accepted</h4> <b>on_buttonBox_accepted</b>(<i></i>) + <p> Private slot called by the buttonBox accepted signal. -</p><a NAME="HgCommitDialog.on_buttonBox_clicked" ID="HgCommitDialog.on_buttonBox_clicked"></a> +</p> +<a NAME="HgCommitDialog.on_buttonBox_clicked" ID="HgCommitDialog.on_buttonBox_clicked"></a> <h4>HgCommitDialog.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> +</p> +<dl> + <dt><i>button</i></dt> <dd> button that was clicked (QAbstractButton) </dd> -</dl><a NAME="HgCommitDialog.on_buttonBox_rejected" ID="HgCommitDialog.on_buttonBox_rejected"></a> +</dl> +<a NAME="HgCommitDialog.on_buttonBox_rejected" ID="HgCommitDialog.on_buttonBox_rejected"></a> <h4>HgCommitDialog.on_buttonBox_rejected</h4> <b>on_buttonBox_rejected</b>(<i></i>) + <p> Private slot called by the buttonBox rejected signal. -</p><a NAME="HgCommitDialog.on_recentComboBox_activated" ID="HgCommitDialog.on_recentComboBox_activated"></a> +</p> +<a NAME="HgCommitDialog.on_recentComboBox_activated" ID="HgCommitDialog.on_recentComboBox_activated"></a> <h4>HgCommitDialog.on_recentComboBox_activated</h4> <b>on_recentComboBox_activated</b>(<i>txt</i>) + <p> Private slot to select a commit message from recent ones. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the selected entry (string) </dd> -</dl><a NAME="HgCommitDialog.showEvent" ID="HgCommitDialog.showEvent"></a> +</dl> +<a NAME="HgCommitDialog.showEvent" ID="HgCommitDialog.showEvent"></a> <h4>HgCommitDialog.showEvent</h4> <b>showEvent</b>(<i>evt</i>) + <p> Protected method called when the dialog is about to be shown. -</p><dl> +</p> +<dl> + <dt><i>evt</i></dt> <dd> the event (QShowEvent)