Mercurial Repositories > eric / file comparison
comparison: E5Gui/E5TreeWidget.py
E5Gui/E5TreeWidget.py
- changeset 1969
- 5522b3266c8b
- child 2016
- 2bbc81fcce4a
equal
deleted
inserted
replaced
| 1968:eb57efc415c6 | 1969:5522b3266c8b |
|---|---|
| 1 # -*- coding: utf-8 -*- | |
| 2 | |
| 3 # Copyright (c) 2009 - 2012 Detlev Offenbach <detlev@die-offenbachs.de> | |
| 4 # | |
| 5 | |
| 6 """ | |
| 7 Module implementing specialized tree views. | |
| 8 """ | |
| 9 | |
| 10 from PyQt4.QtCore import pyqtSignal, Qt | |
| 11 from PyQt4.QtGui import QTreeWidget, QTreeWidgetItem, QAbstractItemView | |
| 12 | |
| 13 | |
| 14 class E5TreeWidget(QTreeWidget): | |
| 15 """ | |
| 16 Class implementing an extended tree widget. | |
| 17 | |
| 18 @signal itemControlClicked(QTreeWidgetItem) emitted after a Ctrl-Click | |
| 19 on an item | |
| 20 @signal itemMiddleButtonClicked(QTreeWidgetItem) emitted after a click | |
| 21 of the middle button on an item | |
| 22 """ | |
| 23 ItemsCollapsed = 0 | |
| 24 ItemsExpanded = 1 | |
| 25 | |
| 26 itemControlClicked = pyqtSignal(QTreeWidgetItem) | |
| 27 itemMiddleButtonClicked = pyqtSignal(QTreeWidgetItem) | |
| 28 | |
| 29 def __init__(self, parent=None): | |
| 30 """ | |
| 31 Constructor | |
| 32 | |
| 33 @param parent reference to the parent widget (QWidget) | |
| 34 """ | |
| 35 super().__init__(parent) | |
| 36 | |
| 37 self.__refreshAllItemsNeeded = True | |
| 38 self.__allTreeItems = [] | |
| 39 self.__showMode = E5TreeWidget.ItemsCollapsed | |
| 40 | |
| 41 self.setVerticalScrollMode(QAbstractItemView.ScrollPerPixel) | |
| 42 | |
| 43 self.itemChanged.connect(self.__scheduleRefresh) | |
| 44 | |
| 45 def setDefaultItemShowMode(self, mode): | |
| 46 """ | |
| 47 Public method to set the default item show mode. | |
| 48 | |
| 49 @param mode default mode (ItemsCollapsed, ItemsExpanded) | |
| 50 """ | |
| 51 assert mode in [E5TreeWidget.ItemsCollapsed, E5TreeWidget.ItemsExpanded] | |
| 52 | |
| 53 self.__showMode = mode | |
| 54 | |
| 55 def allItems(self): | |
| 56 """ | |
| 57 Public method to get a list of all items. | |
| 58 | |
| 59 @return list of all items (list of QTreeWidgetItem) | |
| 60 """ | |
| 61 if self.__refreshAllItemsNeeded: | |
| 62 self.__allTreeItems = [] | |
| 63 self.__iterateAllItems(None) | |
| 64 self.__refreshAllItemsNeeded = False | |
| 65 | |
| 66 return self.__allTreeItems | |
| 67 | |
| 68 def appendToParentItem(self, parent, item): | |
| 69 """ | |
| 70 Public method to append an item to a parent item. | |
| 71 | |
| 72 @param parent text of the parent item (string) or | |
| 73 the parent item (QTreeWidgetItem) | |
| 74 @param item item to be appended (QTreeWidgetItem) | |
| 75 @return flag indicating success (boolean) | |
| 76 """ | |
| 77 if isinstance(parent, QTreeWidgetItem): | |
| 78 if parent is None or parent.treeWidget() != self: | |
| 79 return False | |
| 80 parentItem = parent | |
| 81 elif isinstance(parent, str): | |
| 82 lst = self.findItems(parent, Qt.MatchExactly) | |
| 83 if not lst: | |
| 84 return False | |
| 85 parentItem = lst[0] | |
| 86 if parentItem is None: | |
| 87 return False | |
| 88 else: | |
| 89 raise RuntimeError("illegal type for parent") | |
| 90 | |
| 91 self.__allTreeItems.append(item) | |
| 92 parentItem.addChild(item) | |
| 93 return True | |
| 94 | |
| 95 def prependToParentItem(self, parent, item): | |
| 96 """ | |
| 97 Public method to prepend an item to a parent item. | |
| 98 | |
| 99 @param parent text of the parent item (string) or | |
| 100 the parent item (QTreeWidgetItem) | |
| 101 @param item item to be prepended (QTreeWidgetItem) | |
| 102 @return flag indicating success (boolean) | |
| 103 """ | |
| 104 if isinstance(parent, QTreeWidgetItem): | |
| 105 if parent is None or parent.treeWidget() != self: | |
| 106 return False | |
| 107 parentItem = parent | |
| 108 elif isinstance(parent, str): | |
| 109 lst = self.findItems(parent, Qt.MatchExactly) | |
| 110 if not lst: | |
| 111 return False | |
| 112 parentItem = lst[0] | |
| 113 if parentItem is None: | |
| 114 return False | |
| 115 else: | |
| 116 raise RuntimeError("illegal type for parent") | |
| 117 | |
| 118 self.__allTreeItems.append(item) | |
| 119 parentItem.insertChild(0, item) | |
| 120 return True | |
| 121 | |
| 122 def addTopLevelItem(self, item): | |
| 123 """ | |
| 124 Public method to add a top level item. | |
| 125 | |
| 126 @param item item to be added as a top level item (QTreeWidgetItem) | |
| 127 """ | |
| 128 self.__allTreeItems.append(item) | |
| 129 super().addTopLevelItem(item) | |
| 130 | |
| 131 def addTopLevelItems(self, items): | |
| 132 """ | |
| 133 Public method to add a list of top level items. | |
| 134 | |
| 135 @param items items to be added as top level items (list of QTreeWidgetItem) | |
| 136 """ | |
| 137 self.__allTreeItems.extend(items) | |
| 138 super().addTopLevelItems(items) | |
| 139 | |
| 140 def insertTopLevelItem(self, index, item): | |
| 141 """ | |
| 142 Public method to insert a top level item. | |
| 143 | |
| 144 @param index index for the insertion (integer) | |
| 145 @param item item to be inserted as a top level item (QTreeWidgetItem) | |
| 146 """ | |
| 147 self.__allTreeItems.append(item) | |
| 148 super().insertTopLevelItem(index, item) | |
| 149 | |
| 150 def insertTopLevelItems(self, index, items): | |
| 151 """ | |
| 152 Public method to insert a list of top level items. | |
| 153 | |
| 154 @param index index for the insertion (integer) | |
| 155 @param items items to be inserted as top level items (list of QTreeWidgetItem) | |
| 156 """ | |
| 157 self.__allTreeItems.extend(items) | |
| 158 super().insertTopLevelItems(index, items) | |
| 159 | |
| 160 def deleteItem(self, item): | |
| 161 """ | |
| 162 Public method to delete an item. | |
| 163 | |
| 164 @param item item to be deleted (QTreeWidgetItem) | |
| 165 """ | |
| 166 if item in self.__allTreeItems: | |
| 167 self.__allTreeItems.remove(item) | |
| 168 | |
| 169 self.__refreshAllItemsNeeded = True | |
| 170 | |
| 171 del item | |
| 172 | |
| 173 def deleteItems(self, items): | |
| 174 """ | |
| 175 Public method to delete a list of items. | |
| 176 | |
| 177 @param items items to be deleted (list of QTreeWidgetItem) | |
| 178 """ | |
| 179 for item in items: | |
| 180 self.deleteItem(item) | |
| 181 | |
| 182 def filterString(self, filter): | |
| 183 """ | |
| 184 Public slot to set a new filter. | |
| 185 | |
| 186 @param filter filter to be set (string) | |
| 187 """ | |
| 188 self.expandAll() | |
| 189 allItems = self.allItems() | |
| 190 | |
| 191 if filter: | |
| 192 lFilter = filter.lower() | |
| 193 for itm in allItems: | |
| 194 itm.setHidden(lFilter not in itm.text(0).lower()) | |
| 195 itm.setExpanded(True) | |
| 196 for index in range(self.topLevelItemCount()): | |
| 197 self.topLevelItem(index).setHidden(False) | |
| 198 | |
| 199 firstItm = self.topLevelItem(0) | |
| 200 belowItm = self.itemBelow(firstItm) | |
| 201 topLvlIndex = 0 | |
| 202 while firstItm: | |
| 203 if lFilter in firstItm.text(0).lower(): | |
| 204 firstItm.setHidden(False) | |
| 205 elif not firstItm.parent() and not belowItm: | |
| 206 firstItm.setHidden(True) | |
| 207 elif not belowItm: | |
| 208 break | |
| 209 elif not firstItm.parent() and not belowItm.parent(): | |
| 210 firstItm.setHidden(True) | |
| 211 | |
| 212 topLvlIndex += 1 | |
| 213 firstItm = self.topLevelItem(topLvlIndex) | |
| 214 belowItm = self.itemBelow(firstItm) | |
| 215 else: | |
| 216 for itm in allItems: | |
| 217 itm.setHidden(False) | |
| 218 for index in range(self.topLevelItemCount()): | |
| 219 self.topLevelItem(index).setHidden(False) | |
| 220 if self.__showMode == E5TreeWidget.ItemsCollapsed: | |
| 221 self.collapseAll() | |
| 222 | |
| 223 def clear(self): | |
| 224 """ | |
| 225 Public slot to clear the tree. | |
| 226 """ | |
| 227 self.__allTreeItems = [] | |
| 228 super().clear() | |
| 229 | |
| 230 def __scheduleRefresh(self): | |
| 231 """ | |
| 232 Private slot to schedule a refresh of the tree. | |
| 233 """ | |
| 234 self.__refreshAllItemsNeeded = True | |
| 235 | |
| 236 def mousePressEvent(self, evt): | |
| 237 """ | |
| 238 Protected method handling mouse press events. | |
| 239 | |
| 240 @param evt mouse press event (QMouseEvent) | |
| 241 """ | |
| 242 if evt.modifiers() == Qt.ControlModifier and \ | |
| 243 evt.buttons() == Qt.LeftButton: | |
| 244 self.itemControlClicked.emit(self.itemAt(evt.pos())) | |
| 245 return | |
| 246 elif evt.buttons() == Qt.MiddleButton: | |
| 247 self.itemMiddleButtonClicked.emit(self.itemAt(evt.pos())) | |
| 248 return | |
| 249 else: | |
| 250 super().mousePressEvent(evt) | |
| 251 | |
| 252 def __iterateAllItems(self, parent): | |
| 253 """ | |
| 254 Private method to iterate over the child items of the parent. | |
| 255 | |
| 256 @param parent parent item to iterate (QTreeWidgetItem) | |
| 257 """ | |
| 258 if parent: | |
| 259 count = parent.childCount() | |
| 260 else: | |
| 261 count = self.topLevelItemCount() | |
| 262 | |
| 263 for index in range(count): | |
| 264 if parent: | |
| 265 itm = parent.child(index) | |
| 266 else: | |
| 267 itm = self.topLevelItem(index) | |
| 268 | |
| 269 if itm.childCount() == 0: | |
| 270 self.__allTreeItems.append(itm) | |
| 271 | |
| 272 self.__iterateAllItems(itm) |
