eric6/E5Gui/E5ComboSelectionDialog.py

changeset 8038
73ec029d4107
child 8143
2c730d5fd177
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric6/E5Gui/E5ComboSelectionDialog.py	Sun Jan 31 17:47:55 2021 +0100
@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2021 Detlev Offenbach <detlev@die-offenbachs.de>
+#
+
+"""
+Module implementing a dialog to select one entry from a list of strings.
+"""
+
+from PyQt5.QtCore import pyqtSlot
+from PyQt5.QtWidgets import QDialog, QDialogButtonBox
+
+from .Ui_E5ComboSelectionDialog import Ui_E5ComboSelectionDialog
+
+
+class E5ComboSelectionDialog(QDialog, Ui_E5ComboSelectionDialog):
+    """
+    Class implementing a dialog to select one entry from a list of strings.
+    """
+    def __init__(self, entries, title="", message="", parent=None):
+        """
+        Constructor
+        
+        @param entries list of entries to select from
+        @type list of str or list of tuples of (str, any)
+        @param title title of the dialog (defaults to "")
+        @type str (optional)
+        @param message message to be show in the dialog (defaults to "")
+        @type str (optional)
+        @param parent reference to the parent widget (defaults to None)
+        @type QWidget (optional)
+        """
+        super(E5ComboSelectionDialog, self).__init__(parent)
+        self.setupUi(self)
+        
+        for entry in entries:
+            if isinstance(entry, tuple):
+                self.selectionComboBox.addItem(*entry)
+            else:
+                self.selectionComboBox.addItem(entry)
+        
+        self.on_selectionComboBox_currentTextChanged(
+            self.selectionComboBox.itemText(0))
+        
+        msh = self.minimumSizeHint()
+        self.resize(max(self.width(), msh.width()), msh.height())
+    
+    @pyqtSlot(str)
+    def on_selectionComboBox_currentTextChanged(self, txt):
+        """
+        Private slot to react upon changes of the selected entry.
+        
+        @param txt text of the selected entry
+        @type str
+        """
+        self.buttonBox.button(QDialogButtonBox.Ok).setEnabled(bool(txt))
+    
+    def getSelection(self):
+        """
+        Public method to retrieve the selected item and its data.
+        
+        @return tuple containing the selected entry and its associated data
+        @rtype tuple of (str, any)
+        """
+        return (
+            self.selectionComboBox.currentText(),
+            self.selectionComboBox.currentData()
+        )

eric ide

mercurial