Class: Wx::GRID::GridSizeEvent

Inherits:

NotifyEvent

• Object
• Object
• Event
• CommandEvent
• NotifyEvent
• Wx::GRID::GridSizeEvent

Defined in:

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

Overview

This event class contains information about a row/column resize event.

Events using this class

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

• EvtHandler#evt_grid_cmd_col_size(id, meth = nil, &block): The user resized a column, corresponds to EVT_GRID_COL_SIZE event type.

• EvtHandler#evt_grid_cmd_row_size(id, meth = nil, &block): The user resized a row, corresponds to EVT_GRID_ROW_SIZE event type.

• EvtHandler#evt_grid_row_auto_size(meth = nil, &block): This event is sent when a row must be resized to its best size, e.g. when the user double clicks the row divider. The default implementation simply resizes the row to fit the row label (but not its contents as this could be too slow for big grids). This macro corresponds to EVT_GRID_ROW_AUTO_SIZE event type and is new since wxWidgets 3.1.7.

• EvtHandler#evt_grid_col_size(meth = nil, &block): Same as EVT_GRID_CMD_COL_SIZE() but uses StandardID::ID_ANY id.

• EvtHandler#evt_grid_col_auto_size(meth = nil, &block): This event is sent when a column must be resized to its best size, e.g. when the user double clicks the column divider. The default implementation simply resizes the column to fit the column label (but not its contents as this could be too slow for big grids). This macro corresponds to EVT_GRID_COL_AUTO_SIZE event type and is new since wxWidgets 2.9.5.

• EvtHandler#evt_grid_row_size(meth = nil, &block): Same as EVT_GRID_CMD_ROW_SIZE() but uses StandardID::ID_ANY id.

• EvtHandler#evt_grid_row_label_size(id, meth = nil, &block): The user resized the row labels. Corresponds to EVT_GRID_ROW_LABEL_SIZE event type. This is new since wxWidgets 3.3.0.

• EvtHandler#evt_grid_col_label_size(id, meth = nil, &block): The user resized the column labels. Corresponds to EVT_GRID_COL_LABEL_SIZE event type. This is new since wxWidgets 3.3.0.

Category: Grid Related Classes, Events

Requires:

• USE_GRID

Instance Method Summary

• #alt_down ⇒ Boolean

  Returns true if the Alt key was down at the time of the event.

• #control_down ⇒ Boolean

  Returns true if the Control key was down at the time of the event.

• #get_position ⇒ Wx::Point (also: #position)

  Position in pixels at which the event occurred.

• #get_row_or_col ⇒ Integer (also: #row_or_col)

  Row or column at that was resized.

• #initialize(*args) ⇒ GridSizeEvent constructor

  A new instance of GridSizeEvent.

• #meta_down ⇒ Boolean

  Returns true if the Meta key was down at the time of the event.

• #shift_down ⇒ Boolean

  Returns true if the Shift key was down at the time of the event.

Methods inherited from NotifyEvent

#allow, #is_allowed, #veto

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::GridSizeEvent #initialize(id, type, obj, rowOrCol = -1, x = -1, y = -1, kbd = (Wx::KeyboardState.new())) ⇒ Wx::GRID::GridSizeEvent

Returns a new instance of GridSizeEvent.

Overloads:

• #initialize ⇒ Wx::GRID::GridSizeEvent

  Default constructor.
• #initialize(id, type, obj, rowOrCol = -1, x = -1, y = -1, kbd = (Wx::KeyboardState.new())) ⇒ Wx::GRID::GridSizeEvent

  Constructor for initializing all event attributes.

  Parameters:

  • id (Integer)
  • type (Wx::HTML::SimpleHtmlListBox::EventType)
  • obj (Wx::Object)
  • rowOrCol (Integer) (defaults to: -1)
  • x (Integer) (defaults to: -1)
  • y (Integer) (defaults to: -1)
  • kbd (Wx::KeyboardState) (defaults to: (Wx::KeyboardState.new()))

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

def initialize(*args) end

Instance Method Details

#alt_down ⇒ Boolean

Returns true if the Alt key was down at the time of the event.

Returns:

• (Boolean)

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

def alt_down; end

#control_down ⇒ Boolean

Returns true if the Control key was down at the time of the event.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/grid/grid_size_event.rb', line 60

def control_down; end

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

Position in pixels at which the event occurred.

Returns:

• (Wx::Point)

# File 'lib/wx/doc/gen/grid/grid_size_event.rb', line 64

def get_position; end

#get_row_or_col ⇒ Integer Also known as: row_or_col

Row or column at that was resized.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/grid/grid_size_event.rb', line 69

def get_row_or_col; end

#meta_down ⇒ Boolean

Returns true if the Meta key was down at the time of the event.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/grid/grid_size_event.rb', line 74

def meta_down; end

#shift_down ⇒ Boolean

Returns true if the Shift key was down at the time of the event.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/grid/grid_size_event.rb', line 78

def shift_down; end