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
|
.. 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.CustomDataObject:
==========================================================================================================================================
|phoenix_title| **wx.CustomDataObject**
==========================================================================================================================================
:ref:`wx.CustomDataObject` is a specialization of :ref:`wx.DataObjectSimple` for some application-specific data in arbitrary (either custom or one of the standard ones).
The only restriction is that it is supposed that this data can be copied bitwise (i.e. with ``memcpy()`` ), so it would be a bad idea to make it contain a C++ object (though C struct is fine).
By default, :ref:`wx.CustomDataObject` stores the data inside in a buffer. To put the data into the buffer you may use either :meth:`~wx.CustomDataObject.SetData` or :meth:`~wx.CustomDataObject.TakeData` depending on whether you want the object to make a copy of data or not.
This class may be used as is, but if you don't want store the data inside the object but provide it on demand instead, you should override :meth:`~wx.CustomDataObject.GetSize`, :meth:`~wx.CustomDataObject.GetData` and :meth:`~wx.CustomDataObject.SetData` (or may be only the first two or only the last one if you only allow reading/writing the data).
.. seealso:: :ref:`wx.DataObject`
|
|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>CustomDataObject</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.CustomDataObject_inheritance.png" alt="Inheritance diagram of CustomDataObject" 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.CustomDataObject.html" title="wx.CustomDataObject" alt="" coords="5,160,173,189"/> <area shape="rect" id="node2" href="wx.DataObjectSimple.html" title="wx.DataObjectSimple" alt="" coords="8,83,171,112"/> <area shape="rect" id="node3" href="wx.DataObject.html" title="wx.DataObject" alt="" coords="30,5,149,35"/> </map>
</p>
</div>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.ImageDataObject`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.CustomDataObject.__init__` The constructor accepts a `format` argument which specifies the (single) format supported by this object.
:meth:`~wx.CustomDataObject.GetAllFormats` Returns a list of wx.DataFormat objects which this data object
:meth:`~wx.CustomDataObject.GetData` Returns a reference to the data buffer.
:meth:`~wx.CustomDataObject.GetSize` Returns the data size in bytes.
:meth:`~wx.CustomDataObject.SetData` Copies data from the provided buffer to this data object's buffer
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.CustomDataObject.AllFormats` See :meth:`~wx.CustomDataObject.GetAllFormats`
:attr:`~wx.CustomDataObject.Data` See :meth:`~wx.CustomDataObject.GetData` and :meth:`~wx.CustomDataObject.SetData`
:attr:`~wx.CustomDataObject.Size` See :meth:`~wx.CustomDataObject.GetSize`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.CustomDataObject(DataObjectSimple)
**Possible constructors**::
CustomDataObject(format=FormatInvalid)
CustomDataObject(formatName)
CustomDataObject is a specialization of DataObjectSimple for some
application-specific data in arbitrary (either custom or one of the
standard ones).
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, format=FormatInvalid)`
The constructor accepts a `format` argument which specifies the (single) format supported by this object.
If it isn't set here, :meth:`wx.DataObjectSimple.SetFormat` should be used.
:param `format`:
:type `format`: wx.DataFormat
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, formatName)`
:html:`<hr class="overloadsep" /><br />`
.. method:: GetAllFormats(self, dir=DataObject.Get)
Returns a list of wx.DataFormat objects which this data object
supports transferring in the given direction.
.. method:: GetData(self)
Returns a reference to the data buffer.
:rtype: :ref:`PyObject`
.. method:: GetSize(self)
Returns the data size in bytes.
:rtype: `int`
.. method:: SetData(self, *args, **kw)
|overload| Overloaded Implementations:
:html:`<hr class="overloadsep" /><br />`
**SetData** `(self, buf)`
Copies data from the provided buffer to this data object's buffer
:rtype: `bool`
:html:`<hr class="overloadsep" /><br />`
**SetData** `(self, format, buf)`
:rtype: `bool`
:html:`<hr class="overloadsep" /><br />`
.. attribute:: AllFormats
See :meth:`~wx.CustomDataObject.GetAllFormats`
.. attribute:: Data
See :meth:`~wx.CustomDataObject.GetData` and :meth:`~wx.CustomDataObject.SetData`
.. attribute:: Size
See :meth:`~wx.CustomDataObject.GetSize`
|
