wx.richtext.TextAttrBorders

A class representing a rich text object’s borders.

See also

wx.richtext.RichTextAttr, wx.richtext.RichTextCtrl, RichTextAttrBorder

Class Hierarchy

Inheritance diagram for class TextAttrBorders:

Methods Summary

__init__	Default constructor.
Apply	Applies border to this object, but not if the same as compareWith.
CollectCommonAttributes	Collects the attributes that are common to a range of content, building up a note of which attributes are absent in some objects and which clash in some objects.
EqPartial	Partial equality test.
GetBottom
GetLeft
GetRight
GetTop
IsValid	Returns True if at least one border is valid.
RemoveStyle	Removes the specified attributes from this object.
Reset	Resets all borders.
SetColour	Sets colour of all borders.
SetStyle	Sets the style of all borders.
SetWidth	Sets the width of all borders.
__bool__
__nonzero__
__eq__	Equality operator.

Properties Summary

Bottom	See GetBottom
Left	See GetLeft
Right	See GetRight
Top	See GetTop
m_bottom	A public C++ attribute of type TextAttrBorder .
m_left	A public C++ attribute of type TextAttrBorder .
m_right	A public C++ attribute of type TextAttrBorder .
m_top	A public C++ attribute of type TextAttrBorder .

Class API

class wx.richtext.TextAttrBorders(object)

Possible constructors:

TextAttrBorders() -> None

A class representing a rich text object’s borders.

Methods

__init__(self)

Default constructor.

Return type:

None

---

Apply(self, borders: TextAttrBorders, compareWith: TextAttrBorders | None = None)

Applies border to this object, but not if the same as compareWith.

Parameters:

• borders (wx.richtext.TextAttrBorders)

• compareWith (wx.richtext.TextAttrBorders)

Return type:

bool

---

CollectCommonAttributes(self, attr: TextAttrBorders, clashingAttr: TextAttrBorders, absentAttr: TextAttrBorders)

Collects the attributes that are common to a range of content, building up a note of which attributes are absent in some objects and which clash in some objects.

Parameters:

• attr (wx.richtext.TextAttrBorders)

• clashingAttr (wx.richtext.TextAttrBorders)

• absentAttr (wx.richtext.TextAttrBorders)

Return type:

None

---

EqPartial(self, borders: TextAttrBorders, weakTest: bool = True)

Partial equality test.

If weakTest is True, attributes of this object do not have to be present if those attributes of borders are present. If weakTest is False, the function will fail if an attribute is present in borders but not in this object.

Parameters:

• borders (wx.richtext.TextAttrBorders)

• weakTest (bool)

Return type:

bool

---

GetBottom(self)

Return type:

wx.richtext.TextAttrBorder

---

GetLeft(self)

Return type:

wx.richtext.TextAttrBorder

---

GetRight(self)

Return type:

wx.richtext.TextAttrBorder

---

GetTop(self)

Return type:

wx.richtext.TextAttrBorder

---

IsValid(self)

Returns True if at least one border is valid.

Return type:

bool

---

RemoveStyle(self, attr: TextAttrBorders)

Removes the specified attributes from this object.

Parameters:

attr (wx.richtext.TextAttrBorders)

Return type:

bool

---

Reset(self)

Resets all borders.

Return type:

None

---

SetColour(self, *args, **kw)

Overloaded Implementations:

---

SetColour (self, colour : int)

Sets colour of all borders.

Parameters:

colour (long)

Return type:

None

---

SetColour (self, colour : Colour)

Sets the colour for all borders.

Parameters:

colour (wx.Colour)

Return type:

None

---

---

SetStyle(self, style: int)

Sets the style of all borders.

Parameters:

style (int)

Return type:

None

---

SetWidth(self, *args, **kw)

Sets the width of all borders.

Overloaded Implementations:

---

SetWidth (self, width : TextAttrDimension)

Parameters:

width (wx.richtext.TextAttrDimension)

Return type:

None

---

SetWidth (self, value : int, units: TextAttrUnits=TEXT_ATTR_UNITS_TENTHS_MM)

Parameters:

• value (int)

• units (TextAttrUnits)

Return type:

None

---

---

__bool__(self)

Return type:

int

---

__nonzero__(self)

Return type:

int

---

__eq__(self)

Equality operator.

Parameters:

borders (wx.richtext.TextAttrBorders)

Properties

Bottom

See GetBottom

---

Left

See GetLeft

---

Right

See GetRight

---

Top

See GetTop

---

m_bottom

A public C++ attribute of type TextAttrBorder .

---

m_left

A public C++ attribute of type TextAttrBorder .

---

m_right

A public C++ attribute of type TextAttrBorder .

---

m_top

A public C++ attribute of type TextAttrBorder .