diff -r 3fc8dfeb6ebe -r b99e7fd55fd3 src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBackoutDialog.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBackoutDialog.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,131 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.VcsPlugins.vcsMercurial.HgBackoutDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgBackoutDialog</h1> + +<p> +Module implementing a dialog to enter the data for a backout operation. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#HgBackoutDialog">HgBackoutDialog</a></td> +<td>Class implementing a dialog to enter the data for a backout operation.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="HgBackoutDialog" ID="HgBackoutDialog"></a> +<h2>HgBackoutDialog</h2> + +<p> + Class implementing a dialog to enter the data for a backout operation. +</p> +<h3>Derived from</h3> +QDialog, Ui_HgBackoutDialog +<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="#HgBackoutDialog.__init__">HgBackoutDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#HgBackoutDialog.__updateOK">__updateOK</a></td> +<td>Private slot to update the OK button.</td> +</tr> +<tr> +<td><a href="#HgBackoutDialog.getParameters">getParameters</a></td> +<td>Public method to retrieve the backout data.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="HgBackoutDialog.__init__" ID="HgBackoutDialog.__init__"></a> +<h4>HgBackoutDialog (Constructor)</h4> +<b>HgBackoutDialog</b>(<i>tagsList, branchesList, bookmarksList=None, 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>bookmarksList</i> (list of str)</dt> +<dd> +list of bookmarks +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +parent widget +</dd> +</dl> +<a NAME="HgBackoutDialog.__updateOK" ID="HgBackoutDialog.__updateOK"></a> +<h4>HgBackoutDialog.__updateOK</h4> +<b>__updateOK</b>(<i></i>) + +<p> + Private slot to update the OK button. +</p> +<a NAME="HgBackoutDialog.getParameters" ID="HgBackoutDialog.getParameters"></a> +<h4>HgBackoutDialog.getParameters</h4> +<b>getParameters</b>(<i></i>) + +<p> + Public method to retrieve the backout data. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple naming the revision, a flag indicating a + merge, the commit date, the commit user and a commit message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, bool, str, str, str) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file