.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.agw.customtreectrl
.. highlight:: python
.. _wx.lib.agw.customtreectrl.DragImage:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.customtreectrl.DragImage**
==========================================================================================================================================
This class handles the creation of a custom image in case of item drag
and drop.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
DragImage:
|
|super_classes| Known Superclasses
==================================
:class:`wx.DragImage`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.customtreectrl.DragImage.__init__` Default class constructor.
:meth:`~wx.lib.agw.customtreectrl.DragImage.CreateBitmap` Actually creates the drag and drop bitmap for :class:`DragImage`.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: DragImage(wx.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).