Class: Wx::GRID::GridRangeSelectEvent

Inherits:
NotifyEvent show all
Defined in:
lib/wx/doc/gen/grid/grid_range_select_event.rb

Overview

Events of this class notify about a range of cells being selected.

When the user uses the mouse for selection, one or more SELECTING events are generated first, with SELECTED event generated at the end, when selection is final. This allows the application to handle either the SELECTING events if it needs to update its state in real-time, as the selection changes, or just the final SELECTED event, if updating its state on every selection change would be too time-consuming. Note that if the user performs the selection from keyboard, SELECTING events are not generated at all, so SELECTED event still must be handled. Finally, contrary to most of the other events with the name ending in “ing”, SELECTING event can not be vetoed.

Events using this class

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

Category: Grid Related Classes, Events

Requires:

  • USE_GRID

Instance Method Summary collapse

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::GridRangeSelectEvent #initialize(id, type, obj, topLeft, bottomRight, sel = true, kbd = (Wx::KeyboardState.new())) ⇒ Wx::GRID::GridRangeSelectEvent

Returns a new instance of GridRangeSelectEvent.

Overloads:

  • #initialize ⇒ Wx::GRID::GridRangeSelectEvent

    Default constructor.

  • #initialize(id, type, obj, topLeft, bottomRight, sel = true, kbd = (Wx::KeyboardState.new())) ⇒ Wx::GRID::GridRangeSelectEvent

    Constructor for initializing all event attributes.

    Parameters:

    • id (Integer)
    • type (Wx::GenericCollapsiblePane::EventType)
    • obj (Wx::Object)
    • topLeft (Array(Integer, Integer))
    • bottomRight (Array(Integer, Integer))
    • sel (Boolean) (defaults to: true)
    • kbd (Wx::KeyboardState) (defaults to: (Wx::KeyboardState.new())) 


47
 
# File 'lib/wx/doc/gen/grid/grid_range_select_event.rb', line 47

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) 


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

def alt_down; end

#control_down ⇒ Boolean

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

Returns:

  • (Boolean) 


55
 
# File 'lib/wx/doc/gen/grid/grid_range_select_event.rb', line 55

def control_down; end

#get_bottom_right_coords ⇒ Array(Integer, Integer) Also known as: bottom_right_coords

Top left corner of the rectangular area that was (de)selected.

Returns:

  • (Array(Integer, Integer)) 


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

def get_bottom_right_coords; end

#get_bottom_row ⇒ Integer Also known as: bottom_row

Bottom row of the rectangular area that was (de)selected.

Returns:

  • (Integer) 


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

def get_bottom_row; end

#get_left_col ⇒ Integer Also known as: left_col

Left column of the rectangular area that was (de)selected.

Returns:

  • (Integer) 


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

def get_left_col; end

#get_right_col ⇒ Integer Also known as: right_col

Right column of the rectangular area that was (de)selected.

Returns:

  • (Integer) 


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

def get_right_col; end

#get_top_left_coords ⇒ Array(Integer, Integer) Also known as: top_left_coords

Top left corner of the rectangular area that was (de)selected.

Returns:

  • (Array(Integer, Integer)) 


79
 
# File 'lib/wx/doc/gen/grid/grid_range_select_event.rb', line 79

def get_top_left_coords; end

#get_top_row ⇒ Integer Also known as: top_row

Top row of the rectangular area that was (de)selected.

Returns:

  • (Integer) 


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

def get_top_row; end

#meta_down ⇒ Boolean

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

Returns:

  • (Boolean) 


89
 
# File 'lib/wx/doc/gen/grid/grid_range_select_event.rb', line 89

def meta_down; end

#selecting ⇒ Boolean

Returns true if the area was selected, false otherwise.

Returns:

  • (Boolean) 


93
 
# File 'lib/wx/doc/gen/grid/grid_range_select_event.rb', line 93

def selecting; end

#shift_down ⇒ Boolean

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

Returns:

  • (Boolean) 


97
 
# File 'lib/wx/doc/gen/grid/grid_range_select_event.rb', line 97

def shift_down; end