wx.richtext.TextAttrBorders¶
A class representing a rich text object’s borders.
See also
wx.richtext.RichTextAttr, wx.richtext.RichTextCtrl, RichTextAttrBorder
Class Hierarchy¶
Methods Summary¶
Default constructor. |
|
Applies border to this object, but not if the same as compareWith. |
|
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. |
|
Partial equality test. |
|
Returns |
|
Removes the specified attributes from this object. |
|
Resets all borders. |
|
Sets colour of all borders. |
|
Sets the style of all borders. |
|
Sets the width of all borders. |
|
Equality operator. |
Properties Summary¶
See |
|
See |
|
See |
|
See |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
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, compareWith=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, 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:
attr (wx.richtext.TextAttrBorders)
clashingAttr (wx.richtext.TextAttrBorders)
absentAttr (wx.richtext.TextAttrBorders)
- Return type:
None
- EqPartial(self, borders, weakTest=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 isFalse
, 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:
- GetLeft(self)¶
- Return type:
- GetRight(self)¶
- Return type:
- GetTop(self)¶
- Return type:
- IsValid(self)¶
Returns
True
if at least one border is valid.- Return type:
bool
- RemoveStyle(self, attr)¶
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)¶
-
SetColour (self, colour)
Sets colour of all borders.
- Parameters:
colour (long)
- Return type:
None
SetColour (self, colour)
Sets the colour for all borders.
- Parameters:
colour (wx.Colour)
- Return type:
None
- SetStyle(self, style)¶
Sets the style of all borders.
- Parameters:
style (int)
- Return type:
None
- SetWidth(self, *args, **kw)¶
Sets the width of all borders.
SetWidth (self, width)
- Parameters:
width (wx.richtext.TextAttrDimension)
- Return type:
None
SetWidth (self, value, units=TEXT_ATTR_UNITS_TENTHS_MM)
- Parameters:
value (int)
units (TextAttrUnits)
- Return type:
None
- __bool__(self)¶
- Return type:
bool
- __nonzero__(self)¶
- Return type:
bool
- __eq__(self, borders)¶
Equality operator.
- Parameters:
borders (wx.richtext.TextAttrBorders)
- Return type:
bool
Properties¶
- 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
.