wx.richtext.RichTextDrawingHandler

The base class for custom drawing handlers.

Currently, drawing handlers can provide virtual attributes.

See also

wx.richtext.RichTextBuffer, wx.richtext.RichTextCtrl

Class Hierarchy

Inheritance diagram for class RichTextDrawingHandler:

Methods Summary

__init__	Creates a drawing handler object.
GetName	Returns the name of the handler.
GetVirtualAttributes	Provides virtual attributes that we can provide.
GetVirtualSubobjectAttributes	Gets the mixed virtual attributes for individual positions within the object.
GetVirtualSubobjectAttributesCount	Gets the count for mixed virtual attributes for individual positions within the object.
GetVirtualText	Gets the virtual text for this object.
HasVirtualAttributes	Returns True if this object has virtual attributes that we can provide.
HasVirtualText	Do we have virtual text for this object? Virtual text allows an application to replace characters in an object for editing and display purposes, for example for highlighting special characters.
SetName	Sets the name of the handler.

Properties Summary

Name	See GetName and SetName

Class API

class wx.richtext.RichTextDrawingHandler(Object)

Possible constructors:

RichTextDrawingHandler(name: str='') -> None

The base class for custom drawing handlers.

Methods

__init__(self, name: str='')

Creates a drawing handler object.

Parameters:

name (string) –

Return type:

None

---

GetName(self)

Returns the name of the handler.

Return type:

str

---

GetVirtualAttributes(self, attr : RichTextAttr, obj : RichTextObject)

Provides virtual attributes that we can provide.

Parameters:

• attr (wx.richtext.RichTextAttr) –

• obj (wx.richtext.RichTextObject) –

Return type:

bool

---

GetVirtualSubobjectAttributes(self, obj : RichTextObject, positions : List[int], attributes : RichTextAttrArray)

Gets the mixed virtual attributes for individual positions within the object.

For example, individual characters within a text object may require special highlighting. Returns the number of virtual attributes found.

Parameters:

• obj (wx.richtext.RichTextObject) –

• positions (list of integers) –

• attributes (RichTextAttrArray) –

Return type:

int

---

GetVirtualSubobjectAttributesCount(self, obj : RichTextObject)

Gets the count for mixed virtual attributes for individual positions within the object.

For example, individual characters within a text object may require special highlighting.

Parameters:

obj (wx.richtext.RichTextObject) –

Return type:

int

---

GetVirtualText(self, obj : RichTextPlainText, text : str)

Gets the virtual text for this object.

Parameters:

• obj (wx.richtext.RichTextPlainText) –

• text (string) –

Return type:

bool

---

HasVirtualAttributes(self, obj : RichTextObject)

Returns True if this object has virtual attributes that we can provide.

Parameters:

obj (wx.richtext.RichTextObject) –

Return type:

bool

---

HasVirtualText(self, obj : RichTextPlainText)

Do we have virtual text for this object? Virtual text allows an application to replace characters in an object for editing and display purposes, for example for highlighting special characters.

Parameters:

obj (wx.richtext.RichTextPlainText) –

Return type:

bool

---

SetName(self, name : str)

Sets the name of the handler.

Parameters:

name (string) –

Return type:

None

Properties

Name

See GetName and SetName