.. include:: headings.inc



.. _BitmapDataObject:

==========================================================================================================================================
|phoenix_title|  **BitmapDataObject**
==========================================================================================================================================

:ref:`BitmapDataObject`  is a specialization of :ref:`DataObject`  for bitmap data.          

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







         



.. seealso:: :ref:`Drag and Drop Overview <drag and drop overview>`, :ref:`DataObject`, :ref:`DataObjectSimple`, :ref:`FileDataObject`, :ref:`TextDataObject`, :ref:`DataObject`    







|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **BitmapDataObject**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/BitmapDataObject_inheritance.png" alt="Inheritance diagram of BitmapDataObject" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="DataObjectSimple.html" title="This is the simplest possible implementation of the DataObject  class." alt="" coords="143,5,268,35"/> <area shape="rect" id="node4" href="BitmapDataObject.html" title="BitmapDataObject  is a specialization of DataObject  for bitmap data." alt="" coords="317,5,445,35"/> <area shape="rect" id="node2" href="DataObject.html" title="A DataObject  represents data that can be copied to or from the clipboard, or dragged and dropped." alt="" coords="7,5,92,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~BitmapDataObject.__init__`                                               Constructor, optionally passing a bitmap (otherwise use :meth:`SetBitmap`   later).
:meth:`~BitmapDataObject.GetBitmap`                                              Returns the bitmap associated with the data object.
:meth:`~BitmapDataObject.SetBitmap`                                              Sets the bitmap associated with the data object.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~BitmapDataObject.Bitmap`                                                 See :meth:`~BitmapDataObject.GetBitmap` and :meth:`~BitmapDataObject.SetBitmap`
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: BitmapDataObject(DataObjectSimple)

   BitmapDataObject is a specialization of DataObject for bitmap data.
   
   **Possible constructors**::

       BitmapDataObject(bitmap=NullBitmap)
       



   .. method:: __init__(self, bitmap=NullBitmap)

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


      :param `bitmap`: 
      :type `bitmap`: Bitmap







   .. method:: 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 :ref:`Clipboard`.                  

      :rtype: :ref:`Bitmap`








   .. method:: 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.                  


      :param `bitmap`: 
      :type `bitmap`: Bitmap







   .. attribute:: Bitmap

      See :meth:`~BitmapDataObject.GetBitmap` and :meth:`~BitmapDataObject.SetBitmap`