wx.richtext.RichTextRenderer

This class isolates some common drawing functionality.

See also

wx.richtext.RichTextBuffer, wx.richtext.RichTextCtrl

Class Hierarchy

Inheritance diagram for class RichTextRenderer:

Known Subclasses

wx.richtext.RichTextStdRenderer

Methods Summary

__init__	Constructor.
DrawBitmapBullet	Draws a bitmap bullet, where the bullet bitmap is specified by the value of GetBulletName.
DrawStandardBullet	Draws a standard bullet, as specified by the value of GetBulletName.
DrawTextBullet	Draws a bullet that can be described by text, such as numbered or symbol bullets.
EnumerateStandardBulletNames	Enumerate the standard bullet names currently supported.
MeasureBullet	Measure the bullet.

Class API

class wx.richtext.RichTextRenderer(Object)

Possible constructors:

RichTextRenderer() -> None

This class isolates some common drawing functionality.

Methods

__init__(self)

Constructor.

Return type:

None

---

DrawBitmapBullet(self, paragraph: RichTextParagraph, dc: DC, attr: RichTextAttr, rect: Rect)

Draws a bitmap bullet, where the bullet bitmap is specified by the value of GetBulletName.

This function should be overridden.

Parameters:

• paragraph (wx.richtext.RichTextParagraph)

• dc (wx.DC)

• attr (wx.richtext.RichTextAttr)

• rect (wx.Rect)

Return type:

bool

---

DrawStandardBullet(self, paragraph: RichTextParagraph, dc: DC, attr: RichTextAttr, rect: Rect)

Draws a standard bullet, as specified by the value of GetBulletName.

This function should be overridden.

Parameters:

• paragraph (wx.richtext.RichTextParagraph)

• dc (wx.DC)

• attr (wx.richtext.RichTextAttr)

• rect (wx.Rect)

Return type:

bool

---

DrawTextBullet(self, paragraph: RichTextParagraph, dc: DC, attr: RichTextAttr, rect: Rect, text: str)

Draws a bullet that can be described by text, such as numbered or symbol bullets.

This function should be overridden.

Parameters:

• paragraph (wx.richtext.RichTextParagraph)

• dc (wx.DC)

• attr (wx.richtext.RichTextAttr)

• rect (wx.Rect)

• text (string)

Return type:

bool

---

EnumerateStandardBulletNames(self, bulletNames: List[str])

Enumerate the standard bullet names currently supported.

This function should be overridden.

Parameters:

bulletNames (list of strings)

Return type:

bool

---

MeasureBullet(self, paragraph: RichTextParagraph, dc: DC, attr: RichTextAttr, sz: Size)

Measure the bullet.

Parameters:

• paragraph (wx.richtext.RichTextParagraph)

• dc (wx.DC)

• attr (wx.richtext.RichTextAttr)

• sz (wx.Size)

Return type:

bool