--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.GpgExtension.HgGpgSignDialog.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,133 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.VcsPlugins.vcsMercurial.GpgExtension.HgGpgSignDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Plugins.VcsPlugins.vcsMercurial.GpgExtension.HgGpgSignDialog</h1> + +<p> +Module implementing a dialog to enter data for signing a revision. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#HgGpgSignDialog">HgGpgSignDialog</a></td> +<td>Class implementing a dialog to enter data for signing a revision.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="HgGpgSignDialog" ID="HgGpgSignDialog"></a> +<h2>HgGpgSignDialog</h2> + +<p> + Class implementing a dialog to enter data for signing a revision. +</p> +<h3>Derived from</h3> +QDialog, Ui_HgGpgSignDialog +<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="#HgGpgSignDialog.__init__">HgGpgSignDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#HgGpgSignDialog.__updateOK">__updateOK</a></td> +<td>Private slot to update the OK button.</td> +</tr> +<tr> +<td><a href="#HgGpgSignDialog.getData">getData</a></td> +<td>Public method to retrieve the entered data.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="HgGpgSignDialog.__init__" ID="HgGpgSignDialog.__init__"></a> +<h4>HgGpgSignDialog (Constructor)</h4> +<b>HgGpgSignDialog</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="HgGpgSignDialog.__updateOK" ID="HgGpgSignDialog.__updateOK"></a> +<h4>HgGpgSignDialog.__updateOK</h4> +<b>__updateOK</b>(<i></i>) + +<p> + Private slot to update the OK button. +</p> +<a NAME="HgGpgSignDialog.getData" ID="HgGpgSignDialog.getData"></a> +<h4>HgGpgSignDialog.getData</h4> +<b>getData</b>(<i></i>) + +<p> + Public method to retrieve the entered data. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple giving the revision, a flag indicating not to commit + the signature, a commit message, an ID of the key to be used, + a flag indicating a local signature and a flag indicating a forced + signature +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, bool, str, str, bool, bool) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file