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

<!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> (list of str)</dt>
<dd>
list of entries to be shown
</dd>
<dt><i>selectedEntries</i> (list of str or str)</dt>
<dd>
list of entries to be selected or a string with
            entries separated by separator
</dd>
<dt><i>separator</i> (str)</dt>
<dd>
separator string
</dd>
<dt><i>subEntries</i> (list of str)</dt>
<dd>
secondary list of entries
</dd>
<dt><i>allowMultiMain</i> (bool)</dt>
<dd>
flag indicating to allow multiple selections for
            the main entry
</dd>
<dt><i>allowMultiSub</i> (bool)</dt>
<dd>
flag indicating to allow multiple selections for
            the sub entry
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</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> (str)</dt>
<dd>
separator string
</dd>
<dt><i>separatorAtEnd</i> (bool)</dt>
<dd>
flag indicating to append the separator
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
list of selected entries if the separator is None or a string
            with entries delimited by separator
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list od str or str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>