Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.EricWidgets.EricTreeWidget.html

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

branch
eric7
changeset 10479
856476537696
parent 10423
299802979277
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.EricTreeWidget</h1> 9 <h1>eric7.EricWidgets.EricTreeWidget</h1>
10
11 <p> 10 <p>
12 Module implementing specialized tree views. 11 Module implementing specialized tree views.
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="#EricTreeWidget">EricTreeWidget</a></td> 22 <td><a href="#EricTreeWidget">EricTreeWidget</a></td>
25 <td>Class implementing an extended tree widget.</td> 23 <td>Class implementing an extended tree widget.</td>
26 </tr> 24 </tr>
27 <tr> 25 <tr>
28 <td><a href="#EricTreeWidgetItemsState">EricTreeWidgetItemsState</a></td> 26 <td><a href="#EricTreeWidgetItemsState">EricTreeWidgetItemsState</a></td>
29 <td>Class defining the items expansion state.</td> 27 <td>Class defining the items expansion state.</td>
30 </tr> 28 </tr>
31 </table> 29 </table>
30
32 <h3>Functions</h3> 31 <h3>Functions</h3>
33 32 <table>
34 <table> 33 <tr><td>None</td></tr>
35 <tr><td>None</td></tr> 34 </table>
36 </table> 35
37 <hr /> 36 <hr />
38 <hr /> 37 <hr />
39 <a NAME="EricTreeWidget" ID="EricTreeWidget"></a> 38 <a NAME="EricTreeWidget" ID="EricTreeWidget"></a>
40 <h2>EricTreeWidget</h2> 39 <h2>EricTreeWidget</h2>
41
42 <p> 40 <p>
43 Class implementing an extended tree widget. 41 Class implementing an extended tree widget.
44 </p> 42 </p>
43
45 <h3>Signals</h3> 44 <h3>Signals</h3>
46 <dl> 45 <dl>
47 46
48 <dt>itemControlClicked(QTreeWidgetItem)</dt> 47 <dt>itemControlClicked(QTreeWidgetItem)</dt>
49 <dd> 48 <dd>
57 </dd> 56 </dd>
58 </dl> 57 </dl>
59 <h3>Derived from</h3> 58 <h3>Derived from</h3>
60 QTreeWidget 59 QTreeWidget
61 <h3>Class Attributes</h3> 60 <h3>Class Attributes</h3>
62 61 <table>
63 <table> 62 <tr><td>None</td></tr>
64 <tr><td>None</td></tr> 63 </table>
65 </table> 64
66 <h3>Class Methods</h3> 65 <h3>Class Methods</h3>
67 66 <table>
68 <table> 67 <tr><td>None</td></tr>
69 <tr><td>None</td></tr> 68 </table>
70 </table> 69
71 <h3>Methods</h3> 70 <h3>Methods</h3>
72 71 <table>
73 <table>
74
75 <tr> 72 <tr>
76 <td><a href="#EricTreeWidget.__init__">EricTreeWidget</a></td> 73 <td><a href="#EricTreeWidget.__init__">EricTreeWidget</a></td>
77 <td>Constructor</td> 74 <td>Constructor</td>
78 </tr> 75 </tr>
79 <tr> 76 <tr>
135 <tr> 132 <tr>
136 <td><a href="#EricTreeWidget.setDefaultItemShowMode">setDefaultItemShowMode</a></td> 133 <td><a href="#EricTreeWidget.setDefaultItemShowMode">setDefaultItemShowMode</a></td>
137 <td>Public method to set the default item show mode.</td> 134 <td>Public method to set the default item show mode.</td>
138 </tr> 135 </tr>
139 </table> 136 </table>
137
140 <h3>Static Methods</h3> 138 <h3>Static Methods</h3>
141 139 <table>
142 <table> 140 <tr><td>None</td></tr>
143 <tr><td>None</td></tr> 141 </table>
144 </table> 142
145 143
146 <a NAME="EricTreeWidget.__init__" ID="EricTreeWidget.__init__"></a> 144 <a NAME="EricTreeWidget.__init__" ID="EricTreeWidget.__init__"></a>
147 <h4>EricTreeWidget (Constructor)</h4> 145 <h4>EricTreeWidget (Constructor)</h4>
148 <b>EricTreeWidget</b>(<i>parent=None</i>) 146 <b>EricTreeWidget</b>(<i>parent=None</i>)
149
150 <p> 147 <p>
151 Constructor 148 Constructor
152 </p> 149 </p>
150
153 <dl> 151 <dl>
154 152
155 <dt><i>parent</i> (QWidget)</dt> 153 <dt><i>parent</i> (QWidget)</dt>
156 <dd> 154 <dd>
157 reference to the parent widget 155 reference to the parent widget
158 </dd> 156 </dd>
159 </dl> 157 </dl>
160 <a NAME="EricTreeWidget.__iterateAllItems" ID="EricTreeWidget.__iterateAllItems"></a> 158 <a NAME="EricTreeWidget.__iterateAllItems" ID="EricTreeWidget.__iterateAllItems"></a>
161 <h4>EricTreeWidget.__iterateAllItems</h4> 159 <h4>EricTreeWidget.__iterateAllItems</h4>
162 <b>__iterateAllItems</b>(<i>parent</i>) 160 <b>__iterateAllItems</b>(<i>parent</i>)
163
164 <p> 161 <p>
165 Private method to iterate over the child items of the parent. 162 Private method to iterate over the child items of the parent.
166 </p> 163 </p>
164
167 <dl> 165 <dl>
168 166
169 <dt><i>parent</i> (QTreeWidgetItem)</dt> 167 <dt><i>parent</i> (QTreeWidgetItem)</dt>
170 <dd> 168 <dd>
171 parent item to iterate 169 parent item to iterate
172 </dd> 170 </dd>
173 </dl> 171 </dl>
174 <a NAME="EricTreeWidget.__scheduleRefresh" ID="EricTreeWidget.__scheduleRefresh"></a> 172 <a NAME="EricTreeWidget.__scheduleRefresh" ID="EricTreeWidget.__scheduleRefresh"></a>
175 <h4>EricTreeWidget.__scheduleRefresh</h4> 173 <h4>EricTreeWidget.__scheduleRefresh</h4>
176 <b>__scheduleRefresh</b>(<i></i>) 174 <b>__scheduleRefresh</b>(<i></i>)
177
178 <p> 175 <p>
179 Private slot to schedule a refresh of the tree. 176 Private slot to schedule a refresh of the tree.
180 </p> 177 </p>
178
181 <a NAME="EricTreeWidget.addTopLevelItem" ID="EricTreeWidget.addTopLevelItem"></a> 179 <a NAME="EricTreeWidget.addTopLevelItem" ID="EricTreeWidget.addTopLevelItem"></a>
182 <h4>EricTreeWidget.addTopLevelItem</h4> 180 <h4>EricTreeWidget.addTopLevelItem</h4>
183 <b>addTopLevelItem</b>(<i>item</i>) 181 <b>addTopLevelItem</b>(<i>item</i>)
184
185 <p> 182 <p>
186 Public method to add a top level item. 183 Public method to add a top level item.
187 </p> 184 </p>
185
188 <dl> 186 <dl>
189 187
190 <dt><i>item</i> (QTreeWidgetItem)</dt> 188 <dt><i>item</i> (QTreeWidgetItem)</dt>
191 <dd> 189 <dd>
192 item to be added as a top level item 190 item to be added as a top level item
193 </dd> 191 </dd>
194 </dl> 192 </dl>
195 <a NAME="EricTreeWidget.addTopLevelItems" ID="EricTreeWidget.addTopLevelItems"></a> 193 <a NAME="EricTreeWidget.addTopLevelItems" ID="EricTreeWidget.addTopLevelItems"></a>
196 <h4>EricTreeWidget.addTopLevelItems</h4> 194 <h4>EricTreeWidget.addTopLevelItems</h4>
197 <b>addTopLevelItems</b>(<i>items</i>) 195 <b>addTopLevelItems</b>(<i>items</i>)
198
199 <p> 196 <p>
200 Public method to add a list of top level items. 197 Public method to add a list of top level items.
201 </p> 198 </p>
199
202 <dl> 200 <dl>
203 201
204 <dt><i>items</i> (list of QTreeWidgetItem)</dt> 202 <dt><i>items</i> (list of QTreeWidgetItem)</dt>
205 <dd> 203 <dd>
206 items to be added as top level items 204 items to be added as top level items
207 </dd> 205 </dd>
208 </dl> 206 </dl>
209 <a NAME="EricTreeWidget.allItems" ID="EricTreeWidget.allItems"></a> 207 <a NAME="EricTreeWidget.allItems" ID="EricTreeWidget.allItems"></a>
210 <h4>EricTreeWidget.allItems</h4> 208 <h4>EricTreeWidget.allItems</h4>
211 <b>allItems</b>(<i></i>) 209 <b>allItems</b>(<i></i>)
212
213 <p> 210 <p>
214 Public method to get a list of all items. 211 Public method to get a list of all items.
215 </p> 212 </p>
213
216 <dl> 214 <dl>
217 <dt>Return:</dt> 215 <dt>Return:</dt>
218 <dd> 216 <dd>
219 list of all items 217 list of all items
220 </dd> 218 </dd>
226 </dd> 224 </dd>
227 </dl> 225 </dl>
228 <a NAME="EricTreeWidget.appendToParentItem" ID="EricTreeWidget.appendToParentItem"></a> 226 <a NAME="EricTreeWidget.appendToParentItem" ID="EricTreeWidget.appendToParentItem"></a>
229 <h4>EricTreeWidget.appendToParentItem</h4> 227 <h4>EricTreeWidget.appendToParentItem</h4>
230 <b>appendToParentItem</b>(<i>parent, item</i>) 228 <b>appendToParentItem</b>(<i>parent, item</i>)
231
232 <p> 229 <p>
233 Public method to append an item to a parent item. 230 Public method to append an item to a parent item.
234 </p> 231 </p>
232
235 <dl> 233 <dl>
236 234
237 <dt><i>parent</i> (str or QTreeWidgetItem)</dt> 235 <dt><i>parent</i> (str or QTreeWidgetItem)</dt>
238 <dd> 236 <dd>
239 text of the parent item or the parent item 237 text of the parent item or the parent item
264 </dd> 262 </dd>
265 </dl> 263 </dl>
266 <a NAME="EricTreeWidget.clear" ID="EricTreeWidget.clear"></a> 264 <a NAME="EricTreeWidget.clear" ID="EricTreeWidget.clear"></a>
267 <h4>EricTreeWidget.clear</h4> 265 <h4>EricTreeWidget.clear</h4>
268 <b>clear</b>(<i></i>) 266 <b>clear</b>(<i></i>)
269
270 <p> 267 <p>
271 Public slot to clear the tree. 268 Public slot to clear the tree.
272 </p> 269 </p>
270
273 <a NAME="EricTreeWidget.deleteItem" ID="EricTreeWidget.deleteItem"></a> 271 <a NAME="EricTreeWidget.deleteItem" ID="EricTreeWidget.deleteItem"></a>
274 <h4>EricTreeWidget.deleteItem</h4> 272 <h4>EricTreeWidget.deleteItem</h4>
275 <b>deleteItem</b>(<i>item</i>) 273 <b>deleteItem</b>(<i>item</i>)
276
277 <p> 274 <p>
278 Public method to delete an item. 275 Public method to delete an item.
279 </p> 276 </p>
277
280 <dl> 278 <dl>
281 279
282 <dt><i>item</i> (QTreeWidgetItem)</dt> 280 <dt><i>item</i> (QTreeWidgetItem)</dt>
283 <dd> 281 <dd>
284 item to be deleted 282 item to be deleted
285 </dd> 283 </dd>
286 </dl> 284 </dl>
287 <a NAME="EricTreeWidget.deleteItems" ID="EricTreeWidget.deleteItems"></a> 285 <a NAME="EricTreeWidget.deleteItems" ID="EricTreeWidget.deleteItems"></a>
288 <h4>EricTreeWidget.deleteItems</h4> 286 <h4>EricTreeWidget.deleteItems</h4>
289 <b>deleteItems</b>(<i>items</i>) 287 <b>deleteItems</b>(<i>items</i>)
290
291 <p> 288 <p>
292 Public method to delete a list of items. 289 Public method to delete a list of items.
293 </p> 290 </p>
291
294 <dl> 292 <dl>
295 293
296 <dt><i>items</i> (list of QTreeWidgetItem)</dt> 294 <dt><i>items</i> (list of QTreeWidgetItem)</dt>
297 <dd> 295 <dd>
298 items to be deleted 296 items to be deleted
299 </dd> 297 </dd>
300 </dl> 298 </dl>
301 <a NAME="EricTreeWidget.filterString" ID="EricTreeWidget.filterString"></a> 299 <a NAME="EricTreeWidget.filterString" ID="EricTreeWidget.filterString"></a>
302 <h4>EricTreeWidget.filterString</h4> 300 <h4>EricTreeWidget.filterString</h4>
303 <b>filterString</b>(<i>filterStr</i>) 301 <b>filterString</b>(<i>filterStr</i>)
304
305 <p> 302 <p>
306 Public slot to set a new filter. 303 Public slot to set a new filter.
307 </p> 304 </p>
305
308 <dl> 306 <dl>
309 307
310 <dt><i>filterStr</i> (str)</dt> 308 <dt><i>filterStr</i> (str)</dt>
311 <dd> 309 <dd>
312 filter to be set 310 filter to be set
313 </dd> 311 </dd>
314 </dl> 312 </dl>
315 <a NAME="EricTreeWidget.insertTopLevelItem" ID="EricTreeWidget.insertTopLevelItem"></a> 313 <a NAME="EricTreeWidget.insertTopLevelItem" ID="EricTreeWidget.insertTopLevelItem"></a>
316 <h4>EricTreeWidget.insertTopLevelItem</h4> 314 <h4>EricTreeWidget.insertTopLevelItem</h4>
317 <b>insertTopLevelItem</b>(<i>index, item</i>) 315 <b>insertTopLevelItem</b>(<i>index, item</i>)
318
319 <p> 316 <p>
320 Public method to insert a top level item. 317 Public method to insert a top level item.
321 </p> 318 </p>
319
322 <dl> 320 <dl>
323 321
324 <dt><i>index</i> (int)</dt> 322 <dt><i>index</i> (int)</dt>
325 <dd> 323 <dd>
326 index for the insertion 324 index for the insertion
331 </dd> 329 </dd>
332 </dl> 330 </dl>
333 <a NAME="EricTreeWidget.insertTopLevelItems" ID="EricTreeWidget.insertTopLevelItems"></a> 331 <a NAME="EricTreeWidget.insertTopLevelItems" ID="EricTreeWidget.insertTopLevelItems"></a>
334 <h4>EricTreeWidget.insertTopLevelItems</h4> 332 <h4>EricTreeWidget.insertTopLevelItems</h4>
335 <b>insertTopLevelItems</b>(<i>index, items</i>) 333 <b>insertTopLevelItems</b>(<i>index, items</i>)
336
337 <p> 334 <p>
338 Public method to insert a list of top level items. 335 Public method to insert a list of top level items.
339 </p> 336 </p>
337
340 <dl> 338 <dl>
341 339
342 <dt><i>index</i> (int)</dt> 340 <dt><i>index</i> (int)</dt>
343 <dd> 341 <dd>
344 index for the insertion 342 index for the insertion
349 </dd> 347 </dd>
350 </dl> 348 </dl>
351 <a NAME="EricTreeWidget.mousePressEvent" ID="EricTreeWidget.mousePressEvent"></a> 349 <a NAME="EricTreeWidget.mousePressEvent" ID="EricTreeWidget.mousePressEvent"></a>
352 <h4>EricTreeWidget.mousePressEvent</h4> 350 <h4>EricTreeWidget.mousePressEvent</h4>
353 <b>mousePressEvent</b>(<i>evt</i>) 351 <b>mousePressEvent</b>(<i>evt</i>)
354
355 <p> 352 <p>
356 Protected method handling mouse press events. 353 Protected method handling mouse press events.
357 </p> 354 </p>
355
358 <dl> 356 <dl>
359 357
360 <dt><i>evt</i> (QMouseEvent)</dt> 358 <dt><i>evt</i> (QMouseEvent)</dt>
361 <dd> 359 <dd>
362 mouse press event 360 mouse press event
363 </dd> 361 </dd>
364 </dl> 362 </dl>
365 <a NAME="EricTreeWidget.prependToParentItem" ID="EricTreeWidget.prependToParentItem"></a> 363 <a NAME="EricTreeWidget.prependToParentItem" ID="EricTreeWidget.prependToParentItem"></a>
366 <h4>EricTreeWidget.prependToParentItem</h4> 364 <h4>EricTreeWidget.prependToParentItem</h4>
367 <b>prependToParentItem</b>(<i>parent, item</i>) 365 <b>prependToParentItem</b>(<i>parent, item</i>)
368
369 <p> 366 <p>
370 Public method to prepend an item to a parent item. 367 Public method to prepend an item to a parent item.
371 </p> 368 </p>
369
372 <dl> 370 <dl>
373 371
374 <dt><i>parent</i> (str or QTreeWidgetItem)</dt> 372 <dt><i>parent</i> (str or QTreeWidgetItem)</dt>
375 <dd> 373 <dd>
376 text of the parent item or the parent item 374 text of the parent item or the parent item
401 </dd> 399 </dd>
402 </dl> 400 </dl>
403 <a NAME="EricTreeWidget.setDefaultItemShowMode" ID="EricTreeWidget.setDefaultItemShowMode"></a> 401 <a NAME="EricTreeWidget.setDefaultItemShowMode" ID="EricTreeWidget.setDefaultItemShowMode"></a>
404 <h4>EricTreeWidget.setDefaultItemShowMode</h4> 402 <h4>EricTreeWidget.setDefaultItemShowMode</h4>
405 <b>setDefaultItemShowMode</b>(<i>mode</i>) 403 <b>setDefaultItemShowMode</b>(<i>mode</i>)
406
407 <p> 404 <p>
408 Public method to set the default item show mode. 405 Public method to set the default item show mode.
409 </p> 406 </p>
407
410 <dl> 408 <dl>
411 409
412 <dt><i>mode</i> (EricTreeWidgetItemsState)</dt> 410 <dt><i>mode</i> (EricTreeWidgetItemsState)</dt>
413 <dd> 411 <dd>
414 default mode 412 default mode
417 <div align="right"><a href="#top">Up</a></div> 415 <div align="right"><a href="#top">Up</a></div>
418 <hr /> 416 <hr />
419 <hr /> 417 <hr />
420 <a NAME="EricTreeWidgetItemsState" ID="EricTreeWidgetItemsState"></a> 418 <a NAME="EricTreeWidgetItemsState" ID="EricTreeWidgetItemsState"></a>
421 <h2>EricTreeWidgetItemsState</h2> 419 <h2>EricTreeWidgetItemsState</h2>
422
423 <p> 420 <p>
424 Class defining the items expansion state. 421 Class defining the items expansion state.
425 </p> 422 </p>
423
426 <h3>Derived from</h3> 424 <h3>Derived from</h3>
427 enum.Enum 425 enum.Enum
428 <h3>Class Attributes</h3> 426 <h3>Class Attributes</h3>
429 427 <table>
430 <table> 428 <tr><td>COLLAPSED</td></tr>
431 <tr><td>COLLAPSED</td></tr><tr><td>EXPANDED</td></tr> 429 <tr><td>EXPANDED</td></tr>
432 </table> 430 </table>
431
433 <h3>Class Methods</h3> 432 <h3>Class Methods</h3>
434 433 <table>
435 <table> 434 <tr><td>None</td></tr>
436 <tr><td>None</td></tr> 435 </table>
437 </table> 436
438 <h3>Methods</h3> 437 <h3>Methods</h3>
439 438 <table>
440 <table> 439 <tr><td>None</td></tr>
441 <tr><td>None</td></tr> 440 </table>
442 </table> 441
443 <h3>Static Methods</h3> 442 <h3>Static Methods</h3>
444 443 <table>
445 <table> 444 <tr><td>None</td></tr>
446 <tr><td>None</td></tr> 445 </table>
447 </table> 446
448 447
449 <div align="right"><a href="#top">Up</a></div> 448 <div align="right"><a href="#top">Up</a></div>
450 <hr /> 449 <hr />
451 </body></html> 450 </body></html>

Mercurial Repository: eric

eric ide

mercurial