Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxDropFilesEvent (3erl)

Name

wxDropFilesEvent - Functions for wxDropFilesEvent class

Synopsis

Please see following description for synopsis

Description

wxDropFilesEvent(3)        Erlang Module Definition        wxDropFilesEvent(3)



NAME
       wxDropFilesEvent - Functions for wxDropFilesEvent class

DESCRIPTION
       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.

DATA TYPES
       wxDropFilesEvent() = wx:wx_object()

       wxDropFiles() =
           #wxDropFiles{type = wxDropFilesEvent:wxDropFilesEventType(),
                        pos = {X :: integer(), Y :: integer()},
                        files = [unicode:chardata()]}

       wxDropFilesEventType() = drop_files

EXPORTS
       getPosition(This) -> {X :: integer(), Y :: integer()}

              Types:

                 This = wxDropFilesEvent()

              Returns the position at which the files were dropped.

              Returns an array of filenames.

       getNumberOfFiles(This) -> integer()

              Types:

                 This = wxDropFilesEvent()

              Returns the number of files dropped.

       getFiles(This) -> [unicode:charlist()]

              Types:

                 This = wxDropFilesEvent()

              Returns an array of filenames.



wxWidgets team.                    wx 2.1.1                wxDropFilesEvent(3)