|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.EricWidgets.EricStringListEditWidget</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>eric7.EricWidgets.EricStringListEditWidget</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing a dialog to edit 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="#EricStringListEditWidget">EricStringListEditWidget</a></td> |
|
39 <td>Class implementing a dialog to edit 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="EricStringListEditWidget" ID="EricStringListEditWidget"></a> |
|
50 <h2>EricStringListEditWidget</h2> |
|
51 |
|
52 <p> |
|
53 Class implementing a dialog to edit a list of strings. |
|
54 </p> |
|
55 <h3>Signals</h3> |
|
56 <dl> |
|
57 |
|
58 <dt>setToDefault()</dt> |
|
59 <dd> |
|
60 emitted to request the default list of values |
|
61 </dd> |
|
62 </dl> |
|
63 <h3>Derived from</h3> |
|
64 QWidget, Ui_EricStringListEditWidget |
|
65 <h3>Class Attributes</h3> |
|
66 |
|
67 <table> |
|
68 <tr><td>None</td></tr> |
|
69 </table> |
|
70 <h3>Class Methods</h3> |
|
71 |
|
72 <table> |
|
73 <tr><td>None</td></tr> |
|
74 </table> |
|
75 <h3>Methods</h3> |
|
76 |
|
77 <table> |
|
78 |
|
79 <tr> |
|
80 <td><a href="#EricStringListEditWidget.__init__">EricStringListEditWidget</a></td> |
|
81 <td>Constructor</td> |
|
82 </tr> |
|
83 <tr> |
|
84 <td><a href="#EricStringListEditWidget.getList">getList</a></td> |
|
85 <td>Public method to get the edited list of strings.</td> |
|
86 </tr> |
|
87 <tr> |
|
88 <td><a href="#EricStringListEditWidget.on_addButton_clicked">on_addButton_clicked</a></td> |
|
89 <td>Private slot to add an entry to the list.</td> |
|
90 </tr> |
|
91 <tr> |
|
92 <td><a href="#EricStringListEditWidget.setAddVisible">setAddVisible</a></td> |
|
93 <td>Public method to show or hide the add button.</td> |
|
94 </tr> |
|
95 <tr> |
|
96 <td><a href="#EricStringListEditWidget.setDefaultVisible">setDefaultVisible</a></td> |
|
97 <td>Public method to show or hide the default button.</td> |
|
98 </tr> |
|
99 <tr> |
|
100 <td><a href="#EricStringListEditWidget.setList">setList</a></td> |
|
101 <td>Public method to set the list of strings to be edited.</td> |
|
102 </tr> |
|
103 <tr> |
|
104 <td><a href="#EricStringListEditWidget.setListWhatsThis">setListWhatsThis</a></td> |
|
105 <td>Public method to set a what's that help text for the string list.</td> |
|
106 </tr> |
|
107 </table> |
|
108 <h3>Static Methods</h3> |
|
109 |
|
110 <table> |
|
111 <tr><td>None</td></tr> |
|
112 </table> |
|
113 |
|
114 <a NAME="EricStringListEditWidget.__init__" ID="EricStringListEditWidget.__init__"></a> |
|
115 <h4>EricStringListEditWidget (Constructor)</h4> |
|
116 <b>EricStringListEditWidget</b>(<i>parent=None</i>) |
|
117 |
|
118 <p> |
|
119 Constructor |
|
120 </p> |
|
121 <dl> |
|
122 |
|
123 <dt><i>parent</i></dt> |
|
124 <dd> |
|
125 reference to the parent widget (QWidget) |
|
126 </dd> |
|
127 </dl> |
|
128 <a NAME="EricStringListEditWidget.getList" ID="EricStringListEditWidget.getList"></a> |
|
129 <h4>EricStringListEditWidget.getList</h4> |
|
130 <b>getList</b>(<i></i>) |
|
131 |
|
132 <p> |
|
133 Public method to get the edited list of strings. |
|
134 </p> |
|
135 <dl> |
|
136 <dt>Return:</dt> |
|
137 <dd> |
|
138 edited list of string (list of string) |
|
139 </dd> |
|
140 </dl> |
|
141 <a NAME="EricStringListEditWidget.on_addButton_clicked" ID="EricStringListEditWidget.on_addButton_clicked"></a> |
|
142 <h4>EricStringListEditWidget.on_addButton_clicked</h4> |
|
143 <b>on_addButton_clicked</b>(<i></i>) |
|
144 |
|
145 <p> |
|
146 Private slot to add an entry to the list. |
|
147 </p> |
|
148 <a NAME="EricStringListEditWidget.setAddVisible" ID="EricStringListEditWidget.setAddVisible"></a> |
|
149 <h4>EricStringListEditWidget.setAddVisible</h4> |
|
150 <b>setAddVisible</b>(<i>visible</i>) |
|
151 |
|
152 <p> |
|
153 Public method to show or hide the add button. |
|
154 </p> |
|
155 <dl> |
|
156 |
|
157 <dt><i>visible</i> (bool)</dt> |
|
158 <dd> |
|
159 flag indicating the visibility of the add button |
|
160 </dd> |
|
161 </dl> |
|
162 <a NAME="EricStringListEditWidget.setDefaultVisible" ID="EricStringListEditWidget.setDefaultVisible"></a> |
|
163 <h4>EricStringListEditWidget.setDefaultVisible</h4> |
|
164 <b>setDefaultVisible</b>(<i>visible</i>) |
|
165 |
|
166 <p> |
|
167 Public method to show or hide the default button. |
|
168 </p> |
|
169 <dl> |
|
170 |
|
171 <dt><i>visible</i> (bool)</dt> |
|
172 <dd> |
|
173 flag indicating the visibility of the default button |
|
174 </dd> |
|
175 </dl> |
|
176 <a NAME="EricStringListEditWidget.setList" ID="EricStringListEditWidget.setList"></a> |
|
177 <h4>EricStringListEditWidget.setList</h4> |
|
178 <b>setList</b>(<i>stringList</i>) |
|
179 |
|
180 <p> |
|
181 Public method to set the list of strings to be edited. |
|
182 </p> |
|
183 <dl> |
|
184 |
|
185 <dt><i>stringList</i></dt> |
|
186 <dd> |
|
187 list of strings to be edited (list of string) |
|
188 </dd> |
|
189 </dl> |
|
190 <a NAME="EricStringListEditWidget.setListWhatsThis" ID="EricStringListEditWidget.setListWhatsThis"></a> |
|
191 <h4>EricStringListEditWidget.setListWhatsThis</h4> |
|
192 <b>setListWhatsThis</b>(<i>txt</i>) |
|
193 |
|
194 <p> |
|
195 Public method to set a what's that help text for the string list. |
|
196 </p> |
|
197 <dl> |
|
198 |
|
199 <dt><i>txt</i></dt> |
|
200 <dd> |
|
201 help text to be set (string) |
|
202 </dd> |
|
203 </dl> |
|
204 <div align="right"><a href="#top">Up</a></div> |
|
205 <hr /> |
|
206 </body></html> |