Skip to content

ListWidgetItem

Qt Base Class: QListWidgetItem

Signature: QListWidgetItem(self, icon: Union[PySide6.QtGui.QIcon, PySide6.QtGui.QPixmap], text: str, listview: Optional[PySide6.QtWidgets.QListWidget] = None, type: int = <ItemType.Type: 0>) -> None QListWidgetItem(self, listview: Optional[PySide6.QtWidgets.QListWidget] = None, type: int = <ItemType.Type: 0>) -> None QListWidgetItem(self, other: PySide6.QtWidgets.QListWidgetItem) -> None QListWidgetItem(self, text: str, listview: Optional[PySide6.QtWidgets.QListWidget] = None, type: int = <ItemType.Type: 0>) -> None

Base classes

Name Children Inherits
SerializeMixin
prettyqt.utils.serializemixin
QListWidgetItem
PySide6.QtWidgets
QListWidgetItem(self, icon: Union[PySide6.QtGui.QIcon, PySide6.QtGui.QPixmap], text: str, listview: Optional[PySide6.QtWidgets.QListWidget] \= None, type: int \= <ItemType.Type: 0>) -> None

⋔ Inheritance diagram

graph TD
  1473296240272["widgets.ListWidgetItem"]
  1473299806240["utils.SerializeMixin"]
  140713234304496["builtins.object"]
  1473290811616["QtWidgets.QListWidgetItem"]
  1473291690208["Shiboken.Object"]
  1473299806240 --> 1473296240272
  140713234304496 --> 1473299806240
  1473290811616 --> 1473296240272
  1473291690208 --> 1473290811616
  140713234304496 --> 1473291690208

🛈 DocStrings

Bases: SerializeMixin, QListWidgetItem

Item for use with the QListWidget item view class.

Source code in prettyqt\widgets\listwidgetitem.py 
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
90
91
92
93
94
95
class ListWidgetItem(serializemixin.SerializeMixin, QtWidgets.QListWidgetItem):
    """Item for use with the QListWidget item view class."""

    def __repr__(self):
        return get_repr(self, self.icon(), self.text())

    def __setitem__(self, index: int | constants.ItemDataRoleStr, value):
        self.set_data(index, value)

    def __getitem__(self, index: int | constants.ItemDataRoleStr):
        return self.get_data(index)

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

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

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

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

    def get_checkstate(self) -> constants.CheckStateStr:
        """Return checkstate.

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

    def get_background(self) -> gui.Brush:
        return gui.Brush(self.background())

    def get_foreground(self) -> gui.Brush:
        return gui.Brush(self.foreground())

    def get_font(self) -> gui.Font:
        return gui.Font(self.font())

    def get_icon(self) -> gui.Icon | None:
        return None if (icon := super().icon()).isNull() else gui.Icon(icon)

    def set_data(self, role: constants.ItemDataRoleStr | int, data: Any):
        role = constants.ITEM_DATA_ROLE[role] if isinstance(role, str) else role
        super().setData(role, data)

    def get_data(self, role: constants.ItemDataRoleStr | int):
        role = constants.ITEM_DATA_ROLE[role] if isinstance(role, str) else role
        return super().data(role)

    def set_size_hint(self, hint: datatypes.SizeType):
        super().setSizeHint(datatypes.to_size(hint))

    def set_text_alignment(
        self,
        horizontal: constants.HorizontalAlignmentStr
        | constants.AlignmentFlag
        | None = None,
        vertical: constants.VerticalAlignmentStr | constants.AlignmentFlag | None = None,
    ):
        """Set text alignment of the checkbox.

        Args:
            horizontal: horizontal text alignment to use
            vertical: vertical text alignment to use

        """
        match horizontal, vertical:
            case None, None:
                return
            case None, _:
                flag = constants.V_ALIGNMENT.get_enum_value(vertical)
            case _, None:
                flag = constants.H_ALIGNMENT.get_enum_value(horizontal)
            case _, _:
                flag = constants.V_ALIGNMENT.get_enum_value(
                    vertical
                ) | constants.H_ALIGNMENT.get_enum_value(horizontal)
        self.setTextAlignment(flag)

get_checkstate() -> constants.CheckStateStr

Return checkstate.

Source code in prettyqt\widgets\listwidgetitem.py 
39
40
41
42
43
44
45
def get_checkstate(self) -> constants.CheckStateStr:
    """Return checkstate.

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

set_checkstate(state: constants.CheckStateStr | constants.CheckState)

Set checkstate of the checkbox.

Parameters:

Name Type Description Default
state CheckStateStr | CheckState

checkstate to use

 required
Source code in prettyqt\widgets\listwidgetitem.py 
31
32
33
34
35
36
37
def set_checkstate(self, state: constants.CheckStateStr | constants.CheckState):
    """Set checkstate of the checkbox.

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

set_icon(icon: datatypes.IconType)

Set the icon for the action.

Parameters:

Name Type Description Default
icon IconType

icon to use

 required
Source code in prettyqt\widgets\listwidgetitem.py 
22
23
24
25
26
27
28
29
def set_icon(self, icon: datatypes.IconType):
    """Set the icon for the action.

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

set_text_alignment(horizontal: constants.HorizontalAlignmentStr | constants.AlignmentFlag | None = None, vertical: constants.VerticalAlignmentStr | constants.AlignmentFlag | None = None)

Set text alignment of the checkbox.

Parameters:

Name Type Description Default
horizontal HorizontalAlignmentStr | AlignmentFlag | None

horizontal text alignment to use

 None
vertical VerticalAlignmentStr | AlignmentFlag | None

vertical text alignment to use

 None
Source code in prettyqt\widgets\listwidgetitem.py 
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
def set_text_alignment(
    self,
    horizontal: constants.HorizontalAlignmentStr
    | constants.AlignmentFlag
    | None = None,
    vertical: constants.VerticalAlignmentStr | constants.AlignmentFlag | None = None,
):
    """Set text alignment of the checkbox.

    Args:
        horizontal: horizontal text alignment to use
        vertical: vertical text alignment to use

    """
    match horizontal, vertical:
        case None, None:
            return
        case None, _:
            flag = constants.V_ALIGNMENT.get_enum_value(vertical)
        case _, None:
            flag = constants.H_ALIGNMENT.get_enum_value(horizontal)
        case _, _:
            flag = constants.V_ALIGNMENT.get_enum_value(
                vertical
            ) | constants.H_ALIGNMENT.get_enum_value(horizontal)
    self.setTextAlignment(flag)