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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
|
.. 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.RichTextBufferDataObject:
==========================================================================================================================================
|phoenix_title| **wx.richtext.RichTextBufferDataObject**
==========================================================================================================================================
Implements a rich text data object for clipboard transfer.
.. seealso:: :ref:`wx.DataObjectSimple`, :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>RichTextBufferDataObject</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.RichTextBufferDataObject_inheritance.png" alt="Inheritance diagram of RichTextBufferDataObject" 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.DataObjectSimple.html" title="wx.DataObjectSimple" alt="" coords="53,83,211,112"/> <area shape="rect" id="node3" href="wx.richtext.RichTextBufferDataObject.html" title="wx.richtext.RichTextBufferDataObject" alt="" coords="5,160,259,189"/> <area shape="rect" id="node2" href="wx.DataObject.html" title="wx.DataObject" alt="" coords="75,5,189,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.richtext.RichTextBufferDataObject.__init__` The constructor doesn't copy the pointer, so it shouldn't go away while this object is alive.
:meth:`~wx.richtext.RichTextBufferDataObject.GetDataHere` Copy the data to the buffer, return ``True`` on success.
:meth:`~wx.richtext.RichTextBufferDataObject.GetDataSize` Gets the size of our data.
:meth:`~wx.richtext.RichTextBufferDataObject.GetPreferredFormat` Returns the preferred format for either rendering the data (if `dir` is ``Get`` , its default value) or for setting it.
:meth:`~wx.richtext.RichTextBufferDataObject.GetRichTextBuffer` After a call to this function, the buffer is owned by the caller and it is responsible for deleting it.
:meth:`~wx.richtext.RichTextBufferDataObject.GetRichTextBufferFormatId` Returns the id for the new data format.
:meth:`~wx.richtext.RichTextBufferDataObject.SetData` Copy the data from the buffer, return ``True`` on success.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.richtext.RichTextBufferDataObject.DataSize` See :meth:`~wx.richtext.RichTextBufferDataObject.GetDataSize`
:attr:`~wx.richtext.RichTextBufferDataObject.RichTextBuffer` See :meth:`~wx.richtext.RichTextBufferDataObject.GetRichTextBuffer`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.richtext.RichTextBufferDataObject(DataObjectSimple)
**Possible constructors**::
RichTextBufferDataObject(richTextBuffer=None)
Implements a rich text data object for clipboard transfer.
.. method:: __init__(self, richTextBuffer=None)
The constructor doesn't copy the pointer, so it shouldn't go away while this object is alive.
:param `richTextBuffer`:
:type `richTextBuffer`: wx.richtext.RichTextBuffer
.. method:: GetDataHere(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**GetDataHere** `(self, buf)`
Copy the data to the buffer, return ``True`` on success.
Must be implemented in the derived class if the object supports rendering its data.
:param `buf`:
:rtype: `bool`
**~~~**
**GetDataHere** `(self, format, buf)`
The method will write the data of the format `format` to the buffer `buf`.
In other words, copy the data from this object in the given format to the supplied buffer. Returns ``True`` on success, ``False`` on failure.
:param `format`:
:type `format`: wx.DataFormat
:param `buf`:
:rtype: `bool`
**~~~**
.. method:: GetDataSize(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**GetDataSize** `(self)`
Gets the size of our data.
Must be implemented in the derived class if the object supports rendering its data.
:rtype: `int`
**~~~**
**GetDataSize** `(self, format)`
Returns the data size of the given format `format`.
:param `format`:
:type `format`: wx.DataFormat
:rtype: `int`
**~~~**
.. method:: GetPreferredFormat(self, dir)
Returns the preferred format for either rendering the data (if `dir` is ``Get`` , its default value) or for setting it.
Usually this will be the native format of the :ref:`wx.DataObject`.
:param `dir`:
:type `dir`: wx.DataObject.Direction
:rtype: :ref:`DataFormat`
.. method:: GetRichTextBuffer(self)
After a call to this function, the buffer is owned by the caller and it is responsible for deleting it.
:rtype: :ref:`wx.richtext.RichTextBuffer`
.. staticmethod:: GetRichTextBufferFormatId()
Returns the id for the new data format.
:rtype: :ref:`wx.Char`
.. method:: SetData(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**SetData** `(self, len, buf)`
Copy the data from the buffer, return ``True`` on success.
Must be implemented in the derived class if the object supports setting its data.
:param `len`:
:type `len`: int
:param `buf`:
:rtype: `bool`
**~~~**
**SetData** `(self, format, len, buf)`
Set the data in the format `format` of the length `len` provided in the buffer `buf`.
In other words, copy length bytes of data from the buffer to this data object.
:param `format`: The format for which to set the data.
:type `format`: wx.DataFormat
:param `len`: The size of data in bytes.
:type `len`: int
:param `buf`: Non-NULL pointer to the data.
:rtype: `bool`
:returns:
``True`` on success, ``False`` on failure.
**~~~**
.. attribute:: DataSize
See :meth:`~wx.richtext.RichTextBufferDataObject.GetDataSize`
.. attribute:: RichTextBuffer
See :meth:`~wx.richtext.RichTextBufferDataObject.GetRichTextBuffer`
|
