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


module Wx

  # This class represents the events generated by a splitter control.
  # Also there is only one event class, the data associated to the different events is not the same and so not all accessor functions may be called for each event. The documentation mentions the kind of event(s) for which the given accessor function makes sense: calling it for other types of events will result in assert failure (in debug mode) and will return meaningless results.
  # === Events using this class
  # 
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SplitterEvent} events.
  # Event handler methods:
  # 
  # - {Wx::EvtHandler#evt_splitter_sash_pos_changing}(id, meth = nil, &block): The sash position is in the process of being changed. May be used to modify the position of the tracking bar to properly reflect the position that would be set if the drag were to be completed at this point. Processes a {Wx::EVT_SPLITTER_SASH_POS_CHANGING} event. 
  # 
  # - {Wx::EvtHandler#evt_splitter_sash_pos_changed}(id, meth = nil, &block): The sash position was changed. May be used to modify the sash position before it is set, or to prevent the change from taking place. Processes a {Wx::EVT_SPLITTER_SASH_POS_CHANGED} event. 
  # 
  # - {Wx::EvtHandler#evt_splitter_unsplit}(id, meth = nil, &block): The splitter has been just unsplit. Processes a {Wx::EVT_SPLITTER_UNSPLIT} event. 
  # 
  # - {Wx::EvtHandler#evt_splitter_dclick}(id, meth = nil, &block): The sash was double clicked. The default behaviour is to unsplit the window when this happens (unless the minimum pane size has been set to a value greater than zero). Processes a {Wx::EVT_SPLITTER_DOUBLECLICKED} event. 
  # 
  # === 
  # 
  # Category:  {Wx::Events}
  # @see Wx::SplitterWindow
  # @see  Events and Event Handling 
  # 
  # 
  class SplitterEvent < NotifyEvent
  
    # Constructor.
    # Used internally by wxWidgets only.
    # @param eventType [Wx::CommandLinkButton::EventType] 
    # @param splitter [Wx::SplitterWindow] 
    # @return [Wx::SplitterEvent]
    def initialize(eventType=Wx::EVT_NULL, splitter=nil) end
    
    # Returns the new sash position.
    # May only be called while processing {Wx::EVT_SPLITTER_SASH_POS_CHANGING}, {Wx::EVT_SPLITTER_SASH_POS_RESIZE} and {Wx::EVT_SPLITTER_SASH_POS_CHANGED} events.
    # @return [Integer]
    def get_sash_position; end
    alias_method :sash_position, :get_sash_position
    
    # Returns a pointer to the window being removed when a splitter window is unsplit.
    # May only be called while processing {Wx::EVT_SPLITTER_UNSPLIT} events.
    # @return [Wx::Window]
    def get_window_being_removed; end
    alias_method :window_being_removed, :get_window_being_removed
    
    # Returns the x coordinate of the double-click point.
    # May only be called while processing {Wx::EVT_SPLITTER_DOUBLECLICKED} events.
    # @return [Integer]
    def get_x; end
    alias_method :x, :get_x
    
    # Returns the y coordinate of the double-click point.
    # May only be called while processing {Wx::EVT_SPLITTER_DOUBLECLICKED} events.
    # @return [Integer]
    def get_y; end
    alias_method :y, :get_y
    
    # In the case of {Wx::EVT_SPLITTER_SASH_POS_CHANGED} events, sets the new sash position.
    # In the case of {Wx::EVT_SPLITTER_SASH_POS_CHANGING} events, sets the new tracking bar position so visual feedback during dragging will represent that change that will actually take place. Set to -1 from the event handler code to prevent repositioning.
    # May only be called while processing {Wx::EVT_SPLITTER_SASH_POS_CHANGING}, {Wx::EVT_SPLITTER_SASH_POS_RESIZE} and {Wx::EVT_SPLITTER_SASH_POS_CHANGED} events.
    # @param pos [Integer]  New sash position.
    # @return [void]
    def set_sash_position(pos) end
    alias_method :sash_position=, :set_sash_position
    
    # Sets the size values of the window size.
    # This size is adjusted to the sash orientation. For a vertical sash it should be the width and for a horizontal sash it's the height.
    # May only be called while processing {Wx::EVT_SPLITTER_SASH_POS_CHANGING}, {Wx::EVT_SPLITTER_SASH_POS_RESIZE} and {Wx::EVT_SPLITTER_SASH_POS_CHANGED} events.
    # @param oldSize [Integer] 
    # @param newSize [Integer] 
    # @return [void]
    def set_size(oldSize, newSize) end
    
    # Returns the old size before the update.
    # The size value is already adjusted to the orientation of the sash. So for a vertical sash it's the width and for a horizontal sash it's the height.
    # May only be called while processing {Wx::EVT_SPLITTER_SASH_POS_CHANGING}, {Wx::EVT_SPLITTER_SASH_POS_RESIZE} and {Wx::EVT_SPLITTER_SASH_POS_CHANGED} events. 
    # May only be called while processing {Wx::EVT_SPLITTER_SASH_POS_CHANGING}, {Wx::EVT_SPLITTER_SASH_POS_RESIZE} and {Wx::EVT_SPLITTER_SASH_POS_CHANGED} events.
    # @return [Integer]
    def get_old_size; end
    alias_method :old_size, :get_old_size
    
  end # SplitterEvent
  

end