.. include:: headings.inc

.. currentmodule:: lib.agw.customtreectrl

.. highlight:: python



.. _lib.agw.customtreectrl.DragImage:

==========================================================================================================================================
|phoenix_title|  **DragImage**
==========================================================================================================================================

This class handles the creation of a custom image in case of item drag
and drop.



|

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

Inheritance diagram for class **DragImage**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.agw.customtreectrl.DragImage_inheritance.png" alt="Inheritance diagram of DragImage" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node6" href="lib.agw.customtreectrl.DragImage.html" title="This class handles the creation of a custom image in case of item drag" alt="" coords="397,5,608,35"/> <area shape="rect" id="node2" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="125,5,197,35"/> </map> 
   </p>

|


|super_classes| Known Superclasses
==================================

:class:`DragImage`

|


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

================================================================================ ================================================================================
:meth:`~lib.agw.customtreectrl.DragImage.__init__`                               Default class constructor.
:meth:`~lib.agw.customtreectrl.DragImage.CreateBitmap`                           Actually creates the drag and drop bitmap for :class:`DragImage`.
================================================================================ ================================================================================


|


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

.. class:: DragImage(DragImage)

   This class handles the creation of a custom image in case of item drag
   and drop.

   .. method:: __init__(self, treeCtrl, item)

      Default class constructor.
      For internal use: do not call it in your code!
      
      :param `treeCtrl`: the parent :class:`CustomTreeCtrl`;
      :param `item`: one of the tree control item (an instance of :class:`GenericTreeItem`).


   .. method:: CreateBitmap(self)

      Actually creates the drag and drop bitmap for :class:`DragImage`.
      
      :return: An instance of :class:`DragImage`, a close representation of the item's
       appearance (i.e., a screenshot of the item).