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
|
.. 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.DataObjectSimple:
==========================================================================================================================================
|phoenix_title| **wx.DataObjectSimple**
==========================================================================================================================================
This is the simplest possible implementation of the :ref:`wx.DataObject` class.
The data object of (a class derived from) this class only supports **one format**, so the number of virtual functions to be implemented is reduced.
Notice that this is still an abstract base class and cannot be used directly, it must be derived. The objects supporting rendering the data must override :meth:`~wx.DataObjectSimple.GetDataSize` and :meth:`~wx.DataObjectSimple.GetDataHere` while the objects which may be set must override :meth:`~wx.DataObjectSimple.SetData`. Of course, the objects supporting both operations must override all three methods.
|
|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>DataObjectSimple</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.DataObjectSimple_inheritance.png" alt="Inheritance diagram of DataObjectSimple" 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="5,83,163,112"/> <area shape="rect" id="node2" href="wx.DataObject.html" title="wx.DataObject" alt="" coords="27,5,141,35"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.BitmapDataObject`, :ref:`wx.CustomDataObject`, :ref:`wx.FileDataObject`, :ref:`wx.HTMLDataObject`, :ref:`wx.richtext.RichTextBufferDataObject`, :ref:`wx.TextDataObject`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.DataObjectSimple.__init__` Constructor accepts the supported format (none by default) which may also be set later with :meth:`~DataObjectSimple.SetFormat` .
:meth:`~wx.DataObjectSimple.GetAllFormats` Returns a list of wx.DataFormat objects which this data object
:meth:`~wx.DataObjectSimple.GetDataHere` Copies this data object's data bytes to the given buffer
:meth:`~wx.DataObjectSimple.GetDataSize` Gets the size of our data.
:meth:`~wx.DataObjectSimple.GetFormat` Returns the (one and only one) format supported by this object.
:meth:`~wx.DataObjectSimple.SetData` Copies data from the provided buffer to this data object.
:meth:`~wx.DataObjectSimple.SetFormat` Sets the supported format.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.DataObjectSimple.AllFormats` See :meth:`~wx.DataObjectSimple.GetAllFormats`
:attr:`~wx.DataObjectSimple.DataHere` See :meth:`~wx.DataObjectSimple.GetDataHere`
:attr:`~wx.DataObjectSimple.DataSize` See :meth:`~wx.DataObjectSimple.GetDataSize`
:attr:`~wx.DataObjectSimple.Format` See :meth:`~wx.DataObjectSimple.GetFormat` and :meth:`~wx.DataObjectSimple.SetFormat`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.DataObjectSimple(DataObject)
**Possible constructors**::
DataObjectSimple(format=FormatInvalid)
DataObjectSimple(formatName)
This is the simplest possible implementation of the DataObject
class.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self, format=FormatInvalid)`
Constructor accepts the supported format (none by default) which may also be set later with :meth:`SetFormat` .
:param `format`:
:type `format`: wx.DataFormat
**~~~**
**__init__** `(self, formatName)`
**~~~**
.. method:: GetAllFormats(self, dir=DataObject.Get)
Returns a list of wx.DataFormat objects which this data object
supports transferring in the given direction.
.. method:: GetDataHere(self, buf)
Copies this data object's data bytes to the given buffer
:rtype: `bool`
.. method:: GetDataSize(self)
Gets the size of our data.
Must be implemented in the derived class if the object supports rendering its data.
:rtype: `int`
.. method:: GetFormat(self)
Returns the (one and only one) format supported by this object.
It is assumed that the format is supported in both directions.
:rtype: :ref:`wx.DataFormat`
.. method:: SetData(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**SetData** `(self, buf)`
Copies data from the provided buffer to this data object.
:rtype: `bool`
**~~~**
**SetData** `(self, format, buf)`
:rtype: `bool`
**~~~**
.. method:: SetFormat(self, format)
Sets the supported format.
:param `format`:
:type `format`: wx.DataFormat
.. attribute:: AllFormats
See :meth:`~wx.DataObjectSimple.GetAllFormats`
.. attribute:: DataHere
See :meth:`~wx.DataObjectSimple.GetDataHere`
.. attribute:: DataSize
See :meth:`~wx.DataObjectSimple.GetDataSize`
.. attribute:: Format
See :meth:`~wx.DataObjectSimple.GetFormat` and :meth:`~wx.DataObjectSimple.SetFormat`
|
