src/eric7/Documentation/Source/eric7.EricWidgets.EricStringListEditWidget.html

branch
eric7
changeset 10479
856476537696
parent 9587
6486d40c26f0
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.EricWidgets.EricStringListEditWidget</h1> 9 <h1>eric7.EricWidgets.EricStringListEditWidget</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to edit a list of strings. 11 Module implementing a dialog to edit a list of strings.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#EricStringListEditWidget">EricStringListEditWidget</a></td> 22 <td><a href="#EricStringListEditWidget">EricStringListEditWidget</a></td>
25 <td>Class implementing a dialog to edit a list of strings.</td> 23 <td>Class implementing a dialog to edit a list of strings.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="EricStringListEditWidget" ID="EricStringListEditWidget"></a> 34 <a NAME="EricStringListEditWidget" ID="EricStringListEditWidget"></a>
36 <h2>EricStringListEditWidget</h2> 35 <h2>EricStringListEditWidget</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to edit a list of strings. 37 Class implementing a dialog to edit a list of strings.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>setToDefault()</dt> 43 <dt>setToDefault()</dt>
45 <dd> 44 <dd>
47 </dd> 46 </dd>
48 </dl> 47 </dl>
49 <h3>Derived from</h3> 48 <h3>Derived from</h3>
50 QWidget, Ui_EricStringListEditWidget 49 QWidget, Ui_EricStringListEditWidget
51 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
52 51 <table>
53 <table> 52 <tr><td>None</td></tr>
54 <tr><td>None</td></tr> 53 </table>
55 </table> 54
56 <h3>Class Methods</h3> 55 <h3>Class Methods</h3>
57 56 <table>
58 <table> 57 <tr><td>None</td></tr>
59 <tr><td>None</td></tr> 58 </table>
60 </table> 59
61 <h3>Methods</h3> 60 <h3>Methods</h3>
62 61 <table>
63 <table>
64
65 <tr> 62 <tr>
66 <td><a href="#EricStringListEditWidget.__init__">EricStringListEditWidget</a></td> 63 <td><a href="#EricStringListEditWidget.__init__">EricStringListEditWidget</a></td>
67 <td>Constructor</td> 64 <td>Constructor</td>
68 </tr> 65 </tr>
69 <tr> 66 <tr>
105 <tr> 102 <tr>
106 <td><a href="#EricStringListEditWidget.setResetVisible">setResetVisible</a></td> 103 <td><a href="#EricStringListEditWidget.setResetVisible">setResetVisible</a></td>
107 <td>Public method to show or hide the reset button.</td> 104 <td>Public method to show or hide the reset button.</td>
108 </tr> 105 </tr>
109 </table> 106 </table>
107
110 <h3>Static Methods</h3> 108 <h3>Static Methods</h3>
111 109 <table>
112 <table> 110 <tr><td>None</td></tr>
113 <tr><td>None</td></tr> 111 </table>
114 </table> 112
115 113
116 <a NAME="EricStringListEditWidget.__init__" ID="EricStringListEditWidget.__init__"></a> 114 <a NAME="EricStringListEditWidget.__init__" ID="EricStringListEditWidget.__init__"></a>
117 <h4>EricStringListEditWidget (Constructor)</h4> 115 <h4>EricStringListEditWidget (Constructor)</h4>
118 <b>EricStringListEditWidget</b>(<i>parent=None</i>) 116 <b>EricStringListEditWidget</b>(<i>parent=None</i>)
119
120 <p> 117 <p>
121 Constructor 118 Constructor
122 </p> 119 </p>
120
123 <dl> 121 <dl>
124 122
125 <dt><i>parent</i> (QWidget)</dt> 123 <dt><i>parent</i> (QWidget)</dt>
126 <dd> 124 <dd>
127 reference to the parent widget 125 reference to the parent widget
128 </dd> 126 </dd>
129 </dl> 127 </dl>
130 <a NAME="EricStringListEditWidget.count" ID="EricStringListEditWidget.count"></a> 128 <a NAME="EricStringListEditWidget.count" ID="EricStringListEditWidget.count"></a>
131 <h4>EricStringListEditWidget.count</h4> 129 <h4>EricStringListEditWidget.count</h4>
132 <b>count</b>(<i></i>) 130 <b>count</b>(<i></i>)
133
134 <p> 131 <p>
135 Public method to get the number of entries of the list. 132 Public method to get the number of entries of the list.
136 </p> 133 </p>
134
137 <dl> 135 <dl>
138 <dt>Return:</dt> 136 <dt>Return:</dt>
139 <dd> 137 <dd>
140 number of list entries 138 number of list entries
141 </dd> 139 </dd>
147 </dd> 145 </dd>
148 </dl> 146 </dl>
149 <a NAME="EricStringListEditWidget.getList" ID="EricStringListEditWidget.getList"></a> 147 <a NAME="EricStringListEditWidget.getList" ID="EricStringListEditWidget.getList"></a>
150 <h4>EricStringListEditWidget.getList</h4> 148 <h4>EricStringListEditWidget.getList</h4>
151 <b>getList</b>(<i></i>) 149 <b>getList</b>(<i></i>)
152
153 <p> 150 <p>
154 Public method to get the edited list of strings. 151 Public method to get the edited list of strings.
155 </p> 152 </p>
153
156 <dl> 154 <dl>
157 <dt>Return:</dt> 155 <dt>Return:</dt>
158 <dd> 156 <dd>
159 edited list of string 157 edited list of string
160 </dd> 158 </dd>
166 </dd> 164 </dd>
167 </dl> 165 </dl>
168 <a NAME="EricStringListEditWidget.isListEmpty" ID="EricStringListEditWidget.isListEmpty"></a> 166 <a NAME="EricStringListEditWidget.isListEmpty" ID="EricStringListEditWidget.isListEmpty"></a>
169 <h4>EricStringListEditWidget.isListEmpty</h4> 167 <h4>EricStringListEditWidget.isListEmpty</h4>
170 <b>isListEmpty</b>(<i></i>) 168 <b>isListEmpty</b>(<i></i>)
171
172 <p> 169 <p>
173 Public method to check, if the list is empty. 170 Public method to check, if the list is empty.
174 </p> 171 </p>
172
175 <dl> 173 <dl>
176 <dt>Return:</dt> 174 <dt>Return:</dt>
177 <dd> 175 <dd>
178 flag indicating an empty list 176 flag indicating an empty list
179 </dd> 177 </dd>
185 </dd> 183 </dd>
186 </dl> 184 </dl>
187 <a NAME="EricStringListEditWidget.on_addButton_clicked" ID="EricStringListEditWidget.on_addButton_clicked"></a> 185 <a NAME="EricStringListEditWidget.on_addButton_clicked" ID="EricStringListEditWidget.on_addButton_clicked"></a>
188 <h4>EricStringListEditWidget.on_addButton_clicked</h4> 186 <h4>EricStringListEditWidget.on_addButton_clicked</h4>
189 <b>on_addButton_clicked</b>(<i></i>) 187 <b>on_addButton_clicked</b>(<i></i>)
190
191 <p> 188 <p>
192 Private slot to add an entry to the list. 189 Private slot to add an entry to the list.
193 </p> 190 </p>
191
194 <a NAME="EricStringListEditWidget.on_resetButton_clicked" ID="EricStringListEditWidget.on_resetButton_clicked"></a> 192 <a NAME="EricStringListEditWidget.on_resetButton_clicked" ID="EricStringListEditWidget.on_resetButton_clicked"></a>
195 <h4>EricStringListEditWidget.on_resetButton_clicked</h4> 193 <h4>EricStringListEditWidget.on_resetButton_clicked</h4>
196 <b>on_resetButton_clicked</b>(<i></i>) 194 <b>on_resetButton_clicked</b>(<i></i>)
197
198 <p> 195 <p>
199 Private slot to reset the list to its initial value. 196 Private slot to reset the list to its initial value.
200 </p> 197 </p>
198
201 <a NAME="EricStringListEditWidget.setAddVisible" ID="EricStringListEditWidget.setAddVisible"></a> 199 <a NAME="EricStringListEditWidget.setAddVisible" ID="EricStringListEditWidget.setAddVisible"></a>
202 <h4>EricStringListEditWidget.setAddVisible</h4> 200 <h4>EricStringListEditWidget.setAddVisible</h4>
203 <b>setAddVisible</b>(<i>visible</i>) 201 <b>setAddVisible</b>(<i>visible</i>)
204
205 <p> 202 <p>
206 Public method to show or hide the add button. 203 Public method to show or hide the add button.
207 </p> 204 </p>
205
208 <dl> 206 <dl>
209 207
210 <dt><i>visible</i> (bool)</dt> 208 <dt><i>visible</i> (bool)</dt>
211 <dd> 209 <dd>
212 flag indicating the visibility of the add button 210 flag indicating the visibility of the add button
213 </dd> 211 </dd>
214 </dl> 212 </dl>
215 <a NAME="EricStringListEditWidget.setDefaultVisible" ID="EricStringListEditWidget.setDefaultVisible"></a> 213 <a NAME="EricStringListEditWidget.setDefaultVisible" ID="EricStringListEditWidget.setDefaultVisible"></a>
216 <h4>EricStringListEditWidget.setDefaultVisible</h4> 214 <h4>EricStringListEditWidget.setDefaultVisible</h4>
217 <b>setDefaultVisible</b>(<i>visible</i>) 215 <b>setDefaultVisible</b>(<i>visible</i>)
218
219 <p> 216 <p>
220 Public method to show or hide the default button. 217 Public method to show or hide the default button.
221 </p> 218 </p>
219
222 <dl> 220 <dl>
223 221
224 <dt><i>visible</i> (bool)</dt> 222 <dt><i>visible</i> (bool)</dt>
225 <dd> 223 <dd>
226 flag indicating the visibility of the default button 224 flag indicating the visibility of the default button
227 </dd> 225 </dd>
228 </dl> 226 </dl>
229 <a NAME="EricStringListEditWidget.setList" ID="EricStringListEditWidget.setList"></a> 227 <a NAME="EricStringListEditWidget.setList" ID="EricStringListEditWidget.setList"></a>
230 <h4>EricStringListEditWidget.setList</h4> 228 <h4>EricStringListEditWidget.setList</h4>
231 <b>setList</b>(<i>stringList</i>) 229 <b>setList</b>(<i>stringList</i>)
232
233 <p> 230 <p>
234 Public method to set the list of strings to be edited. 231 Public method to set the list of strings to be edited.
235 </p> 232 </p>
233
236 <dl> 234 <dl>
237 235
238 <dt><i>stringList</i> (list of str)</dt> 236 <dt><i>stringList</i> (list of str)</dt>
239 <dd> 237 <dd>
240 list of strings to be edited 238 list of strings to be edited
241 </dd> 239 </dd>
242 </dl> 240 </dl>
243 <a NAME="EricStringListEditWidget.setListWhatsThis" ID="EricStringListEditWidget.setListWhatsThis"></a> 241 <a NAME="EricStringListEditWidget.setListWhatsThis" ID="EricStringListEditWidget.setListWhatsThis"></a>
244 <h4>EricStringListEditWidget.setListWhatsThis</h4> 242 <h4>EricStringListEditWidget.setListWhatsThis</h4>
245 <b>setListWhatsThis</b>(<i>txt</i>) 243 <b>setListWhatsThis</b>(<i>txt</i>)
246
247 <p> 244 <p>
248 Public method to set a what's that help text for the string list. 245 Public method to set a what's that help text for the string list.
249 </p> 246 </p>
247
250 <dl> 248 <dl>
251 249
252 <dt><i>txt</i> (str)</dt> 250 <dt><i>txt</i> (str)</dt>
253 <dd> 251 <dd>
254 help text to be set 252 help text to be set
255 </dd> 253 </dd>
256 </dl> 254 </dl>
257 <a NAME="EricStringListEditWidget.setResetVisible" ID="EricStringListEditWidget.setResetVisible"></a> 255 <a NAME="EricStringListEditWidget.setResetVisible" ID="EricStringListEditWidget.setResetVisible"></a>
258 <h4>EricStringListEditWidget.setResetVisible</h4> 256 <h4>EricStringListEditWidget.setResetVisible</h4>
259 <b>setResetVisible</b>(<i>visible</i>) 257 <b>setResetVisible</b>(<i>visible</i>)
260
261 <p> 258 <p>
262 Public method to show or hide the reset button. 259 Public method to show or hide the reset button.
263 </p> 260 </p>
261
264 <dl> 262 <dl>
265 263
266 <dt><i>visible</i> (bool)</dt> 264 <dt><i>visible</i> (bool)</dt>
267 <dd> 265 <dd>
268 flag indicating the visibility of the reset button 266 flag indicating the visibility of the reset button

eric ide

mercurial