| Version: 3.2.5

Public Member Functions | List of all members
wxRichTextRenderer Class Referenceabstract
Class List by Category » Rich Text

`#include <wx/richtext/richtextbuffer.h>`

Inheritance diagram for wxRichTextRenderer:
[legend]

## Detailed Description

This class isolates some common drawing functionality.

##

Library: wxRichText
Category: Rich Text

See also
  wxRichTextBuffer, wxRichTextCtrl

## Public Member Functions

| wxRichTextRenderer ()
| Constructor. More...
virtual | ~wxRichTextRenderer ()
virtual bool | DrawStandardBullet (wxRichTextParagraph *paragraph, wxDC &dc, const wxRichTextAttr &attr, const wxRect &rect)=0
| Draws a standard bullet, as specified by the value of GetBulletName. More...
virtual bool | DrawTextBullet (wxRichTextParagraph *paragraph, wxDC &dc, const wxRichTextAttr &attr, const wxRect &rect, const wxString &text)=0
| Draws a bullet that can be described by text, such as numbered or symbol bullets. More...
virtual bool | DrawBitmapBullet (wxRichTextParagraph *paragraph, wxDC &dc, const wxRichTextAttr &attr, const wxRect &rect)=0
| Draws a bitmap bullet, where the bullet bitmap is specified by the value of GetBulletName. More...
virtual bool | EnumerateStandardBulletNames (wxArrayString &bulletNames)=0
| Enumerate the standard bullet names currently supported. More...
virtual bool | MeasureBullet (wxRichTextParagraph *paragraph, wxDC &dc, const wxRichTextAttr &attr, wxSize &sz)=0
| Measure the bullet. More...
Public Member Functions inherited from wxObject
| wxObject ()
| Default ctor; initializes to NULL the internal reference data. More...
| wxObject (const wxObject &other)
| Copy ctor. More...
virtual | ~wxObject ()
| Destructor. More...
virtual wxClassInfo * | GetClassInfo () const
| This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
wxObjectRefData * | GetRefData () const
| Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
bool | IsKindOf (const wxClassInfo *info) const
| Determines whether this class is a subclass of (or the same class as) the given class. More...
bool | IsSameAs (const wxObject &obj) const
| Returns true if this object has the same data pointer as obj. More...
void | Ref (const wxObject &clone)
| Makes this object refer to the data in clone. More...
void | SetRefData (wxObjectRefData *data)
| Sets the wxObject::m_refData pointer. More...
void | UnRef ()
| Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
void | UnShare ()
| This is the same of AllocExclusive() but this method is public. More...
void | operator delete (void *buf)
| The delete operator is defined for debugging versions of the library only, when the identifier `__WXDEBUG__` is defined. More...
void * | operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
| The new operator is defined for debugging versions of the library only, when the identifier `__WXDEBUG__` is defined. More...

## Additional Inherited Members

Protected Member Functions inherited from wxObject
void | AllocExclusive ()
| Ensure that this object's data is not shared with any other object. More...
virtual wxObjectRefData * | CreateRefData () const
| Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
virtual wxObjectRefData * | CloneRefData (const wxObjectRefData *data) const
| Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
Protected Attributes inherited from wxObject
wxObjectRefData * | m_refData
| Pointer to an object which is the object's reference-counted data. More...

## Constructor & Destructor Documentation

## ◆ wxRichTextRenderer()

wxRichTextRenderer::wxRichTextRenderer | ( |  | ) |

inline

Constructor.

## ◆ ~wxRichTextRenderer()

virtual wxRichTextRenderer::~wxRichTextRenderer | ( |  | ) |

inline virtual

## Member Function Documentation

## ◆ DrawBitmapBullet()

virtual bool wxRichTextRenderer::DrawBitmapBullet | ( | wxRichTextParagraph * | paragraph,
|  | wxDC & | dc,
|  | const wxRichTextAttr & | attr,
|  | const wxRect & | rect
| ) |  |

pure virtual

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

This function should be overridden.

Implemented in wxRichTextStdRenderer.

## ◆ DrawStandardBullet()

virtual bool wxRichTextRenderer::DrawStandardBullet | ( | wxRichTextParagraph * | paragraph,
|  | wxDC & | dc,
|  | const wxRichTextAttr & | attr,
|  | const wxRect & | rect
| ) |  |

pure virtual

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

This function should be overridden.

Implemented in wxRichTextStdRenderer.

## ◆ DrawTextBullet()

virtual bool wxRichTextRenderer::DrawTextBullet | ( | wxRichTextParagraph * | paragraph,
|  | wxDC & | dc,
|  | const wxRichTextAttr & | attr,
|  | const wxRect & | rect,
|  | const wxString & | text
| ) |  |

pure virtual

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

This function should be overridden.

Implemented in wxRichTextStdRenderer.

## ◆ EnumerateStandardBulletNames()

virtual bool wxRichTextRenderer::EnumerateStandardBulletNames | ( | wxArrayString & | bulletNames | ) |

pure virtual

Enumerate the standard bullet names currently supported.

This function should be overridden.

Implemented in wxRichTextStdRenderer.

## ◆ MeasureBullet()

virtual bool wxRichTextRenderer::MeasureBullet | ( | wxRichTextParagraph * | paragraph,
|  | wxDC & | dc,
|  | const wxRichTextAttr & | attr,
|  | wxSize & | sz
| ) |  |

pure virtual

Measure the bullet.

Implemented in wxRichTextStdRenderer.