Skip to content

Pen

Qt Base Class: QPen

Signature: QPen(self) -> None QPen(self, arg__1: PySide6.QtCore.Qt.PenStyle) -> None QPen(self, brush: Union[PySide6.QtGui.QBrush, PySide6.QtCore.Qt.BrushStyle, PySide6.QtCore.Qt.GlobalColor, PySide6.QtGui.QColor, PySide6.QtGui.QGradient, PySide6.QtGui.QImage, PySide6.QtGui.QPixmap], width: float, s: PySide6.QtCore.Qt.PenStyle = Instance(Qt.SolidLine), c: PySide6.QtCore.Qt.PenCapStyle = Instance(Qt.SquareCap), j: PySide6.QtCore.Qt.PenJoinStyle = Instance(Qt.BevelJoin)) -> None QPen(self, color: Union[PySide6.QtGui.QColor, PySide6.QtGui.QRgba64, Any, PySide6.QtCore.Qt.GlobalColor, str, int]) -> None QPen(self, pen: Union[PySide6.QtGui.QPen, PySide6.QtCore.Qt.PenStyle, PySide6.QtGui.QColor]) -> None

Base classes

Name Children Inherits
SerializeMixin
prettyqt.utils.serializemixin
QPen
PySide6.QtGui
QPen(self) -> None

⋔ Inheritance diagram

graph TD
  1473245630464["gui.Pen"]
  1473299806240["utils.SerializeMixin"]
  140713234304496["builtins.object"]
  1473300084320["QtGui.QPen"]
  1473291690208["Shiboken.Object"]
  1473299806240 --> 1473245630464
  140713234304496 --> 1473299806240
  1473300084320 --> 1473245630464
  1473291690208 --> 1473300084320
  140713234304496 --> 1473291690208

🛈 DocStrings

Bases: SerializeMixin, QPen

Defines how a QPainter should draw lines and outlines of shapes.

Source code in prettyqt\gui\pen.py 
 7
 8
 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
class Pen(serializemixin.SerializeMixin, gui.QPen):
    """Defines how a QPainter should draw lines and outlines of shapes."""

    def __repr__(self):
        return get_repr(self, self.get_color())

    def set_color(self, color: datatypes.ColorType):
        color = colors.get_color(color)
        self.setColor(color)

    def get_color(self) -> gui.Color:
        return gui.Color(self.color())

    def get_brush(self) -> gui.Brush:
        return gui.Brush(self.brush())

    def set_cap_style(self, style: constants.CapStyleStr | constants.PenCapStyle):
        """Set cap style to use.

        Args:
            style: cap style to use
        """
        self.setCapStyle(constants.CAP_STYLE.get_enum_value(style))

    def get_cap_style(self) -> constants.CapStyleStr:
        """Return current cap style.

        Returns:
            cap style
        """
        return constants.CAP_STYLE.inverse[self.capStyle()]

    def set_join_style(self, style: constants.JoinStyleStr | constants.PenJoinStyle):
        """Set join style to use.

        Args:
            style: join style to use
        """
        self.setJoinStyle(constants.JOIN_STYLE.get_enum_value(style))

    def get_join_style(self) -> constants.JoinStyleStr:
        """Return current join style.

        Returns:
            join style
        """
        return constants.JOIN_STYLE.inverse[self.joinStyle()]

    def set_style(
        self, style: constants.PenStyleStr | constants.PenStyle | list[float] | None
    ):
        """Set pen style to use.

        Args:
            style: pen style to use
        """
        if isinstance(style, list):
            self.setDashPattern(style)
        else:
            if style is None:
                style = "none"
            self.setStyle(constants.PEN_STYLE.get_enum_value(style))

    def get_style(self) -> constants.PenStyleStr:
        """Return current pen style.

        Returns:
            pen style
        """
        return constants.PEN_STYLE.inverse[self.style()]

get_cap_style() -> constants.CapStyleStr

Return current cap style.

Source code in prettyqt\gui\pen.py 
31
32
33
34
35
36
37
def get_cap_style(self) -> constants.CapStyleStr:
    """Return current cap style.

    Returns:
        cap style
    """
    return constants.CAP_STYLE.inverse[self.capStyle()]

get_join_style() -> constants.JoinStyleStr

Return current join style.

Source code in prettyqt\gui\pen.py 
47
48
49
50
51
52
53
def get_join_style(self) -> constants.JoinStyleStr:
    """Return current join style.

    Returns:
        join style
    """
    return constants.JOIN_STYLE.inverse[self.joinStyle()]

get_style() -> constants.PenStyleStr

Return current pen style.

Source code in prettyqt\gui\pen.py 
70
71
72
73
74
75
76
def get_style(self) -> constants.PenStyleStr:
    """Return current pen style.

    Returns:
        pen style
    """
    return constants.PEN_STYLE.inverse[self.style()]

set_cap_style(style: constants.CapStyleStr | constants.PenCapStyle)

Set cap style to use.

Parameters:

Name Type Description Default
style CapStyleStr | PenCapStyle

cap style to use

 required
Source code in prettyqt\gui\pen.py 
23
24
25
26
27
28
29
def set_cap_style(self, style: constants.CapStyleStr | constants.PenCapStyle):
    """Set cap style to use.

    Args:
        style: cap style to use
    """
    self.setCapStyle(constants.CAP_STYLE.get_enum_value(style))

set_join_style(style: constants.JoinStyleStr | constants.PenJoinStyle)

Set join style to use.

Parameters:

Name Type Description Default
style JoinStyleStr | PenJoinStyle

join style to use

 required
Source code in prettyqt\gui\pen.py 
39
40
41
42
43
44
45
def set_join_style(self, style: constants.JoinStyleStr | constants.PenJoinStyle):
    """Set join style to use.

    Args:
        style: join style to use
    """
    self.setJoinStyle(constants.JOIN_STYLE.get_enum_value(style))

set_style(style: constants.PenStyleStr | constants.PenStyle | list[float] | None)

Set pen style to use.

Parameters:

Name Type Description Default
style PenStyleStr | PenStyle | list[float] | None

pen style to use

 required
Source code in prettyqt\gui\pen.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
def set_style(
    self, style: constants.PenStyleStr | constants.PenStyle | list[float] | None
):
    """Set pen style to use.

    Args:
        style: pen style to use
    """
    if isinstance(style, list):
        self.setDashPattern(style)
    else:
        if style is None:
            style = "none"
        self.setStyle(constants.PEN_STYLE.get_enum_value(style))