eric6/Documentation/Source/eric6.E5Gui.E5ComboSelectionDialog.html

branch
maintenance
changeset 8043
0acf98cd089a
parent 8040
da76e49572b1
equal deleted inserted replaced
7991:866adc8c315b 8043:0acf98cd089a
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.E5Gui.E5ComboSelectionDialog</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric6.E5Gui.E5ComboSelectionDialog</h1>
24
25 <p>
26 Module implementing a dialog to select one entry from a list of strings.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#E5ComboSelectionDialog">E5ComboSelectionDialog</a></td>
39 <td>Class implementing a dialog to select one entry from a list of strings.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="E5ComboSelectionDialog" ID="E5ComboSelectionDialog"></a>
50 <h2>E5ComboSelectionDialog</h2>
51
52 <p>
53 Class implementing a dialog to select one entry from a list of strings.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_E5ComboSelectionDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#E5ComboSelectionDialog.__init__">E5ComboSelectionDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#E5ComboSelectionDialog.getSelection">getSelection</a></td>
77 <td>Public method to retrieve the selected item and its data.</td>
78 </tr>
79 <tr>
80 <td><a href="#E5ComboSelectionDialog.on_selectionComboBox_currentTextChanged">on_selectionComboBox_currentTextChanged</a></td>
81 <td>Private slot to react upon changes of the selected entry.</td>
82 </tr>
83 </table>
84 <h3>Static Methods</h3>
85
86 <table>
87 <tr><td>None</td></tr>
88 </table>
89
90 <a NAME="E5ComboSelectionDialog.__init__" ID="E5ComboSelectionDialog.__init__"></a>
91 <h4>E5ComboSelectionDialog (Constructor)</h4>
92 <b>E5ComboSelectionDialog</b>(<i>entries, title="", message="", parent=None</i>)
93
94 <p>
95 Constructor
96 </p>
97 <dl>
98
99 <dt><i>entries</i> (list of str or list of tuples of (str, any))</dt>
100 <dd>
101 list of entries to select from
102 </dd>
103 <dt><i>title</i> (str (optional))</dt>
104 <dd>
105 title of the dialog (defaults to "")
106 </dd>
107 <dt><i>message</i> (str (optional))</dt>
108 <dd>
109 message to be show in the dialog (defaults to "")
110 </dd>
111 <dt><i>parent</i> (QWidget (optional))</dt>
112 <dd>
113 reference to the parent widget (defaults to None)
114 </dd>
115 </dl>
116 <a NAME="E5ComboSelectionDialog.getSelection" ID="E5ComboSelectionDialog.getSelection"></a>
117 <h4>E5ComboSelectionDialog.getSelection</h4>
118 <b>getSelection</b>(<i></i>)
119
120 <p>
121 Public method to retrieve the selected item and its data.
122 </p>
123 <dl>
124 <dt>Return:</dt>
125 <dd>
126 tuple containing the selected entry and its associated data
127 </dd>
128 </dl>
129 <dl>
130 <dt>Return Type:</dt>
131 <dd>
132 tuple of (str, any)
133 </dd>
134 </dl>
135 <a NAME="E5ComboSelectionDialog.on_selectionComboBox_currentTextChanged" ID="E5ComboSelectionDialog.on_selectionComboBox_currentTextChanged"></a>
136 <h4>E5ComboSelectionDialog.on_selectionComboBox_currentTextChanged</h4>
137 <b>on_selectionComboBox_currentTextChanged</b>(<i>txt</i>)
138
139 <p>
140 Private slot to react upon changes of the selected entry.
141 </p>
142 <dl>
143
144 <dt><i>txt</i> (str)</dt>
145 <dd>
146 text of the selected entry
147 </dd>
148 </dl>
149 <div align="right"><a href="#top">Up</a></div>
150 <hr />
151 </body></html>

eric ide

mercurial