# :stopdoc:
# This file is automatically generated by the WXRuby3 documentation 
# generator. Do not alter this file.
# :startdoc:


module Wx::GRID

  # 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 {Wx::GRID::GridRangeSelectEvent} events.
  # Event handler methods:
  # - {Wx::EvtHandler#evt_grid_range_selecting}(meth = nil, &block): The user is selecting a group of contiguous cells. Processes a {Wx::GRID::EVT_GRID_RANGE_SELECTING} event type. This event is available in wxWidgets 3.1.5 and later only. 
  # - {Wx::EvtHandler#evt_grid_cmd_range_selecting}(id, meth = nil, &block): The user is selecting a group of contiguous cells; variant taking a window identifier. Processes a {Wx::GRID::EVT_GRID_RANGE_SELECTING} event type. This event is available in wxWidgets 3.1.5 and later only. 
  # - {Wx::EvtHandler#evt_grid_range_selected}(meth = nil, &block): The user selected a group of contiguous cells. Processes a {Wx::GRID::EVT_GRID_RANGE_SELECTED} event type. This event is available in wxWidgets 3.1.5 and later only and was called {Wx::EVT_GRID_RANGE_SELECT} in the previous versions. 
  # - {Wx::EvtHandler#evt_grid_cmd_range_selected}(id, meth = nil, &block): The user selected a group of contiguous cells; variant taking a window identifier. Processes a {Wx::GRID::EVT_GRID_RANGE_SELECTED} event type. This event is available in wxWidgets 3.1.5 and later only and was called {Wx::EVT_GRID_CMD_RANGE_SELECT} in the previous versions. 
  # 
  # === 
  # 
  # Category:  Grid Related Classes, {Wx::Events}
  # 
  class GridRangeSelectEvent < NotifyEvent
  
    # @overload initialize()
    #   Default constructor.
    #   @return [GridRangeSelectEvent]
    # @overload initialize(id, type, obj, topLeft, bottomRight, sel=true, kbd=(Wx::KeyboardState.new()))
    #   Constructor for initializing all event attributes.
    #   @param id [Integer] 
    #   @param type [Integer] 
    #   @param obj [Wx::Object] 
    #   @param topLeft [Wx::GridCellCoords] 
    #   @param bottomRight [Wx::GridCellCoords] 
    #   @param sel [true,false] 
    #   @param kbd [Wx::KeyboardState] 
    #   @return [GridRangeSelectEvent]
    def initialize(*args) end
    
    # Returns true if the Alt key was down at the time of the event.
    # @return [true,false]
    def alt_down; end
    
    # Returns true if the Control key was down at the time of the event.
    # @return [true,false]
    def control_down; end
    
    # Top left corner of the rectangular area that was (de)selected.
    # @return [Array(Integer, Integer)]
    def get_bottom_right_coords; end
    alias_method :bottom_right_coords, :get_bottom_right_coords
    
    # Bottom row of the rectangular area that was (de)selected.
    # @return [Integer]
    def get_bottom_row; end
    alias_method :bottom_row, :get_bottom_row
    
    # Left column of the rectangular area that was (de)selected.
    # @return [Integer]
    def get_left_col; end
    alias_method :left_col, :get_left_col
    
    # Right column of the rectangular area that was (de)selected.
    # @return [Integer]
    def get_right_col; end
    alias_method :right_col, :get_right_col
    
    # Top left corner of the rectangular area that was (de)selected.
    # @return [Array(Integer, Integer)]
    def get_top_left_coords; end
    alias_method :top_left_coords, :get_top_left_coords
    
    # Top row of the rectangular area that was (de)selected.
    # @return [Integer]
    def get_top_row; end
    alias_method :top_row, :get_top_row
    
    # Returns true if the Meta key was down at the time of the event.
    # @return [true,false]
    def meta_down; end
    
    # Returns true if the area was selected, false otherwise.
    # @return [true,false]
    def selecting; end
    
    # Returns true if the Shift key was down at the time of the event.
    # @return [true,false]
    def shift_down; end
    
  end # GridRangeSelectEvent
  

end