Skip to content

GridLayout

Qt Base Class: QGridLayout

Signature: QGridLayout(self, parent: Optional[PySide6.QtWidgets.QWidget] = None) -> None

Base classes

Name Children Inherits
LayoutMixin
prettyqt.widgets.layout
QGridLayout
PySide6.QtWidgets
QGridLayout(self, parent: Optional[PySide6.QtWidgets.QWidget] \= None) -> None

⋔ Inheritance diagram

graph TD
  1473296334944["widgets.GridLayout"]
  1473296333968["widgets.LayoutMixin"]
  1473299815024["core.ObjectMixin"]
  140713234304496["builtins.object"]
  1473296346656["widgets.LayoutItemMixin"]
  1473365795280["QtWidgets.QGridLayout"]
  1473365768928["QtWidgets.QLayout"]
  1473288842240["QtCore.QObject"]
  1473291690208["Shiboken.Object"]
  1473290791120["QtWidgets.QLayoutItem"]
  1473296333968 --> 1473296334944
  1473299815024 --> 1473296333968
  140713234304496 --> 1473299815024
  1473296346656 --> 1473296333968
  140713234304496 --> 1473296346656
  1473365795280 --> 1473296334944
  1473365768928 --> 1473365795280
  1473288842240 --> 1473365768928
  1473291690208 --> 1473288842240
  140713234304496 --> 1473291690208
  1473290791120 --> 1473365768928
  1473291690208 --> 1473290791120

🛈 DocStrings

Bases: LayoutMixin, QGridLayout

Lays out widgets in a grid.

Source code in prettyqt\widgets\gridlayout.py 
  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
 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
class GridLayout(widgets.LayoutMixin, widgets.QGridLayout):
    """Lays out widgets in a grid."""

    ID = "grid"

    def __getitem__(
        self, index: tuple[int | slice, int | slice] | int | str
    ) -> (
        widgets.QWidget
        | widgets.QLayout
        | listdelegators.ListDelegator[widgets.QWidget | widgets.QLayout]
        | None
    ):
        rowcount = self.rowCount()
        colcount = self.columnCount()
        match index:
            case int() as row, int() as col:
                if row < 0:
                    row = rowcount + row
                if col < 0:
                    col = colcount + col
                if row >= rowcount or row < 0 or col >= colcount or col < 0:
                    raise IndexError(index)
                item = self.itemAtPosition(row, col)
                return i if (i := item.widget()) is not None else item.layout()
            case (row, col):
                items = [
                    item
                    for i, j in helpers.iter_positions(row, col, rowcount, colcount)
                    if (item := self.itemAtPosition(i, j)) is not None
                ]
                items = [
                    w if (w := i.widget()) is not None else i.layout() for i in items
                ]
                return listdelegators.ListDelegator(list(set(items)))
            case int() as row:
                if row < 0:
                    row = rowcount + row
                if row >= rowcount or row < 0:
                    raise IndexError(index)
                item = self.itemAt(row)
                return i if (i := item.widget()) is not None else item.layout()
            case slice() as rowslice:
                count = rowcount if rowslice.stop is None else rowslice.stop
                items = [self.itemAt(i) for i in range(count)[rowslice]]
                items = [
                    w if (w := i.widget()) is not None else i.layout() for i in items
                ]
                return listdelegators.ListDelegator(list(set(items)))
            case str():
                return self.find_child(widgets.QWidget | widgets.QLayout, index)
            case _:
                raise TypeError(index)

    def __setitem__(
        self,
        idx: tuple[int | slice, int | slice],
        value: widgets.QWidget | widgets.QLayout | widgets.QLayoutItem,
    ):
        row, col = idx
        rowspan = row.stop - row.start + 1 if isinstance(row, slice) else 1
        colspan = col.stop - col.start + 1 if isinstance(col, slice) else 1
        rowstart = row.start if isinstance(row, slice) else row
        colstart = col.start if isinstance(col, slice) else col
        self.add(value, rowstart, colstart, rowspan, colspan)

    # def __setstate__(self, state):
    #     for item, pos in zip(state["widgets"], state["positions"]):
    #         x, y, w, h = pos
    #         self[x : x + w - 1, y : y + h - 1] = item

    # def __reduce__(self):
    #     return type(self), (), self.__getstate__()

    def __iter__(self) -> Iterator[widgets.QWidget | widgets.QLayout]:
        return iter(
            item for i in range(self.count()) if (item := self.itemAt(i)) is not None
        )

    def __add__(
        self,
        other: (tuple | list | widgets.QWidget | widgets.QLayout | widgets.QLayoutItem),
    ):
        if isinstance(other, tuple | list):
            for i, _control in enumerate(other):
                self[self.rowCount(), i] = other  # type: ignore
        else:
            self[self.rowCount(), 0 : self.columnCount() - 1] = other
        return self

    def __iadd__(self, item, *args, **kwargs):
        self.__add__(item, *args, **kwargs)
        return self

    def add(
        self,
        item: widgets.QWidget | widgets.QLayout | widgets.QLayoutItem,
        rowstart: int,
        colstart: int,
        rowspan: int = 1,
        colspan: int = 1,
        alignment: constants.AlignmentStr | constants.AlignmentFlag | None = None,
    ):
        if alignment is None:
            alignment = "none"
        flag = constants.ALIGNMENTS.get_enum_value(alignment)
        match item:
            case widgets.QWidget():
                self.addWidget(item, rowstart, colstart, rowspan, colspan, flag)
            case widgets.QLayout():
                self.addLayout(item, rowstart, colstart, rowspan, colspan, flag)
            case widgets.QLayoutItem():
                self.addItem(item, rowstart, colstart, rowspan, colspan, flag)

    def append(self, item: widgets.QWidget | widgets.QLayout | widgets.QLayoutItem):
        self[self.rowCount(), 0 : self.columnCount() - 1] = item

    def set_origin_corner(self, corner: constants.CornerStr | constants.Corner):
        """Set the origin corner.

        Args:
            corner: origin corner
        """
        self.setOriginCorner(constants.CORNER.get_enum_value(corner))

    def get_origin_corner(self) -> constants.CornerStr:
        """Return current origin corner.

        Returns:
            origin corner
        """
        return constants.CORNER.inverse[self.originCorner()]

get_origin_corner() -> constants.CornerStr

Return current origin corner.

Source code in prettyqt\widgets\gridlayout.py 
134
135
136
137
138
139
140
def get_origin_corner(self) -> constants.CornerStr:
    """Return current origin corner.

    Returns:
        origin corner
    """
    return constants.CORNER.inverse[self.originCorner()]

set_origin_corner(corner: constants.CornerStr | constants.Corner)

Set the origin corner.

Parameters:

Name Type Description Default
corner CornerStr | Corner

origin corner

 required
Source code in prettyqt\widgets\gridlayout.py 
126
127
128
129
130
131
132
def set_origin_corner(self, corner: constants.CornerStr | constants.Corner):
    """Set the origin corner.

    Args:
        corner: origin corner
    """
    self.setOriginCorner(constants.CORNER.get_enum_value(corner))

⌗ Property table

Qt Property Type Doc
objectName QString
spacing int
contentsMargins QMargins
sizeConstraint QLayout::SizeConstraint