wx.richtext.RichTextDrawingHandler¶

The base class for custom drawing handlers.

Currently, drawing handlers can provide virtual attributes.

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="")

The base class for custom drawing handlers.

Methods¶

__init__(self, name="")¶

Creates a drawing handler object.

Parameters:	name (string) –

GetName(self)¶

Returns the name of the handler.

Return type:	`string`

GetVirtualAttributes(self, attr, obj)¶

Provides virtual attributes that we can provide.

Parameters:	attr (wx.richtext.RichTextAttr) – obj (wx.richtext.RichTextObject) –
Return type:	bool

GetVirtualSubobjectAttributes(self, obj, positions, attributes)¶

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)¶

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, text)¶

Gets the virtual text for this object.

Parameters:	obj (wx.richtext.RichTextPlainText) – text (string) –
Return type:	bool

HasVirtualAttributes(self, obj)¶

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

Parameters:	obj (wx.richtext.RichTextObject) –
Return type:	bool

HasVirtualText(self, obj)¶

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)¶

Sets the name of the handler.

Parameters:	name (string) –

Properties¶

Name¶: See GetName and SetName

Navigation