src/eric7/Documentation/Source/eric7.EricWidgets.EricListSelectionDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.EricWidgets.EricListSelectionDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricWidgets.EricListSelectionDialog</h1>

<p>
Module implementing a dialog to select from a list of strings.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#EricListSelectionDialog">EricListSelectionDialog</a></td>
<td>Class implementing a dialog to select from a list of strings.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="EricListSelectionDialog" ID="EricListSelectionDialog"></a>
<h2>EricListSelectionDialog</h2>

<p>
    Class implementing a dialog to select from a list of strings.
</p>
<h3>Derived from</h3>
QDialog, Ui_EricListSelectionDialog
<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="#EricListSelectionDialog.__init__">EricListSelectionDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricListSelectionDialog.__selectAll">__selectAll</a></td>
<td>Private method to select or deselect all entries.</td>
</tr>
<tr>
<td><a href="#EricListSelectionDialog.getSelection">getSelection</a></td>
<td>Public method to retrieve the selected items.</td>
</tr>
<tr>
<td><a href="#EricListSelectionDialog.on_selectionList_itemChanged">on_selectionList_itemChanged</a></td>
<td>Private slot handling a change of an item.</td>
</tr>
<tr>
<td><a href="#EricListSelectionDialog.on_selectionList_itemDoubleClicked">on_selectionList_itemDoubleClicked</a></td>
<td>Private slot handling double clicking an item.</td>
</tr>
<tr>
<td><a href="#EricListSelectionDialog.on_selectionList_itemSelectionChanged">on_selectionList_itemSelectionChanged</a></td>
<td>Private slot handling a change of the selection.</td>
</tr>
<tr>
<td><a href="#EricListSelectionDialog.setSelection">setSelection</a></td>
<td>Public method to preselect a list of entries.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="EricListSelectionDialog.__init__" ID="EricListSelectionDialog.__init__"></a>
<h4>EricListSelectionDialog (Constructor)</h4>
<b>EricListSelectionDialog</b>(<i>entries, selectionMode=QAbstractItemView.SelectionMode.ExtendedSelection, title="", message="", checkBoxSelection=False, doubleClickOk=False, emptySelectionOk=False, showSelectAll=False, parent=None, </i>)

<p>
        Constructor
</p>
<dl>

<dt><i>entries</i> (list of str or list of tuple of (str, Any))</dt>
<dd>
list of entries to select from
</dd>
<dt><i>selectionMode</i> (QAbstractItemView.SelectionMode)</dt>
<dd>
selection mode for the list
</dd>
<dt><i>title</i> (str)</dt>
<dd>
title of the dialog
</dd>
<dt><i>message</i> (str)</dt>
<dd>
message to be show in the dialog
</dd>
<dt><i>checkBoxSelection</i> (bool)</dt>
<dd>
flag indicating to select items via their
            checkbox
</dd>
<dt><i>doubleClickOk</i> (bool)</dt>
<dd>
flag indicating to accept the dialog upon a
            double click of an item (single selection only)
</dd>
<dt><i>emptySelectionOk</i> (bool)</dt>
<dd>
flag indicating that an empty selection is allowed
</dd>
<dt><i>showSelectAll</i> (bool)</dt>
<dd>
flag indicating to show a 'Select All' button
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="EricListSelectionDialog.__selectAll" ID="EricListSelectionDialog.__selectAll"></a>
<h4>EricListSelectionDialog.__selectAll</h4>
<b>__selectAll</b>(<i>state</i>)

<p>
        Private method to select or deselect all entries.
</p>
<dl>

<dt><i>state</i> (bool)</dt>
<dd>
flag indicating the desired selection state
</dd>
</dl>
<a NAME="EricListSelectionDialog.getSelection" ID="EricListSelectionDialog.getSelection"></a>
<h4>EricListSelectionDialog.getSelection</h4>
<b>getSelection</b>(<i></i>)

<p>
        Public method to retrieve the selected items.
</p>
<dl>
<dt>Return:</dt>
<dd>
selected entries
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of str or list of tuple of (str, Any)
</dd>
</dl>
<a NAME="EricListSelectionDialog.on_selectionList_itemChanged" ID="EricListSelectionDialog.on_selectionList_itemChanged"></a>
<h4>EricListSelectionDialog.on_selectionList_itemChanged</h4>
<b>on_selectionList_itemChanged</b>(<i>itm</i>)

<p>
        Private slot handling a change of an item.
</p>
<dl>

<dt><i>itm</i> (QListWidgetItem)</dt>
<dd>
reference to the changed item
</dd>
</dl>
<a NAME="EricListSelectionDialog.on_selectionList_itemDoubleClicked" ID="EricListSelectionDialog.on_selectionList_itemDoubleClicked"></a>
<h4>EricListSelectionDialog.on_selectionList_itemDoubleClicked</h4>
<b>on_selectionList_itemDoubleClicked</b>(<i>item</i>)

<p>
        Private slot handling double clicking an item.
</p>
<dl>

<dt><i>item</i> (QListWidgetItem)</dt>
<dd>
double clicked item
</dd>
</dl>
<a NAME="EricListSelectionDialog.on_selectionList_itemSelectionChanged" ID="EricListSelectionDialog.on_selectionList_itemSelectionChanged"></a>
<h4>EricListSelectionDialog.on_selectionList_itemSelectionChanged</h4>
<b>on_selectionList_itemSelectionChanged</b>(<i></i>)

<p>
        Private slot handling a change of the selection.
</p>
<a NAME="EricListSelectionDialog.setSelection" ID="EricListSelectionDialog.setSelection"></a>
<h4>EricListSelectionDialog.setSelection</h4>
<b>setSelection</b>(<i>selection</i>)

<p>
        Public method to preselect a list of entries.
</p>
<dl>

<dt><i>selection</i> (list of str)</dt>
<dd>
list of selected entries
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>