Skip to content

TreeViewMixin

Base classes

Name Children Inherits
AbstractItemViewMixin
prettyqt.widgets.abstractitemview

Subclasses

Class Module Description
TreeView prettyqt.widgets.treeview
TreeWidgetMixin prettyqt.widgets.treewidget
HelpContentWidget prettyqt.qthelp.helpcontentwidget

⋔ Inheritance diagram

graph TD
  1473296343728["widgets.TreeViewMixin"]
  1473293692144["widgets.AbstractItemViewMixin"]
  1473293679456["widgets.AbstractScrollAreaMixin"]
  1473293662864["widgets.FrameMixin"]
  1473293688240["widgets.WidgetMixin"]
  1473299815024["core.ObjectMixin"]
  140713234304496["builtins.object"]
  1473245548480["gui.PaintDeviceMixin"]
  1473293692144 --> 1473296343728
  1473293679456 --> 1473293692144
  1473293662864 --> 1473293679456
  1473293688240 --> 1473293662864
  1473299815024 --> 1473293688240
  140713234304496 --> 1473299815024
  1473245548480 --> 1473293688240
  140713234304496 --> 1473245548480

🛈 DocStrings

Bases: AbstractItemViewMixin

Source code in prettyqt\widgets\treeview.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
class TreeViewMixin(widgets.AbstractItemViewMixin):
    def __init__(
        self,
        *args,
        root_is_decorated: bool = True,
        all_columns_show_focus: bool = True,
        uniform_row_heights: bool = True,
        alternating_row_colors: bool = True,
        selection_mode: str = "extended",
        **kwargs,
    ):
        super().__init__(
            *args,
            root_is_decorated=root_is_decorated,
            all_columns_show_focus=all_columns_show_focus,
            uniform_row_heights=uniform_row_heights,
            alternating_row_colors=alternating_row_colors,
            selection_mode=selection_mode,
            **kwargs,
        )
        self.setStyleSheet("QTreeView::item { padding: 5px }")
        self.h_header = widgets.HeaderView("horizontal", parent=self)

    @property
    def h_header(self) -> widgets.HeaderView:
        return self.header()

    @h_header.setter
    def h_header(self, header: widgets.QHeaderView):
        self.setHeader(header)

    def show_root(self, value: bool):
        self.setRootIndex(core.QModelIndex())
        if not value:
            self.setRootIndex(self.model().index(0, 0))

    def set_expanded(
        self, index: core.ModelIndex | Iterable[core.ModelIndex], expanded: bool = True
    ):
        """Set expaned state of an index or an Iterable of indexes."""
        match index:
            case Iterable():
                for idx in index:
                    self.setExpanded(idx, expanded)
            case _:
                self.setExpanded(index, expanded)

    def expand_all(self, depth: int | None = None):
        if depth is None:
            super().expandAll()
        else:
            for idx in self.model().iter_tree(parent_index=self.rootIndex(), depth=depth):
                self.setExpanded(idx, True)

    def set_sorting_enabled(self, enabled: bool, do_sort: bool = False):
        """Hack to avoid direct sort when setting sorting enabled."""
        model = self.model()
        if not do_sort and model is not None:
            backup = model.sort
            model.sort = lambda x, y: None
        self.setSortingEnabled(enabled)
        if not do_sort and model is not None:
            model.sort = backup

    def set_indentation(self, indentation: int):
        self.setIndentation(indentation)

    def setup_list_style(self):
        self.setSelectionBehavior(self.SelectionBehavior.SelectRows)
        self.h_header.setStretchLastSection(True)

    def adapt_sizes(self):
        model = self.model()
        if model is not None and (model.rowCount() * model.columnCount()) < 1000:
            self.h_header.resizeSections(self.h_header.ResizeMode.ResizeToContents)
        else:
            self.h_header.resize_sections("interactive")

    def sort_by_column(self, column: int | None, ascending: bool = True):
        column = -1 if column is None else column
        order = constants.ASCENDING if ascending else constants.DESCENDING
        self.sortByColumn(column, order)

set_expanded(index: core.ModelIndex | Iterable[core.ModelIndex], expanded: bool = True)

Set expaned state of an index or an Iterable of indexes.

Source code in prettyqt\widgets\treeview.py 
44
45
46
47
48
49
50
51
52
53
def set_expanded(
    self, index: core.ModelIndex | Iterable[core.ModelIndex], expanded: bool = True
):
    """Set expaned state of an index or an Iterable of indexes."""
    match index:
        case Iterable():
            for idx in index:
                self.setExpanded(idx, expanded)
        case _:
            self.setExpanded(index, expanded)

set_sorting_enabled(enabled: bool, do_sort: bool = False)

Hack to avoid direct sort when setting sorting enabled.

Source code in prettyqt\widgets\treeview.py 
62
63
64
65
66
67
68
69
70
def set_sorting_enabled(self, enabled: bool, do_sort: bool = False):
    """Hack to avoid direct sort when setting sorting enabled."""
    model = self.model()
    if not do_sort and model is not None:
        backup = model.sort
        model.sort = lambda x, y: None
    self.setSortingEnabled(enabled)
    if not do_sort and model is not None:
        model.sort = backup