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-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.DataObjectComposite:
==========================================================================================================================================
|phoenix_title| **wx.DataObjectComposite**
==========================================================================================================================================
:ref:`wx.DataObjectComposite` is the simplest :ref:`wx.DataObject` derivation which may be used to support multiple formats.
It contains several :ref:`wx.DataObjectSimple` objects and supports any format supported by at least one of them. Only one of these data objects is `preferred` (the first one if not explicitly changed by using the second parameter of :meth:`~wx.DataObjectComposite.Add`) and its format determines the preferred format of the composite data object as well.
See :ref:`wx.DataObject` documentation for the reasons why you might prefer to use :ref:`wx.DataObject` directly instead of :ref:`wx.DataObjectComposite` for efficiency reasons.
This example shows how a composite data object capable of storing either bitmaps or file names (presumably of bitmap files) can be initialized and used:
::
def MyDropTarget(self):
dataobj = wx.DataObjectComposite()
dataobj.Add(wx.BitmapDataObject(), True)
dataobj.Add(wx.FileDataObject())
self.SetDataObject(dataobj)
def OnData(self, x, y, defaultDragResult):
dragResult = wx.DropTarget.OnData(x, y, defaultDragResult)
if dragResult == defaultDragResult:
dataobjComp = self.GetDataObject()
format = dataObjects.GetReceivedFormat()
dataobj = dataobjComp.GetObject(format)
if format.GetType() == wx.DF_BITMAP:
dataobjBitmap = dataobj
# ... use dataobj.GetBitmap() ...
elif format.GetType() == wx.DF_FILENAME:
dataobjFile = dataobj
# ... use dataobj.GetFilenames() ...
else:
raise Exception("unexpected data object format")
return dragResult
.. seealso:: :ref:`Drag and Drop Overview <drag and drop overview>`, :ref:`wx.DataObject`, :ref:`wx.DataObjectSimple`, :ref:`wx.FileDataObject`, :ref:`wx.TextDataObject`, :ref:`wx.BitmapDataObject`
|
|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>DataObjectComposite</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.DataObjectComposite_inheritance.png" alt="Inheritance diagram of DataObjectComposite" 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.DataObjectComposite.html" title="wx.DataObjectComposite" alt="" coords="5,83,187,112"/> <area shape="rect" id="node2" href="wx.DataObject.html" title="wx.DataObject" alt="" coords="39,5,153,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.DataObjectComposite.__init__` The default constructor.
:meth:`~wx.DataObjectComposite.Add` Adds the `dataObject` to the list of supported objects and it becomes the preferred object if `preferred` is ``True``.
:meth:`~wx.DataObjectComposite.GetAllFormats` Returns a list of wx.DataFormat objects which this data object
:meth:`~wx.DataObjectComposite.GetObject` Returns the pointer to the object which supports the passed format for the specified direction.
:meth:`~wx.DataObjectComposite.GetReceivedFormat` Report the format passed to the :meth:`~DataObjectComposite.SetData` method.
:meth:`~wx.DataObjectComposite.SetData`
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.DataObjectComposite.AllFormats` See :meth:`~wx.DataObjectComposite.GetAllFormats`
:attr:`~wx.DataObjectComposite.ReceivedFormat` See :meth:`~wx.DataObjectComposite.GetReceivedFormat`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.DataObjectComposite(DataObject)
**Possible constructors**::
DataObjectComposite()
DataObjectComposite is the simplest DataObject derivation which
may be used to support multiple formats.
.. method:: __init__(self)
The default constructor.
.. method:: Add(self, dataObject, preferred=False)
Adds the `dataObject` to the list of supported objects and it becomes the preferred object if `preferred` is ``True``.
:param `dataObject`:
:type `dataObject`: wx.DataObjectSimple
:param `preferred`:
:type `preferred`: bool
.. method:: GetAllFormats(self, dir=DataObject.Get)
Returns a list of wx.DataFormat objects which this data object
supports transferring in the given direction.
.. method:: GetObject(self, format, dir=DataObject.Get)
Returns the pointer to the object which supports the passed format for the specified direction.
``None`` is returned if the specified `format` is not supported for this direction `dir`. The returned pointer is owned by :ref:`wx.DataObjectComposite` itself and shouldn't be deleted by caller.
:param `format`:
:type `format`: wx.DataFormat
:param `dir`:
:type `dir`: DataObject.Direction
:rtype: :ref:`wx.DataObjectSimple`
.. versionadded:: 2.9.1
.. method:: GetReceivedFormat(self)
Report the format passed to the :meth:`SetData` method.
This should be the format of the data object within the composite that received data from the clipboard or the DnD operation. You can use this method to find out what kind of data object was received.
:rtype: :ref:`wx.DataFormat`
.. method:: SetData(self, format, buf)
:rtype: `bool`
.. attribute:: AllFormats
See :meth:`~wx.DataObjectComposite.GetAllFormats`
.. attribute:: ReceivedFormat
See :meth:`~wx.DataObjectComposite.GetReceivedFormat`
|
