phoenix_title wx.richtext.RichTextBox

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


class_hierarchy Class Hierarchy

Inheritance diagram for class RichTextBox:

sub_classes Known Subclasses

wx.richtext.RichTextCell, wx.richtext.RichTextTable


method_summary 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.


property_summary Properties Summary

PropertiesMenuLabel

See GetPropertiesMenuLabel

XMLNodeName

See GetXMLNodeName


api Class API

class wx.richtext.RichTextBox(RichTextParagraphLayoutBox)

Possible constructors:

RichTextBox(parent=None) -> None

RichTextBox(obj) -> None

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


Methods

__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self, parent=None)

Default constructor; optionally pass the parent object.

Parameters:

parent (wx.richtext.RichTextObject)

Return type:

None



__init__ (self, obj)

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)
Parameters:

obj (wx.richtext.RichTextBox)

Return type:

None



Draw(self, dc, context, range, selection, rect, descent, style)

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:
Return type:

bool



EditProperties(self, parent, buffer)

Edits the object’s properties via a GUI.

Parameters:
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