.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2020 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.richtext.RichTextRenderer:

==========================================================================================================================================
|phoenix_title|  **wx.richtext.RichTextRenderer**
==========================================================================================================================================

This class isolates some common drawing functionality. 
         








         



.. seealso:: :ref:`wx.richtext.RichTextBuffer`, :ref:`wx.richtext.RichTextCtrl`    







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>RichTextRenderer</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.richtext.RichTextRenderer_inheritance.svg" alt="Inheritance diagram of RichTextRenderer" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.richtext.RichTextRenderer.html" title="This class isolates some common drawing functionality." alt="" coords="5,82,242,111"/> <area shape="rect" id="node2" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="74,5,173,34"/> </map> 
   </p>
   </div>

|


|sub_classes| Known Subclasses
==============================

:ref:`wx.richtext.RichTextStdRenderer`

|


|method_summary| Methods Summary
================================

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


|


|api| Class API
===============


.. class:: wx.richtext.RichTextRenderer(Object)

   **Possible constructors**::

       RichTextRenderer() -> None
       
   
   This class isolates some common drawing functionality.



   .. method:: __init__(self)

      Constructor. 
                 

      :rtype: `None`     








   .. method:: 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. 
                 


      :param `paragraph`: 
      :type `paragraph`: wx.richtext.RichTextParagraph
      :param `dc`: 
      :type `dc`: wx.DC
      :param `attr`: 
      :type `attr`: wx.richtext.RichTextAttr
      :param `rect`: 
      :type `rect`: wx.Rect




      :rtype: `bool`








   .. method:: 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. 
                 


      :param `paragraph`: 
      :type `paragraph`: wx.richtext.RichTextParagraph
      :param `dc`: 
      :type `dc`: wx.DC
      :param `attr`: 
      :type `attr`: wx.richtext.RichTextAttr
      :param `rect`: 
      :type `rect`: wx.Rect




      :rtype: `bool`








   .. method:: 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. 
                 


      :param `paragraph`: 
      :type `paragraph`: wx.richtext.RichTextParagraph
      :param `dc`: 
      :type `dc`: wx.DC
      :param `attr`: 
      :type `attr`: wx.richtext.RichTextAttr
      :param `rect`: 
      :type `rect`: wx.Rect
      :param `text`: 
      :type `text`: string




      :rtype: `bool`








   .. method:: EnumerateStandardBulletNames(self, bulletNames : List[str])

      Enumerate the standard bullet names currently supported. 
                 

      This function should be overridden. 
                 


      :param `bulletNames`: 
      :type `bulletNames`: list of strings




      :rtype: `bool`








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

      Measure the bullet. 
                 


      :param `paragraph`: 
      :type `paragraph`: wx.richtext.RichTextParagraph
      :param `dc`: 
      :type `dc`: wx.DC
      :param `attr`: 
      :type `attr`: wx.richtext.RichTextAttr
      :param `sz`: 
      :type `sz`: wx.Size




      :rtype: `bool`