1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 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.png" alt="Inheritance diagram of RichTextRenderer" usemap="#dummy" class="inheritance"/></center>
</div>
<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="wx.richtext.RichTextRenderer" alt="" coords="5,83,208,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="65,5,147,35"/> </map>
</p>
|
|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.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.richtext.RichTextRenderer(Object)
**Possible constructors**::
RichTextRenderer()
This class isolates some common drawing functionality.
.. method:: __init__(self)
Constructor.
.. method:: DrawBitmapBullet(self, paragraph, dc, attr, 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, dc, attr, 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, dc, attr, rect, text)
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)
Enumerate the standard bullet names currently supported.
This function should be overridden.
:param `bulletNames`:
:type `bulletNames`: list of strings
:rtype: `bool`
|