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


module Wx::GRID

  # This event class contains information about various grid events.
  # Notice that all grid event table macros are available in two versions: EVT_GRID_XXX and EVT_GRID_CMD_XXX. The only difference between the two is that the former doesn't allow to specify the grid window identifier and so takes a single parameter, the event handler, but is not suitable if there is more than one grid control in the window where the event table is used (as it would catch the events from all the grids). The version with CMD takes the id as first argument and the event handler as the second one and so can be used with multiple grids as well. Otherwise there are no difference between the two and only the versions without the id are documented below for brevity.
  # ### Events using this class
  # 
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::GRID::GridEvent} events.
  # Event handler methods:
  # 
  # - {Wx::EvtHandler#evt_grid_cell_changing}(meth = nil, &block): The user is about to change the data in a cell. The new cell value as string is available from {Wx::GRID::GridEvent#get_string} event object method. This event can be vetoed if the change is not allowed. Processes a {Wx::GRID::EVT_GRID_CELL_CHANGING} event type. 
  # 
  # - {Wx::EvtHandler#evt_grid_cell_changed}(meth = nil, &block): The user changed the data in a cell. The old cell value as string is available from {Wx::GRID::GridEvent#get_string} event object method. Notice that vetoing this event still works for backwards compatibility reasons but any new code should only veto EVT_GRID_CELL_CHANGING event and not this one. Processes a {Wx::GRID::EVT_GRID_CELL_CHANGED} event type. 
  # 
  # - {Wx::EvtHandler#evt_grid_cell_left_click}(meth = nil, &block): The user clicked a cell with the left mouse button. Processes a {Wx::GRID::EVT_GRID_CELL_LEFT_CLICK} event type. 
  # 
  # - {Wx::EvtHandler#evt_grid_cell_left_dclick}(meth = nil, &block): The user double-clicked a cell with the left mouse button. Processes a {Wx::GRID::EVT_GRID_CELL_LEFT_DCLICK} event type. 
  # 
  # - {Wx::EvtHandler#evt_grid_cell_right_click}(meth = nil, &block): The user clicked a cell with the right mouse button. Processes a {Wx::GRID::EVT_GRID_CELL_RIGHT_CLICK} event type. 
  # 
  # - {Wx::EvtHandler#evt_grid_cell_right_dclick}(meth = nil, &block): The user double-clicked a cell with the right mouse button. Processes a {Wx::GRID::EVT_GRID_CELL_RIGHT_DCLICK} event type. 
  # 
  # - {Wx::EvtHandler#evt_grid_editor_hidden}(meth = nil, &block): The editor for a cell was hidden. Processes a {Wx::GRID::EVT_GRID_EDITOR_HIDDEN} event type. 
  # 
  # - {Wx::EvtHandler#evt_grid_editor_shown}(meth = nil, &block): The editor for a cell was shown. Processes a {Wx::GRID::EVT_GRID_EDITOR_SHOWN} event type. 
  # 
  # - {Wx::EvtHandler#evt_grid_label_left_click}(meth = nil, &block): The user clicked a label with the left mouse button. Processes a {Wx::GRID::EVT_GRID_LABEL_LEFT_CLICK} event type. 
  # 
  # - {Wx::EvtHandler#evt_grid_label_left_dclick}(meth = nil, &block): The user double-clicked a label with the left mouse button. Processes a {Wx::GRID::EVT_GRID_LABEL_LEFT_DCLICK} event type. 
  # 
  # - {Wx::EvtHandler#evt_grid_label_right_click}(meth = nil, &block): The user clicked a label with the right mouse button. Processes a {Wx::GRID::EVT_GRID_LABEL_RIGHT_CLICK} event type. 
  # 
  # - {Wx::EvtHandler#evt_grid_label_right_dclick}(meth = nil, &block): The user double-clicked a label with the right mouse button. Processes a {Wx::GRID::EVT_GRID_LABEL_RIGHT_DCLICK} event type. 
  # 
  # - {Wx::EvtHandler#evt_grid_select_cell}(meth = nil, &block): The given cell is about to be made current, either by user or by the program via a call to {Wx::GRID::Grid#set_grid_cursor} or {Wx::GRID::Grid#go_to_cell}. The event can be vetoed to prevent this from happening and {Wx::GRID::Grid#get_grid_cursor_coords} still returns the previous current cell coordinates during the event handler execution, while the new ones are available via the event object {Wx::GRID::GridEvent#get_row} and {Wx::GRID::GridEvent#get_col} functions. Processes a {Wx::GRID::EVT_GRID_SELECT_CELL} event type. 
  # 
  # - {Wx::EvtHandler#evt_grid_row_move}(meth = nil, &block): The user tries to change the order of the rows in the grid by dragging the row specified by {Wx::GRID::GridEvent#get_row}. This event can be vetoed to either prevent the user from reordering the row change completely (but notice that if you don't want to allow it at all, you simply shouldn't call {Wx::GRID::Grid#enable_drag_row_move} in the first place), vetoed but handled in some way in the handler, e.g. by really moving the row to the new position at the associated table level, or allowed to proceed in which case {Wx::GRID::Grid#set_row_pos} is used to reorder the rows display order without affecting the use of the row indices otherwise. This event macro corresponds to {Wx::GRID::EVT_GRID_ROW_MOVE} event type. It is only available since wxWidgets 3.1.7. 
  # 
  # - {Wx::EvtHandler#evt_grid_col_move}(meth = nil, &block): The user tries to change the order of the columns in the grid by dragging the column specified by {Wx::GRID::GridEvent#get_col}. This event can be vetoed to either prevent the user from reordering the column change completely (but notice that if you don't want to allow it at all, you simply shouldn't call {Wx::GRID::Grid#enable_drag_col_move} in the first place), vetoed but handled in some way in the handler, e.g. by really moving the column to the new position at the associated table level, or allowed to proceed in which case {Wx::GRID::Grid#set_col_pos} is used to reorder the columns display order without affecting the use of the column indices otherwise. This event macro corresponds to {Wx::GRID::EVT_GRID_COL_MOVE} event type. 
  # 
  # - {Wx::EvtHandler#evt_grid_col_sort}(meth = nil, &block): This event is generated when a column is clicked by the user and its name is explained by the fact that the custom reaction to a click on a column is to sort the grid contents by this column. However the grid itself has no special support for sorting and it's up to the handler of this event to update the associated table. But if the event is handled (and not vetoed) the grid supposes that the table was indeed resorted and updates the column to indicate the new sort order and refreshes itself. This event macro corresponds to {Wx::GRID::EVT_GRID_COL_SORT} event type. 
  # 
  # - {Wx::EvtHandler#evt_grid_tabbing}(meth = nil, &block): This event is generated when the user presses TAB or Shift-TAB in the grid. It can be used to customize the simple default TAB handling logic, e.g. to go to the next non-empty cell instead of just the next cell. See also {Wx::GRID::Grid#set_tab_behaviour}. This event is new since wxWidgets 2.9.5. 
  # 
  # Category:  Grid Related Classes, {Wx::Events}
  # 
  # @wxrb_require USE_GRID
  class GridEvent < NotifyEvent
  
    # @overload initialize()
    #   Default constructor.
    #   @return [Wx::GRID::GridEvent]
    # @overload initialize(id, type, obj, row=-1, col=-1, x=-1, y=-1, sel=true, kbd=(Wx::KeyboardState.new()))
    #   Constructor for initializing all event attributes.
    #   @param id [Integer] 
    #   @param type [Wx::Slider::EventType] 
    #   @param obj [Wx::Object] 
    #   @param row [Integer] 
    #   @param col [Integer] 
    #   @param x [Integer] 
    #   @param y [Integer] 
    #   @param sel [Boolean] 
    #   @param kbd [Wx::KeyboardState] 
    #   @return [Wx::GRID::GridEvent]
    def initialize(*args) end
    
    # Returns true if the Alt key was down at the time of the event.
    # @return [Boolean]
    def alt_down; end
    
    # Returns true if the Control key was down at the time of the event.
    # @return [Boolean]
    def control_down; end
    
    # Column at which the event occurred.
    # Notice that for a {Wx::GRID::EVT_GRID_SELECT_CELL} event this column is the column of the newly selected cell while the previously selected cell can be retrieved using {Wx::GRID::Grid#get_grid_cursor_col}.
    # @return [Integer]
    def get_col; end
    alias_method :col, :get_col
    
    # Position in pixels at which the event occurred.
    # @return [Wx::Point]
    def get_position; end
    alias_method :position, :get_position
    
    # Row at which the event occurred.
    # Notice that for a {Wx::GRID::EVT_GRID_SELECT_CELL} event this row is the row of the newly selected cell while the previously selected cell can be retrieved using {Wx::GRID::Grid#get_grid_cursor_row}.
    # @return [Integer]
    def get_row; end
    alias_method :row, :get_row
    
    # Returns true if the Meta key was down at the time of the event.
    # @return [Boolean]
    def meta_down; end
    
    # Returns true if the user is selecting grid cells, or false if deselecting.
    # @return [Boolean]
    def selecting; end
    
    # Returns true if the Shift key was down at the time of the event.
    # @return [Boolean]
    def shift_down; end
    
  end # GridEvent
  

end