tip/src/eric7/Documentation/Source/eric7.EricWidgets.EricComboSelectionDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.EricWidgets.EricComboSelectionDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricWidgets.EricComboSelectionDialog</h1>
<p>
Module implementing a dialog to select one entry 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="#EricComboSelectionDialog">EricComboSelectionDialog</a></td>
<td>Class implementing a dialog to select one entry from a list of strings.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="EricComboSelectionDialog" ID="EricComboSelectionDialog"></a>
<h2>EricComboSelectionDialog</h2>
<p>
    Class implementing a dialog to select one entry from a list of strings.
</p>

<h3>Derived from</h3>
QDialog, Ui_EricComboSelectionDialog
<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="#EricComboSelectionDialog.__init__">EricComboSelectionDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricComboSelectionDialog.getSelection">getSelection</a></td>
<td>Public method to retrieve the selected item and its data.</td>
</tr>
<tr>
<td><a href="#EricComboSelectionDialog.on_selectionComboBox_currentTextChanged">on_selectionComboBox_currentTextChanged</a></td>
<td>Private slot to react upon changes of the selected entry.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="EricComboSelectionDialog.__init__" ID="EricComboSelectionDialog.__init__"></a>
<h4>EricComboSelectionDialog (Constructor)</h4>
<b>EricComboSelectionDialog</b>(<i>entries, title="", message="", parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>entries</i> (list of str or list of tuples of (str, any))</dt>
<dd>
list of entries to select from
</dd>
<dt><i>title</i> (str (optional))</dt>
<dd>
title of the dialog (defaults to "")
</dd>
<dt><i>message</i> (str (optional))</dt>
<dd>
message to be show in the dialog (defaults to "")
</dd>
<dt><i>parent</i> (QWidget (optional))</dt>
<dd>
reference to the parent widget (defaults to None)
</dd>
</dl>
<a NAME="EricComboSelectionDialog.getSelection" ID="EricComboSelectionDialog.getSelection"></a>
<h4>EricComboSelectionDialog.getSelection</h4>
<b>getSelection</b>(<i></i>)
<p>
        Public method to retrieve the selected item and its data.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple containing the selected entry and its associated data
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, any)
</dd>
</dl>
<a NAME="EricComboSelectionDialog.on_selectionComboBox_currentTextChanged" ID="EricComboSelectionDialog.on_selectionComboBox_currentTextChanged"></a>
<h4>EricComboSelectionDialog.on_selectionComboBox_currentTextChanged</h4>
<b>on_selectionComboBox_currentTextChanged</b>(<i>txt</i>)
<p>
        Private slot to react upon changes of the selected entry.
</p>

<dl>

<dt><i>txt</i> (str)</dt>
<dd>
text of the selected entry
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>