Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric5.E5Gui.E5TreeWidget.html

changeset 1969
5522b3266c8b
child 2367
78f6c8193d37
equal deleted inserted replaced
1968:eb57efc415c6 1969:5522b3266c8b
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric5.E5Gui.E5TreeWidget</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.E5Gui.E5TreeWidget</h1>
24 <p>
25 Module implementing specialized tree views.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#E5TreeWidget">E5TreeWidget</a></td>
35 <td>Class implementing an extended tree widget.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="E5TreeWidget" ID="E5TreeWidget"></a>
44 <h2>E5TreeWidget</h2>
45 <p>
46 Class implementing an extended tree widget.
47 </p><h3>Signals</h3>
48 <dl>
49 <dt>itemControlClicked(QTreeWidgetItem)</dt>
50 <dd>
51 emitted after a Ctrl-Click
52 on an item
53 </dd><dt>itemMiddleButtonClicked(QTreeWidgetItem)</dt>
54 <dd>
55 emitted after a click
56 of the middle button on an item
57 </dd>
58 </dl>
59 <h3>Derived from</h3>
60 QTreeWidget
61 <h3>Class Attributes</h3>
62 <table>
63 <tr><td>ItemsCollapsed</td></tr><tr><td>ItemsExpanded</td></tr>
64 </table>
65 <h3>Class Methods</h3>
66 <table>
67 <tr><td>None</td></tr>
68 </table>
69 <h3>Methods</h3>
70 <table>
71 <tr>
72 <td><a href="#E5TreeWidget.__init__">E5TreeWidget</a></td>
73 <td>Constructor</td>
74 </tr><tr>
75 <td><a href="#E5TreeWidget.__iterateAllItems">__iterateAllItems</a></td>
76 <td>Private method to iterate over the child items of the parent.</td>
77 </tr><tr>
78 <td><a href="#E5TreeWidget.__scheduleRefresh">__scheduleRefresh</a></td>
79 <td>Private slot to schedule a refresh of the tree.</td>
80 </tr><tr>
81 <td><a href="#E5TreeWidget.addTopLevelItem">addTopLevelItem</a></td>
82 <td>Public method to add a top level item.</td>
83 </tr><tr>
84 <td><a href="#E5TreeWidget.addTopLevelItems">addTopLevelItems</a></td>
85 <td>Public method to add a list of top level items.</td>
86 </tr><tr>
87 <td><a href="#E5TreeWidget.allItems">allItems</a></td>
88 <td>Public method to get a list of all items.</td>
89 </tr><tr>
90 <td><a href="#E5TreeWidget.appendToParentItem">appendToParentItem</a></td>
91 <td>Public method to append an item to a parent item.</td>
92 </tr><tr>
93 <td><a href="#E5TreeWidget.clear">clear</a></td>
94 <td>Public slot to clear the tree.</td>
95 </tr><tr>
96 <td><a href="#E5TreeWidget.deleteItem">deleteItem</a></td>
97 <td>Public method to delete an item.</td>
98 </tr><tr>
99 <td><a href="#E5TreeWidget.deleteItems">deleteItems</a></td>
100 <td>Public method to delete a list of items.</td>
101 </tr><tr>
102 <td><a href="#E5TreeWidget.filterString">filterString</a></td>
103 <td>Public slot to set a new filter.</td>
104 </tr><tr>
105 <td><a href="#E5TreeWidget.insertTopLevelItem">insertTopLevelItem</a></td>
106 <td>Public method to insert a top level item.</td>
107 </tr><tr>
108 <td><a href="#E5TreeWidget.insertTopLevelItems">insertTopLevelItems</a></td>
109 <td>Public method to insert a list of top level items.</td>
110 </tr><tr>
111 <td><a href="#E5TreeWidget.mousePressEvent">mousePressEvent</a></td>
112 <td>Protected method handling mouse press events.</td>
113 </tr><tr>
114 <td><a href="#E5TreeWidget.prependToParentItem">prependToParentItem</a></td>
115 <td>Public method to prepend an item to a parent item.</td>
116 </tr><tr>
117 <td><a href="#E5TreeWidget.setDefaultItemShowMode">setDefaultItemShowMode</a></td>
118 <td>Public method to set the default item show mode.</td>
119 </tr>
120 </table>
121 <h3>Static Methods</h3>
122 <table>
123 <tr><td>None</td></tr>
124 </table>
125 <a NAME="E5TreeWidget.__init__" ID="E5TreeWidget.__init__"></a>
126 <h4>E5TreeWidget (Constructor)</h4>
127 <b>E5TreeWidget</b>(<i>parent=None</i>)
128 <p>
129 Constructor
130 </p><dl>
131 <dt><i>parent</i></dt>
132 <dd>
133 reference to the parent widget (QWidget)
134 </dd>
135 </dl><a NAME="E5TreeWidget.__iterateAllItems" ID="E5TreeWidget.__iterateAllItems"></a>
136 <h4>E5TreeWidget.__iterateAllItems</h4>
137 <b>__iterateAllItems</b>(<i>parent</i>)
138 <p>
139 Private method to iterate over the child items of the parent.
140 </p><dl>
141 <dt><i>parent</i></dt>
142 <dd>
143 parent item to iterate (QTreeWidgetItem)
144 </dd>
145 </dl><a NAME="E5TreeWidget.__scheduleRefresh" ID="E5TreeWidget.__scheduleRefresh"></a>
146 <h4>E5TreeWidget.__scheduleRefresh</h4>
147 <b>__scheduleRefresh</b>(<i></i>)
148 <p>
149 Private slot to schedule a refresh of the tree.
150 </p><a NAME="E5TreeWidget.addTopLevelItem" ID="E5TreeWidget.addTopLevelItem"></a>
151 <h4>E5TreeWidget.addTopLevelItem</h4>
152 <b>addTopLevelItem</b>(<i>item</i>)
153 <p>
154 Public method to add a top level item.
155 </p><dl>
156 <dt><i>item</i></dt>
157 <dd>
158 item to be added as a top level item (QTreeWidgetItem)
159 </dd>
160 </dl><a NAME="E5TreeWidget.addTopLevelItems" ID="E5TreeWidget.addTopLevelItems"></a>
161 <h4>E5TreeWidget.addTopLevelItems</h4>
162 <b>addTopLevelItems</b>(<i>items</i>)
163 <p>
164 Public method to add a list of top level items.
165 </p><dl>
166 <dt><i>items</i></dt>
167 <dd>
168 items to be added as top level items (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><a NAME="E5TreeWidget.clear" ID="E5TreeWidget.clear"></a>
200 <h4>E5TreeWidget.clear</h4>
201 <b>clear</b>(<i></i>)
202 <p>
203 Public slot to clear the tree.
204 </p><a NAME="E5TreeWidget.deleteItem" ID="E5TreeWidget.deleteItem"></a>
205 <h4>E5TreeWidget.deleteItem</h4>
206 <b>deleteItem</b>(<i>item</i>)
207 <p>
208 Public method to delete an item.
209 </p><dl>
210 <dt><i>item</i></dt>
211 <dd>
212 item to be deleted (QTreeWidgetItem)
213 </dd>
214 </dl><a NAME="E5TreeWidget.deleteItems" ID="E5TreeWidget.deleteItems"></a>
215 <h4>E5TreeWidget.deleteItems</h4>
216 <b>deleteItems</b>(<i>items</i>)
217 <p>
218 Public method to delete a list of items.
219 </p><dl>
220 <dt><i>items</i></dt>
221 <dd>
222 items to be deleted (list of QTreeWidgetItem)
223 </dd>
224 </dl><a NAME="E5TreeWidget.filterString" ID="E5TreeWidget.filterString"></a>
225 <h4>E5TreeWidget.filterString</h4>
226 <b>filterString</b>(<i>filter</i>)
227 <p>
228 Public slot to set a new filter.
229 </p><dl>
230 <dt><i>filter</i></dt>
231 <dd>
232 filter to be set (string)
233 </dd>
234 </dl><a NAME="E5TreeWidget.insertTopLevelItem" ID="E5TreeWidget.insertTopLevelItem"></a>
235 <h4>E5TreeWidget.insertTopLevelItem</h4>
236 <b>insertTopLevelItem</b>(<i>index, item</i>)
237 <p>
238 Public method to insert a top level item.
239 </p><dl>
240 <dt><i>index</i></dt>
241 <dd>
242 index for the insertion (integer)
243 </dd><dt><i>item</i></dt>
244 <dd>
245 item to be inserted as a top level item (QTreeWidgetItem)
246 </dd>
247 </dl><a NAME="E5TreeWidget.insertTopLevelItems" ID="E5TreeWidget.insertTopLevelItems"></a>
248 <h4>E5TreeWidget.insertTopLevelItems</h4>
249 <b>insertTopLevelItems</b>(<i>index, items</i>)
250 <p>
251 Public method to insert a list of top level items.
252 </p><dl>
253 <dt><i>index</i></dt>
254 <dd>
255 index for the insertion (integer)
256 </dd><dt><i>items</i></dt>
257 <dd>
258 items to be inserted as top level items (list of QTreeWidgetItem)
259 </dd>
260 </dl><a NAME="E5TreeWidget.mousePressEvent" ID="E5TreeWidget.mousePressEvent"></a>
261 <h4>E5TreeWidget.mousePressEvent</h4>
262 <b>mousePressEvent</b>(<i>evt</i>)
263 <p>
264 Protected method handling mouse press events.
265 </p><dl>
266 <dt><i>evt</i></dt>
267 <dd>
268 mouse press event (QMouseEvent)
269 </dd>
270 </dl><a NAME="E5TreeWidget.prependToParentItem" ID="E5TreeWidget.prependToParentItem"></a>
271 <h4>E5TreeWidget.prependToParentItem</h4>
272 <b>prependToParentItem</b>(<i>parent, item</i>)
273 <p>
274 Public method to prepend an item to a parent item.
275 </p><dl>
276 <dt><i>parent</i></dt>
277 <dd>
278 text of the parent item (string) or
279 the parent item (QTreeWidgetItem)
280 </dd><dt><i>item</i></dt>
281 <dd>
282 item to be prepended (QTreeWidgetItem)
283 </dd>
284 </dl><dl>
285 <dt>Returns:</dt>
286 <dd>
287 flag indicating success (boolean)
288 </dd>
289 </dl><a NAME="E5TreeWidget.setDefaultItemShowMode" ID="E5TreeWidget.setDefaultItemShowMode"></a>
290 <h4>E5TreeWidget.setDefaultItemShowMode</h4>
291 <b>setDefaultItemShowMode</b>(<i>mode</i>)
292 <p>
293 Public method to set the default item show mode.
294 </p><dl>
295 <dt><i>mode</i></dt>
296 <dd>
297 default mode (ItemsCollapsed, ItemsExpanded)
298 </dd>
299 </dl>
300 <div align="right"><a href="#top">Up</a></div>
301 <hr />
302 </body></html>

Mercurial Repository: eric

eric ide

mercurial