wx.richtext.RichTextAttr

A class representing enhanced attributes for rich text objects.

This adds a wx.richtext.TextBoxAttr member to the basic wx.TextAttr class.

See also

wx.TextAttr, wx.richtext.TextBoxAttr, wx.richtext.RichTextCtrl

Class Hierarchy

Inheritance diagram for class RichTextAttr:

Methods Summary

__init__	Constructor taking a wx.TextAttr.
Apply	Merges the given attributes.
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.
Copy	Copy function.
EqPartial	Partial equality test.
GetTextBoxAttr	Returns the text box attributes.
IsDefault	Returns True if no attributes are set.
RemoveStyle	Removes the specified attributes from this object.
SetTextBoxAttr	Set the text box attributes.
__eq__	Equality test.

Properties Summary

TextBoxAttr	See GetTextBoxAttr and SetTextBoxAttr
m_textBoxAttr	A public C++ attribute of type TextBoxAttr .

Class API

class wx.richtext.RichTextAttr(TextAttr)

Possible constructors:

RichTextAttr(attr : TextAttr) -> None

RichTextAttr(attr : RichTextAttr) -> None

RichTextAttr() -> None

A class representing enhanced attributes for rich text objects.

Methods

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self, attr : TextAttr)

Constructor taking a wx.TextAttr.

Parameters:

attr (wx.TextAttr)

Return type:

None

---

__init__ (self, attr : RichTextAttr)

Copy constructor.

Parameters:

attr (wx.richtext.RichTextAttr)

Return type:

None

---

__init__ (self)

Default constructor.

Return type:

None

---

---

Apply(self, style: RichTextAttr, compareWith: RichTextAttr | None = None)

Merges the given attributes.

If compareWith is not None, then it will be used to mask out those attributes that are the same in style and compareWith, for situations where we don’t want to explicitly set inherited attributes.

Parameters:

• style (wx.richtext.RichTextAttr)

• compareWith (wx.richtext.RichTextAttr)

Return type:

bool

---

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

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.RichTextAttr)

• clashingAttr (wx.richtext.RichTextAttr)

• absentAttr (wx.richtext.RichTextAttr)

Return type:

None

---

Copy(self, attr: RichTextAttr)

Copy function.

Parameters:

attr (wx.richtext.RichTextAttr)

Return type:

None

---

EqPartial(self, attr: RichTextAttr, weakTest: bool = True)

Partial equality test.

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

Parameters:

• attr (wx.richtext.RichTextAttr)

• weakTest (bool)

Return type:

bool

---

GetTextBoxAttr(self)

Returns the text box attributes.

Return type:

wx.richtext.TextBoxAttr

---

IsDefault(self)

Returns True if no attributes are set.

Return type:

bool

---

RemoveStyle(self, attr: RichTextAttr)

Removes the specified attributes from this object.

Parameters:

attr (wx.richtext.RichTextAttr)

Return type:

bool

---

SetTextBoxAttr(self, attr: TextBoxAttr)

Set the text box attributes.

Parameters:

attr (wx.richtext.TextBoxAttr)

Return type:

None

---

__eq__(self)

Equality test.

Parameters:

attr (wx.richtext.RichTextAttr)

Properties

TextBoxAttr

See GetTextBoxAttr and SetTextBoxAttr

---

m_textBoxAttr

A public C++ attribute of type TextBoxAttr .