phoenix_title wx.richtext.TextAttrDimensions

A class for left, right, top and bottom dimensions.


class_hierarchy Class Hierarchy

Inheritance diagram for class TextAttrDimensions:

method_summary Methods Summary

__init__

Default constructor.

Apply

Apply to ‘this’, 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.

GetBottom

GetLeft

GetRight

GetTop

IsValid

Are all dimensions valid?

RemoveStyle

Remove specified attributes from this object.

Reset

Resets the value and flags for all dimensions.

__bool__

__nonzero__

__eq__

Equality operator.


property_summary Properties Summary

Bottom

See GetBottom

Left

See GetLeft

Right

See GetRight

Top

See GetTop

m_bottom

A public C++ attribute of type TextAttrDimension .

m_left

A public C++ attribute of type TextAttrDimension .

m_right

A public C++ attribute of type TextAttrDimension .

m_top

A public C++ attribute of type TextAttrDimension .


api Class API

class wx.richtext.TextAttrDimensions(object)

Possible constructors:

TextAttrDimensions()

A class for left, right, top and bottom dimensions.

__init__(self)

Default constructor.

Apply(self, dims, compareWith=None)

Apply to ‘this’, but not if the same as compareWith.

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
EqPartial(self, dims, weakTest=True)

Partial equality test.

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

Parameters
Return type

bool

GetBottom(self)
Return type

wx.richtext.TextAttrDimension

GetLeft(self)
Return type

wx.richtext.TextAttrDimension

GetRight(self)
Return type

wx.richtext.TextAttrDimension

GetTop(self)
Return type

wx.richtext.TextAttrDimension

IsValid(self)

Are all dimensions valid?

Return type

bool

RemoveStyle(self, attr)

Remove specified attributes from this object.

Parameters

attr (wx.richtext.TextAttrDimensions) –

Return type

bool

Reset(self)

Resets the value and flags for all dimensions.

__bool__(self)
Return type

int

__nonzero__(self)
Return type

int

__eq__(self)

Equality operator.

Parameters

dims (wx.richtext.TextAttrDimensions) –

Bottom

See GetBottom

Left

See GetLeft

Right

See GetRight

Top

See GetTop

m_bottom

A public C++ attribute of type TextAttrDimension .

m_left

A public C++ attribute of type TextAttrDimension .

m_right

A public C++ attribute of type TextAttrDimension .

m_top

A public C++ attribute of type TextAttrDimension .