wx.richtext.RichTextPlainText

This object represents a single piece of text.

See also

wx.richtext.RichTextBuffer, wx.richtext.RichTextCtrl

Class Hierarchy

Inheritance diagram for class RichTextPlainText:

Methods Summary

__init__	Constructor.
CalculateRange	Calculates the range of the object.
CanMerge	Returns True if this object can merge itself with the given one.
CanSplit	Returns True if this object can potentially be split, by virtue of having different virtual attributes for individual sub-objects.
Clone	Clones the object.
Copy
DeleteRange	Deletes the given range.
DoSplit	Do a split from pos, returning an object containing the second part, and setting the first part in ‘this’.
Draw	Draw the item, within the given range.
GetFirstLineBreakPosition	Get the first position from pos that has a line break character.
GetRangeSize	Returns the object size for the given range.
GetText	Returns the text.
GetTextForRange	Returns any text in this object for the given range.
GetXMLNodeName	Returns the XML node name of this object.
ImportFromXML	Imports this object from XML.
IsEmpty	Returns True if the object is empty.
Layout	Lay the item out at the specified position with the given size constraint.
Merge	Returns True if this object merged itself with the given one.
SetText	Sets the text.
Split	Returns the final object in the split objects if this object was split due to differences between sub-object virtual attributes.
UsesParagraphAttributes	Does this object take note of paragraph attributes? Text and image objects don’t.

Properties Summary

Text	See GetText and SetText
XMLNodeName	See GetXMLNodeName

Class API

class wx.richtext.RichTextPlainText(RichTextObject)

Possible constructors:

RichTextPlainText(text: str='', parent: Optional[RichTextObject]=None,
                  style: Optional[RichTextAttr]=None) -> None

RichTextPlainText(obj : RichTextPlainText) -> None

This object represents a single piece of text.

Methods

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self, text: str=’’, parent: Optional[RichTextObject]=None, style: Optional[RichTextAttr]=None)

Constructor.

Parameters:

• text (string)

• parent (wx.richtext.RichTextObject)

• style (wx.richtext.RichTextAttr)

Return type:

None

---

__init__ (self, obj : RichTextPlainText)

Copy constructor.

Parameters:

obj (wx.richtext.RichTextPlainText)

Return type:

None

---

---

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

---

CanMerge(self, object: RichTextObject, context: RichTextDrawingContext)

Returns True if this object can merge itself with the given one.

Parameters:

• object (wx.richtext.RichTextObject)

• context (wx.richtext.RichTextDrawingContext)

Return type:

bool

---

CanSplit(self, context: RichTextDrawingContext)

Returns True if this object can potentially be split, by virtue of having different virtual attributes for individual sub-objects.

Parameters:

context (wx.richtext.RichTextDrawingContext)

Return type:

bool

---

Clone(self)

Clones the object.

Return type:

wx.richtext.RichTextObject

---

Copy(self, obj: RichTextPlainText)

Parameters:

obj (wx.richtext.RichTextPlainText)

Return type:

None

---

DeleteRange(self, range: RichTextRange)

Deletes the given range.

Parameters:

range (wx.richtext.RichTextRange)

Return type:

bool

---

DoSplit(self, pos: int)

Do a split from pos, returning an object containing the second part, and setting the first part in ‘this’.

Parameters:

pos (long)

Return type:

wx.richtext.RichTextObject

---

Draw(self, dc: DC, context: RichTextDrawingContext, range: RichTextRange, selection: RichTextSelection, rect: Rect, descent: int, style: int)

Draw the item, within the given range.

Some objects may ignore the range (for example paragraphs) while others must obey it (lines, to implement wrapping)

Parameters:

• dc (wx.DC)

• context (wx.richtext.RichTextDrawingContext)

• range (wx.richtext.RichTextRange)

• selection (wx.richtext.RichTextSelection)

• rect (wx.Rect)

• descent (int)

• style (int)

Return type:

bool

---

GetFirstLineBreakPosition(self, pos: int)

Get the first position from pos that has a line break character.

Parameters:

pos (long)

Return type:

int

---

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

---

GetText(self)

Returns the text.

Return type:

str

---

GetTextForRange(self, range: RichTextRange)

Returns any text in this object for the given range.

Parameters:

range (wx.richtext.RichTextRange)

Return type:

str

---

GetXMLNodeName(self)

Returns the XML node name of this object.

This must be overridden for XmlNode-base XML export to work.

Return type:

str

---

ImportFromXML(self, buffer: RichTextBuffer, node: XmlNode, handler: RichTextXMLHandler, recurse: bool)

Imports this object from XML.

Parameters:

• buffer (wx.richtext.RichTextBuffer)

• node (wx.xml.XmlNode)

• handler (wx.richtext.RichTextXMLHandler)

• recurse (bool)

Return type:

bool

---

IsEmpty(self)

Returns True if the object is empty.

Return type:

bool

---

Layout(self, dc: DC, context: RichTextDrawingContext, rect: Rect, parentRect: Rect, style: int)

Lay the item out at the specified position with the given size constraint.

Layout must set the cached size. rect is the available space for the object, and parentRect is the container that is used to determine a relative size or position (for example if a text box must be 50% of the parent text box).

Parameters:

• dc (wx.DC)

• context (wx.richtext.RichTextDrawingContext)

• rect (wx.Rect)

• parentRect (wx.Rect)

• style (int)

Return type:

bool

---

Merge(self, object: RichTextObject, context: RichTextDrawingContext)

Returns True if this object merged itself with the given one.

The calling code will then delete the given object.

Parameters:

• object (wx.richtext.RichTextObject)

• context (wx.richtext.RichTextDrawingContext)

Return type:

bool

---

SetText(self, text: str)

Sets the text.

Parameters:

text (string)

Return type:

None

---

Split(self, context: RichTextDrawingContext)

Returns the final object in the split objects if this object was split due to differences between sub-object virtual attributes.

Returns itself if it was not split.

Parameters:

context (wx.richtext.RichTextDrawingContext)

Return type:

wx.richtext.RichTextObject

---

UsesParagraphAttributes(self)

Does this object take note of paragraph attributes? Text and image objects don’t.

Return type:

bool

Properties

Text

See GetText and SetText

---

XMLNodeName

See GetXMLNodeName