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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
|
.. 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.RichTextDrawingHandler:
==========================================================================================================================================
|phoenix_title| **wx.richtext.RichTextDrawingHandler**
==========================================================================================================================================
The base class for custom drawing handlers.
Currently, drawing handlers can provide virtual attributes.
.. 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>RichTextDrawingHandler</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.RichTextDrawingHandler_inheritance.png" alt="Inheritance diagram of RichTextDrawingHandler" 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.RichTextDrawingHandler.html" title="wx.richtext.RichTextDrawingHandler" alt="" coords="5,83,251,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="87,5,168,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.richtext.RichTextDrawingHandler.__init__` Creates a drawing handler object.
:meth:`~wx.richtext.RichTextDrawingHandler.GetName` Returns the name of the handler.
:meth:`~wx.richtext.RichTextDrawingHandler.GetVirtualAttributes` Provides virtual attributes that we can provide.
:meth:`~wx.richtext.RichTextDrawingHandler.GetVirtualSubobjectAttributes` Gets the mixed virtual attributes for individual positions within the object.
:meth:`~wx.richtext.RichTextDrawingHandler.GetVirtualSubobjectAttributesCount` Gets the count for mixed virtual attributes for individual positions within the object.
:meth:`~wx.richtext.RichTextDrawingHandler.GetVirtualText` Gets the virtual text for this object.
:meth:`~wx.richtext.RichTextDrawingHandler.HasVirtualAttributes` Returns ``True`` if this object has virtual attributes that we can provide.
:meth:`~wx.richtext.RichTextDrawingHandler.HasVirtualText` 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.
:meth:`~wx.richtext.RichTextDrawingHandler.SetName` Sets the name of the handler.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.richtext.RichTextDrawingHandler.Name` See :meth:`~wx.richtext.RichTextDrawingHandler.GetName` and :meth:`~wx.richtext.RichTextDrawingHandler.SetName`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.richtext.RichTextDrawingHandler(Object)
**Possible constructors**::
RichTextDrawingHandler(name="")
The base class for custom drawing handlers.
.. method:: __init__(self, name=EmptyString)
Creates a drawing handler object.
:param `name`:
:type `name`: string
.. method:: GetName(self)
Returns the name of the handler.
:rtype: `string`
.. method:: GetVirtualAttributes(self, attr, obj)
Provides virtual attributes that we can provide.
:param `attr`:
:type `attr`: wx.richtext.RichTextAttr
:param `obj`:
:type `obj`: wx.richtext.RichTextObject
:rtype: `bool`
.. method:: GetVirtualSubobjectAttributes(self, obj, positions, attributes)
Gets the mixed virtual attributes for individual positions within the object.
For example, individual characters within a text object may require special highlighting. Returns the number of virtual attributes found.
:param `obj`:
:type `obj`: wx.richtext.RichTextObject
:param `positions`:
:type `positions`: list of integers
:param `attributes`:
:type `attributes`: RichTextAttrArray
:rtype: `int`
.. method:: GetVirtualSubobjectAttributesCount(self, obj)
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.
:param `obj`:
:type `obj`: wx.richtext.RichTextObject
:rtype: `int`
.. method:: GetVirtualText(self, obj, text)
Gets the virtual text for this object.
:param `obj`:
:type `obj`: wx.richtext.RichTextPlainText
:param `text`:
:type `text`: string
:rtype: `bool`
.. method:: HasVirtualAttributes(self, obj)
Returns ``True`` if this object has virtual attributes that we can provide.
:param `obj`:
:type `obj`: wx.richtext.RichTextObject
:rtype: `bool`
.. method:: HasVirtualText(self, obj)
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.
:param `obj`:
:type `obj`: wx.richtext.RichTextPlainText
:rtype: `bool`
.. method:: SetName(self, name)
Sets the name of the handler.
:param `name`:
:type `name`: string
.. attribute:: Name
See :meth:`~wx.richtext.RichTextDrawingHandler.GetName` and :meth:`~wx.richtext.RichTextDrawingHandler.SetName`
|
