wx.richtext.RichTextDrawingContext¶A class for passing information to drawing and measuring functions.
See also
wx.richtext.RichTextBuffer, wx.richtext.RichTextCtrl
Class Hierarchy¶
Inheritance diagram for class RichTextDrawingContext:
Methods Summary¶Pass the buffer to the context so the context can retrieve information such as virtual attributes. |
|
Applies any virtual attributes relevant to this object. |
|
Enable or disable delayed image loading. |
|
Enable or disable images. |
|
Enables virtual attribute processing. |
|
Returns |
|
Returns |
|
Returns |
|
Returns the virtual attributes for this object. |
|
Returns |
|
Gets the mixed virtual attributes for individual positions within the object. |
|
Gets the count for mixed virtual attributes for individual positions within the object. |
|
Gets the virtual text for this object. |
|
Does this object have virtual attributes? Virtual attributes can be provided for visual cues without affecting the actual styling. |
|
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. |
|
Set laying out flag. |
Properties Summary¶See |
|
See |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
Class API¶wx.richtext.RichTextDrawingContext(Object)¶Possible constructors:
RichTextDrawingContext(buffer : RichTextBuffer) -> None
A class for passing information to drawing and measuring functions.
__init__(self, buffer : RichTextBuffer)¶Pass the buffer to the context so the context can retrieve information such as virtual attributes.
buffer (wx.richtext.RichTextBuffer) –
None
ApplyVirtualAttributes(self, attr : RichTextAttr, obj : RichTextObject)¶Applies any virtual attributes relevant to this object.
attr (wx.richtext.RichTextAttr) –
obj (wx.richtext.RichTextObject) –
bool
EnableDelayedImageLoading(self, b : bool)¶Enable or disable delayed image loading.
b (bool) –
None
EnableImages(self, b : bool)¶Enable or disable images.
b (bool) –
None
EnableVirtualAttributes(self, b : bool)¶Enables virtual attribute processing.
b (bool) –
None
GetDelayedImageLoading(self)¶Returns True if delayed image loading is enabled.
bool
GetImagesEnabled(self)¶Returns True if images are enabled.
bool
GetLayingOut(self)¶Returns True if laying out.
bool
GetVirtualAttributes(self, obj : RichTextObject)¶Returns the virtual attributes for this object.
Virtual attributes can be provided for visual cues without affecting the actual styling.
obj (wx.richtext.RichTextObject) –
GetVirtualAttributesEnabled(self)¶Returns True if virtual attribute processing is enabled.
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. The function is passed the count returned by GetVirtualSubobjectAttributesCount.
obj (wx.richtext.RichTextObject) –
positions (list of integers) –
attributes (RichTextAttrArray) –
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.
obj (wx.richtext.RichTextObject) –
int
GetVirtualText(self, obj : RichTextPlainText, text : str)¶Gets the virtual text for this object.
obj (wx.richtext.RichTextPlainText) –
text (string) –
bool
HasVirtualAttributes(self, obj : RichTextObject)¶Does this object have virtual attributes? Virtual attributes can be provided for visual cues without affecting the actual styling.
obj (wx.richtext.RichTextObject) –
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.
obj (wx.richtext.RichTextPlainText) –
bool
Init(self)¶None
SetLayingOut(self, b : bool)¶Set laying out flag.
b (bool) –
None
DelayedImageLoading¶ImagesEnabled¶See GetImagesEnabled
LayingOut¶See GetLayingOut and SetLayingOut
VirtualAttributesEnabled¶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.