View Source wxDropFilesEvent (wx v2.4.2)
Functions for wxDropFilesEvent class
This class is used for drop files events, that is, when files have been dropped onto the window.
The window must have previously been enabled for dropping by calling
wxWindow:dragAcceptFiles/2.
Important note: this is a separate implementation to the more general drag and drop implementation documented in the overview_dnd. It uses the older, Windows message-based approach of dropping files.
Remark: Windows only until version 2.8.9, available on all platforms since 2.8.10.
See:
Overview events,
wxWindow:dragAcceptFiles/2
This class is derived (and can use functions) from: wxEvent
wxWidgets docs: wxDropFilesEvent
Events
Use wxEvtHandler:connect/3 with
wxDropFilesEventType to subscribe to events of
this type.
Summary
Functions
Returns an array of filenames.
Returns the number of files dropped.
Returns the position at which the files were dropped.
Types
-type wxDropFiles() :: #wxDropFiles{type :: wxDropFilesEvent:wxDropFilesEventType(), pos :: {X :: integer(), Y :: integer()}, files :: [unicode:chardata()]}.
-type wxDropFilesEvent() :: wx:wx_object().
-type wxDropFilesEventType() :: drop_files.
Functions
-spec getFiles(This) -> [unicode:charlist()] when This :: wxDropFilesEvent().
Returns an array of filenames.
-spec getNumberOfFiles(This) -> integer() when This :: wxDropFilesEvent().
Returns the number of files dropped.
-spec getPosition(This) -> {X :: integer(), Y :: integer()} when This :: wxDropFilesEvent().
Returns the position at which the files were dropped.
Returns an array of filenames.