eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.CloseheadExtension.HgCloseHeadSelectionDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.CloseheadExtension.HgCloseHeadSelectionDialog.html	Mon May 24 11:19:57 2021 +0200
@@ -0,0 +1,168 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Plugins.VcsPlugins.vcsMercurial.CloseheadExtension.HgCloseHeadSelectionDialog</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Plugins.VcsPlugins.vcsMercurial.CloseheadExtension.HgCloseHeadSelectionDialog</h1>
+
+<p>
+Module implementing a dialog to select the heads to be closed.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#HgCloseHeadSelectionDialog">HgCloseHeadSelectionDialog</a></td>
+<td>Class implementing a dialog to select the heads to be closed.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="HgCloseHeadSelectionDialog" ID="HgCloseHeadSelectionDialog"></a>
+<h2>HgCloseHeadSelectionDialog</h2>
+
+<p>
+    Class implementing a dialog to select the heads to be closed.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_HgCloseHeadSelectionDialog
+<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="#HgCloseHeadSelectionDialog.__init__">HgCloseHeadSelectionDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#HgCloseHeadSelectionDialog.__getHeads">__getHeads</a></td>
+<td>Private method to get the open heads.</td>
+</tr>
+<tr>
+<td><a href="#HgCloseHeadSelectionDialog.getData">getData</a></td>
+<td>Public method to retrieve the entered data.</td>
+</tr>
+<tr>
+<td><a href="#HgCloseHeadSelectionDialog.on_headsList_itemSelectionChanged">on_headsList_itemSelectionChanged</a></td>
+<td>Private slot handling changes of the selection.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="HgCloseHeadSelectionDialog.__init__" ID="HgCloseHeadSelectionDialog.__init__"></a>
+<h4>HgCloseHeadSelectionDialog (Constructor)</h4>
+<b>HgCloseHeadSelectionDialog</b>(<i>vcs, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>vcs</i> (Hg)</dt>
+<dd>
+reference to the VCS object
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl>
+<a NAME="HgCloseHeadSelectionDialog.__getHeads" ID="HgCloseHeadSelectionDialog.__getHeads"></a>
+<h4>HgCloseHeadSelectionDialog.__getHeads</h4>
+<b>__getHeads</b>(<i>vcs</i>)
+
+<p>
+        Private method to get the open heads.
+</p>
+<dl>
+
+<dt><i>vcs</i> (Hg)</dt>
+<dd>
+reference to the VCS object
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of tuples containing the revision and the corresponding
+            branch name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of tuples of (str, str)
+</dd>
+</dl>
+<a NAME="HgCloseHeadSelectionDialog.getData" ID="HgCloseHeadSelectionDialog.getData"></a>
+<h4>HgCloseHeadSelectionDialog.getData</h4>
+<b>getData</b>(<i></i>)
+
+<p>
+        Public method to retrieve the entered data.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing a list of selected revisions and the commit
+            message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (list of str, str)
+</dd>
+</dl>
+<a NAME="HgCloseHeadSelectionDialog.on_headsList_itemSelectionChanged" ID="HgCloseHeadSelectionDialog.on_headsList_itemSelectionChanged"></a>
+<h4>HgCloseHeadSelectionDialog.on_headsList_itemSelectionChanged</h4>
+<b>on_headsList_itemSelectionChanged</b>(<i></i>)
+
+<p>
+        Private slot handling changes of the selection.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial