Class: Wx::DropFilesEvent

Inherits:
Event show all
Defined in:
lib/wx/doc/gen/events.rb

Overview

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 Window#drag_accept_files. Important note: this is a separate implementation to the more general drag and drop implementation documented in the Drag and Drop Overview. It uses the older, Windows message-based approach of dropping files.

Events using this class

The following event-handler methods redirect the events to member method or handler blocks for DropFilesEvent events. Event handler methods:

Remark:

Windows only until version 2.8.9, available on all platforms since 2.8.10.

Category: Events

See Also:

Instance Method Summary collapse

Methods inherited from Event

#clone, #get_event_category, #get_event_object, #get_event_type, #get_id, #get_skipped, #get_timestamp, #is_command_event, #resume_propagation, #set_event_object, #set_event_type, #set_id, #set_timestamp, #should_propagate, #skip, #stop_propagation

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(id = 0, noFiles = 0, files = nil) ⇒ Wx::DropFilesEvent

Constructor.

Parameters:

  • id (Wx::GenericCollapsiblePane::EventType) (defaults to: 0)
  • noFiles (Integer) (defaults to: 0)
  • files (String) (defaults to: nil) 


2085
 
# File 'lib/wx/doc/gen/events.rb', line 2085

def initialize(id=0, noFiles=0, files=nil) end

Instance Method Details

#get_files ⇒ String Also known as: files

Returns an array of filenames.

Returns:

  • (String) 


2089
 
# File 'lib/wx/doc/gen/events.rb', line 2089

def get_files; end

#get_number_of_files ⇒ Integer Also known as: number_of_files

Returns the number of files dropped.

Returns:

  • (Integer) 


2094
 
# File 'lib/wx/doc/gen/events.rb', line 2094

def get_number_of_files; end

#get_position ⇒ Wx::Point Also known as: position

Returns the position at which the files were dropped.

Returns an array of filenames.

Returns:



2101
 
# File 'lib/wx/doc/gen/events.rb', line 2101

def get_position; end