Skip to content

TextTableCellFormat

Qt Base Class: QTextTableCellFormat

Signature: QTextTableCellFormat(self) -> None QTextTableCellFormat(self, QTextTableCellFormat: PySide6.QtGui.QTextTableCellFormat) -> None QTextTableCellFormat(self, fmt: PySide6.QtGui.QTextFormat) -> None

Base classes

Name Children Inherits
TextCharFormatMixin
prettyqt.gui.textcharformat
QTextTableCellFormat
PySide6.QtGui
QTextTableCellFormat(self) -> None

â‹” Inheritance diagram

graph TD
  1473245649984["gui.TextTableCellFormat"]
  1473245667552["gui.TextCharFormatMixin"]
  1473245646080["gui.TextFormatMixin"]
  140713234304496["builtins.object"]
  1473299997456["QtGui.QTextTableCellFormat"]
  1473299992576["QtGui.QTextCharFormat"]
  1473299700832["QtGui.QTextFormat"]
  1473291690208["Shiboken.Object"]
  1473245667552 --> 1473245649984
  1473245646080 --> 1473245667552
  140713234304496 --> 1473245646080
  1473299997456 --> 1473245649984
  1473299992576 --> 1473299997456
  1473299700832 --> 1473299992576
  1473291690208 --> 1473299700832
  140713234304496 --> 1473291690208

🛈 DocStrings

Bases: TextCharFormatMixin, QTextTableCellFormat

Source code in prettyqt\gui\texttablecellformat.py 
 6
 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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
class TextTableCellFormat(gui.TextCharFormatMixin, gui.QTextTableCellFormat):
    def get_bottom_border_brush(self) -> gui.Brush:
        return gui.Brush(self.bottomBorderBrush())

    def set_border_style(
        self, style: gui.textframeformat.BorderStyleStr | gui.QTextFrameFormat.BorderStyle
    ):
        """Set border style.

        Args:
            style: border style
        """
        self.setBorderStyle(gui.textframeformat.BORDER_STYLES.get_enum_value(style))

    def set_bottom_border_style(
        self, style: gui.textframeformat.BorderStyleStr | gui.QTextFrameFormat.BorderStyle
    ):
        """Set bottom border style.

        Args:
            style: bottom border style
        """
        self.setBottomBorderStyle(gui.textframeformat.BORDER_STYLES.get_enum_value(style))

    def get_bottom_border_style(self) -> gui.textframeformat.BorderStyleStr:
        """Get the current bottom border style.

        Returns:
            bottom border style
        """
        return gui.textframeformat.BORDER_STYLES.inverse[self.bottomBorderStyle()]

    def get_left_border_brush(self) -> gui.Brush:
        return gui.Brush(self.leftBorderBrush())

    def set_left_border_style(
        self, style: gui.textframeformat.BorderStyleStr | gui.QTextFrameFormat.BorderStyle
    ):
        """Set left border style.

        Args:
            style: left border style
        """
        self.setLeftBorderStyle(gui.textframeformat.BORDER_STYLES.get_enum_value(style))

    def get_left_border_style(self) -> gui.textframeformat.BorderStyleStr:
        """Get the current left border style.

        Returns:
            left border style
        """
        return gui.textframeformat.BORDER_STYLES.inverse[self.leftBorderStyle()]

    def get_right_border_brush(self) -> gui.Brush:
        return gui.Brush(self.rightBorderBrush())

    def set_right_border_style(
        self, style: gui.textframeformat.BorderStyleStr | gui.QTextFrameFormat.BorderStyle
    ):
        """Set right border style.

        Args:
            style: right border style
        """
        self.setRightBorderStyle(gui.textframeformat.BORDER_STYLES.get_enum_value(style))

    def get_right_border_style(self) -> gui.textframeformat.BorderStyleStr:
        """Get the current right border style.

        Returns:
            right border style
        """
        return gui.textframeformat.BORDER_STYLES.inverse[self.rightBorderStyle()]

    def get_top_border_brush(self) -> gui.Brush:
        return gui.Brush(self.topBorderBrush())

    def set_top_border_style(
        self, style: gui.textframeformat.BorderStyleStr | gui.QTextFrameFormat.BorderStyle
    ):
        """Set top border style.

        Args:
            style: top border style
        """
        self.setTopBorderStyle(gui.textframeformat.BORDER_STYLES.get_enum_value(style))

    def get_top_border_style(self) -> gui.textframeformat.BorderStyleStr:
        """Get the current top border style.

        Returns:
            top border style
        """
        return gui.textframeformat.BORDER_STYLES.inverse[self.topBorderStyle()]

get_bottom_border_style() -> gui.textframeformat.BorderStyleStr

Get the current bottom border style.

Source code in prettyqt\gui\texttablecellformat.py 
30
31
32
33
34
35
36
def get_bottom_border_style(self) -> gui.textframeformat.BorderStyleStr:
    """Get the current bottom border style.

    Returns:
        bottom border style
    """
    return gui.textframeformat.BORDER_STYLES.inverse[self.bottomBorderStyle()]

get_left_border_style() -> gui.textframeformat.BorderStyleStr

Get the current left border style.

Source code in prettyqt\gui\texttablecellformat.py 
51
52
53
54
55
56
57
def get_left_border_style(self) -> gui.textframeformat.BorderStyleStr:
    """Get the current left border style.

    Returns:
        left border style
    """
    return gui.textframeformat.BORDER_STYLES.inverse[self.leftBorderStyle()]

get_right_border_style() -> gui.textframeformat.BorderStyleStr

Get the current right border style.

Source code in prettyqt\gui\texttablecellformat.py 
72
73
74
75
76
77
78
def get_right_border_style(self) -> gui.textframeformat.BorderStyleStr:
    """Get the current right border style.

    Returns:
        right border style
    """
    return gui.textframeformat.BORDER_STYLES.inverse[self.rightBorderStyle()]

get_top_border_style() -> gui.textframeformat.BorderStyleStr

Get the current top border style.

Source code in prettyqt\gui\texttablecellformat.py 
93
94
95
96
97
98
99
def get_top_border_style(self) -> gui.textframeformat.BorderStyleStr:
    """Get the current top border style.

    Returns:
        top border style
    """
    return gui.textframeformat.BORDER_STYLES.inverse[self.topBorderStyle()]

set_border_style(style: gui.textframeformat.BorderStyleStr | gui.QTextFrameFormat.BorderStyle)

Set border style.

Parameters:

Name Type Description Default
style BorderStyleStr | BorderStyle

border style

 required
Source code in prettyqt\gui\texttablecellformat.py 
10
11
12
13
14
15
16
17
18
def set_border_style(
    self, style: gui.textframeformat.BorderStyleStr | gui.QTextFrameFormat.BorderStyle
):
    """Set border style.

    Args:
        style: border style
    """
    self.setBorderStyle(gui.textframeformat.BORDER_STYLES.get_enum_value(style))

set_bottom_border_style(style: gui.textframeformat.BorderStyleStr | gui.QTextFrameFormat.BorderStyle)

Set bottom border style.

Parameters:

Name Type Description Default
style BorderStyleStr | BorderStyle

bottom border style

 required
Source code in prettyqt\gui\texttablecellformat.py 
20
21
22
23
24
25
26
27
28
def set_bottom_border_style(
    self, style: gui.textframeformat.BorderStyleStr | gui.QTextFrameFormat.BorderStyle
):
    """Set bottom border style.

    Args:
        style: bottom border style
    """
    self.setBottomBorderStyle(gui.textframeformat.BORDER_STYLES.get_enum_value(style))

set_left_border_style(style: gui.textframeformat.BorderStyleStr | gui.QTextFrameFormat.BorderStyle)

Set left border style.

Parameters:

Name Type Description Default
style BorderStyleStr | BorderStyle

left border style

 required
Source code in prettyqt\gui\texttablecellformat.py 
41
42
43
44
45
46
47
48
49
def set_left_border_style(
    self, style: gui.textframeformat.BorderStyleStr | gui.QTextFrameFormat.BorderStyle
):
    """Set left border style.

    Args:
        style: left border style
    """
    self.setLeftBorderStyle(gui.textframeformat.BORDER_STYLES.get_enum_value(style))

set_right_border_style(style: gui.textframeformat.BorderStyleStr | gui.QTextFrameFormat.BorderStyle)

Set right border style.

Parameters:

Name Type Description Default
style BorderStyleStr | BorderStyle

right border style

 required
Source code in prettyqt\gui\texttablecellformat.py 
62
63
64
65
66
67
68
69
70
def set_right_border_style(
    self, style: gui.textframeformat.BorderStyleStr | gui.QTextFrameFormat.BorderStyle
):
    """Set right border style.

    Args:
        style: right border style
    """
    self.setRightBorderStyle(gui.textframeformat.BORDER_STYLES.get_enum_value(style))

set_top_border_style(style: gui.textframeformat.BorderStyleStr | gui.QTextFrameFormat.BorderStyle)

Set top border style.

Parameters:

Name Type Description Default
style BorderStyleStr | BorderStyle

top border style

 required
Source code in prettyqt\gui\texttablecellformat.py 
83
84
85
86
87
88
89
90
91
def set_top_border_style(
    self, style: gui.textframeformat.BorderStyleStr | gui.QTextFrameFormat.BorderStyle
):
    """Set top border style.

    Args:
        style: top border style
    """
    self.setTopBorderStyle(gui.textframeformat.BORDER_STYLES.get_enum_value(style))