Version: 3.1.1
wxTextDropTarget Class Referenceabstract

#include <wx/dnd.h>

+ Inheritance diagram for wxTextDropTarget:

Detailed Description

A predefined drop target for dealing with text data.

Library:  wxCore
Category:  Clipboard and Drag & Drop
See also
Drag and Drop Overview, wxDropSource, wxDropTarget, wxFileDropTarget

Public Member Functions

 wxTextDropTarget ()
 Constructor. More...
 
virtual bool OnDrop (wxCoord x, wxCoord y)
 See wxDropTarget::OnDrop(). More...
 
virtual bool OnDropText (wxCoord x, wxCoord y, const wxString &data)=0
 Override this function to receive dropped text. More...
 
- Public Member Functions inherited from wxDropTarget
 wxDropTarget (wxDataObject *data=NULL)
 Constructor. More...
 
virtual ~wxDropTarget ()
 Destructor. More...
 
virtual bool GetData ()
 This method may only be called from within OnData(). More...
 
virtual wxDragResult OnData (wxCoord x, wxCoord y, wxDragResult defResult)=0
 Called after OnDrop() returns true. More...
 
virtual wxDragResult OnDragOver (wxCoord x, wxCoord y, wxDragResult defResult)
 Called when the mouse is being dragged over the drop target. More...
 
virtual wxDragResult OnEnter (wxCoord x, wxCoord y, wxDragResult defResult)
 Called when the mouse enters the drop target. More...
 
virtual void OnLeave ()
 Called when the mouse leaves the drop target. More...
 
wxDataObjectGetDataObject () const
 Returns the data wxDataObject associated with the drop target. More...
 
void SetDataObject (wxDataObject *data)
 Sets the data wxDataObject associated with the drop target and deletes any previously associated data object. More...
 
void SetDefaultAction (wxDragResult action)
 Sets the default action for drag and drop. More...
 
wxDragResult GetDefaultAction ()
 Returns default action for drag and drop or wxDragNone if this not specified. More...
 

Constructor & Destructor Documentation

wxTextDropTarget::wxTextDropTarget ( )

Constructor.

Member Function Documentation

virtual bool wxTextDropTarget::OnDrop ( wxCoord  x,
wxCoord  y 
)
virtual

See wxDropTarget::OnDrop().

This function is implemented appropriately for text, and calls OnDropText().

Reimplemented from wxDropTarget.

virtual bool wxTextDropTarget::OnDropText ( wxCoord  x,
wxCoord  y,
const wxString data 
)
pure virtual

Override this function to receive dropped text.

Parameters
xThe x coordinate of the mouse.
yThe y coordinate of the mouse.
dataThe data being dropped: a wxString.

Return true to accept the data, or false to veto the operation.