wx.richtext.TextAttrDimension

A class representing a rich text dimension, including units and position.

See also

wx.richtext.RichTextAttr, wx.richtext.RichTextCtrl, wx.richtext.TextAttrDimensions

Class Hierarchy

Inheritance diagram for class TextAttrDimension:

Methods Summary

__init__	Default constructor.
Apply	Apply the dimension, but not those identical to compareWith if present.
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.
GetFlags	Gets the dimension flags.
GetPosition	Gets the position flags.
GetUnits	Gets the units of the dimension.
GetValue	Returns the integer value of the dimension.
GetValueMM	Returns the floating-pointing value of the dimension in mm.
IsValid	Returns True if the dimension is valid.
Reset	Resets the dimension value and flags.
SetFlags	Sets the dimension flags.
SetPosition	Sets the position flags.
SetUnits	Sets the units of the dimension.
SetValid	Sets the valid flag.
SetValue	Sets the integer value of the dimension.
SetValueMM	Sets the value of the dimension in mm.
__bool__
__nonzero__
__eq__	Equality operator.

Properties Summary

Flags	See GetFlags and SetFlags
Position	See GetPosition and SetPosition
Units	See GetUnits and SetUnits
Value	See GetValue and SetValue
ValueMM	See GetValueMM and SetValueMM
m_flags	A public C++ attribute of type TextAttrDimensionFlags .
m_value	A public C++ attribute of type int.

Class API

class wx.richtext.TextAttrDimension(object)

Possible constructors:

TextAttrDimension()

TextAttrDimension(value, units=TEXT_ATTR_UNITS_TENTHS_MM)

A class representing a rich text dimension, including units and position.

Methods

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self)

Default constructor.

---

__init__ (self, value, units=TEXT_ATTR_UNITS_TENTHS_MM)

Constructor taking value and units flag.

Parameters:

• value (int) –

• units (TextAttrUnits) –

---

---

Apply(self, dim, compareWith=None)

Apply the dimension, but not those identical to compareWith if present.

Parameters:

• dim (wx.richtext.TextAttrDimension) –

• compareWith (wx.richtext.TextAttrDimension) –

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

• clashingAttr (wx.richtext.TextAttrDimension) –

• absentAttr (wx.richtext.TextAttrDimension) –

---

EqPartial(self, dim, weakTest=True)

Partial equality test.

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

Parameters:

• dim (wx.richtext.TextAttrDimension) –

• weakTest (bool) –

Return type:

bool

---

GetFlags(self)

Gets the dimension flags.

Return type:

wx.richtext.TextAttrDimensionFlags

---

GetPosition(self)

Gets the position flags.

Return type:

wx.richtext.TextBoxAttrPosition

---

GetUnits(self)

Gets the units of the dimension.

Return type:

wx.richtext.TextAttrUnits

---

GetValue(self)

Returns the integer value of the dimension.

Return type:

int

---

GetValueMM(self)

Returns the floating-pointing value of the dimension in mm.

Return type:

float

---

IsValid(self)

Returns True if the dimension is valid.

Return type:

bool

---

Reset(self)

Resets the dimension value and flags.

---

SetFlags(self, flags)

Sets the dimension flags.

Parameters:

flags (wx.richtext.TextAttrDimensionFlags) –

---

SetPosition(self, pos)

Sets the position flags.

Parameters:

pos (TextBoxAttrPosition) –

---

SetUnits(self, units)

Sets the units of the dimension.

Parameters:

units (TextAttrUnits) –

---

SetValid(self, b)

Sets the valid flag.

Parameters:

b (bool) –

---

SetValue(self, *args, **kw)

Overloaded Implementations:

---

SetValue (self, value)

Sets the integer value of the dimension.

Parameters:

value (int) –

---

SetValue (self, value, flags)

Sets the integer value of the dimension, passing dimension flags.

Parameters:

• value (int) –

• flags (wx.richtext.TextAttrDimensionFlags) –

---

SetValue (self, dim)

Sets the dimension.

Parameters:

dim (wx.richtext.TextAttrDimension) –

---

---

SetValueMM(self, value)

Sets the value of the dimension in mm.

Parameters:

value (float) –

---

__bool__(self)

Return type:

int

---

__nonzero__(self)

Return type:

int

---

__eq__(self)

Equality operator.

Parameters:

dim (wx.richtext.TextAttrDimension) –

Properties

Flags

See GetFlags and SetFlags

---

Position

See GetPosition and SetPosition

---

Units

See GetUnits and SetUnits

---

Value

See GetValue and SetValue

---

ValueMM

See GetValueMM and SetValueMM

---

m_flags

A public C++ attribute of type TextAttrDimensionFlags .

---

m_value

A public C++ attribute of type int.