--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitCherryPickDialog.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,120 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.VcsPlugins.vcsGit.GitCherryPickDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Plugins.VcsPlugins.vcsGit.GitCherryPickDialog</h1> + +<p> +Module implementing a dialog to enter cherry-pick data. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#GitCherryPickDialog">GitCherryPickDialog</a></td> +<td>Class implementing a dialog to enter cherry-pick data.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="GitCherryPickDialog" ID="GitCherryPickDialog"></a> +<h2>GitCherryPickDialog</h2> + +<p> + Class implementing a dialog to enter cherry-pick data. +</p> +<h3>Derived from</h3> +QDialog, Ui_GitCherryPickDialog +<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="#GitCherryPickDialog.__init__">GitCherryPickDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#GitCherryPickDialog.getData">getData</a></td> +<td>Public method to retrieve the entered data.</td> +</tr> +<tr> +<td><a href="#GitCherryPickDialog.on_commitsEdit_textChanged">on_commitsEdit_textChanged</a></td> +<td>Private slot to react upon changes of commits.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="GitCherryPickDialog.__init__" ID="GitCherryPickDialog.__init__"></a> +<h4>GitCherryPickDialog (Constructor)</h4> +<b>GitCherryPickDialog</b>(<i>commits=None, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>commits</i></dt> +<dd> +list of commits to show in the commits pane (list of + strings) +</dd> +<dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl> +<a NAME="GitCherryPickDialog.getData" ID="GitCherryPickDialog.getData"></a> +<h4>GitCherryPickDialog.getData</h4> +<b>getData</b>(<i></i>) + +<p> + Public method to retrieve the entered data. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple with list of commits, a flag indicating to append + cherry-pick info to the commit message, a flag indicating to append + a signed-off-by line to the commit message and a flag indicating to + not commit the action (list of strings, boolean, boolean, boolean) +</dd> +</dl> +<a NAME="GitCherryPickDialog.on_commitsEdit_textChanged" ID="GitCherryPickDialog.on_commitsEdit_textChanged"></a> +<h4>GitCherryPickDialog.on_commitsEdit_textChanged</h4> +<b>on_commitsEdit_textChanged</b>(<i></i>) + +<p> + Private slot to react upon changes of commits. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file