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


module Wx

  # A {Wx::ScrollBar} is a control that represents a horizontal or vertical scrollbar.
  # 
  # It is distinct from the two scrollbars that some windows provide automatically, but the two types of scrollbar share the way events are received.
  # 
  # <div class="wxrb-remark">
  # <b>Remark:</b>
  # <p>A scrollbar has the following main attributes: range, thumb size, page size, and position. The range is the total number of units associated with the view represented by the scrollbar. For a table with 15 columns, the range would be 15. The thumb size is the number of units that are currently visible. For the table example, the window might be sized so that only 5 columns are currently visible, in which case the application would set the thumb size to 5. When the thumb size becomes the same as or greater than the range, the scrollbar will be automatically hidden on most platforms. The page size is the number of units that the scrollbar should scroll by, when 'paging' through the data. This value is normally the same as the thumb size length, because it is natural to assume that the visible window size defines a page. The scrollbar position is the current thumb position. Most applications will find it convenient to provide a function called AdjustScrollbars() which can be called initially, from an OnSize event handler, and whenever the application data changes in size. It will adjust the view, object and page size according to the size of the window and the size of the data.
  # </p>
  # </div>
  # 
  # ### Styles
  # 
  # This class supports the following styles:
  # 
  # - {Wx::SB_HORIZONTAL}: Specifies a horizontal scrollbar. 
  # 
  # - {Wx::SB_VERTICAL}: Specifies a vertical scrollbar. 
  # 
  # ### Events emitted by this class
  # 
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ScrollEvent} events.
  # Event handler methods for events emitted by this class: except for this, the macros behave exactly the same. 
  # 
  # - {Wx::EvtHandler#evt_scroll}(meth = nil, &block): Process all scroll events. 
  # 
  # - {Wx::EvtHandler#evt_scroll_top}(meth = nil, &block): Process {Wx::EVT_SCROLL_TOP} scroll to top or leftmost (minimum) position events. 
  # 
  # - {Wx::EvtHandler#evt_scroll_bottom}(meth = nil, &block): Process {Wx::EVT_SCROLL_BOTTOM} scroll to bottom or rightmost (maximum) position events. 
  # 
  # - {Wx::EvtHandler#evt_scroll_lineup}(meth = nil, &block): Process {Wx::EVT_SCROLL_LINEUP} line up or left events. 
  # 
  # - {Wx::EvtHandler#evt_scroll_linedown}(meth = nil, &block): Process {Wx::EVT_SCROLL_LINEDOWN} line down or right events. 
  # 
  # - {Wx::EvtHandler#evt_scroll_pageup}(meth = nil, &block): Process {Wx::EVT_SCROLL_PAGEUP} page up or left events. 
  # 
  # - {Wx::EvtHandler#evt_scroll_pagedown}(meth = nil, &block): Process {Wx::EVT_SCROLL_PAGEDOWN} page down or right events. 
  # 
  # - {Wx::EvtHandler#evt_scroll_thumbtrack}(meth = nil, &block): Process {Wx::EVT_SCROLL_THUMBTRACK} thumbtrack events (frequent events sent as the user drags the thumbtrack). 
  # 
  # - {Wx::EvtHandler#evt_scroll_thumbrelease}(meth = nil, &block): Process {Wx::EVT_SCROLL_THUMBRELEASE} thumb release events. 
  # 
  # - {Wx::EvtHandler#evt_scroll_changed}(meth = nil, &block): Process {Wx::EVT_SCROLL_CHANGED} end of scrolling events (MSW only). 
  # 
  # - {Wx::EvtHandler#evt_command_scroll}(id, meth = nil, &block): Process all scroll events. 
  # 
  # - {Wx::EvtHandler#evt_command_scroll_top}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_TOP} scroll to top or leftmost (minimum) position events. 
  # 
  # - {Wx::EvtHandler#evt_command_scroll_bottom}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_BOTTOM} scroll to bottom or rightmost (maximum) position events. 
  # 
  # - {Wx::EvtHandler#evt_command_scroll_lineup}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_LINEUP} line up or left events. 
  # 
  # - {Wx::EvtHandler#evt_command_scroll_linedown}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_LINEDOWN} line down or right events. 
  # 
  # - {Wx::EvtHandler#evt_command_scroll_pageup}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_PAGEUP} page up or left events. 
  # 
  # - {Wx::EvtHandler#evt_command_scroll_pagedown}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_PAGEDOWN} page down or right events. 
  # 
  # - {Wx::EvtHandler#evt_command_scroll_thumbtrack}(id, meth = nil, &block): Process {Wx::EVT_SCROLL_THUMBTRACK} thumbtrack events (frequent events sent as the user drags the thumbtrack). 
  # 
  # - {Wx::EvtHandler#evt_command_scroll_thumbrelease}(meth = nil, &block): Process {Wx::EVT_SCROLL_THUMBRELEASE} thumb release events. 
  # 
  # - {Wx::EvtHandler#evt_command_scroll_changed}(meth = nil, &block): Process {Wx::EVT_SCROLL_CHANGED} end of scrolling events (MSW only). 
  # 
  # ## The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
  # The EVT_SCROLL_THUMBRELEASE event is only emitted when actually dragging the thumb using the mouse and releasing it (This EVT_SCROLL_THUMBRELEASE event is also followed by an EVT_SCROLL_CHANGED event).
  # The EVT_SCROLL_CHANGED event also occurs when using the keyboard to change the thumb position, and when clicking next to the thumb (In all these cases the EVT_SCROLL_THUMBRELEASE event does not happen).
  # In short, the EVT_SCROLL_CHANGED event is triggered when scrolling/moving has finished independently of the way it had started. Please see the Widgets Sample ("Slider" page) to see the difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
  # 
  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
  #   </td><td> WXGTK Appearance
  #   </td><td> WXOSX Appearance
  #   </td></tr></table></div>
  # @see Scrolled Windows
  # @see  Events and Event Handling
  # @see  Wx::Scrolled 
  # 
  # 
  # @wxrb_require USE_SCROLLBAR
  class ScrollBar < Control
  
    # @overload initialize()
    #   Default constructor.
    #   @return [Wx::ScrollBar]
    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::SB_HORIZONTAL, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SCROLL_BAR_NAME_STR)
    #   Constructor, creating and showing a scrollbar.
    #   
    #   
    #   @see Wx::ScrollBar#create
    #   @see  Wx::Validator 
    #   @param parent [Wx::Window]  Parent window. Must be non-NULL.
    #   @param id [Integer]  Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
    #   @param pos [Array(Integer, Integer), Wx::Point]  Window position. If {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
    #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If {Wx::DEFAULT_SIZE} is specified then a default size is chosen.
    #   @param style [Integer]  Window style. See {Wx::ScrollBar}.
    #   @param validator [Wx::Validator]  Window validator.
    #   @param name [String]  Window name.
    #   @return [Wx::ScrollBar]
    def initialize(*args) end
    
    # Scrollbar creation function called by the scrollbar constructor.
    # 
    # See {Wx::ScrollBar#initialize} for details.
    # @param parent [Wx::Window] 
    # @param id [Integer] 
    # @param pos [Array(Integer, Integer), Wx::Point] 
    # @param size [Array(Integer, Integer), Wx::Size] 
    # @param style [Integer] 
    # @param validator [Wx::Validator] 
    # @param name [String] 
    # @return [Boolean]
    def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::SB_HORIZONTAL, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SCROLL_BAR_NAME_STR) end
    
    # Returns the page size of the scrollbar.
    # 
    # This is the number of scroll units that will be scrolled when the user pages up or down. Often it is the same as the thumb size.
    # @see Wx::ScrollBar#set_scrollbar 
    # @return [Integer]
    def get_page_size; end
    alias_method :page_size, :get_page_size
    
    # Returns the length of the scrollbar.
    # 
    # 
    # @see Wx::ScrollBar#set_scrollbar 
    # @return [Integer]
    def get_range; end
    alias_method :range, :get_range
    
    # Returns the current position of the scrollbar thumb.
    # 
    # 
    # @see Wx::ScrollBar#set_thumb_position 
    # @return [Integer]
    def get_thumb_position; end
    alias_method :thumb_position, :get_thumb_position
    
    # Returns the thumb or 'view' size.
    # 
    # 
    # @see Wx::ScrollBar#set_scrollbar 
    # @return [Integer]
    def get_thumb_size; end
    alias_method :thumb_size, :get_thumb_size
    
    # Sets the scrollbar properties.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>Let's say you wish to display 50 lines of text, using the same font. The window is sized so that you can only see 16 lines at a time. You would use: 
    # ```ruby
    #   scrollbar.set_scrollbar(0, 16, 50, 15)
    # ```
    #  The page size is 1 less than the thumb size so that the last line of the previous page will be visible on the next page, to help orient the user. Note that with the window at this size, the thumb position can never go above 50 minus 16, or 34. You can determine how many lines are currently visible by dividing the current view size by the character height in pixels. When defining your own scrollbar behaviour, you will always need to recalculate the scrollbar settings when the window size changes. You could therefore put your scrollbar calculations and {Wx::ScrollBar#set_scrollbar} call into a function named AdjustScrollbars, which can be called initially and also from a {Wx::SizeEvent} event handler function. 
    # </p>
    # </div>
    # @param position [Integer]  The position of the scrollbar in scroll units.
    # @param thumbSize [Integer]  The size of the thumb, or visible portion of the scrollbar, in scroll units.
    # @param range [Integer]  The maximum position of the scrollbar.
    # @param pageSize [Integer]  The size of the page size in scroll units. This is the number of units the scrollbar will scroll when it is paged up or down. Often it is the same as the thumb size.
    # @param refresh [Boolean]  true to redraw the scrollbar, false otherwise.
    # @return [void]
    def set_scrollbar(position, thumbSize, range, pageSize, refresh=true) end
    
    # Sets the position of the scrollbar.
    # 
    # 
    # @see Wx::ScrollBar#get_thumb_position 
    # @param viewStart [Integer]  The position of the scrollbar thumb.
    # @return [void]
    def set_thumb_position(viewStart) end
    alias_method :thumb_position=, :set_thumb_position
    
    # Returns true for scrollbars that have the vertical style set.
    # @return [Boolean]
    def is_vertical; end
    alias_method :vertical?, :is_vertical
    
  end # ScrollBar
  

end