Skip to content

TreeWidgetItem

Qt Base Class: QTreeWidgetItem

Signature: QTreeWidgetItem(self, other: PySide6.QtWidgets.QTreeWidgetItem) -> None QTreeWidgetItem(self, parent: PySide6.QtWidgets.QTreeWidgetItem, after: PySide6.QtWidgets.QTreeWidgetItem, type: int = <ItemType.Type: 0>) -> None QTreeWidgetItem(self, parent: PySide6.QtWidgets.QTreeWidgetItem, strings: Sequence[str], type: int = <ItemType.Type: 0>) -> None QTreeWidgetItem(self, parent: PySide6.QtWidgets.QTreeWidgetItem, type: int = <ItemType.Type: 0>) -> None QTreeWidgetItem(self, strings: Sequence[str], type: int = <ItemType.Type: 0>) -> None QTreeWidgetItem(self, treeview: PySide6.QtWidgets.QTreeWidget, after: PySide6.QtWidgets.QTreeWidgetItem, type: int = <ItemType.Type: 0>) -> None QTreeWidgetItem(self, treeview: PySide6.QtWidgets.QTreeWidget, strings: Sequence[str], type: int = <ItemType.Type: 0>) -> None QTreeWidgetItem(self, treeview: PySide6.QtWidgets.QTreeWidget, type: int = <ItemType.Type: 0>) -> None QTreeWidgetItem(self, type: int = <ItemType.Type: 0>) -> None

Base classes

Name Children Inherits
SerializeMixin
prettyqt.utils.serializemixin
QTreeWidgetItem
PySide6.QtWidgets
QTreeWidgetItem(self, other: PySide6.QtWidgets.QTreeWidgetItem) -> None

â‹” Inheritance diagram

graph TD
  1473296209040["widgets.TreeWidgetItem"]
  1473299806240["utils.SerializeMixin"]
  140713234304496["builtins.object"]
  1473290740368["QtWidgets.QTreeWidgetItem"]
  1473291690208["Shiboken.Object"]
  1473299806240 --> 1473296209040
  140713234304496 --> 1473299806240
  1473290740368 --> 1473296209040
  1473291690208 --> 1473290740368
  140713234304496 --> 1473291690208

🛈 DocStrings

Bases: SerializeMixin, QTreeWidgetItem

Source code in prettyqt\widgets\treewidgetitem.py 
 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
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
class TreeWidgetItem(serializemixin.SerializeMixin, QtWidgets.QTreeWidgetItem):
    def __repr__(self):
        return get_repr(self)

    def serialize_fields(self):
        data = [
            self.data(i, constants.USER_ROLE)  # type: ignore
            for i in range(self.columnCount())
        ]
        return dict(
            text=[self.text(i) for i in range(self.columnCount())],
            tool_tip=[self.toolTip(i) for i in range(self.columnCount())],
            status_tip=[self.statusTip(i) for i in range(self.columnCount())],
            checkstate=[self.get_checkstate(i) for i in range(self.columnCount())],
            icon=[self.get_icon(i) for i in range(self.columnCount())],
            data=data,
        )

    def __iter__(self) -> Iterator[QtWidgets.QTreeWidgetItem]:
        return iter(self.child(i) for i in range(self.childCount()))

    def __len__(self):
        return self.childCount()

    def __getitem__(
        self, index: int | slice
    ) -> (
        QtWidgets.QTreeWidgetItem
        | listdelegators.ListDelegator[QtWidgets.QTreeWidgetItem]
    ):
        match index:
            case int():
                item = self.child(index)
                if item is None:
                    raise KeyError(index)
                return item
            case slice():
                count = self.childCount() if index.stop is None else index.stop
                values = list(range(count)[index])
                ls = [self.child(i) for i in values]
                return listdelegators.ListDelegator(ls)
            case _:
                raise TypeError(index)

    def __delitem__(self, index: int):
        self.takeChild(index)

    def __add__(self, other: QtWidgets.QTreeWidgetItem) -> TreeWidgetItem:
        self.addChild(other)
        return self

    def setChecked(self, column: int, checked: bool):
        self.setCheckState(
            column,
            constants.CheckState.Checked if checked else constants.CheckState.Unchecked,
        )

    def isChecked(self, col: int) -> bool:
        return self.checkState(col) == constants.CheckState.Checked

    def get_children(
        self, recursive: bool = False
    ) -> listdelegators.ListDelegator[QtWidgets.QTreeWidgetItem]:
        """Get children of this item.

        recursive option is written iteratively to also support original QTreeWidgetItems.
        """
        if not recursive:
            return [self.child(i) for i in range(self.childCount())]
        results = []
        nodes = [self]
        while nodes:
            items = []
            for node in nodes:
                results.append(node)
                items.extend(node.child(i) for i in range(node.childCount()))
            nodes = items
        return listdelegators.ListDelegator(results[1:])

    def get_top_level_items(
        self,
    ) -> listdelegators.ListDelegator[QtWidgets.QTreeWidgetItem]:
        items = [self.topLevelItem(i) for i in range(self.topLevelItemCount())]
        return listdelegators.ListDelegator(items)

    def collapse(self, recursive: bool = False):
        if recursive:
            for i in range(self.childCount()):
                self.child(i).collapse(True)
        self.setExpanded(False)

    def expand(self, recursive: bool = False):
        self.setExpanded(True)
        if recursive:
            for i in range(self.childCount()):
                self.child(i).expand(True)

    def set_size_hint(self, hint: datatypes.SizeType, column: int = 0):
        self.setSizeHint(column, datatypes.to_size(hint))

    def sort_children(self, column: int, descending: bool = False):
        order = constants.DESCENDING if descending else constants.ASCENDING
        self.sortChildren(column, order)

    def set_data(
        self, data: Any, role: constants.ItemDataRoleStr | constants.ItemDataRole | int
    ):
        if not isinstance(role, int):
            role = constants.ITEM_DATA_ROLE.get_enum_value(role)
        super().setData(data, role)

    def get_data(
        self, role: constants.ItemDataRoleStr | constants.ItemDataRole | int
    ) -> Any:
        if not isinstance(role, int):
            role = constants.ITEM_DATA_ROLE.get_enum_value(role)
        return super().data(role)

    def set_icon(self, icon: datatypes.IconType, column: int = 0):
        """Set the icon for the action.

        Args:
            icon: icon to use
            column: column
        """
        icon = iconprovider.get_icon(icon)
        self.setIcon(column, icon)

    def get_background(self, column: int = 0) -> gui.Brush:
        return gui.Brush(self.background(column))

    def get_foreground(self, column: int = 0) -> gui.Brush:
        return gui.Brush(self.foreground(column))

    def get_font(self, column: int = 0) -> gui.Font:
        return gui.Font(self.font(column))

    def get_icon(self, column: int = 0) -> gui.Icon | None:
        return None if (icon := self.icon(column)).isNull() else gui.Icon(icon)

    def set_checkstate(
        self, state: constants.CheckStateStr | constants.CheckState, column: int = 0
    ):
        """Set checkstate of the checkbox.

        Args:
            state: checkstate to use
            column: column
        """
        self.setCheckState(column, constants.CHECK_STATE.get_enum_value(state))

    def get_checkstate(self, column: int = 0) -> constants.CheckStateStr:
        """Return checkstate.

        Args:
            column: column

        Returns:
            checkstate
        """
        return constants.CHECK_STATE.inverse[self.checkState(column)]

    def set_child_indicator_policy(
        self, policy: ChildIndicatorPolicyStr | mod.ChildIndicatorPolicy
    ):
        """Set the child indicator policy.

        Args:
            policy: child indicator policy
        """
        self.setChildIndicatorPolicy(CHILD_INDICATOR_POLICY.get_enum_value(policy))

    def get_child_indicator_policy(self) -> ChildIndicatorPolicyStr:
        """Return current child indicator policy.

        Returns:
            child indicator policy
        """
        return CHILD_INDICATOR_POLICY.inverse[self.childIndicatorPolicy()]

    def get_text_alignment(self, column: int) -> constants.AlignmentStr:
        return constants.ALIGNMENTS.inverse[self.textAlignment(column)]

get_checkstate(column: int = 0) -> constants.CheckStateStr

Return checkstate.

Parameters:

Name Type Description Default
column int

column

 0
Source code in prettyqt\widgets\treewidgetitem.py 
175
176
177
178
179
180
181
182
183
184
def get_checkstate(self, column: int = 0) -> constants.CheckStateStr:
    """Return checkstate.

    Args:
        column: column

    Returns:
        checkstate
    """
    return constants.CHECK_STATE.inverse[self.checkState(column)]

get_child_indicator_policy() -> ChildIndicatorPolicyStr

Return current child indicator policy.

Source code in prettyqt\widgets\treewidgetitem.py 
196
197
198
199
200
201
202
def get_child_indicator_policy(self) -> ChildIndicatorPolicyStr:
    """Return current child indicator policy.

    Returns:
        child indicator policy
    """
    return CHILD_INDICATOR_POLICY.inverse[self.childIndicatorPolicy()]

get_children(recursive: bool = False) -> listdelegators.ListDelegator[QtWidgets.QTreeWidgetItem]

Get children of this item.

recursive option is written iteratively to also support original QTreeWidgetItems.

Source code in prettyqt\widgets\treewidgetitem.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
def get_children(
    self, recursive: bool = False
) -> listdelegators.ListDelegator[QtWidgets.QTreeWidgetItem]:
    """Get children of this item.

    recursive option is written iteratively to also support original QTreeWidgetItems.
    """
    if not recursive:
        return [self.child(i) for i in range(self.childCount())]
    results = []
    nodes = [self]
    while nodes:
        items = []
        for node in nodes:
            results.append(node)
            items.extend(node.child(i) for i in range(node.childCount()))
        nodes = items
    return listdelegators.ListDelegator(results[1:])

set_checkstate(state: constants.CheckStateStr | constants.CheckState, column: int = 0)

Set checkstate of the checkbox.

Parameters:

Name Type Description Default
state CheckStateStr | CheckState

checkstate to use

 required
column int

column

 0
Source code in prettyqt\widgets\treewidgetitem.py 
164
165
166
167
168
169
170
171
172
173
def set_checkstate(
    self, state: constants.CheckStateStr | constants.CheckState, column: int = 0
):
    """Set checkstate of the checkbox.

    Args:
        state: checkstate to use
        column: column
    """
    self.setCheckState(column, constants.CHECK_STATE.get_enum_value(state))

set_child_indicator_policy(policy: ChildIndicatorPolicyStr | mod.ChildIndicatorPolicy)

Set the child indicator policy.

Parameters:

Name Type Description Default
policy ChildIndicatorPolicyStr | ChildIndicatorPolicy

child indicator policy

 required
Source code in prettyqt\widgets\treewidgetitem.py 
186
187
188
189
190
191
192
193
194
def set_child_indicator_policy(
    self, policy: ChildIndicatorPolicyStr | mod.ChildIndicatorPolicy
):
    """Set the child indicator policy.

    Args:
        policy: child indicator policy
    """
    self.setChildIndicatorPolicy(CHILD_INDICATOR_POLICY.get_enum_value(policy))

set_icon(icon: datatypes.IconType, column: int = 0)

Set the icon for the action.

Parameters:

Name Type Description Default
icon IconType

icon to use

 required
column int

column

 0
Source code in prettyqt\widgets\treewidgetitem.py 
142
143
144
145
146
147
148
149
150
def set_icon(self, icon: datatypes.IconType, column: int = 0):
    """Set the icon for the action.

    Args:
        icon: icon to use
        column: column
    """
    icon = iconprovider.get_icon(icon)
    self.setIcon(column, icon)