Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.E5Gui.E5TreeWidget.html

eric6/Documentation/Source/eric6.E5Gui.E5TreeWidget.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.E5Gui.E5TreeWidget</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><a NAME="top" ID="top"></a>
22 <h1>eric6.E5Gui.E5TreeWidget</h1>
23 <p>
24 Module implementing specialized tree views.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#E5TreeWidget">E5TreeWidget</a></td>
34 <td>Class implementing an extended tree widget.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="E5TreeWidget" ID="E5TreeWidget"></a>
43 <h2>E5TreeWidget</h2>
44 <p>
45 Class implementing an extended tree widget.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>itemControlClicked(QTreeWidgetItem)</dt>
49 <dd>
50 emitted after a Ctrl-Click
51 on an item
52 </dd><dt>itemMiddleButtonClicked(QTreeWidgetItem)</dt>
53 <dd>
54 emitted after a click
55 of the middle button on an item
56 </dd>
57 </dl>
58 <h3>Derived from</h3>
59 QTreeWidget
60 <h3>Class Attributes</h3>
61 <table>
62 <tr><td>ItemsCollapsed</td></tr><tr><td>ItemsExpanded</td></tr>
63 </table>
64 <h3>Class Methods</h3>
65 <table>
66 <tr><td>None</td></tr>
67 </table>
68 <h3>Methods</h3>
69 <table>
70 <tr>
71 <td><a href="#E5TreeWidget.__init__">E5TreeWidget</a></td>
72 <td>Constructor</td>
73 </tr><tr>
74 <td><a href="#E5TreeWidget.__iterateAllItems">__iterateAllItems</a></td>
75 <td>Private method to iterate over the child items of the parent.</td>
76 </tr><tr>
77 <td><a href="#E5TreeWidget.__scheduleRefresh">__scheduleRefresh</a></td>
78 <td>Private slot to schedule a refresh of the tree.</td>
79 </tr><tr>
80 <td><a href="#E5TreeWidget.addTopLevelItem">addTopLevelItem</a></td>
81 <td>Public method to add a top level item.</td>
82 </tr><tr>
83 <td><a href="#E5TreeWidget.addTopLevelItems">addTopLevelItems</a></td>
84 <td>Public method to add a list of top level items.</td>
85 </tr><tr>
86 <td><a href="#E5TreeWidget.allItems">allItems</a></td>
87 <td>Public method to get a list of all items.</td>
88 </tr><tr>
89 <td><a href="#E5TreeWidget.appendToParentItem">appendToParentItem</a></td>
90 <td>Public method to append an item to a parent item.</td>
91 </tr><tr>
92 <td><a href="#E5TreeWidget.clear">clear</a></td>
93 <td>Public slot to clear the tree.</td>
94 </tr><tr>
95 <td><a href="#E5TreeWidget.deleteItem">deleteItem</a></td>
96 <td>Public method to delete an item.</td>
97 </tr><tr>
98 <td><a href="#E5TreeWidget.deleteItems">deleteItems</a></td>
99 <td>Public method to delete a list of items.</td>
100 </tr><tr>
101 <td><a href="#E5TreeWidget.filterString">filterString</a></td>
102 <td>Public slot to set a new filter.</td>
103 </tr><tr>
104 <td><a href="#E5TreeWidget.insertTopLevelItem">insertTopLevelItem</a></td>
105 <td>Public method to insert a top level item.</td>
106 </tr><tr>
107 <td><a href="#E5TreeWidget.insertTopLevelItems">insertTopLevelItems</a></td>
108 <td>Public method to insert a list of top level items.</td>
109 </tr><tr>
110 <td><a href="#E5TreeWidget.mousePressEvent">mousePressEvent</a></td>
111 <td>Protected method handling mouse press events.</td>
112 </tr><tr>
113 <td><a href="#E5TreeWidget.prependToParentItem">prependToParentItem</a></td>
114 <td>Public method to prepend an item to a parent item.</td>
115 </tr><tr>
116 <td><a href="#E5TreeWidget.setDefaultItemShowMode">setDefaultItemShowMode</a></td>
117 <td>Public method to set the default item show mode.</td>
118 </tr>
119 </table>
120 <h3>Static Methods</h3>
121 <table>
122 <tr><td>None</td></tr>
123 </table>
124 <a NAME="E5TreeWidget.__init__" ID="E5TreeWidget.__init__"></a>
125 <h4>E5TreeWidget (Constructor)</h4>
126 <b>E5TreeWidget</b>(<i>parent=None</i>)
127 <p>
128 Constructor
129 </p><dl>
130 <dt><i>parent</i></dt>
131 <dd>
132 reference to the parent widget (QWidget)
133 </dd>
134 </dl><a NAME="E5TreeWidget.__iterateAllItems" ID="E5TreeWidget.__iterateAllItems"></a>
135 <h4>E5TreeWidget.__iterateAllItems</h4>
136 <b>__iterateAllItems</b>(<i>parent</i>)
137 <p>
138 Private method to iterate over the child items of the parent.
139 </p><dl>
140 <dt><i>parent</i></dt>
141 <dd>
142 parent item to iterate (QTreeWidgetItem)
143 </dd>
144 </dl><a NAME="E5TreeWidget.__scheduleRefresh" ID="E5TreeWidget.__scheduleRefresh"></a>
145 <h4>E5TreeWidget.__scheduleRefresh</h4>
146 <b>__scheduleRefresh</b>(<i></i>)
147 <p>
148 Private slot to schedule a refresh of the tree.
149 </p><a NAME="E5TreeWidget.addTopLevelItem" ID="E5TreeWidget.addTopLevelItem"></a>
150 <h4>E5TreeWidget.addTopLevelItem</h4>
151 <b>addTopLevelItem</b>(<i>item</i>)
152 <p>
153 Public method to add a top level item.
154 </p><dl>
155 <dt><i>item</i></dt>
156 <dd>
157 item to be added as a top level item (QTreeWidgetItem)
158 </dd>
159 </dl><a NAME="E5TreeWidget.addTopLevelItems" ID="E5TreeWidget.addTopLevelItems"></a>
160 <h4>E5TreeWidget.addTopLevelItems</h4>
161 <b>addTopLevelItems</b>(<i>items</i>)
162 <p>
163 Public method to add a list of top level items.
164 </p><dl>
165 <dt><i>items</i></dt>
166 <dd>
167 items to be added as top level items
168 (list of QTreeWidgetItem)
169 </dd>
170 </dl><a NAME="E5TreeWidget.allItems" ID="E5TreeWidget.allItems"></a>
171 <h4>E5TreeWidget.allItems</h4>
172 <b>allItems</b>(<i></i>)
173 <p>
174 Public method to get a list of all items.
175 </p><dl>
176 <dt>Returns:</dt>
177 <dd>
178 list of all items (list of QTreeWidgetItem)
179 </dd>
180 </dl><a NAME="E5TreeWidget.appendToParentItem" ID="E5TreeWidget.appendToParentItem"></a>
181 <h4>E5TreeWidget.appendToParentItem</h4>
182 <b>appendToParentItem</b>(<i>parent, item</i>)
183 <p>
184 Public method to append an item to a parent item.
185 </p><dl>
186 <dt><i>parent</i></dt>
187 <dd>
188 text of the parent item (string) or
189 the parent item (QTreeWidgetItem)
190 </dd><dt><i>item</i></dt>
191 <dd>
192 item to be appended (QTreeWidgetItem)
193 </dd>
194 </dl><dl>
195 <dt>Returns:</dt>
196 <dd>
197 flag indicating success (boolean)
198 </dd>
199 </dl><dl>
200 <dt>Raises <b>RuntimeError</b>:</dt>
201 <dd>
202 raised to indicate an illegal type for
203 the parent
204 </dd>
205 </dl><a NAME="E5TreeWidget.clear" ID="E5TreeWidget.clear"></a>
206 <h4>E5TreeWidget.clear</h4>
207 <b>clear</b>(<i></i>)
208 <p>
209 Public slot to clear the tree.
210 </p><a NAME="E5TreeWidget.deleteItem" ID="E5TreeWidget.deleteItem"></a>
211 <h4>E5TreeWidget.deleteItem</h4>
212 <b>deleteItem</b>(<i>item</i>)
213 <p>
214 Public method to delete an item.
215 </p><dl>
216 <dt><i>item</i></dt>
217 <dd>
218 item to be deleted (QTreeWidgetItem)
219 </dd>
220 </dl><a NAME="E5TreeWidget.deleteItems" ID="E5TreeWidget.deleteItems"></a>
221 <h4>E5TreeWidget.deleteItems</h4>
222 <b>deleteItems</b>(<i>items</i>)
223 <p>
224 Public method to delete a list of items.
225 </p><dl>
226 <dt><i>items</i></dt>
227 <dd>
228 items to be deleted (list of QTreeWidgetItem)
229 </dd>
230 </dl><a NAME="E5TreeWidget.filterString" ID="E5TreeWidget.filterString"></a>
231 <h4>E5TreeWidget.filterString</h4>
232 <b>filterString</b>(<i>filterStr</i>)
233 <p>
234 Public slot to set a new filter.
235 </p><dl>
236 <dt><i>filterStr</i></dt>
237 <dd>
238 filter to be set (string)
239 </dd>
240 </dl><a NAME="E5TreeWidget.insertTopLevelItem" ID="E5TreeWidget.insertTopLevelItem"></a>
241 <h4>E5TreeWidget.insertTopLevelItem</h4>
242 <b>insertTopLevelItem</b>(<i>index, item</i>)
243 <p>
244 Public method to insert a top level item.
245 </p><dl>
246 <dt><i>index</i></dt>
247 <dd>
248 index for the insertion (integer)
249 </dd><dt><i>item</i></dt>
250 <dd>
251 item to be inserted as a top level item (QTreeWidgetItem)
252 </dd>
253 </dl><a NAME="E5TreeWidget.insertTopLevelItems" ID="E5TreeWidget.insertTopLevelItems"></a>
254 <h4>E5TreeWidget.insertTopLevelItems</h4>
255 <b>insertTopLevelItems</b>(<i>index, items</i>)
256 <p>
257 Public method to insert a list of top level items.
258 </p><dl>
259 <dt><i>index</i></dt>
260 <dd>
261 index for the insertion (integer)
262 </dd><dt><i>items</i></dt>
263 <dd>
264 items to be inserted as top level items
265 (list of QTreeWidgetItem)
266 </dd>
267 </dl><a NAME="E5TreeWidget.mousePressEvent" ID="E5TreeWidget.mousePressEvent"></a>
268 <h4>E5TreeWidget.mousePressEvent</h4>
269 <b>mousePressEvent</b>(<i>evt</i>)
270 <p>
271 Protected method handling mouse press events.
272 </p><dl>
273 <dt><i>evt</i></dt>
274 <dd>
275 mouse press event (QMouseEvent)
276 </dd>
277 </dl><a NAME="E5TreeWidget.prependToParentItem" ID="E5TreeWidget.prependToParentItem"></a>
278 <h4>E5TreeWidget.prependToParentItem</h4>
279 <b>prependToParentItem</b>(<i>parent, item</i>)
280 <p>
281 Public method to prepend an item to a parent item.
282 </p><dl>
283 <dt><i>parent</i></dt>
284 <dd>
285 text of the parent item (string) or
286 the parent item (QTreeWidgetItem)
287 </dd><dt><i>item</i></dt>
288 <dd>
289 item to be prepended (QTreeWidgetItem)
290 </dd>
291 </dl><dl>
292 <dt>Returns:</dt>
293 <dd>
294 flag indicating success (boolean)
295 </dd>
296 </dl><dl>
297 <dt>Raises <b>RuntimeError</b>:</dt>
298 <dd>
299 raised to indicate an illegal type for
300 the parent
301 </dd>
302 </dl><a NAME="E5TreeWidget.setDefaultItemShowMode" ID="E5TreeWidget.setDefaultItemShowMode"></a>
303 <h4>E5TreeWidget.setDefaultItemShowMode</h4>
304 <b>setDefaultItemShowMode</b>(<i>mode</i>)
305 <p>
306 Public method to set the default item show mode.
307 </p><dl>
308 <dt><i>mode</i></dt>
309 <dd>
310 default mode (ItemsCollapsed, ItemsExpanded)
311 </dd>
312 </dl>
313 <div align="right"><a href="#top">Up</a></div>
314 <hr />
315 </body></html>

Mercurial Repository: eric

eric ide

mercurial