# ---------------------------------------------------------------------------- # This file is automatically generated by the WXRuby3 documentation # generator. Do not alter this file. # ---------------------------------------------------------------------------- module Wx class EvtHandler # @!group GRID Event handler methods # 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. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridEvent] event the event to handle def evt_grid_cell_changing(meth = nil, &block) end # 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. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridEvent] event the event to handle def evt_grid_cell_changed(meth = nil, &block) end # The user clicked a cell with the left mouse button. Processes a {Wx::GRID::EVT_GRID_CELL_LEFT_CLICK} event type. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridEvent] event the event to handle def evt_grid_cell_left_click(meth = nil, &block) end # The user double-clicked a cell with the left mouse button. Processes a {Wx::GRID::EVT_GRID_CELL_LEFT_DCLICK} event type. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridEvent] event the event to handle def evt_grid_cell_left_dclick(meth = nil, &block) end # The user clicked a cell with the right mouse button. Processes a {Wx::GRID::EVT_GRID_CELL_RIGHT_CLICK} event type. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridEvent] event the event to handle def evt_grid_cell_right_click(meth = nil, &block) end # The user double-clicked a cell with the right mouse button. Processes a {Wx::GRID::EVT_GRID_CELL_RIGHT_DCLICK} event type. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridEvent] event the event to handle def evt_grid_cell_right_dclick(meth = nil, &block) end # The editor for a cell was hidden. Processes a {Wx::GRID::EVT_GRID_EDITOR_HIDDEN} event type. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridEvent] event the event to handle def evt_grid_editor_hidden(meth = nil, &block) end # The editor for a cell was shown. Processes a {Wx::GRID::EVT_GRID_EDITOR_SHOWN} event type. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridEvent] event the event to handle def evt_grid_editor_shown(meth = nil, &block) end # The user clicked a label with the left mouse button. Processes a {Wx::GRID::EVT_GRID_LABEL_LEFT_CLICK} event type. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridEvent] event the event to handle def evt_grid_label_left_click(meth = nil, &block) end # The user double-clicked a label with the left mouse button. Processes a {Wx::GRID::EVT_GRID_LABEL_LEFT_DCLICK} event type. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridEvent] event the event to handle def evt_grid_label_left_dclick(meth = nil, &block) end # The user clicked a label with the right mouse button. Processes a {Wx::GRID::EVT_GRID_LABEL_RIGHT_CLICK} event type. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridEvent] event the event to handle def evt_grid_label_right_click(meth = nil, &block) end # The user double-clicked a label with the right mouse button. Processes a {Wx::GRID::EVT_GRID_LABEL_RIGHT_DCLICK} event type. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridEvent] event the event to handle def evt_grid_label_right_dclick(meth = nil, &block) end # 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. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridEvent] event the event to handle def evt_grid_select_cell(meth = nil, &block) end # 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. # Processes a {Wx::GRID::EVT_GRID_ROW_MOVE} event. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridEvent] event the event to handle def evt_grid_row_move(meth = nil, &block) end # 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. # Processes a {Wx::GRID::EVT_GRID_COL_MOVE} event. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridEvent] event the event to handle def evt_grid_col_move(meth = nil, &block) end # 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. # Processes a {Wx::GRID::EVT_GRID_COL_SORT} event. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridEvent] event the event to handle def evt_grid_col_sort(meth = nil, &block) end # 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. # Processes a {Wx::GRID::EVT_GRID_TABBING} event. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridEvent] event the event to handle def evt_grid_tabbing(meth = nil, &block) end # The user resized a column, corresponds to {Wx::GRID::EVT_GRID_COL_SIZE} event type. # Processes a {Wx::GRID::EVT_GRID_CMD_COL_SIZE} event. # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridSizeEvent] event the event to handle def evt_grid_cmd_col_size(id, meth = nil, &block) end # The user resized a row, corresponds to {Wx::GRID::EVT_GRID_ROW_SIZE} event type. # Processes a {Wx::GRID::EVT_GRID_CMD_ROW_SIZE} event. # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridSizeEvent] event the event to handle def evt_grid_cmd_row_size(id, meth = nil, &block) end # 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 {Wx::GRID::EVT_GRID_ROW_AUTO_SIZE} event type and is new since wxWidgets 3.1.7. # Processes a {Wx::GRID::EVT_GRID_ROW_AUTO_SIZE} event. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridSizeEvent] event the event to handle def evt_grid_row_auto_size(meth = nil, &block) end # Same as EVT_GRID_CMD_COL_SIZE() but uses {Wx::StandardID::ID_ANY} id. # Processes a {Wx::GRID::EVT_GRID_COL_SIZE} event. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridSizeEvent] event the event to handle def evt_grid_col_size(meth = nil, &block) end # 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 {Wx::GRID::EVT_GRID_COL_AUTO_SIZE} event type and is new since wxWidgets 2.9.5. # Processes a {Wx::GRID::EVT_GRID_COL_AUTO_SIZE} event. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridSizeEvent] event the event to handle def evt_grid_col_auto_size(meth = nil, &block) end # Same as EVT_GRID_CMD_ROW_SIZE() but uses {Wx::StandardID::ID_ANY} id. # Processes a {Wx::GRID::EVT_GRID_ROW_SIZE} event. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridSizeEvent] event the event to handle def evt_grid_row_size(meth = nil, &block) end # The editor for a cell was created. Processes a {Wx::GRID::EVT_GRID_EDITOR_CREATED} event type. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridEditorCreatedEvent] event the event to handle def evt_grid_editor_created(meth = nil, &block) end # The editor for a cell was created; variant taking a window identifier. Processes a {Wx::GRID::EVT_GRID_EDITOR_CREATED} event type. # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridEditorCreatedEvent] event the event to handle def evt_grid_cmd_editor_created(id, meth = nil, &block) end # 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. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridRangeSelectEvent] event the event to handle def evt_grid_range_selecting(meth = nil, &block) end # 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. # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridRangeSelectEvent] event the event to handle def evt_grid_cmd_range_selecting(id, meth = nil, &block) end # 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. # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridRangeSelectEvent] event the event to handle def evt_grid_range_selected(meth = nil, &block) end # 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. # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc # @yieldparam [Wx::GRID::GridRangeSelectEvent] event the event to handle def evt_grid_cmd_range_selected(id, meth = nil, &block) end # @!endgroup end end