--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveBuiltin.HgShelvesSelectionDialog.html Sun Dec 01 18:17:51 2024 +0100 @@ -0,0 +1,124 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.VcsPlugins.vcsMercurial.ShelveBuiltin.HgShelvesSelectionDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Plugins.VcsPlugins.vcsMercurial.ShelveBuiltin.HgShelvesSelectionDialog</h1> +<p> +Module implementing a dialog to select multiple shelve names. +</p> + +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Classes</h3> +<table> +<tr> +<td><a href="#HgShelvesSelectionDialog">HgShelvesSelectionDialog</a></td> +<td>Class implementing a dialog to select multiple shelve names.</td> +</tr> +</table> + +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> + +<hr /> +<hr /> +<a NAME="HgShelvesSelectionDialog" ID="HgShelvesSelectionDialog"></a> +<h2>HgShelvesSelectionDialog</h2> +<p> + Class implementing a dialog to select multiple shelve names. +</p> + +<h3>Derived from</h3> +QDialog, Ui_HgShelvesSelectionDialog +<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="#HgShelvesSelectionDialog.__init__">HgShelvesSelectionDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#HgShelvesSelectionDialog.getSelectedShelves">getSelectedShelves</a></td> +<td>Public method to retrieve the selected shelve names.</td> +</tr> +<tr> +<td><a href="#HgShelvesSelectionDialog.on_shelvesList_itemSelectionChanged">on_shelvesList_itemSelectionChanged</a></td> +<td>Private slot to enabled the OK button if items have been selected.</td> +</tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + +<a NAME="HgShelvesSelectionDialog.__init__" ID="HgShelvesSelectionDialog.__init__"></a> +<h4>HgShelvesSelectionDialog (Constructor)</h4> +<b>HgShelvesSelectionDialog</b>(<i>message, shelveNames, parent=None</i>) +<p> + Constructor +</p> + +<dl> + +<dt><i>message</i> (str)</dt> +<dd> +message to be shown +</dd> +<dt><i>shelveNames</i> (list of str)</dt> +<dd> +list of shelve names +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="HgShelvesSelectionDialog.getSelectedShelves" ID="HgShelvesSelectionDialog.getSelectedShelves"></a> +<h4>HgShelvesSelectionDialog.getSelectedShelves</h4> +<b>getSelectedShelves</b>(<i></i>) +<p> + Public method to retrieve the selected shelve names. +</p> + +<dl> +<dt>Return:</dt> +<dd> +selected shelve names +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> +<a NAME="HgShelvesSelectionDialog.on_shelvesList_itemSelectionChanged" ID="HgShelvesSelectionDialog.on_shelvesList_itemSelectionChanged"></a> +<h4>HgShelvesSelectionDialog.on_shelvesList_itemSelectionChanged</h4> +<b>on_shelvesList_itemSelectionChanged</b>(<i></i>) +<p> + Private slot to enabled the OK button if items have been selected. +</p> + +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html>