wx.richtext.RichTextBox¶

This class implements a floating or inline text box, containing paragraphs.

Class Hierarchy¶

Inheritance diagram for class RichTextBox:

Known Subclasses¶

wx.richtext.RichTextCell, wx.richtext.RichTextTable

Methods Summary¶

`__init__`	Default constructor; optionally pass the parent object.
`CanEditProperties`	Returns `True` if we can edit the object’s properties via a GUI.
`Clone`	Clones the object.
`Copy`
`Draw`	Draw the item, within the given range.
`EditProperties`	Edits the object’s properties via a GUI.
`GetPropertiesMenuLabel`	Returns the label to be used for the properties context menu item.
`GetXMLNodeName`	Returns the `XML` node name of this object.

Properties Summary¶

`PropertiesMenuLabel`	See `GetPropertiesMenuLabel`
`XMLNodeName`	See `GetXMLNodeName`

Class API¶

class wx.richtext.RichTextBox(RichTextParagraphLayoutBox)¶

Possible constructors:

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

RichTextBox(obj : RichTextBox) -> None

This class implements a floating or inline text box, containing paragraphs.

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self, parent: Optional[RichTextObject]=None)

Default constructor; optionally pass the parent object.

Parameters:: parent (wx.richtext.RichTextObject)
Return type:: None

__init__ (self, obj : RichTextBox)

Copy constructor.

Parameters:: obj (wx.richtext.RichTextBox)
Return type:: None

CanEditProperties(self)¶

Returns True if we can edit the object’s properties via a GUI.

Return type:: bool

Clone(self)¶

Clones the object.

Return type:: wx.richtext.RichTextObject

Copy(self, obj: RichTextBox)¶

Parameters:: obj (wx.richtext.RichTextBox)
Return type:: None

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

EditProperties(self, parent: Window, buffer: RichTextBuffer)¶

Edits the object’s properties via a GUI.

Parameters:

parent (wx.Window)
buffer (wx.richtext.RichTextBuffer)

Return type:

bool

GetPropertiesMenuLabel(self)¶

Returns the label to be used for the properties context menu item.

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

Properties¶

PropertiesMenuLabel¶: See GetPropertiesMenuLabel

XMLNodeName¶: See GetXMLNodeName

Navigation