Package wx :: Class BitmapDataObject
[frames | no frames]

Type BitmapDataObject

  object --+        
           |        
  DataObject --+    
               |    
DataObjectSimple --+
                   |
                  BitmapDataObject

Known Subclasses:
PyBitmapDataObject

wx.BitmapDataObject is a specialization of wxDataObject for bitmap data. It can be used without change to paste data into the wx.Clipboard or a wx.DropSource.


See Also:

wx.PyBitmapDataObject if you wish to override GetBitmap to increase efficiency.

Method Summary
BitmapDataObject __init__(self, bitmap)
Constructor, optionally passing a bitmap (otherwise use SetBitmap later).
  __repr__(self)
Bitmap GetBitmap(self)
Returns the bitmap associated with the data object.
  SetBitmap(self, bitmap)
Sets the bitmap associated with the data object.
    Inherited from DataObjectSimple
String GetDataHere(self)
Returns the data bytes from the data object as a string, returns None on failure.
size_t GetDataSize(self)
Get the size of our data.
DataFormat GetFormat(self)
Returns the (one and only one) format supported by this object.
bool SetData(self, data)
Copy the data value to the data object.
  SetFormat(self, format)
Sets the supported format.
    Inherited from DataObject
  __del__(self)
[formats] GetAllFormats(self, dir)
Returns a list of all the wx.DataFormats that this dataobject supports in the given direction.
size_t GetFormatCount(self, dir)
Returns the number of available formats for rendering or setting the data.
DataFormat GetPreferredFormat(self, dir)
Returns the preferred format for either rendering the data (if dir is Get, its default value) or for setting it.
bool IsSupported(self, format, dir)
Returns True if this format is supported.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
Return hash(x)...
  __new__(T, S, ...)
Return a new object with type S, a subtype of T...
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
Return str(x)...

Class Variable Summary
    Inherited from DataObject
int Both = 3                                                                     
int Get = 1                                                                     
int Set = 2                                                                     

Method Details

__init__(self, bitmap=wxNullBitmap)
(Constructor)

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

Parameters:
bitmap
           (type=Bitmap)

Returns:
BitmapDataObject
Overrides:
wx.DataObjectSimple.__init__

GetBitmap(self)

Returns the bitmap associated with the data object. You may wish to override this method (by deriving from wx.PyBitmapDataObject) 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.

Returns:
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
           (type=Bitmap)


Generated by Epydoc 2.1.20050511.rpd on Sat Jun 16 16:48:13 2007 http://epydoc.sf.net