wx.richtext.TextAttrSize

A class for representing width and height.

See also

wx.richtext.RichTextAttr, wx.richtext.RichTextCtrl, wx.richtext.TextAttrDimension

Class Hierarchy

Inheritance diagram for class TextAttrSize:

Methods Summary

__init__	Default constructor.
Apply	Apply 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.
GetHeight	Gets the height.
GetWidth	Returns the width.
IsValid	Is the size valid?
RemoveStyle	Removes the specified attributes from this object.
Reset	Resets the width and height dimensions.
SetHeight	Sets the height.
SetWidth	Sets the width.
__bool__
__nonzero__
__eq__	Equality operator.

Properties Summary

Height	See GetHeight and SetHeight
Width	See GetWidth and SetWidth
m_height	A public C++ attribute of type TextAttrDimension .
m_width	A public C++ attribute of type TextAttrDimension .

Class API

class wx.richtext.TextAttrSize(object)

Possible constructors:

TextAttrSize()

A class for representing width and height.

Methods

__init__(self)

Default constructor.

---

Apply(self, dims, compareWith=None)

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

Parameters:

• dims (wx.richtext.TextAttrSize) –

• compareWith (wx.richtext.TextAttrSize) –

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.TextAttrSize) –

• clashingAttr (wx.richtext.TextAttrSize) –

• absentAttr (wx.richtext.TextAttrSize) –

---

EqPartial(self, size, weakTest=True)

Partial equality test.

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

Parameters:

• size (wx.richtext.TextAttrSize) –

• weakTest (bool) –

Return type:

bool

---

GetHeight(self)

Gets the height.

Return type:

wx.richtext.TextAttrDimension

---

GetWidth(self)

Returns the width.

Return type:

wx.richtext.TextAttrDimension

---

IsValid(self)

Is the size valid?

Return type:

bool

---

RemoveStyle(self, attr)

Removes the specified attributes from this object.

Parameters:

attr (wx.richtext.TextAttrSize) –

Return type:

bool

---

Reset(self)

Resets the width and height dimensions.

---

SetHeight(self, *args, **kw)

Sets the height.

Overloaded Implementations:

---

SetHeight (self, value, flags)

Parameters:

• value (int) –

• flags (wx.richtext.TextAttrDimensionFlags) –

---

SetHeight (self, dim)

Parameters:

dim (wx.richtext.TextAttrDimension) –

---

---

SetWidth(self, *args, **kw)

Sets the width.

Overloaded Implementations:

---

SetWidth (self, value, flags)

Parameters:

• value (int) –

• flags (wx.richtext.TextAttrDimensionFlags) –

---

SetWidth (self, dim)

Parameters:

dim (wx.richtext.TextAttrDimension) –

---

---

__bool__(self)

Return type:

int

---

__nonzero__(self)

Return type:

int

---

__eq__(self)

Equality operator.

Parameters:

size (wx.richtext.TextAttrSize) –

Properties

Height

See GetHeight and SetHeight

---

Width

See GetWidth and SetWidth

---

m_height

A public C++ attribute of type TextAttrDimension .

---

m_width

A public C++ attribute of type TextAttrDimension .