BitmapDataObject

BitmapDataObject is a specialization of DataObject for bitmap data.

It can be used without change to paste data into the Clipboard or a 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 GetBitmap may be overridden to increase efficiency.

See also

Drag and Drop Overview, DataObject, DataObjectSimple, FileDataObject, TextDataObject, DataObject

Inheritance Diagram

Inheritance diagram for class BitmapDataObject

Methods Summary

__init__	Constructor, optionally passing a bitmap (otherwise use SetBitmap later).
GetBitmap	Returns the bitmap associated with the data object.
SetBitmap	Sets the bitmap associated with the data object.

Properties Summary

Bitmap

See GetBitmap and SetBitmap

Class API

---

class BitmapDataObject(DataObjectSimple)

BitmapDataObject is a specialization of DataObject for bitmap data.

Possible constructors:

BitmapDataObject(bitmap=NullBitmap)

Methods

---

__init__(self, bitmap=NullBitmap)

Constructor, optionally passing a bitmap (otherwise use SetBitmap later).

Parameters:bitmap (Bitmap) –

---

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 Clipboard.

Return type: Bitmap

---

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.

Parameters:bitmap (Bitmap) –

Properties

---

Bitmap

See GetBitmap and SetBitmap