src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.DotDesktopWizard.DotDesktopListSelectionDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9236
db53a9efe7ef
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.DotDesktopWizard.DotDesktopListSelectionDialog.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,141 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Plugins.WizardPlugins.DotDesktopWizard.DotDesktopListSelectionDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Plugins.WizardPlugins.DotDesktopWizard.DotDesktopListSelectionDialog</h1>
+
+<p>
+Module implementing a dialog to select multiple entries from a list.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#DotDesktopListSelectionDialog">DotDesktopListSelectionDialog</a></td>
+<td>Class implementing a dialog to select multiple entries from a list.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="DotDesktopListSelectionDialog" ID="DotDesktopListSelectionDialog"></a>
+<h2>DotDesktopListSelectionDialog</h2>
+
+<p>
+    Class implementing a dialog to select multiple entries from a list.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_DotDesktopListSelectionDialog
+<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="#DotDesktopListSelectionDialog.__init__">DotDesktopListSelectionDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#DotDesktopListSelectionDialog.getData">getData</a></td>
+<td>Public method to extract the selected entries as a list or a string.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="DotDesktopListSelectionDialog.__init__" ID="DotDesktopListSelectionDialog.__init__"></a>
+<h4>DotDesktopListSelectionDialog (Constructor)</h4>
+<b>DotDesktopListSelectionDialog</b>(<i>entries, selectedEntries, separator, subEntries=None, allowMultiMain=True, allowMultiSub=True, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>entries</i></dt>
+<dd>
+list of entries to be shown (list of string)
+</dd>
+<dt><i>selectedEntries</i></dt>
+<dd>
+list of entries to be selected (list of string
+            or string of entries separated by separator)
+</dd>
+<dt><i>separator</i></dt>
+<dd>
+separator string (string)
+</dd>
+<dt><i>subEntries</i></dt>
+<dd>
+secondary list of entries (list of string)
+</dd>
+<dt><i>allowMultiMain</i></dt>
+<dd>
+flag indicating to allow multiple selections for
+            the main entry (bool)
+</dd>
+<dt><i>allowMultiSub</i></dt>
+<dd>
+flag indicating to allow multiple selections for
+            the sub entry (bool)
+</dd>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl>
+<a NAME="DotDesktopListSelectionDialog.getData" ID="DotDesktopListSelectionDialog.getData"></a>
+<h4>DotDesktopListSelectionDialog.getData</h4>
+<b>getData</b>(<i>separator=None, separatorAtEnd=False</i>)
+
+<p>
+        Public method to extract the selected entries as a list
+        or a string.
+</p>
+<dl>
+
+<dt><i>separator</i></dt>
+<dd>
+separator string (string)
+</dd>
+<dt><i>separatorAtEnd</i></dt>
+<dd>
+flag indicating to append the separator (boolean)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of selected entries (list of string) if the separator is
+            None or a string with entries delimited by separator (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial