Phoenix Logo

phoenix_title 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 Class Hierarchy

Inheritance diagram for class BitmapDataObject:


method_summary 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  

property_summary Properties Summary

AllFormats See GetAllFormats
Bitmap See GetBitmap and SetBitmap

api Class API



class wx.BitmapDataObject(DataObjectSimple)

Possible constructors:

BitmapDataObject(bitmap=NullBitmap)

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) –


GetAllFormats(self, dir=DataObject.Get)

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



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) –


SetData(self, format, buf)
Return type:bool

Properties



AllFormats

See GetAllFormats



Bitmap

See GetBitmap and SetBitmap