Class: Wx::FileDirPickerEvent

Inherits:

CommandEvent

• Object
• Object
• Event
• CommandEvent
• Wx::FileDirPickerEvent

Defined in:

lib/wx/doc/gen/file_dir_picker_event.rb

Overview

This event class is used for the events generated by FilePickerCtrl and by DirPickerCtrl.

Events using this class

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

• EvtHandler#evt_filepicker_changed(id, meth = nil, &block): Generated whenever the selected file changes.

• EvtHandler#evt_dirpicker_changed(id, meth = nil, &block): Generated whenever the selected directory changes.

Category: Events

See Also:

• FilePickerCtrl
• DirPickerCtrl

Requires:

• USE_DIRDLG&USE_DIRPICKERCTRL or USE_FILEDLG&USE_FILEPICKERCTRL

Instance Method Summary

• #get_path ⇒ String (also: #path)

  Retrieve the absolute path of the file/directory the user has just selected.

• #initialize(*args) ⇒ FileDirPickerEvent constructor

  A new instance of FileDirPickerEvent.

• #set_path(path) ⇒ void (also: #path=)

  Set the absolute path of the file/directory associated with the 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 ⇒ Wx::FileDirPickerEvent #initialize(type, generator, id, path) ⇒ Wx::FileDirPickerEvent

Returns a new instance of FileDirPickerEvent.

Overloads:

• #initialize ⇒ Wx::FileDirPickerEvent
• #initialize(type, generator, id, path) ⇒ Wx::FileDirPickerEvent

  The constructor is not normally used by the user code.

  Parameters:

  • type (Wx::GenericCollapsiblePane::EventType)
  • generator (Wx::Object)
  • id (Integer)
  • path (String)

# File 'lib/wx/doc/gen/file_dir_picker_event.rb', line 84

def initialize(*args) end

Instance Method Details

#get_path ⇒ String Also known as: path

Retrieve the absolute path of the file/directory the user has just selected.

Returns:

• (String)

# File 'lib/wx/doc/gen/file_dir_picker_event.rb', line 88

def get_path; end

#set_path(path) ⇒ void Also known as: path=

This method returns an undefined value.

Set the absolute path of the file/directory associated with the event.

Parameters:

• path (String)

# File 'lib/wx/doc/gen/file_dir_picker_event.rb', line 94

def set_path(path) end