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
|
.. 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.BitmapDataObject:
==========================================================================================================================================
|phoenix_title| **wx.BitmapDataObject**
==========================================================================================================================================
:ref:`wx.BitmapDataObject` is a specialization of :ref:`wx.DataObject` for bitmap data.
It can be used without change to paste data into the :ref:`wx.Clipboard` or a :ref:`wx.DropSource`. A user may wish to derive a new class from this class for providing a bitmap on-demand in order to minimize memory consumption when offering data in several formats, such as a bitmap and ``GIF``.
This class may be used as is, but :meth:`~wx.BitmapDataObject.GetBitmap` may be overridden to increase efficiency.
.. seealso:: :ref:`Drag and Drop Overview <drag and drop overview>`, :ref:`wx.DataObject`, :ref:`wx.DataObjectSimple`, :ref:`wx.FileDataObject`, :ref:`wx.TextDataObject`, :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>BitmapDataObject</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.BitmapDataObject_inheritance.png" alt="Inheritance diagram of BitmapDataObject" 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.BitmapDataObject.html" title="wx.BitmapDataObject" alt="" coords="5,160,171,189"/> <area shape="rect" id="node2" href="wx.DataObjectSimple.html" title="wx.DataObjectSimple" alt="" coords="7,83,169,112"/> <area shape="rect" id="node3" href="wx.DataObject.html" title="wx.DataObject" alt="" coords="29,5,147,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.BitmapDataObject.__init__` Constructor, optionally passing a bitmap (otherwise use :meth:`~BitmapDataObject.SetBitmap` later).
:meth:`~wx.BitmapDataObject.GetAllFormats` Returns a list of wx.DataFormat objects which this data object
:meth:`~wx.BitmapDataObject.GetBitmap` Returns the bitmap associated with the data object.
:meth:`~wx.BitmapDataObject.SetBitmap` Sets the bitmap associated with the data object.
:meth:`~wx.BitmapDataObject.SetData`
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.BitmapDataObject.AllFormats` See :meth:`~wx.BitmapDataObject.GetAllFormats`
:attr:`~wx.BitmapDataObject.Bitmap` See :meth:`~wx.BitmapDataObject.GetBitmap` and :meth:`~wx.BitmapDataObject.SetBitmap`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.BitmapDataObject(DataObjectSimple)
**Possible constructors**::
BitmapDataObject(bitmap=NullBitmap)
BitmapDataObject is a specialization of DataObject for bitmap
data.
.. method:: __init__(self, bitmap=NullBitmap)
Constructor, optionally passing a bitmap (otherwise use :meth:`SetBitmap` later).
:param `bitmap`:
:type `bitmap`: wx.Bitmap
.. method:: GetAllFormats(self, dir=DataObject.Get)
Returns a list of wx.DataFormat objects which this data object
supports transferring in the given direction.
.. method:: GetBitmap(self)
Returns the bitmap associated with the data object.
You may wish to override this method when offering data on-demand, but this is not required by wxWidgets' internals. Use this method to get data in bitmap form from the :ref:`wx.Clipboard`.
:rtype: :ref:`wx.Bitmap`
.. method:: SetBitmap(self, bitmap)
Sets the bitmap associated with the data object.
This method is called when the data object receives data. Usually there will be no reason to override this function.
:param `bitmap`:
:type `bitmap`: wx.Bitmap
.. method:: SetData(self, format, buf)
:rtype: `bool`
.. attribute:: AllFormats
See :meth:`~wx.BitmapDataObject.GetAllFormats`
.. attribute:: Bitmap
See :meth:`~wx.BitmapDataObject.GetBitmap` and :meth:`~wx.BitmapDataObject.SetBitmap`
|
