wx.richtext.TextAttrBorder¶

A class representing a rich text object border.

Class Hierarchy¶

Inheritance diagram for class TextAttrBorder:

Methods Summary¶

`__init__`	Default constructor.
`AddFlag`	Adds a border flag.
`Apply`	Applies the 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.
`GetColour`	Gets the colour.
`GetColourLong`	Gets the colour as a long.
`GetFlags`	Returns the border flags.
`GetStyle`	Gets the border style.
`GetWidth`	Gets the border width.
`HasColour`	True if the border has a valid colour.
`HasStyle`	True if the border has a valid style.
`HasWidth`	True if the border has a valid width.
`IsDefault`	True if the border has no attributes set.
`IsValid`	True if the border is valid.
`MakeValid`	Set the valid flag for this border.
`RemoveFlag`	Removes a border flag.
`RemoveStyle`	Removes the specified attributes from this object.
`Reset`	Resets the border style, colour, width and flags.
`SetColour`	Sets the border colour.
`SetFlags`	Sets the border flags.
`SetStyle`	Sets the border style.
`SetWidth`	Sets the border width.
`__nonzero__`
`__eq__`	Equality operator.

Properties Summary¶

`Colour`	See `GetColour` and `SetColour`
`ColourLong`	See `GetColourLong`
`Flags`	See `GetFlags` and `SetFlags`
`Style`	See `GetStyle` and `SetStyle`
`Width`	See `GetWidth` and `SetWidth`
`m_borderColour`	A public C++ attribute of type `long`.
`m_borderStyle`	A public C++ attribute of type `int`.
`m_borderWidth`	A public C++ attribute of type `TextAttrDimension` .
`m_flags`	A public C++ attribute of type `int`.

Class API¶

class wx.richtext.TextAttrBorder(object)¶

Possible constructors:

TextAttrBorder()

A class representing a rich text object border.

Methods¶

__init__(self)¶: Default constructor.

AddFlag(self, flag)¶

Adds a border flag.

Parameters:	flag (int) –

Apply(self, border, compareWith=None)¶

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

Parameters:	border (wx.richtext.TextAttrBorder) – compareWith (wx.richtext.TextAttrBorder) –
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.TextAttrBorder) – clashingAttr (wx.richtext.TextAttrBorder) – absentAttr (wx.richtext.TextAttrBorder) –

EqPartial(self, border, weakTest=True)¶

Partial equality test.

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

Parameters:	border (wx.richtext.TextAttrBorder) – weakTest (bool) –
Return type:	bool

GetColour(self)¶

Gets the colour.

Return type:	`Colour`

GetColourLong(self)¶

Gets the colour as a long.

Return type:	int

GetFlags(self)¶

Returns the border flags.

Return type:	int

GetStyle(self)¶

Gets the border style.

Return type:	int

GetWidth(self)¶

Gets the border width.

Return type:	wx.richtext.TextAttrDimension

HasColour(self)¶

True if the border has a valid colour.

Return type:	bool

HasStyle(self)¶

True if the border has a valid style.

Return type:	bool

HasWidth(self)¶

True if the border has a valid width.

Return type:	bool

IsDefault(self)¶

True if the border has no attributes set.

Return type:	bool

IsValid(self)¶

True if the border is valid.

Return type:	bool

MakeValid(self)¶: Set the valid flag for this border.

RemoveFlag(self, flag)¶

Removes a border flag.

Parameters:	flag (int) –

RemoveStyle(self, attr)¶

Removes the specified attributes from this object.

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

Reset(self)¶: Resets the border style, colour, width and flags.

SetColour(self, *args, **kw)¶

Sets the border colour.

Overloaded Implementations:

SetColour (self, colour)

Parameters:	colour (long) –

SetColour (self, colour)

Parameters:	colour (wx.Colour) –

SetFlags(self, flags)¶

Sets the border flags.

Parameters:	flags (int) –

SetStyle(self, style)¶

Sets the border style.

Parameters:	style (int) –

SetWidth(self, *args, **kw)¶

Sets the border width.

Overloaded Implementations:

SetWidth (self, width)

Parameters:	width (wx.richtext.TextAttrDimension) –

SetWidth (self, value, units=TEXT_ATTR_UNITS_TENTHS_MM)

Parameters:	value (int) – units (TextAttrUnits) –

__nonzero__(self)¶

Return type:	int

__eq__(self)¶

Equality operator.

Parameters:	border (wx.richtext.TextAttrBorder) –

Properties¶

Colour¶: See GetColour and SetColour

ColourLong¶: See GetColourLong

Flags¶: See GetFlags and SetFlags

Style¶: See GetStyle and SetStyle

Width¶: See GetWidth and SetWidth

m_borderColour¶: A public C++ attribute of type long.

m_borderStyle¶: A public C++ attribute of type int.

m_borderWidth¶: A public C++ attribute of type TextAttrDimension .

m_flags¶: A public C++ attribute of type int.

Navigation