Version: 3.1.1
wxFileDropTarget Class Referenceabstract

#include <wx/dnd.h>

+ Inheritance diagram for wxFileDropTarget:

Detailed Description

This is a drop target which accepts files (dragged from File Manager or Explorer).

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

Public Member Functions

 wxFileDropTarget ()
 Constructor. More...
 
virtual bool OnDrop (wxCoord x, wxCoord y)
 See wxDropTarget::OnDrop(). More...
 
virtual bool OnDropFiles (wxCoord x, wxCoord y, const wxArrayString &filenames)=0
 Override this function to receive dropped files. 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

wxFileDropTarget::wxFileDropTarget ( )

Constructor.

Member Function Documentation

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

See wxDropTarget::OnDrop().

This function is implemented appropriately for files, and calls OnDropFiles().

Reimplemented from wxDropTarget.

virtual bool wxFileDropTarget::OnDropFiles ( wxCoord  x,
wxCoord  y,
const wxArrayString filenames 
)
pure virtual

Override this function to receive dropped files.

Parameters
xThe x coordinate of the mouse.
yThe y coordinate of the mouse.
filenamesAn array of filenames.

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