wx.richtext.TextAttrShadow

A class representing a shadow.

See also

wx.richtext.RichTextAttr, wx.richtext.RichTextCtrl

Class Hierarchy

Inheritance diagram for class TextAttrShadow:

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.
GetBlurDistance	Gets the shadow blur distance.
GetColour	Gets the colour.
GetColourLong	Gets the colour as a long.
GetFlags	Returns the border flags.
GetOffsetX	Gets the shadow horizontal offset.
GetOffsetY	Gets the shadow vertical offset.
GetOpacity	Gets the shadow opacity.
GetSpread	Gets the shadow spread size.
HasColour	True if the shadow has a valid colour.
IsDefault	True if the shadow has no attributes set.
IsValid	Returns True if the dimension is valid.
RemoveFlag	Removes a border flag.
RemoveStyle	Removes the specified attributes from this object.
Reset	Resets the shadow.
SetBlurDistance	Sets the shadow blur distance.
SetColour	Sets the shadow colour.
SetFlags	Sets the border flags.
SetOffsetX	Sets the shadow horizontal offset.
SetOffsetY	Sets the shadow vertical offset.
SetOpacity	Sets the shadow opacity.
SetSpread	Sets the shadow spread size.
SetValid	Sets the valid flag.
__eq__	Equality operator.

Properties Summary

BlurDistance	See GetBlurDistance and SetBlurDistance
Colour	See GetColour and SetColour
ColourLong	See GetColourLong
Flags	See GetFlags and SetFlags
OffsetX	See GetOffsetX and SetOffsetX
OffsetY	See GetOffsetY and SetOffsetY
Opacity	See GetOpacity and SetOpacity
Spread	See GetSpread and SetSpread
m_blurDistance	A public C++ attribute of type TextAttrDimension .
m_flags	A public C++ attribute of type int.
m_offsetX	A public C++ attribute of type TextAttrDimension .
m_offsetY	A public C++ attribute of type TextAttrDimension .
m_opacity	A public C++ attribute of type TextAttrDimension .
m_shadowColour	A public C++ attribute of type long.
m_spread	A public C++ attribute of type TextAttrDimension .

Class API

class wx.richtext.TextAttrShadow(object)

Possible constructors:

TextAttrShadow() -> None

A class representing a shadow.

Methods

__init__(self)

Default constructor.

Return type:

None

---

AddFlag(self, flag: int)

Adds a border flag.

Parameters:

flag (int)

Return type:

None

---

Apply(self, shadow: TextAttrShadow, compareWith: TextAttrShadow | None = None)

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

Parameters:

• shadow (wx.richtext.TextAttrShadow)

• compareWith (wx.richtext.TextAttrShadow)

Return type:

bool

---

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

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

• clashingAttr (wx.richtext.TextAttrShadow)

• absentAttr (wx.richtext.TextAttrShadow)

Return type:

None

---

EqPartial(self, shadow: TextAttrShadow, weakTest: bool = 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:

• shadow (wx.richtext.TextAttrShadow)

• weakTest (bool)

Return type:

bool

---

GetBlurDistance(self)

Gets the shadow blur distance.

Return type:

wx.richtext.TextAttrDimension

---

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

---

GetOffsetX(self)

Gets the shadow horizontal offset.

Return type:

wx.richtext.TextAttrDimension

---

GetOffsetY(self)

Gets the shadow vertical offset.

Return type:

wx.richtext.TextAttrDimension

---

GetOpacity(self)

Gets the shadow opacity.

Return type:

wx.richtext.TextAttrDimension

---

GetSpread(self)

Gets the shadow spread size.

Return type:

wx.richtext.TextAttrDimension

---

HasColour(self)

True if the shadow has a valid colour.

Return type:

bool

---

IsDefault(self)

True if the shadow has no attributes set.

Return type:

bool

---

IsValid(self)

Returns True if the dimension is valid.

Return type:

bool

---

RemoveFlag(self, flag: int)

Removes a border flag.

Parameters:

flag (int)

Return type:

None

---

RemoveStyle(self, attr: TextAttrShadow)

Removes the specified attributes from this object.

Parameters:

attr (wx.richtext.TextAttrShadow)

Return type:

bool

---

Reset(self)

Resets the shadow.

Return type:

None

---

SetBlurDistance(self, blur: TextAttrDimension)

Sets the shadow blur distance.

Parameters:

blur (wx.richtext.TextAttrDimension)

Return type:

None

---

SetColour(self, *args, **kw)

Sets the shadow colour.

Overloaded Implementations:

---

SetColour (self, colour : int)

Parameters:

colour (long)

Return type:

None

---

SetColour (self, colour : Colour)

Parameters:

colour (wx.Colour)

Return type:

None

---

---

SetFlags(self, flags: int)

Sets the border flags.

Parameters:

flags (int)

Return type:

None

---

SetOffsetX(self, offset: TextAttrDimension)

Sets the shadow horizontal offset.

Parameters:

offset (wx.richtext.TextAttrDimension)

Return type:

None

---

SetOffsetY(self, offset: TextAttrDimension)

Sets the shadow vertical offset.

Parameters:

offset (wx.richtext.TextAttrDimension)

Return type:

None

---

SetOpacity(self, opacity: TextAttrDimension)

Sets the shadow opacity.

Parameters:

opacity (wx.richtext.TextAttrDimension)

Return type:

None

---

SetSpread(self, spread: TextAttrDimension)

Sets the shadow spread size.

Parameters:

spread (wx.richtext.TextAttrDimension)

Return type:

None

---

SetValid(self, b: bool)

Sets the valid flag.

Parameters:

b (bool)

Return type:

None

---

__eq__(self)

Equality operator.

Parameters:

shadow (wx.richtext.TextAttrShadow)

Properties

BlurDistance

See GetBlurDistance and SetBlurDistance

---

Colour

See GetColour and SetColour

---

ColourLong

See GetColourLong

---

Flags

See GetFlags and SetFlags

---

OffsetX

See GetOffsetX and SetOffsetX

---

OffsetY

See GetOffsetY and SetOffsetY

---

Opacity

See GetOpacity and SetOpacity

---

Spread

See GetSpread and SetSpread

---

m_blurDistance

A public C++ attribute of type TextAttrDimension .

---

m_flags

A public C++ attribute of type int.

---

m_offsetX

A public C++ attribute of type TextAttrDimension .

---

m_offsetY

A public C++ attribute of type TextAttrDimension .

---

m_opacity

A public C++ attribute of type TextAttrDimension .

---

m_shadowColour

A public C++ attribute of type long.

---

m_spread

A public C++ attribute of type TextAttrDimension .