wx.richtext.RichTextDrawingContext¶

A class for passing information to drawing and measuring functions.

Class Hierarchy¶

Inheritance diagram for class RichTextDrawingContext:

Inheritance diagram of RichTextDrawingContext

Methods Summary¶

`__init__`	Pass the buffer to the context so the context can retrieve information such as virtual attributes.
`ApplyVirtualAttributes`	Applies any virtual attributes relevant to this object.
`EnableDelayedImageLoading`	Enable or disable delayed image loading.
`EnableImages`	Enable or disable images.
`EnableVirtualAttributes`	Enables virtual attribute processing.
`GetDelayedImageLoading`	Returns `True` if delayed image loading is enabled.
`GetImagesEnabled`	Returns `True` if images are enabled.
`GetLayingOut`	Returns `True` if laying out.
`GetVirtualAttributes`	Returns the virtual attributes for this object.
`GetVirtualAttributesEnabled`	Returns `True` if virtual attribute processing is enabled.
`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`	Does this object have virtual attributes? Virtual attributes can be provided for visual cues without affecting the actual styling.
`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.
`Init`
`SetLayingOut`	Set laying out flag.

Properties Summary¶

`DelayedImageLoading`	See `GetDelayedImageLoading`
`ImagesEnabled`	See `GetImagesEnabled`
`LayingOut`	See `GetLayingOut` and `SetLayingOut`
`VirtualAttributesEnabled`	See `GetVirtualAttributesEnabled`
`m_buffer`	A public C++ attribute of type `RichTextBuffer` .
`m_enableDelayedImageLoading`	A public C++ attribute of type `bool`.
`m_enableImages`	A public C++ attribute of type `bool`.
`m_enableVirtualAttributes`	A public C++ attribute of type `bool`.
`m_layingOut`	A public C++ attribute of type `bool`.

Class API¶

class wx.richtext.RichTextDrawingContext(Object)¶

Possible constructors:

RichTextDrawingContext(buffer) -> None

A class for passing information to drawing and measuring functions.

Methods¶

__init__(self, buffer)¶

Pass the buffer to the context so the context can retrieve information such as virtual attributes.

Parameters:: buffer (wx.richtext.RichTextBuffer)
Return type:: None

ApplyVirtualAttributes(self, attr, obj)¶

Applies any virtual attributes relevant to this object.

Parameters:

attr (wx.richtext.RichTextAttr)
obj (wx.richtext.RichTextObject)

Return type:

bool

EnableDelayedImageLoading(self, b)¶

Enable or disable delayed image loading.

Parameters:: b (bool)
Return type:: None

EnableImages(self, b)¶

Enable or disable images.

Parameters:: b (bool)
Return type:: None

EnableVirtualAttributes(self, b)¶

Enables virtual attribute processing.

Parameters:: b (bool)
Return type:: None

GetDelayedImageLoading(self)¶

Returns True if delayed image loading is enabled.

Return type:: bool

GetImagesEnabled(self)¶

Returns True if images are enabled.

Return type:: bool

GetLayingOut(self)¶

Returns True if laying out.

Return type:: bool

GetVirtualAttributes(self, obj)¶

Returns the virtual attributes for this object.

Virtual attributes can be provided for visual cues without affecting the actual styling.

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

GetVirtualAttributesEnabled(self)¶

Returns True if virtual attribute processing is enabled.

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. The function is passed the count returned by GetVirtualSubobjectAttributesCount.

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

Does this object have virtual attributes? Virtual attributes can be provided for visual cues without affecting the actual styling.

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

Init(self)¶

Return type:: None

SetLayingOut(self, b)¶

Set laying out flag.

Parameters:: b (bool)
Return type:: None

Properties¶

DelayedImageLoading¶: See GetDelayedImageLoading

ImagesEnabled¶: See GetImagesEnabled

LayingOut¶: See GetLayingOut and SetLayingOut

VirtualAttributesEnabled¶: See GetVirtualAttributesEnabled

m_buffer¶: A public C++ attribute of type RichTextBuffer .

m_enableDelayedImageLoading¶: A public C++ attribute of type bool.

m_enableImages¶: A public C++ attribute of type bool.

m_enableVirtualAttributes¶: A public C++ attribute of type bool.

m_layingOut¶: A public C++ attribute of type bool.

wx.richtext.RichTextDrawingContext¶

Class Hierarchy¶

Methods Summary¶

Properties Summary¶

Class API¶

Methods¶

Properties¶

Table of Contents

This Page