Class: Wx::GRID::GridEditorCreatedEvent

Inherits:

CommandEvent

• Object
• Object
• Event
• CommandEvent
• Wx::GRID::GridEditorCreatedEvent

Defined in:

lib/wx/doc/gen/grid/grid_editor_created_event.rb

Overview

Events using this class

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

• EvtHandler#evt_grid_editor_created(meth = nil, &block): The editor for a cell was created. Processes a EVT_GRID_EDITOR_CREATED event type.

• EvtHandler#evt_grid_cmd_editor_created(id, meth = nil, &block): The editor for a cell was created; variant taking a window identifier. Processes a EVT_GRID_EDITOR_CREATED event type.

Category: Grid Related Classes, Events

Requires:

• USE_GRID

Instance Method Summary

• #get_col ⇒ Integer (also: #col)

  Returns the column at which the event occurred.

• #get_control ⇒ Wx::Control (also: #control)

  Returns the edit control.

• #get_row ⇒ Integer (also: #row)

  Returns the row at which the event occurred.

• #get_window ⇒ Wx::Window (also: #window)

  Returns the edit window.

• #initialize(*args) ⇒ GridEditorCreatedEvent constructor

  A new instance of GridEditorCreatedEvent.

• #set_col(col) ⇒ void (also: #col=)

  Sets the column at which the event occurred.

• #set_control(ctrl) ⇒ void (also: #control=)

  Sets the edit control.

• #set_row(row) ⇒ void (also: #row=)

  Sets the row at which the event occurred.

• #set_window(window) ⇒ void (also: #window=)

  Sets the edit window.

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::GRID::GridEditorCreatedEvent #initialize(id, type, obj, row, col, ctrl) ⇒ Wx::GRID::GridEditorCreatedEvent

Returns a new instance of GridEditorCreatedEvent.

Overloads:

• #initialize ⇒ Wx::GRID::GridEditorCreatedEvent

  Default constructor.
• #initialize(id, type, obj, row, col, ctrl) ⇒ Wx::GRID::GridEditorCreatedEvent

  Constructor for initializing all event attributes.

  Parameters:

  • id (Integer)
  • type (Wx::GenericCollapsiblePane::EventType)
  • obj (Wx::Object)
  • row (Integer)
  • col (Integer)
  • ctrl (Wx::Control)

# File 'lib/wx/doc/gen/grid/grid_editor_created_event.rb', line 39

def initialize(*args) end

Instance Method Details

#get_col ⇒ Integer Also known as: col

Returns the column at which the event occurred.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/grid/grid_editor_created_event.rb', line 43

def get_col; end

#get_control ⇒ Wx::Control Also known as: control

Returns the edit control.

This function is preserved for compatibility, but #get_window should be preferred in the new code as the associated window doesn’t need to be of a Control-derived class. Note that if #set_window had been called with an object not deriving from Control, this method will return NULL.

Returns:

• (Wx::Control)

# File 'lib/wx/doc/gen/grid/grid_editor_created_event.rb', line 51

def get_control; end

#get_row ⇒ Integer Also known as: row

Returns the row at which the event occurred.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/grid/grid_editor_created_event.rb', line 56

def get_row; end

#get_window ⇒ Wx::Window Also known as: window

Returns the edit window.

Returns:

• (Wx::Window)

# File 'lib/wx/doc/gen/grid/grid_editor_created_event.rb', line 61

def get_window; end

#set_col(col) ⇒ void Also known as: col=

This method returns an undefined value.

Sets the column at which the event occurred.

Parameters:

• col (Integer)

# File 'lib/wx/doc/gen/grid/grid_editor_created_event.rb', line 67

def set_col(col) end

#set_control(ctrl) ⇒ void Also known as: control=

This method returns an undefined value.

Sets the edit control.

This function is preserved for compatibility, but #set_window should be preferred in the new code, see #get_control.

Parameters:

• ctrl (Wx::Control)

# File 'lib/wx/doc/gen/grid/grid_editor_created_event.rb', line 75

def set_control(ctrl) end

#set_row(row) ⇒ void Also known as: row=

This method returns an undefined value.

Sets the row at which the event occurred.

Parameters:

• row (Integer)

# File 'lib/wx/doc/gen/grid/grid_editor_created_event.rb', line 81

def set_row(row) end

#set_window(window) ⇒ void Also known as: window=

This method returns an undefined value.

Sets the edit window.

Parameters:

• window (Wx::Window)

# File 'lib/wx/doc/gen/grid/grid_editor_created_event.rb', line 87

def set_window(window) end