|
| 1 | +from __future__ import annotations |
| 2 | + |
| 3 | +from typing import Any |
| 4 | + |
| 5 | +from qgis.gui import QgsFilterLineEdit |
| 6 | +from qgis.PyQt.QtCore import Qt |
| 7 | +from qgis.PyQt.QtWidgets import QSizePolicy, QTreeWidget, QTreeWidgetItem, QVBoxLayout, QWidget |
| 8 | + |
| 9 | + |
| 10 | +class TreeWithSearchWidget(QWidget): |
| 11 | + """A widget combining a QTreeWidget and QgsFilterLineEdit.""" |
| 12 | + |
| 13 | + def __init__(self): |
| 14 | + super().__init__() |
| 15 | + self.search = QgsFilterLineEdit(self) |
| 16 | + self.search.setShowClearButton(True) |
| 17 | + self.search.setShowSearchIcon(True) |
| 18 | + self.search.setSizePolicy(QSizePolicy.Preferred, QSizePolicy.Fixed) |
| 19 | + self.search.valueChanged.connect(self.filter_tree_items) |
| 20 | + |
| 21 | + self.tree = QTreeWidget(self) |
| 22 | + self.tree.setHeaderHidden(True) |
| 23 | + self.tree.setSizePolicy(QSizePolicy.Preferred, QSizePolicy.Expanding) |
| 24 | + |
| 25 | + layout = QVBoxLayout() |
| 26 | + layout.addWidget(self.search) |
| 27 | + layout.addWidget(self.tree) |
| 28 | + self.setLayout(layout) |
| 29 | + |
| 30 | + self.setContentsMargins(0, 0, 0, 0) |
| 31 | + layout.setContentsMargins(0, 0, 0, 0) |
| 32 | + |
| 33 | + def add_item_to_tree( |
| 34 | + self, text: str | None, model: Any | None = None, parent: QTreeWidgetItem | None = None |
| 35 | + ) -> QTreeWidgetItem: |
| 36 | + item = QTreeWidgetItem(parent) |
| 37 | + if text: |
| 38 | + item.setText(0, text) |
| 39 | + item.setToolTip(0, text) # Set text as tooltip in case the tree width is not enough to show item text |
| 40 | + if model: |
| 41 | + item.setData(0, Qt.UserRole, model) |
| 42 | + if not parent: |
| 43 | + self.tree.addTopLevelItem(item) |
| 44 | + |
| 45 | + return item |
| 46 | + |
| 47 | + def filter_tree_items(self): |
| 48 | + search_text = self.search.value().lower() |
| 49 | + |
| 50 | + # Iterate over all group (top-level) items in the tree |
| 51 | + for i in range(self.tree.topLevelItemCount()): |
| 52 | + group_item = self.tree.topLevelItem(i) |
| 53 | + group_item.setHidden(True) # Initially hide the top-level item |
| 54 | + |
| 55 | + matches_group = search_text in group_item.text(0).lower() |
| 56 | + if matches_group: |
| 57 | + # If group matches, show it and all its children |
| 58 | + self.show_all_children(group_item) |
| 59 | + group_item.setHidden(False) |
| 60 | + else: |
| 61 | + # Otherwise, recursively filter its children |
| 62 | + matches_child = self.filter_children(group_item, search_text) |
| 63 | + group_item.setHidden(not matches_child) |
| 64 | + |
| 65 | + def filter_children(self, parent_item: QTreeWidgetItem, search_text: str) -> bool: |
| 66 | + """Recursively filter children and return True if any child matches.""" |
| 67 | + has_match = False |
| 68 | + for i in range(parent_item.childCount()): |
| 69 | + child = parent_item.child(i) |
| 70 | + matches = search_text in child.text(0).lower() |
| 71 | + child.setHidden(not matches) |
| 72 | + |
| 73 | + if child.childCount() > 0: |
| 74 | + matches |= self.filter_children(child, search_text) |
| 75 | + |
| 76 | + if matches: |
| 77 | + has_match = True |
| 78 | + |
| 79 | + return has_match |
| 80 | + |
| 81 | + def show_all_children(self, parent_item: QTreeWidgetItem): |
| 82 | + """Show the parent item and all its children recursively.""" |
| 83 | + parent_item.setHidden(False) |
| 84 | + for i in range(parent_item.childCount()): |
| 85 | + child = parent_item.child(i) |
| 86 | + child.setHidden(False) |
| 87 | + if child.childCount() > 0: |
| 88 | + self.show_all_children(child) |
0 commit comments