.. include:: headings.inc



.. _TextDropTarget:

==========================================================================================================================================
|phoenix_title|  **TextDropTarget**
==========================================================================================================================================

A predefined drop target for dealing with text data.          







         



.. seealso:: :ref:`Drag and Drop Overview <drag and drop overview>`, :ref:`DropSource`, :ref:`DropTarget`, :ref:`FileDropTarget`    







|

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

Inheritance diagram for class **TextDropTarget**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/TextDropTarget_inheritance.png" alt="Inheritance diagram of TextDropTarget" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="TextDropTarget.html" title="A predefined drop target for dealing with text data." alt="" coords="140,5,249,35"/> <area shape="rect" id="node2" href="DropTarget.html" title="This class represents a target for a drag and drop operation." alt="" coords="5,5,91,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~TextDropTarget.__init__`                                                 Constructor.
:meth:`~TextDropTarget.OnDrop`                                                   See :meth:`DropTarget.OnDrop` .
:meth:`~TextDropTarget.OnDropText`                                               Override this function to receive dropped text.
================================================================================ ================================================================================


|


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

.. class:: TextDropTarget(DropTarget)

   A predefined drop target for dealing with text data.
   
   **Possible constructors**::

       TextDropTarget()
       



   .. method:: __init__(self)

      Constructor.                   





   .. method:: OnDrop(self, x, y)

      See :meth:`DropTarget.OnDrop` .                  

      This function is implemented appropriately for text, and calls :meth:`OnDropText` .                  


      :param `x`: 
      :type `x`: int
      :param `y`: 
      :type `y`: int




      :rtype: `bool`








   .. method:: OnDropText(self, x, y, data)

      Override this function to receive dropped text.                  




      :param `x`: The x coordinate of the mouse.   
      :type `x`: int
      :param `y`: The y coordinate of the mouse.   
      :type `y`: int
      :param `data`: The data being dropped: a `String`.  
      :type `data`: string










      :rtype: `bool`