Skip to content

FrameMixin

Base classes

Name Children Inherits
WidgetMixin
prettyqt.widgets.widget

Subclasses

Class Module Description
Frame prettyqt.widgets.frame
AbstractScrollAreaMixin prettyqt.widgets.abstractscrollarea
Label prettyqt.widgets.label
LCDNumber prettyqt.widgets.lcdnumber
ToolBox prettyqt.widgets.toolbox
SplitterMixin prettyqt.widgets.splitter
StackedWidget prettyqt.widgets.stackedwidget

⋔ Inheritance diagram

graph TD
  1473293662864["widgets.FrameMixin"]
  1473293688240["widgets.WidgetMixin"]
  1473299815024["core.ObjectMixin"]
  140713234304496["builtins.object"]
  1473245548480["gui.PaintDeviceMixin"]
  1473293688240 --> 1473293662864
  1473299815024 --> 1473293688240
  140713234304496 --> 1473299815024
  1473245548480 --> 1473293688240
  140713234304496 --> 1473245548480

🛈 DocStrings

Bases: WidgetMixin

Source code in prettyqt\widgets\frame.py 
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
class FrameMixin(widgets.WidgetMixin):
    def _get_map(self):
        maps = super()._get_map()
        maps |= {"frameShape": FRAME_SHAPE, "frameShadow": SHADOW}
        return maps

    def set_frame_shadow(self, style: ShadowStr | widgets.QFrame.Shadow):
        """Set frame shadow.

        Args:
            style: frame style to use
        """
        self.setFrameShadow(SHADOW.get_enum_value(style))

    def get_frame_shadow(self) -> ShadowStr | None:
        """Return current frame shadow.

        Returns:
            frame style
        """
        if (frame_shadow := self.frameShadow()) == 0:
            return None
        return SHADOW.inverse[frame_shadow]

    def set_frame_shape(self, shape: FrameShapeStr | widgets.QFrame.Shape):
        """Set frame shape.

        Args:
            shape: frame shape to use
        """
        self.setFrameShape(FRAME_SHAPE.get_enum_value(shape))

    def get_frame_shape(self) -> FrameShapeStr:
        """Return current frame shape.

        Returns:
            frame shape
        """
        return FRAME_SHAPE.inverse[self.frameShape()]

    def set_frame_rect(self, rect: datatypes.RectType):
        self.setFrameRect(datatypes.to_rect(rect))

get_frame_shadow() -> ShadowStr | None

Return current frame shadow.

Source code in prettyqt\widgets\frame.py 
46
47
48
49
50
51
52
53
54
def get_frame_shadow(self) -> ShadowStr | None:
    """Return current frame shadow.

    Returns:
        frame style
    """
    if (frame_shadow := self.frameShadow()) == 0:
        return None
    return SHADOW.inverse[frame_shadow]

get_frame_shape() -> FrameShapeStr

Return current frame shape.

Source code in prettyqt\widgets\frame.py 
64
65
66
67
68
69
70
def get_frame_shape(self) -> FrameShapeStr:
    """Return current frame shape.

    Returns:
        frame shape
    """
    return FRAME_SHAPE.inverse[self.frameShape()]

set_frame_shadow(style: ShadowStr | widgets.QFrame.Shadow)

Set frame shadow.

Parameters:

Name Type Description Default
style ShadowStr | Shadow

frame style to use

 required
Source code in prettyqt\widgets\frame.py 
38
39
40
41
42
43
44
def set_frame_shadow(self, style: ShadowStr | widgets.QFrame.Shadow):
    """Set frame shadow.

    Args:
        style: frame style to use
    """
    self.setFrameShadow(SHADOW.get_enum_value(style))

set_frame_shape(shape: FrameShapeStr | widgets.QFrame.Shape)

Set frame shape.

Parameters:

Name Type Description Default
shape FrameShapeStr | Shape

frame shape to use

 required
Source code in prettyqt\widgets\frame.py 
56
57
58
59
60
61
62
def set_frame_shape(self, shape: FrameShapeStr | widgets.QFrame.Shape):
    """Set frame shape.

    Args:
        shape: frame shape to use
    """
    self.setFrameShape(FRAME_SHAPE.get_enum_value(shape))