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


module Wx

  # {Wx::SashWindow} allows any of its edges to have a sash which can be dragged to resize the window.
  # The actual content window will be created by the application as a child of {Wx::SashWindow}.
  # The window (or an ancestor) will be notified of a drag via a {Wx::SashEvent} notification.
  # === Styles
  # 
  # This class supports the following styles:
  #  
  # - {Wx::SW_3D}: Draws a 3D effect sash and border. 
  # - {Wx::SW_3DSASH}: Draws a 3D effect sash. 
  # - {Wx::SW_3DBORDER}: Draws a 3D effect border. 
  # - {Wx::SW_BORDER}: Draws a thin black border. 
  # 
  # === Events emitted by this class
  # 
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SashEvent} events.
  # Event handler methods for events emitted by this class:
  # - {Wx::EvtHandler#evt_sash_dragged}(id, meth = nil, &block): Process a {Wx::EVT_SASH_DRAGGED} event, when the user has finished dragging a sash. 
  # - {Wx::EvtHandler#evt_sash_dragged_range}(id1,  id2, meth = nil, &block): Process a {Wx::EVT_SASH_DRAGGED_RANGE} event, when the user has finished dragging a sash. The event handler is called when windows with ids in the given range have their sashes dragged. 
  # 
  # === 
  # 
  # Category:  Miscellaneous Windows
  # @see Wx::SashEvent
  # @see  Wx::SashLayoutWindow
  # @see  Events and Event Handling 
  # 
  # 
  class SashWindow < Window
  
    # @overload initialize()
    #   Default ctor.
    #   @return [SashWindow]
    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::CLIP_CHILDREN|wxSW_3D), name=("Wx::SASH_WINDOW"))
    #   Constructs a sash window, which can be a child of a frame, dialog or any other non-control window.
    #   @param parent [Wx::Window]  Pointer to a parent window.
    #   @param id [Integer]  Window identifier. If -1, will automatically create an identifier.
    #   @param pos [Array(Integer, Integer), Wx::Point]  Window position. {Wx::DEFAULT_POSITION} is (-1, -1) which indicates that {Wx::SashWindows} should generate a default position for the window. If using the {Wx::SashWindow} class directly, supply an actual position.
    #   @param size [Array(Integer, Integer), Wx::Size]  Window size. {Wx::DEFAULT_SIZE} is (-1, -1) which indicates that {Wx::SashWindows} should generate a default size for the window.
    #   @param style [Integer]  Window style. For window styles, please see {Wx::SashWindow}.
    #   @param name [String]  Window name.
    #   @return [SashWindow]
    def initialize(*args) end
    
    # Gets the maximum window size in the x direction.
    # @return [Integer]
    def get_maximum_size_x; end
    alias_method :maximum_size_x, :get_maximum_size_x
    
    # Gets the maximum window size in the y direction.
    # @return [Integer]
    def get_maximum_size_y; end
    alias_method :maximum_size_y, :get_maximum_size_y
    
    # Gets the minimum window size in the x direction.
    # @return [Integer]
    def get_minimum_size_x; end
    alias_method :minimum_size_x, :get_minimum_size_x
    
    # Gets the minimum window size in the y direction.
    # @return [Integer]
    def get_minimum_size_y; end
    alias_method :minimum_size_y, :get_minimum_size_y
    
    # Returns true if a sash is visible on the given edge, false otherwise.
    # 
    # @see Wx::SashWindow#set_sash_visible 
    # @param edge [SashEdgePosition]  Edge. One of {Wx::SashEdgePosition::SASH_TOP}, {Wx::SashEdgePosition::SASH_RIGHT}, {Wx::SashEdgePosition::SASH_BOTTOM}, {Wx::SashEdgePosition::SASH_LEFT}.
    # @return [true,false]
    def get_sash_visible(edge) end
    alias_method :sash_visible, :get_sash_visible
    
    # Sets the maximum window size in the x direction.
    # @param min [Integer] 
    # @return [void]
    def set_maximum_size_x(min) end
    alias_method :maximum_size_x=, :set_maximum_size_x
    
    # Sets the maximum window size in the y direction.
    # @param min [Integer] 
    # @return [void]
    def set_maximum_size_y(min) end
    alias_method :maximum_size_y=, :set_maximum_size_y
    
    # Sets the minimum window size in the x direction.
    # @param min [Integer] 
    # @return [void]
    def set_minimum_size_x(min) end
    alias_method :minimum_size_x=, :set_minimum_size_x
    
    # Sets the minimum window size in the y direction.
    # @param min [Integer] 
    # @return [void]
    def set_minimum_size_y(min) end
    alias_method :minimum_size_y=, :set_minimum_size_y
    
    # Call this function to make a sash visible or invisible on a particular edge.
    # 
    # @see Wx::SashWindow#get_sash_visible 
    # @param edge [SashEdgePosition]  Edge to change. One of {Wx::SashEdgePosition::SASH_TOP}, {Wx::SashEdgePosition::SASH_RIGHT}, {Wx::SashEdgePosition::SASH_BOTTOM}, {Wx::SashEdgePosition::SASH_LEFT}.
    # @param visible [true,false]  true to make the sash visible, false to make it invisible.
    # @return [void]
    def set_sash_visible(edge, visible) end
    
    # Get border size.
    # @param edge [SashEdgePosition] 
    # @return [Integer]
    def get_edge_margin(edge) end
    alias_method :edge_margin, :get_edge_margin
    
    # Sets the default sash border size.
    # @param width [Integer] 
    # @return [void]
    def set_default_border_size(width) end
    alias_method :default_border_size=, :set_default_border_size
    
    # Gets the default sash border size.
    # @return [Integer]
    def get_default_border_size; end
    alias_method :default_border_size, :get_default_border_size
    
    # Sets the additional border size between child and sash window.
    # @param width [Integer] 
    # @return [void]
    def set_extra_border_size(width) end
    alias_method :extra_border_size=, :set_extra_border_size
    
    # Gets the addition border size between child and sash window.
    # @return [Integer]
    def get_extra_border_size; end
    alias_method :extra_border_size, :get_extra_border_size
    
    # Tests for x, y over sash.
    # @param x [Integer] 
    # @param y [Integer] 
    # @param tolerance [Integer] 
    # @return [SashEdgePosition]
    def sash_hit_test(x, y, tolerance=2) end
    
    # Resizes subwindows.
    # @return [void]
    def size_windows; end
    
  end # SashWindow
  

end