wx.richtext.RichTextCompositeObject

Objects of this class can contain other objects.

See also

wx.richtext.RichTextObject, wx.richtext.RichTextBuffer, wx.richtext.RichTextCtrl

Class Hierarchy

Inheritance diagram for class RichTextCompositeObject:

Known Subclasses

wx.richtext.RichTextParagraph, wx.richtext.RichTextParagraphLayoutBox

Methods Summary

__init__
AppendChild	Appends a child, returning the position.
CalculateRange	Calculates the range of the object.
Copy
Defragment	Recursively merges all pieces that can be merged.
DeleteChildren	Deletes all the children.
DeleteRange	Deletes the given range.
FindPosition	Finds the absolute position and row height for the given character position.
GetChild	Returns the nth child.
GetChildAtPosition	Returns the child object at the given character position.
GetChildCount	Returns the number of children.
GetChildren	Returns the children.
GetRangeSize	Returns the object size for the given range.
GetTextForRange	Returns any text in this object for the given range.
HitTest	Hit-testing: returns a flag indicating hit test details, plus information about position.
InsertChild	Inserts the child in front of the given object, or at the beginning.
Invalidate	Invalidates the object at the given range.
IsAtomic	Returns True if no user editing can be done inside the object.
IsComposite	Returns True if this object is composite.
IsEmpty	Returns True if the buffer is empty.
Move	Moves the object recursively, by adding the offset from old to new.
RemoveChild	Removes and optionally deletes the specified child.

Properties Summary

ChildCount	See GetChildCount
Children	See GetChildren

Class API

class wx.richtext.RichTextCompositeObject(RichTextObject)

Possible constructors:

RichTextCompositeObject(parent: Optional[RichTextObject]=None) -> None

Objects of this class can contain other objects.

Methods

__init__(self, parent: RichTextObject | None = None)

Parameters:

parent (wx.richtext.RichTextObject)

Return type:

None

---

AppendChild(self, child: RichTextObject)

Appends a child, returning the position.

Parameters:

child (wx.richtext.RichTextObject)

Return type:

int

---

CalculateRange(self, start: int)

Calculates the range of the object.

By default, guess that the object is 1 unit long.

Parameters:

start (long)

Return type:

int

---

Copy(self, obj: RichTextCompositeObject)

Parameters:

obj (wx.richtext.RichTextCompositeObject)

Return type:

None

---

Defragment(self, context: RichTextDrawingContext, range: RichTextRange = RICHTEXT_ALL)

Recursively merges all pieces that can be merged.

Parameters:

• context (wx.richtext.RichTextDrawingContext)

• range (wx.richtext.RichTextRange)

Return type:

bool

---

DeleteChildren(self)

Deletes all the children.

Return type:

bool

---

DeleteRange(self, range: RichTextRange)

Deletes the given range.

Parameters:

range (wx.richtext.RichTextRange)

Return type:

bool

---

FindPosition(self, dc: DC, context: RichTextDrawingContext, index: int, forceLineStart: bool)

Finds the absolute position and row height for the given character position.

Parameters:

• dc (wx.DC)

• context (wx.richtext.RichTextDrawingContext)

• index (long)

• forceLineStart (bool)

Return type:

le[bool, wx.Point, int]

---

GetChild(self, n: int)

Returns the nth child.

Parameters:

n (int)

Return type:

wx.richtext.RichTextObject

---

GetChildAtPosition(self, pos: int)

Returns the child object at the given character position.

Parameters:

pos (long)

Return type:

wx.richtext.RichTextObject

---

GetChildCount(self)

Returns the number of children.

Return type:

int

---

GetChildren(self)

Returns the children.

Return type:

RichTextObjectList

---

GetRangeSize(self, range: RichTextRange, size: Size, descent: int, dc: DC, context: RichTextDrawingContext, flags: int, position: Point = Point(0, 0), parentSize: Size = DefaultSize, partialExtents: List[int] | None = None)

Returns the object size for the given range.

Returns False if the range is invalid for this object.

Parameters:

• range (wx.richtext.RichTextRange)

• size (wx.Size)

• descent (int)

• dc (wx.DC)

• context (wx.richtext.RichTextDrawingContext)

• flags (int)

• position (wx.Point)

• parentSize (wx.Size)

• partialExtents (list of integers)

Return type:

bool

---

GetTextForRange(self, range: RichTextRange)

Returns any text in this object for the given range.

Parameters:

range (wx.richtext.RichTextRange)

Return type:

str

---

HitTest(self, dc: DC, context: RichTextDrawingContext, pt: Point, flags: int = 0)

Hit-testing: returns a flag indicating hit test details, plus information about position.

contextObj is returned to specify what object position is relevant to, since otherwise there’s an ambiguity. @ obj might not be a child of contextObj, since we may be referring to the container itself if we have no hit on a child - for example if we click outside an object.

The function puts the position in textPosition if one is found. pt is in logical units (a zero y position is at the beginning of the buffer).

Parameters:

• dc (wx.DC)

• context (wx.richtext.RichTextDrawingContext)

• pt (wx.Point)

• flags (int)

Return type:

Tuple[int, int, RichTextObject, RichTextObject]

Returns:

One of the wx.richtext.RichTextHitTestFlags values.

---

InsertChild(self, child: RichTextObject, inFrontOf: RichTextObject)

Inserts the child in front of the given object, or at the beginning.

Parameters:

• child (wx.richtext.RichTextObject)

• inFrontOf (wx.richtext.RichTextObject)

Return type:

bool

---

Invalidate(self, invalidRange: RichTextRange = RICHTEXT_ALL)

Invalidates the object at the given range.

With no argument, invalidates the whole object.

Parameters:

invalidRange (wx.richtext.RichTextRange)

Return type:

None

---

IsAtomic(self)

Returns True if no user editing can be done inside the object.

This returns True for simple objects, False for most composite objects, but True for fields, which if composite, should not be user-edited.

Return type:

bool

---

IsComposite(self)

Returns True if this object is composite.

Return type:

bool

---

IsEmpty(self)

Returns True if the buffer is empty.

Return type:

bool

---

Move(self, pt: Point)

Moves the object recursively, by adding the offset from old to new.

Parameters:

pt (wx.Point)

Return type:

None

---

RemoveChild(self, child: RichTextObject, deleteChild: bool = False)

Removes and optionally deletes the specified child.

Parameters:

• child (wx.richtext.RichTextObject)

• deleteChild (bool)

Return type:

bool

Properties

ChildCount

See GetChildCount

---

Children

See GetChildren