Skip to content

GraphicsItemMixin

Subclasses

Class Module Description
GraphicsItem prettyqt.widgets.graphicsitem
GraphicsItemGroup prettyqt.widgets.graphicsitemgroup
AbstractGraphicsShapeItemMixin prettyqt.widgets.abstractgraphicsshapeitem
GraphicsPixmapItem prettyqt.widgets.graphicspixmapitem
GraphicsObjectMixin prettyqt.widgets.graphicsobject
GraphicsLineItem prettyqt.widgets.graphicslineitem

⋔ Inheritance diagram

graph TD
  1473293706784["widgets.GraphicsItemMixin"]
  140713234304496["builtins.object"]
  140713234304496 --> 1473293706784

🛈 DocStrings

Source code in prettyqt\widgets\graphicsitem.py 
 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
class GraphicsItemMixin:
    def __repr__(self):
        return get_repr(self)

    def __contains__(self, value: QtCore.QPointF) -> bool:
        return self.contains(value)

    def __getitem__(self, key: int):
        return self.data(key)

    def __setitem__(self, key: int, value):
        self.setData(key, value)

    def set_focus(
        self, reason: constants.FocusReasonStr | constants.FocusReason = "other"
    ):
        self.setFocus(constants.FOCUS_REASONS.get_enum_value(reason))

    def colliding_items(
        self,
        mode: constants.ItemSelectionModeStr
        | constants.ItemSelectionMode = "intersects_shape",
    ) -> listdelegators.ListDelegator[QtWidgets.QGraphicsItem]:
        items = self.collidingItems(constants.ITEM_SELECTION_MODE.get_enum_value(mode))
        return listdelegators.ListDelegator(items)

    def collides_with(
        self,
        item: gui.QPainterPath | QtWidgets.QGraphicsItem,
        mode: constants.ItemSelectionModeStr
        | constants.ItemSelectionMode = "intersects_shape",
    ) -> bool:
        if isinstance(item, gui.QPainterPath):
            return self.collidesWithPath(
                item, constants.ITEM_SELECTION_MODE.get_enum_value(mode)
            )
        else:
            return self.collidesWithItem(
                item, constants.ITEM_SELECTION_MODE.get_enum_value(mode)
            )

    def set_panel_modality(
        self, modality: PanelModalityStr | QtWidgets.QGraphicsItem.PanelModality
    ):
        """Set panel modality.

        Args:
            modality: panel modality
        """
        self.setPanelModality(PANEL_MODALITY.get_enum_value(modality))

    def get_panel_modality(self) -> PanelModalityStr:
        """Get the current modality modes as a string.

        Returns:
            panel modality
        """
        return PANEL_MODALITY.inverse[self.panelModality()]

    def set_cache_mode(self, mode: CacheModeStr | QtWidgets.QGraphicsItem.CacheMode):
        """Set cache mode.

        Args:
            mode: cache mode
        """
        self.setCacheMode(CACHE_MODE.get_enum_value(mode))

    def get_cache_mode(self) -> CacheModeStr:
        """Get the current mode modes as a string.

        Returns:
            cache mode
        """
        return CACHE_MODE.inverse[self.cacheMode()]

    def get_shape(self) -> gui.PainterPath:
        return gui.PainterPath(self.shape())

    def set_scale(self, scale: tuple[float, float] | float):
        if isinstance(scale, float):
            self.setScale(scale)
        else:
            self.setTransform(gui.Transform.fromScale(scale[0], scale[1]), True)

    def set_transform(self, transform: datatypes.TransformType, combine: bool = False):
        if isinstance(transform, tuple):
            transform = gui.Transform(*transform)
        self.setTransform(transform, combine)

get_cache_mode() -> CacheModeStr

Get the current mode modes as a string.

Source code in prettyqt\widgets\graphicsitem.py 
 94
 95
 96
 97
 98
 99
100
def get_cache_mode(self) -> CacheModeStr:
    """Get the current mode modes as a string.

    Returns:
        cache mode
    """
    return CACHE_MODE.inverse[self.cacheMode()]

get_panel_modality() -> PanelModalityStr

Get the current modality modes as a string.

Source code in prettyqt\widgets\graphicsitem.py 
78
79
80
81
82
83
84
def get_panel_modality(self) -> PanelModalityStr:
    """Get the current modality modes as a string.

    Returns:
        panel modality
    """
    return PANEL_MODALITY.inverse[self.panelModality()]

set_cache_mode(mode: CacheModeStr | QtWidgets.QGraphicsItem.CacheMode)

Set cache mode.

Parameters:

Name Type Description Default
mode CacheModeStr | CacheMode

cache mode

 required
Source code in prettyqt\widgets\graphicsitem.py 
86
87
88
89
90
91
92
def set_cache_mode(self, mode: CacheModeStr | QtWidgets.QGraphicsItem.CacheMode):
    """Set cache mode.

    Args:
        mode: cache mode
    """
    self.setCacheMode(CACHE_MODE.get_enum_value(mode))

set_panel_modality(modality: PanelModalityStr | QtWidgets.QGraphicsItem.PanelModality)

Set panel modality.

Parameters:

Name Type Description Default
modality PanelModalityStr | PanelModality

panel modality

 required
Source code in prettyqt\widgets\graphicsitem.py 
68
69
70
71
72
73
74
75
76
def set_panel_modality(
    self, modality: PanelModalityStr | QtWidgets.QGraphicsItem.PanelModality
):
    """Set panel modality.

    Args:
        modality: panel modality
    """
    self.setPanelModality(PANEL_MODALITY.get_enum_value(modality))