Class: Wx::FileCtrlEvent

Inherits:

CommandEvent

• Object
• Object
• Event
• CommandEvent
• Wx::FileCtrlEvent

Defined in:

lib/wx/doc/gen/file_ctrl_event.rb

Overview

A file control event holds information about events associated with FileCtrl objects.

Events using this class

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

• EvtHandler#evt_filectrl_fileactivated(id, meth = nil, &block): The user activated a file(by double-clicking or pressing Enter)

• EvtHandler#evt_filectrl_selectionchanged(id, meth = nil, &block): The user changed the current selection(by selecting or deselecting a file)

• EvtHandler#evt_filectrl_folderchanged(id, meth = nil, &block): The current folder of the file control has been changed

• EvtHandler#evt_filectrl_filterchanged(id, meth = nil, &block): The current file filter of the file control has been changed

Category: Events

Requires:

• USE_FILECTRL

Instance Method Summary

• #get_directory ⇒ String (also: #directory)

  Returns the current directory.

• #get_file ⇒ String (also: #file)

  Returns the file selected (assuming it is only one file).

• #get_files ⇒ Array<String> (also: #files)

  Returns the files selected.

• #get_filter_index ⇒ Integer (also: #filter_index)

  Returns the current file filter index.

• #initialize(type, evtObject, id) ⇒ Wx::FileCtrlEvent constructor

  Constructor.

• #set_directory(directory) ⇒ void (also: #directory=)

  Sets the directory of this event.

• #set_files(files) ⇒ void (also: #files=)

  Sets the files changed by this event.

• #set_filter_index(index) ⇒ void (also: #filter_index=)

  Sets the filter index changed by this event.

Methods inherited from CommandEvent

#client_data, #client_data=, #get_client_data, #get_client_object, #get_int, #get_selection, #get_string, #is_checked, #is_selection, #set_client_data, #set_client_object, #set_extra_long, #set_int, #set_string

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(type, evtObject, id) ⇒ Wx::FileCtrlEvent

Constructor.

Parameters:

• type (Wx::GenericCollapsiblePane::EventType)
• evtObject (Wx::Object)
• id (Integer)

# File 'lib/wx/doc/gen/file_ctrl_event.rb', line 34

def initialize(type, evtObject, id) end

Instance Method Details

#get_directory ⇒ String Also known as: directory

Returns the current directory.

In case of a EVT_FILECTRL_FOLDERCHANGED, this method returns the new directory.

Returns:

• (String)

# File 'lib/wx/doc/gen/file_ctrl_event.rb', line 40

def get_directory; end

#get_file ⇒ String Also known as: file

Returns the file selected (assuming it is only one file).

Returns:

• (String)

# File 'lib/wx/doc/gen/file_ctrl_event.rb', line 45

def get_file; end

#get_files ⇒ Array<String> Also known as: files

Returns the files selected.

In case of a EVT_FILECTRL_SELECTIONCHANGED, this method returns the files selected after the event.

Returns:

• (Array<String>)

# File 'lib/wx/doc/gen/file_ctrl_event.rb', line 52

def get_files; end

#get_filter_index ⇒ Integer Also known as: filter_index

Returns the current file filter index.

For a EVT_FILECTRL_FILTERCHANGED event, this method returns the new file filter index.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/file_ctrl_event.rb', line 59

def get_filter_index; end

#set_directory(directory) ⇒ void Also known as: directory=

This method returns an undefined value.

Sets the directory of this event.

Parameters:

• directory (String)

# File 'lib/wx/doc/gen/file_ctrl_event.rb', line 71

def set_directory(directory) end

#set_files(files) ⇒ void Also known as: files=

This method returns an undefined value.

Sets the files changed by this event.

Parameters:

• files (Array<String>)

# File 'lib/wx/doc/gen/file_ctrl_event.rb', line 65

def set_files(files) end

#set_filter_index(index) ⇒ void Also known as: filter_index=

This method returns an undefined value.

Sets the filter index changed by this event.

Parameters:

• index (Integer)

# File 'lib/wx/doc/gen/file_ctrl_event.rb', line 77

def set_filter_index(index) end