Phoenix Logo

phoenix_title 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.


class_hierarchy Class Hierarchy

Inheritance diagram for class RichTextAttr:


method_summary 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.

property_summary Properties Summary

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

api Class API



class wx.richtext.RichTextAttr(TextAttr)

Possible constructors:

RichTextAttr(attr)

RichTextAttr(attr)

RichTextAttr()

A class representing enhanced attributes for rich text objects.


Methods



__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self, attr)

Constructor taking a wx.TextAttr.

Parameters:attr (wx.TextAttr) –



__init__ (self, attr)

Copy constructor.

Parameters:attr (wx.richtext.RichTextAttr) –



__init__ (self)

Default constructor.





Apply(self, style, compareWith=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:
Return type:

bool



CollectCommonAttributes(self, attr, clashingAttr, absentAttr)

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:


Copy(self, attr)

Copy function.

Parameters:attr (wx.richtext.RichTextAttr) –


EqPartial(self, attr, weakTest=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:
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)

Removes the specified attributes from this object.

Parameters:attr (wx.richtext.RichTextAttr) –
Return type:bool


SetTextBoxAttr(self, attr)

Set the text box attributes.

Parameters:attr (wx.richtext.TextBoxAttr) –


__eq__(self)

Equality test.

Parameters:attr (wx.richtext.RichTextAttr) –

Properties



TextBoxAttr

See GetTextBoxAttr and SetTextBoxAttr



m_textBoxAttr

A public C++ attribute of type TextBoxAttr .