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


module Wx

  # A list event holds information about events associated with {Wx::ListCtrl} objects.
  # === Events using this class
  # 
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ListEvent} events.
  # Event handler methods:
  # 
  # - {Wx::EvtHandler#evt_list_begin_drag}(id, meth = nil, &block): Begin dragging with the left mouse button. 
  # 
  # - {Wx::EvtHandler#evt_list_begin_rdrag}(id, meth = nil, &block): Begin dragging with the right mouse button. 
  # 
  # - {Wx::EvtHandler#evt_list_begin_label_edit}(id, meth = nil, &block): Begin editing a label. This can be prevented by calling {Wx::ListEvent#veto}. 
  # 
  # - {Wx::EvtHandler#evt_list_end_label_edit}(id, meth = nil, &block): Finish editing a label. This can be prevented by calling {Wx::ListEvent#veto}. 
  # 
  # - {Wx::EvtHandler#evt_list_delete_item}(id, meth = nil, &block): Delete an item. 
  # 
  # - {Wx::EvtHandler#evt_list_delete_all_items}(id, meth = nil, &block): Delete all items. 
  # 
  # - {Wx::EvtHandler#evt_list_item_selected}(id, meth = nil, &block): The item has been selected. Notice that the mouse is captured by the control itself when this event is generated, see event handling overview. 
  # 
  # - {Wx::EvtHandler#evt_list_item_deselected}(id, meth = nil, &block): The item has been deselected. {Wx::ListEvent#get_index} may be -1 with virtual lists. 
  # 
  # - {Wx::EvtHandler#evt_list_item_activated}(id, meth = nil, &block): The item has been activated (ENTER or double click). 
  # 
  # - {Wx::EvtHandler#evt_list_item_focused}(id, meth = nil, &block): The currently focused item has changed. 
  # 
  # - {Wx::EvtHandler#evt_list_item_middle_click}(id, meth = nil, &block): The middle mouse button has been clicked on an item. 
  # 
  # - {Wx::EvtHandler#evt_list_item_right_click}(id, meth = nil, &block): The right mouse button has been clicked on an item. 
  # 
  # - {Wx::EvtHandler#evt_list_key_down}(id, meth = nil, &block): A key has been pressed. {Wx::ListEvent#get_index} may be -1 if no item is selected. 
  # 
  # - {Wx::EvtHandler#evt_list_insert_item}(id, meth = nil, &block): An item has been inserted. 
  # 
  # - {Wx::EvtHandler#evt_list_col_click}(id, meth = nil, &block): A column (m_col) has been left-clicked. 
  # 
  # - {Wx::EvtHandler#evt_list_col_right_click}(id, meth = nil, &block): A column (m_col) (which can be -1 if the click occurred outside any column) has been right-clicked. 
  # 
  # - {Wx::EvtHandler#evt_list_col_begin_drag}(id, meth = nil, &block): The user started resizing a column - can be vetoed. 
  # 
  # - {Wx::EvtHandler#evt_list_col_dragging}(id, meth = nil, &block): The divider between columns is being dragged. 
  # 
  # - {Wx::EvtHandler#evt_list_col_end_drag}(id, meth = nil, &block): A column has been resized by the user. 
  # 
  # - {Wx::EvtHandler#evt_list_cache_hint}(id, meth = nil, &block): Prepare cache for a virtual list control 
  # 
  # - {Wx::EvtHandler#evt_list_item_checked}(id, meth = nil, &block): The item has been checked (new since wxWidgets 3.1.0). 
  # 
  # - {Wx::EvtHandler#evt_list_item_unchecked}(id, meth = nil, &block): The item has been unchecked (new since wxWidgets 3.1.0). 
  # 
  # === 
  # 
  # Category:  {Wx::Events}
  # @see Wx::ListCtrl 
  # 
  # 
  class ListEvent < NotifyEvent
  
    # Constructor.
    # @param commandType [Wx::CommandLinkButton::EventType] 
    # @param id [Integer] 
    # @return [Wx::ListEvent]
    def initialize(commandType=Wx::EVT_NULL, id=0) end
    
    # For EVT_LIST_CACHE_HINT event only: return the first item which the list control advises us to cache.
    # @return [Integer]
    def get_cache_from; end
    alias_method :cache_from, :get_cache_from
    
    # For EVT_LIST_CACHE_HINT event only: return the last item (inclusive) which the list control advises us to cache.
    # @return [Integer]
    def get_cache_to; end
    alias_method :cache_to, :get_cache_to
    
    # The column position: it is only used with COL events.
    # For the column dragging events, it is the column to the left of the divider being dragged, for the column click events it may be -1 if the user clicked in the list control header outside any column.
    # @return [Integer]
    def get_column; end
    alias_method :column, :get_column
    
    # The data.
    # @return [Integer]
    def get_data; end
    alias_method :data, :get_data
    
    # The image.
    # @return [Integer]
    def get_image; end
    alias_method :image, :get_image
    
    # The item index.
    # @return [Integer]
    def get_index; end
    alias_method :index, :get_index
    
    # An item object, used by some events.
    # See also {Wx::ListCtrl#set_item}.
    # @return [Wx::ListItem]
    def get_item; end
    alias_method :item, :get_item
    
    # Key code if the event is a keypress event.
    # @return [Integer]
    def get_key_code; end
    alias_method :key_code, :get_key_code
    
    # The (new) item label for EVT_LIST_END_LABEL_EDIT event.
    # @return [Wx::String]
    def get_label; end
    alias_method :label, :get_label
    
    # The mask.
    # @return [Integer]
    def get_mask; end
    alias_method :mask, :get_mask
    
    # The position of the mouse pointer if the event is a drag event.
    # @return [Wx::Point]
    def get_point; end
    alias_method :point, :get_point
    
    # The text.
    # @return [Wx::String]
    def get_text; end
    alias_method :text, :get_text
    
    # This method only makes sense for EVT_LIST_END_LABEL_EDIT message and returns true if it the label editing has been cancelled by the user ({Wx::ListEvent#get_label} returns an empty string in this case but it doesn't allow the application to distinguish between really cancelling the edit and the admittedly rare case when the user wants to rename it to an empty string).
    # @return [Boolean]
    def is_edit_cancelled; end
    alias_method :edit_cancelled?, :is_edit_cancelled
    
    # 
    # 
    # @see Wx::ListEvent#get_key_code 
    # @param code [Integer] 
    # @return [void]
    def set_key_code(code) end
    alias_method :key_code=, :set_key_code
    
    # 
    # 
    # @see Wx::ListEvent#get_index 
    # @param index [Integer] 
    # @return [void]
    def set_index(index) end
    alias_method :index=, :set_index
    
    # 
    # 
    # @see Wx::ListEvent#get_column 
    # @param col [Integer] 
    # @return [void]
    def set_column(col) end
    alias_method :column=, :set_column
    
    # 
    # 
    # @see Wx::ListEvent#get_point 
    # @param point [Array(Integer, Integer), Wx::Point] 
    # @return [void]
    def set_point(point) end
    alias_method :point=, :set_point
    
    # 
    # 
    # @see Wx::ListEvent#get_item 
    # @param item [Wx::ListItem] 
    # @return [void]
    def set_item(item) end
    alias_method :item=, :set_item
    
    # 
    # 
    # @see Wx::ListEvent#get_cache_from 
    # @param cacheFrom [Integer] 
    # @return [void]
    def set_cache_from(cacheFrom) end
    alias_method :cache_from=, :set_cache_from
    
    # 
    # 
    # @see Wx::ListEvent#get_cache_to 
    # @param cacheTo [Integer] 
    # @return [void]
    def set_cache_to(cacheTo) end
    alias_method :cache_to=, :set_cache_to
    
  end # ListEvent
  

end