|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.EricWidgets.EricStringListEditWidget</title> |
|
4 <meta charset="UTF-8"> |
|
5 <link rel="stylesheet" href="styles.css"> |
|
6 </head> |
|
7 <body> |
|
8 <a NAME="top" ID="top"></a> |
|
9 <h1>eric7.EricWidgets.EricStringListEditWidget</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing a dialog to edit a list of strings. |
|
13 </p> |
|
14 <h3>Global Attributes</h3> |
|
15 |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 |
|
21 <table> |
|
22 |
|
23 <tr> |
|
24 <td><a href="#EricStringListEditWidget">EricStringListEditWidget</a></td> |
|
25 <td>Class implementing a dialog to edit a list of strings.</td> |
|
26 </tr> |
|
27 </table> |
|
28 <h3>Functions</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <hr /> |
|
34 <hr /> |
|
35 <a NAME="EricStringListEditWidget" ID="EricStringListEditWidget"></a> |
|
36 <h2>EricStringListEditWidget</h2> |
|
37 |
|
38 <p> |
|
39 Class implementing a dialog to edit a list of strings. |
|
40 </p> |
|
41 <h3>Signals</h3> |
|
42 <dl> |
|
43 |
|
44 <dt>setToDefault()</dt> |
|
45 <dd> |
|
46 emitted to request the default list of values |
|
47 </dd> |
|
48 </dl> |
|
49 <h3>Derived from</h3> |
|
50 QWidget, Ui_EricStringListEditWidget |
|
51 <h3>Class Attributes</h3> |
|
52 |
|
53 <table> |
|
54 <tr><td>None</td></tr> |
|
55 </table> |
|
56 <h3>Class Methods</h3> |
|
57 |
|
58 <table> |
|
59 <tr><td>None</td></tr> |
|
60 </table> |
|
61 <h3>Methods</h3> |
|
62 |
|
63 <table> |
|
64 |
|
65 <tr> |
|
66 <td><a href="#EricStringListEditWidget.__init__">EricStringListEditWidget</a></td> |
|
67 <td>Constructor</td> |
|
68 </tr> |
|
69 <tr> |
|
70 <td><a href="#EricStringListEditWidget.getList">getList</a></td> |
|
71 <td>Public method to get the edited list of strings.</td> |
|
72 </tr> |
|
73 <tr> |
|
74 <td><a href="#EricStringListEditWidget.on_addButton_clicked">on_addButton_clicked</a></td> |
|
75 <td>Private slot to add an entry to the list.</td> |
|
76 </tr> |
|
77 <tr> |
|
78 <td><a href="#EricStringListEditWidget.setAddVisible">setAddVisible</a></td> |
|
79 <td>Public method to show or hide the add button.</td> |
|
80 </tr> |
|
81 <tr> |
|
82 <td><a href="#EricStringListEditWidget.setDefaultVisible">setDefaultVisible</a></td> |
|
83 <td>Public method to show or hide the default button.</td> |
|
84 </tr> |
|
85 <tr> |
|
86 <td><a href="#EricStringListEditWidget.setList">setList</a></td> |
|
87 <td>Public method to set the list of strings to be edited.</td> |
|
88 </tr> |
|
89 <tr> |
|
90 <td><a href="#EricStringListEditWidget.setListWhatsThis">setListWhatsThis</a></td> |
|
91 <td>Public method to set a what's that help text for the string list.</td> |
|
92 </tr> |
|
93 </table> |
|
94 <h3>Static Methods</h3> |
|
95 |
|
96 <table> |
|
97 <tr><td>None</td></tr> |
|
98 </table> |
|
99 |
|
100 <a NAME="EricStringListEditWidget.__init__" ID="EricStringListEditWidget.__init__"></a> |
|
101 <h4>EricStringListEditWidget (Constructor)</h4> |
|
102 <b>EricStringListEditWidget</b>(<i>parent=None</i>) |
|
103 |
|
104 <p> |
|
105 Constructor |
|
106 </p> |
|
107 <dl> |
|
108 |
|
109 <dt><i>parent</i></dt> |
|
110 <dd> |
|
111 reference to the parent widget (QWidget) |
|
112 </dd> |
|
113 </dl> |
|
114 <a NAME="EricStringListEditWidget.getList" ID="EricStringListEditWidget.getList"></a> |
|
115 <h4>EricStringListEditWidget.getList</h4> |
|
116 <b>getList</b>(<i></i>) |
|
117 |
|
118 <p> |
|
119 Public method to get the edited list of strings. |
|
120 </p> |
|
121 <dl> |
|
122 <dt>Return:</dt> |
|
123 <dd> |
|
124 edited list of string (list of string) |
|
125 </dd> |
|
126 </dl> |
|
127 <a NAME="EricStringListEditWidget.on_addButton_clicked" ID="EricStringListEditWidget.on_addButton_clicked"></a> |
|
128 <h4>EricStringListEditWidget.on_addButton_clicked</h4> |
|
129 <b>on_addButton_clicked</b>(<i></i>) |
|
130 |
|
131 <p> |
|
132 Private slot to add an entry to the list. |
|
133 </p> |
|
134 <a NAME="EricStringListEditWidget.setAddVisible" ID="EricStringListEditWidget.setAddVisible"></a> |
|
135 <h4>EricStringListEditWidget.setAddVisible</h4> |
|
136 <b>setAddVisible</b>(<i>visible</i>) |
|
137 |
|
138 <p> |
|
139 Public method to show or hide the add button. |
|
140 </p> |
|
141 <dl> |
|
142 |
|
143 <dt><i>visible</i> (bool)</dt> |
|
144 <dd> |
|
145 flag indicating the visibility of the add button |
|
146 </dd> |
|
147 </dl> |
|
148 <a NAME="EricStringListEditWidget.setDefaultVisible" ID="EricStringListEditWidget.setDefaultVisible"></a> |
|
149 <h4>EricStringListEditWidget.setDefaultVisible</h4> |
|
150 <b>setDefaultVisible</b>(<i>visible</i>) |
|
151 |
|
152 <p> |
|
153 Public method to show or hide the default button. |
|
154 </p> |
|
155 <dl> |
|
156 |
|
157 <dt><i>visible</i> (bool)</dt> |
|
158 <dd> |
|
159 flag indicating the visibility of the default button |
|
160 </dd> |
|
161 </dl> |
|
162 <a NAME="EricStringListEditWidget.setList" ID="EricStringListEditWidget.setList"></a> |
|
163 <h4>EricStringListEditWidget.setList</h4> |
|
164 <b>setList</b>(<i>stringList</i>) |
|
165 |
|
166 <p> |
|
167 Public method to set the list of strings to be edited. |
|
168 </p> |
|
169 <dl> |
|
170 |
|
171 <dt><i>stringList</i></dt> |
|
172 <dd> |
|
173 list of strings to be edited (list of string) |
|
174 </dd> |
|
175 </dl> |
|
176 <a NAME="EricStringListEditWidget.setListWhatsThis" ID="EricStringListEditWidget.setListWhatsThis"></a> |
|
177 <h4>EricStringListEditWidget.setListWhatsThis</h4> |
|
178 <b>setListWhatsThis</b>(<i>txt</i>) |
|
179 |
|
180 <p> |
|
181 Public method to set a what's that help text for the string list. |
|
182 </p> |
|
183 <dl> |
|
184 |
|
185 <dt><i>txt</i></dt> |
|
186 <dd> |
|
187 help text to be set (string) |
|
188 </dd> |
|
189 </dl> |
|
190 <div align="right"><a href="#top">Up</a></div> |
|
191 <hr /> |
|
192 </body></html> |