*******************
wx.BitmapDataObject
*******************

Inheritance diagram for `wx.BitmapDataObject`:

|

.. inheritance-diagram:: wx.BitmapDataObject

|

Description
===========

`wx.BitmapDataObject` is a specialization of `wx.DataObject <wx.DataObject.html>`_ for bitmap data. It can be used without change to paste 
data into the  `wx.Clipboard <wx.Clipboard.html>`_ or a `wx.DropSource <wx.DropSource.html>`_. 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.

.. note:: **wxPython note**: If you wish to create a derived `wx.BitmapDataObject` class in wxPython you should derive the class 
   from `wx.PyBitmapDataObject <wx.PyBitmapDataObject.html>`_ in order to get Python-aware capabilities for the various virtual methods.


Derived From
^^^^^^^^^^^^^

* `wx.DataObjectSimple <wx.DataObjectSimple.html>`_ 
* `wx.DataObject <wx.DataObject.html>`_ 


Known Subclasses
^^^^^^^^^^^^^^^^

`wx.PyBitmapDataObject <wx.PyBitmapDataObject.html>`_

Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetBitmap <#GetBitmap>`_ 
* `SetBitmap <#SetBitmap>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `Bitmap <#Bitmap>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(bitmap=wx.NullBitmap)

   Constructor, optionally passing a bitmap (otherwise use `SetBitmap <#SetBitmap>`_ later).
   
   **Parameters:**

   * `bitmap` (`wx.Bitmap <wx.Bitmap.html>`_)

   |

   **Returns:**

   `wx.BitmapDataObject <wx.BitmapDataObject.html>`_
 

--------

.. method:: GetBitmap()

   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 <wx.Clipboard.html>`_ .

   |  

   **Returns:**

   `wx.Bitmap <wx.Bitmap.html>`_
 

--------

.. method:: SetBitmap(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 <wx.Bitmap.html>`_) 

--------

Properties
^^^^^^^^^^

.. attribute:: Bitmap

   See `GetBitmap <#GetBitmap>`_  and `SetBitmap <#SetBitmap>`_