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

branch
eric7
changeset 10215
d476667171a1
parent 9236
db53a9efe7ef
child 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.EricWidgets.EricListSelectionDialog.html	Mon Sep 25 12:09:23 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricListSelectionDialog.html	Tue Sep 26 18:26:21 2023 +0200
@@ -59,6 +59,10 @@
 <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>
@@ -74,6 +78,10 @@
 <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>
 
@@ -83,14 +91,14 @@
 
 <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, parent=None, </i>)
+<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)</dt>
+<dt><i>entries</i> (list of str or list of tuple of (str, Any))</dt>
 <dd>
 list of entries to select from
 </dd>
@@ -116,11 +124,33 @@
 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>)
@@ -137,7 +167,7 @@
 <dl>
 <dt>Return Type:</dt>
 <dd>
-list of str
+list of str or list of tuple of (str, Any)
 </dd>
 </dl>
 <a NAME="EricListSelectionDialog.on_selectionList_itemChanged" ID="EricListSelectionDialog.on_selectionList_itemChanged"></a>
@@ -175,6 +205,20 @@
 <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>
\ No newline at end of file

eric ide

mercurial