wx.BitmapDataObject¶

wx.BitmapDataObject is a specialization of wx.DataObject for bitmap data.

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

Class Hierarchy¶

Inheritance diagram for class BitmapDataObject:

Methods Summary¶

`__init__`	Constructor, optionally passing a bitmap (otherwise use `SetBitmap` later).
`GetAllFormats`	Returns a list of wx.DataFormat objects which this data object
`GetBitmap`	Returns the bitmap associated with the data object.
`SetBitmap`	Sets the bitmap associated with the data object.
`SetData`

Properties Summary¶

`AllFormats`	See `GetAllFormats`
`Bitmap`	See `GetBitmap` and `SetBitmap`

Class API¶

class wx.BitmapDataObject(DataObjectSimple)¶

Possible constructors:

BitmapDataObject(bitmap=NullBitmap) -> None

BitmapDataObject is a specialization of DataObject for bitmap data.

Methods¶

__init__(self, bitmap=NullBitmap)¶

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

Parameters:: bitmap (wx.Bitmap)
Return type:: None

GetAllFormats(self, dir=DataObject.Get)¶

Returns a list of wx.DataFormat objects which this data object supports transferring in the given direction.

Return type:: Any

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

Return type:: wx.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 (wx.Bitmap)
Return type:: None

SetData(self, format, buf)¶

Return type:: bool

Properties¶

AllFormats¶: See GetAllFormats

Bitmap¶: See GetBitmap and SetBitmap