wxruby3 0.9.0.pre.rc.2-x64-mingw-ucrt → 0.9.0-x64-mingw-ucrt

data/lib/wx/doc/gen/scrolled_canvas.rb

@@ -9,7 +9,8 @@ module Wx
   # The {Wx::Scrolled} class manages scrolling for its client area, transforming the coordinates according to the scrollbar positions, and setting the scroll positions, thumb sizes and ranges according to the area in view.
   # There are two commonly used (but not the only possible!) specializations of this class:
   # 
-  # - {Wx::ScrolledWindow}, aka {Wx::Scrolled}<{Wx::Panel}>, is equivalent to {Wx::ScrolledWindow} from earlier versions. Derived from {Wx::Panel}, it shares {Wx::Panel}'s behaviour with regard to TAB traversal and focus handling. Use this if the scrolled window will have child controls.- {Wx::ScrolledCanvas}, aka {Wx::Scrolled}<{Wx::Window}>, derives from {Wx::Window} and so doesn't handle children specially. This is suitable e.g. for implementing scrollable controls such as tree or list controls.
+  # - {Wx::ScrolledWindow}, aka {Wx::Scrolled}<{Wx::Panel}>, is equivalent to {Wx::ScrolledWindow} from earlier versions. Derived from {Wx::Panel}, it shares {Wx::Panel}'s behaviour with regard to TAB traversal and focus handling. Use this if the scrolled window will have child controls.
+  # - {Wx::ScrolledCanvas}, aka {Wx::Scrolled}<{Wx::Window}>, derives from {Wx::Window} and so doesn't handle children specially. This is suitable e.g. for implementing scrollable controls such as tree or list controls.
   # 
   # See Wx::Scrolled#create if you want to use {Wx::Scrolled} with a custom class.
   # 
@@ -28,24 +29,36 @@ module Wx
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::HSCROLL}: If this style is specified and {Wx::VSCROLL} isn't, the window will be scrollable only in horizontal direction (by default, i.e. if neither this style nor {Wx::VSCROLL} is specified, it scrolls in both directions). 
+  # 
   # - {Wx::VSCROLL}: If this style is specified and {Wx::HSCROLL} isn't, the window will be scrollable only in vertical direction (by default, i.e. if neither this style nor {Wx::HSCROLL} is specified, it scrolls in both directions). 
+  # 
   # - {Wx::ALWAYS_SHOW_SB}: Since wxWidgets 2.9.5, specifying this style makes the window always show its scrollbars, even if they are not used. See Wx::Scrolled#show_scrollbars. 
+  # 
   # - {Wx::RETAINED}: Uses a backing pixmap to speed refreshes. Motif only. 
   # 
   # === Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ScrollWinEvent} events.
   # Event handler methods for events emitted by this class:
+  # 
   # - {Wx::EvtHandler#evt_scrollwin}(meth = nil, &block): Process all scroll events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_top}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_TOP} scroll-to-top events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_bottom}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_BOTTOM} scroll-to-bottom events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_lineup}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_LINEUP} line up events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_linedown}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_LINEDOWN} line down events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_pageup}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_PAGEUP} page up events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_pagedown}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_PAGEDOWN} page down events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_thumbtrack}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_THUMBTRACK} thumbtrack events (frequent events sent as the user drags the thumbtrack). 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_thumbrelease}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_THUMBRELEASE} thumb release events. 
   # 
   # Don't confuse {Wx::ScrollWinEvents} generated by this class with {Wx::ScrollEvent} objects generated by {Wx::ScrollBar} and {Wx::Slider}.
@@ -68,7 +81,7 @@ module Wx
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [Scrolled]
+    #   @return [Wx::ScrolledCanvas]
     # @overload initialize(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("scrolledWindow"))
     #   Constructor.
     #   The window is initially created without visible scrollbars. Call Wx::Scrolled#set_scrollbars to specify how big the virtual window size should be.
@@ -78,7 +91,7 @@ module Wx
     #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If a size of {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
     #   @param style [Integer]  Window style. See {Wx::Scrolled}.
     #   @param name [String]  Window name.
-    #   @return [Scrolled]
+    #   @return [Wx::ScrolledCanvas]
     def initialize(*args) end
     
     # @overload calc_scrolled_position(x, y)
@@ -114,7 +127,7 @@ module Wx
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param style [Integer] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("scrolledWindow")) end
     
     # Disable use of keyboard keys for scrolling.
@@ -125,22 +138,24 @@ module Wx
     # Call this function to prepare the device context for drawing a scrolled image.
     # It sets the device origin according to the current scroll position. Wx::Scrolled#do_prepare_dc is called automatically within the default {Wx::EVT_PAINT} event handler, so your Wx::Scrolled#on_draw override will be passed an already 'pre-scrolled' device context. However, if you wish to draw from outside of Wx::Scrolled#on_draw (e.g. from your own {Wx::EVT_PAINT} handler), you must call this function yourself.
     # For example: 
-    # ```
-    #   void MyWindow::OnEvent(wxMouseEvent& event)
-    #   {
-    #     wxClientDC dc(this);
-    #     DoPrepareDC(dc);
-    #   
-    #     dc.SetPen(*wxBLACK_PEN);
-    #     float x, y;
-    #     event.Position(&x, &y);
-    #     if (xpos > -1 && ypos > -1 && event.Dragging())
-    #     {
-    #       dc.DrawLine(xpos, ypos, x, y);
-    #     }
-    #     xpos = x;
-    #     ypos = y;
-    #   }
+    # ```ruby
+    #   class MyWindow < Wx::ScrolledCanvas
+    # 
+    #     def on_event(event)
+    #       Wx::ClientDC.draw_on(self) do |dc|
+    #         do_prepare_dc(dc)
+    #       
+    #         dc.set_pen(Wx::BLACK_PEN)
+    #         pos = event.position
+    #         if xpos > -1 && ypos > -1 && event.dragging
+    #           dc.draw_line(xpos, ypos, pos.x, pos.y)
+    #         end
+    #         xpos = pos.x
+    #         ypos = pos.y
+    #       end
+    #     end
+    # 
+    #   end
     # ```
     # 
     # Notice that the function sets the origin by moving it relatively to the current origin position, so you shouldn't change the origin before calling Wx::Scrolled#do_prepare_dc or, if you do, reset it to (0, 0) later. If you call Wx::Scrolled#do_prepare_dc immediately after device context creation, as in the example above, this problem doesn't arise, of course, so it is customary to do it like this.
@@ -151,18 +166,21 @@ module Wx
     # Enable or disable use of {Wx::Window#scroll_window} for scrolling.
     # By default, when a scrolled window is logically scrolled, {Wx::Window#scroll_window} is called on the underlying window which scrolls the window contents and only invalidates the part of the window newly brought into view. If false is passed as an argument, then this "physical scrolling" is disabled and the window is entirely invalidated whenever it is scrolled by calling {Wx::Window#refresh}.
     # It should be rarely necessary to disable physical scrolling, so this method shouldn't be called in normal circumstances.
-    # @param xScrolling [true,false]  If true, enables physical scrolling in the x direction.
-    # @param yScrolling [true,false]  If true, enables physical scrolling in the y direction.
+    # @param xScrolling [Boolean]  If true, enables physical scrolling in the x direction.
+    # @param yScrolling [Boolean]  If true, enables physical scrolling in the y direction.
     # @return [void]
     def enable_scrolling(xScrolling, yScrolling) end
     
     # Set the scrollbar visibility.
     # By default the scrollbar in the corresponding direction is only shown if it is needed, i.e. if the virtual size of the scrolled window in this direction is greater than the current physical window size. Using this function the scrollbar visibility can be changed to be:
-    # - {Wx::ScrollbarVisibility::SHOW_SB_ALWAYS}: To always show the scrollbar, even if it is not needed currently ({Wx::ALWAYS_SHOW_SB} style can be used during the window creation to achieve the same effect but it applies in both directions).- {Wx::ScrollbarVisibility::SHOW_SB_NEVER}: To never show the scrollbar at all. In this case the program should presumably provide some other way for the user to scroll the window.- {Wx::ScrollbarVisibility::SHOW_SB_DEFAULT}: To restore the default behaviour described above.
+    # 
+    # - {Wx::ScrollbarVisibility::SHOW_SB_ALWAYS}: To always show the scrollbar, even if it is not needed currently ({Wx::ALWAYS_SHOW_SB} style can be used during the window creation to achieve the same effect but it applies in both directions).
+    # - {Wx::ScrollbarVisibility::SHOW_SB_NEVER}: To never show the scrollbar at all. In this case the program should presumably provide some other way for the user to scroll the window.
+    # - {Wx::ScrollbarVisibility::SHOW_SB_DEFAULT}: To restore the default behaviour described above.
     # 
     # Note that the window must be created before calling this method.
-    # @param horz [ScrollbarVisibility]  The desired visibility for the horizontal scrollbar.
-    # @param vert [ScrollbarVisibility]  The desired visibility for the vertical scrollbar.
+    # @param horz [Wx::ScrollbarVisibility]  The desired visibility for the horizontal scrollbar.
+    # @param vert [Wx::ScrollbarVisibility]  The desired visibility for the vertical scrollbar.
     # @return [void]
     def show_scrollbars(horz, vert) end
     
@@ -188,7 +206,7 @@ module Wx
     alias_method :virtual_size, :get_virtual_size
     
     # Motif only: true if the window has a backing bitmap.
-    # @return [true,false]
+    # @return [Boolean]
     def is_retained; end
     alias_method :retained?, :is_retained
     
@@ -223,8 +241,8 @@ module Wx
     # The first pair of parameters give the number of pixels per 'scroll step', i.e. amount moved when the up or down scroll arrows are pressed. The second pair gives the length of scrollbar in scroll steps, which sets the size of the virtual window.
     # xPos and yPos optionally specify a position to scroll to immediately.
     # For example, the following gives a window horizontal and vertical scrollbars with 20 pixels per scroll step, and a size of 50 steps (1000 pixels) in each direction: 
-    # ```
-    #   window->SetScrollbars(20, 20, 50, 50);
+    # ```ruby
+    #   window.set_scrollbars(20, 20, 50, 50)
     # ```
     # 
     # {Wx::Scrolled} manages the page size itself, using the current client window size as the page size.
@@ -236,7 +254,7 @@ module Wx
     # @param noUnitsY [Integer]  Number of units in the vertical direction.
     # @param xPos [Integer]  Position to initialize the scrollbars in the horizontal direction, in scroll units.
     # @param yPos [Integer]  Position to initialize the scrollbars in the vertical direction, in scroll units.
-    # @param noRefresh [true,false]  Will not refresh window if true.
+    # @param noRefresh [Boolean]  Will not refresh window if true.
     # @return [void]
     def set_scrollbars(pixelsPerUnitX, pixelsPerUnitY, noUnitsX, noUnitsY, xPos=0, yPos=0, noRefresh=false) end
     
@@ -293,7 +311,7 @@ module Wx
     def adjust_scrollbars; end
     
     # Are we generating the autoscroll events?
-    # @return [true,false]
+    # @return [Boolean]
     def is_auto_scrolling; end
     alias_method :auto_scrolling?, :is_auto_scrolling
     
@@ -301,12 +319,6 @@ module Wx
     # @return [void]
     def stop_auto_scrolling; end
     
-    # This method can be overridden in a derived class to forbid sending the auto scroll events - note that unlike Wx::Scrolled#stop_auto_scrolling it doesn't stop the timer, so it will be called repeatedly and will typically return different values depending on the current mouse position.
-    # The base class version just returns true.
-    # @param event [Wx::ScrollWinEvent] 
-    # @return [true,false]
-    def send_auto_scroll_events(event) end
-    
   end # ScrolledCanvas
   
 

data/lib/wx/doc/gen/scrolled_control.rb

@@ -9,7 +9,8 @@ module Wx
   # The {Wx::Scrolled} class manages scrolling for its client area, transforming the coordinates according to the scrollbar positions, and setting the scroll positions, thumb sizes and ranges according to the area in view.
   # There are two commonly used (but not the only possible!) specializations of this class:
   # 
-  # - {Wx::ScrolledWindow}, aka {Wx::Scrolled}<{Wx::Panel}>, is equivalent to {Wx::ScrolledWindow} from earlier versions. Derived from {Wx::Panel}, it shares {Wx::Panel}'s behaviour with regard to TAB traversal and focus handling. Use this if the scrolled window will have child controls.- {Wx::ScrolledCanvas}, aka {Wx::Scrolled}<{Wx::Window}>, derives from {Wx::Window} and so doesn't handle children specially. This is suitable e.g. for implementing scrollable controls such as tree or list controls.
+  # - {Wx::ScrolledWindow}, aka {Wx::Scrolled}<{Wx::Panel}>, is equivalent to {Wx::ScrolledWindow} from earlier versions. Derived from {Wx::Panel}, it shares {Wx::Panel}'s behaviour with regard to TAB traversal and focus handling. Use this if the scrolled window will have child controls.
+  # - {Wx::ScrolledCanvas}, aka {Wx::Scrolled}<{Wx::Window}>, derives from {Wx::Window} and so doesn't handle children specially. This is suitable e.g. for implementing scrollable controls such as tree or list controls.
   # 
   # See Wx::Scrolled#create if you want to use {Wx::Scrolled} with a custom class.
   # 
@@ -28,24 +29,36 @@ module Wx
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::HSCROLL}: If this style is specified and {Wx::VSCROLL} isn't, the window will be scrollable only in horizontal direction (by default, i.e. if neither this style nor {Wx::VSCROLL} is specified, it scrolls in both directions). 
+  # 
   # - {Wx::VSCROLL}: If this style is specified and {Wx::HSCROLL} isn't, the window will be scrollable only in vertical direction (by default, i.e. if neither this style nor {Wx::HSCROLL} is specified, it scrolls in both directions). 
+  # 
   # - {Wx::ALWAYS_SHOW_SB}: Since wxWidgets 2.9.5, specifying this style makes the window always show its scrollbars, even if they are not used. See Wx::Scrolled#show_scrollbars. 
+  # 
   # - {Wx::RETAINED}: Uses a backing pixmap to speed refreshes. Motif only. 
   # 
   # === Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ScrollWinEvent} events.
   # Event handler methods for events emitted by this class:
+  # 
   # - {Wx::EvtHandler#evt_scrollwin}(meth = nil, &block): Process all scroll events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_top}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_TOP} scroll-to-top events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_bottom}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_BOTTOM} scroll-to-bottom events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_lineup}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_LINEUP} line up events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_linedown}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_LINEDOWN} line down events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_pageup}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_PAGEUP} page up events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_pagedown}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_PAGEDOWN} page down events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_thumbtrack}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_THUMBTRACK} thumbtrack events (frequent events sent as the user drags the thumbtrack). 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_thumbrelease}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_THUMBRELEASE} thumb release events. 
   # 
   # Don't confuse {Wx::ScrollWinEvents} generated by this class with {Wx::ScrollEvent} objects generated by {Wx::ScrollBar} and {Wx::Slider}.
@@ -68,7 +81,7 @@ module Wx
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [Scrolled]
+    #   @return [Wx::ScrolledControl]
     # @overload initialize(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("scrolledWindow"))
     #   Constructor.
     #   The window is initially created without visible scrollbars. Call Wx::Scrolled#set_scrollbars to specify how big the virtual window size should be.
@@ -78,7 +91,7 @@ module Wx
     #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If a size of {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
     #   @param style [Integer]  Window style. See {Wx::Scrolled}.
     #   @param name [String]  Window name.
-    #   @return [Scrolled]
+    #   @return [Wx::ScrolledControl]
     def initialize(*args) end
     
     # @overload calc_scrolled_position(x, y)
@@ -114,7 +127,7 @@ module Wx
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param style [Integer] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("scrolledWindow")) end
     
     # Disable use of keyboard keys for scrolling.
@@ -125,22 +138,24 @@ module Wx
     # Call this function to prepare the device context for drawing a scrolled image.
     # It sets the device origin according to the current scroll position. Wx::Scrolled#do_prepare_dc is called automatically within the default {Wx::EVT_PAINT} event handler, so your Wx::Scrolled#on_draw override will be passed an already 'pre-scrolled' device context. However, if you wish to draw from outside of Wx::Scrolled#on_draw (e.g. from your own {Wx::EVT_PAINT} handler), you must call this function yourself.
     # For example: 
-    # ```
-    #   void MyWindow::OnEvent(wxMouseEvent& event)
-    #   {
-    #     wxClientDC dc(this);
-    #     DoPrepareDC(dc);
-    #   
-    #     dc.SetPen(*wxBLACK_PEN);
-    #     float x, y;
-    #     event.Position(&x, &y);
-    #     if (xpos > -1 && ypos > -1 && event.Dragging())
-    #     {
-    #       dc.DrawLine(xpos, ypos, x, y);
-    #     }
-    #     xpos = x;
-    #     ypos = y;
-    #   }
+    # ```ruby
+    #   class MyWindow < Wx::ScrolledControl
+    # 
+    #     def on_event(event)
+    #       Wx::ClientDC.draw_on(self) do |dc|
+    #         do_prepare_dc(dc)
+    #       
+    #         dc.set_pen(Wx::BLACK_PEN)
+    #         pos = event.position
+    #         if xpos > -1 && ypos > -1 && event.dragging
+    #           dc.draw_line(xpos, ypos, pos.x, pos.y)
+    #         end
+    #         xpos = pos.x
+    #         ypos = pos.y
+    #       end
+    #     end
+    # 
+    #   end
     # ```
     # 
     # Notice that the function sets the origin by moving it relatively to the current origin position, so you shouldn't change the origin before calling Wx::Scrolled#do_prepare_dc or, if you do, reset it to (0, 0) later. If you call Wx::Scrolled#do_prepare_dc immediately after device context creation, as in the example above, this problem doesn't arise, of course, so it is customary to do it like this.
@@ -151,18 +166,21 @@ module Wx
     # Enable or disable use of {Wx::Window#scroll_window} for scrolling.
     # By default, when a scrolled window is logically scrolled, {Wx::Window#scroll_window} is called on the underlying window which scrolls the window contents and only invalidates the part of the window newly brought into view. If false is passed as an argument, then this "physical scrolling" is disabled and the window is entirely invalidated whenever it is scrolled by calling {Wx::Window#refresh}.
     # It should be rarely necessary to disable physical scrolling, so this method shouldn't be called in normal circumstances.
-    # @param xScrolling [true,false]  If true, enables physical scrolling in the x direction.
-    # @param yScrolling [true,false]  If true, enables physical scrolling in the y direction.
+    # @param xScrolling [Boolean]  If true, enables physical scrolling in the x direction.
+    # @param yScrolling [Boolean]  If true, enables physical scrolling in the y direction.
     # @return [void]
     def enable_scrolling(xScrolling, yScrolling) end
     
     # Set the scrollbar visibility.
     # By default the scrollbar in the corresponding direction is only shown if it is needed, i.e. if the virtual size of the scrolled window in this direction is greater than the current physical window size. Using this function the scrollbar visibility can be changed to be:
-    # - {Wx::ScrollbarVisibility::SHOW_SB_ALWAYS}: To always show the scrollbar, even if it is not needed currently ({Wx::ALWAYS_SHOW_SB} style can be used during the window creation to achieve the same effect but it applies in both directions).- {Wx::ScrollbarVisibility::SHOW_SB_NEVER}: To never show the scrollbar at all. In this case the program should presumably provide some other way for the user to scroll the window.- {Wx::ScrollbarVisibility::SHOW_SB_DEFAULT}: To restore the default behaviour described above.
+    # 
+    # - {Wx::ScrollbarVisibility::SHOW_SB_ALWAYS}: To always show the scrollbar, even if it is not needed currently ({Wx::ALWAYS_SHOW_SB} style can be used during the window creation to achieve the same effect but it applies in both directions).
+    # - {Wx::ScrollbarVisibility::SHOW_SB_NEVER}: To never show the scrollbar at all. In this case the program should presumably provide some other way for the user to scroll the window.
+    # - {Wx::ScrollbarVisibility::SHOW_SB_DEFAULT}: To restore the default behaviour described above.
     # 
     # Note that the window must be created before calling this method.
-    # @param horz [ScrollbarVisibility]  The desired visibility for the horizontal scrollbar.
-    # @param vert [ScrollbarVisibility]  The desired visibility for the vertical scrollbar.
+    # @param horz [Wx::ScrollbarVisibility]  The desired visibility for the horizontal scrollbar.
+    # @param vert [Wx::ScrollbarVisibility]  The desired visibility for the vertical scrollbar.
     # @return [void]
     def show_scrollbars(horz, vert) end
     
@@ -188,7 +206,7 @@ module Wx
     alias_method :virtual_size, :get_virtual_size
     
     # Motif only: true if the window has a backing bitmap.
-    # @return [true,false]
+    # @return [Boolean]
     def is_retained; end
     alias_method :retained?, :is_retained
     
@@ -223,8 +241,8 @@ module Wx
     # The first pair of parameters give the number of pixels per 'scroll step', i.e. amount moved when the up or down scroll arrows are pressed. The second pair gives the length of scrollbar in scroll steps, which sets the size of the virtual window.
     # xPos and yPos optionally specify a position to scroll to immediately.
     # For example, the following gives a window horizontal and vertical scrollbars with 20 pixels per scroll step, and a size of 50 steps (1000 pixels) in each direction: 
-    # ```
-    #   window->SetScrollbars(20, 20, 50, 50);
+    # ```ruby
+    #   window.set_scrollbars(20, 20, 50, 50)
     # ```
     # 
     # {Wx::Scrolled} manages the page size itself, using the current client window size as the page size.
@@ -236,7 +254,7 @@ module Wx
     # @param noUnitsY [Integer]  Number of units in the vertical direction.
     # @param xPos [Integer]  Position to initialize the scrollbars in the horizontal direction, in scroll units.
     # @param yPos [Integer]  Position to initialize the scrollbars in the vertical direction, in scroll units.
-    # @param noRefresh [true,false]  Will not refresh window if true.
+    # @param noRefresh [Boolean]  Will not refresh window if true.
     # @return [void]
     def set_scrollbars(pixelsPerUnitX, pixelsPerUnitY, noUnitsX, noUnitsY, xPos=0, yPos=0, noRefresh=false) end
     
@@ -293,7 +311,7 @@ module Wx
     def adjust_scrollbars; end
     
     # Are we generating the autoscroll events?
-    # @return [true,false]
+    # @return [Boolean]
     def is_auto_scrolling; end
     alias_method :auto_scrolling?, :is_auto_scrolling
     
@@ -301,12 +319,6 @@ module Wx
     # @return [void]
     def stop_auto_scrolling; end
     
-    # This method can be overridden in a derived class to forbid sending the auto scroll events - note that unlike Wx::Scrolled#stop_auto_scrolling it doesn't stop the timer, so it will be called repeatedly and will typically return different values depending on the current mouse position.
-    # The base class version just returns true.
-    # @param event [Wx::ScrollWinEvent] 
-    # @return [true,false]
-    def send_auto_scroll_events(event) end
-    
   end # ScrolledControl
   
 

data/lib/wx/doc/gen/scrolled_window.rb

@@ -29,7 +29,8 @@ module Wx
   # The {Wx::Scrolled} class manages scrolling for its client area, transforming the coordinates according to the scrollbar positions, and setting the scroll positions, thumb sizes and ranges according to the area in view.
   # There are two commonly used (but not the only possible!) specializations of this class:
   # 
-  # - {Wx::ScrolledWindow}, aka {Wx::Scrolled}<{Wx::Panel}>, is equivalent to {Wx::ScrolledWindow} from earlier versions. Derived from {Wx::Panel}, it shares {Wx::Panel}'s behaviour with regard to TAB traversal and focus handling. Use this if the scrolled window will have child controls.- {Wx::ScrolledCanvas}, aka {Wx::Scrolled}<{Wx::Window}>, derives from {Wx::Window} and so doesn't handle children specially. This is suitable e.g. for implementing scrollable controls such as tree or list controls.
+  # - {Wx::ScrolledWindow}, aka {Wx::Scrolled}<{Wx::Panel}>, is equivalent to {Wx::ScrolledWindow} from earlier versions. Derived from {Wx::Panel}, it shares {Wx::Panel}'s behaviour with regard to TAB traversal and focus handling. Use this if the scrolled window will have child controls.
+  # - {Wx::ScrolledCanvas}, aka {Wx::Scrolled}<{Wx::Window}>, derives from {Wx::Window} and so doesn't handle children specially. This is suitable e.g. for implementing scrollable controls such as tree or list controls.
   # 
   # See Wx::Scrolled#create if you want to use {Wx::Scrolled} with a custom class.
   # 
@@ -48,24 +49,36 @@ module Wx
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::HSCROLL}: If this style is specified and {Wx::VSCROLL} isn't, the window will be scrollable only in horizontal direction (by default, i.e. if neither this style nor {Wx::VSCROLL} is specified, it scrolls in both directions). 
+  # 
   # - {Wx::VSCROLL}: If this style is specified and {Wx::HSCROLL} isn't, the window will be scrollable only in vertical direction (by default, i.e. if neither this style nor {Wx::HSCROLL} is specified, it scrolls in both directions). 
+  # 
   # - {Wx::ALWAYS_SHOW_SB}: Since wxWidgets 2.9.5, specifying this style makes the window always show its scrollbars, even if they are not used. See Wx::Scrolled#show_scrollbars. 
+  # 
   # - {Wx::RETAINED}: Uses a backing pixmap to speed refreshes. Motif only. 
   # 
   # === Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ScrollWinEvent} events.
   # Event handler methods for events emitted by this class:
+  # 
   # - {Wx::EvtHandler#evt_scrollwin}(meth = nil, &block): Process all scroll events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_top}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_TOP} scroll-to-top events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_bottom}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_BOTTOM} scroll-to-bottom events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_lineup}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_LINEUP} line up events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_linedown}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_LINEDOWN} line down events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_pageup}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_PAGEUP} page up events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_pagedown}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_PAGEDOWN} page down events. 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_thumbtrack}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_THUMBTRACK} thumbtrack events (frequent events sent as the user drags the thumbtrack). 
+  # 
   # - {Wx::EvtHandler#evt_scrollwin_thumbrelease}(meth = nil, &block): Process {Wx::EVT_SCROLLWIN_THUMBRELEASE} thumb release events. 
   # 
   # Don't confuse {Wx::ScrollWinEvents} generated by this class with {Wx::ScrollEvent} objects generated by {Wx::ScrollBar} and {Wx::Slider}.
@@ -88,7 +101,7 @@ module Wx
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [Scrolled]
+    #   @return [Wx::ScrolledWindow]
     # @overload initialize(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("scrolledWindow"))
     #   Constructor.
     #   The window is initially created without visible scrollbars. Call Wx::Scrolled#set_scrollbars to specify how big the virtual window size should be.
@@ -98,7 +111,7 @@ module Wx
     #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If a size of {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
     #   @param style [Integer]  Window style. See {Wx::Scrolled}.
     #   @param name [String]  Window name.
-    #   @return [Scrolled]
+    #   @return [Wx::ScrolledWindow]
     def initialize(*args) end
     
     # @overload calc_scrolled_position(x, y)
@@ -134,7 +147,7 @@ module Wx
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param style [Integer] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("scrolledWindow")) end
     
     # Disable use of keyboard keys for scrolling.
@@ -145,22 +158,24 @@ module Wx
     # Call this function to prepare the device context for drawing a scrolled image.
     # It sets the device origin according to the current scroll position. Wx::Scrolled#do_prepare_dc is called automatically within the default {Wx::EVT_PAINT} event handler, so your Wx::Scrolled#on_draw override will be passed an already 'pre-scrolled' device context. However, if you wish to draw from outside of Wx::Scrolled#on_draw (e.g. from your own {Wx::EVT_PAINT} handler), you must call this function yourself.
     # For example: 
-    # ```
-    #   void MyWindow::OnEvent(wxMouseEvent& event)
-    #   {
-    #     wxClientDC dc(this);
-    #     DoPrepareDC(dc);
-    #   
-    #     dc.SetPen(*wxBLACK_PEN);
-    #     float x, y;
-    #     event.Position(&x, &y);
-    #     if (xpos > -1 && ypos > -1 && event.Dragging())
-    #     {
-    #       dc.DrawLine(xpos, ypos, x, y);
-    #     }
-    #     xpos = x;
-    #     ypos = y;
-    #   }
+    # ```ruby
+    #   class MyWindow < Wx::ScrolledWindow
+    # 
+    #     def on_event(event)
+    #       Wx::ClientDC.draw_on(self) do |dc|
+    #         do_prepare_dc(dc)
+    #       
+    #         dc.set_pen(Wx::BLACK_PEN)
+    #         pos = event.position
+    #         if xpos > -1 && ypos > -1 && event.dragging
+    #           dc.draw_line(xpos, ypos, pos.x, pos.y)
+    #         end
+    #         xpos = pos.x
+    #         ypos = pos.y
+    #       end
+    #     end
+    # 
+    #   end
     # ```
     # 
     # Notice that the function sets the origin by moving it relatively to the current origin position, so you shouldn't change the origin before calling Wx::Scrolled#do_prepare_dc or, if you do, reset it to (0, 0) later. If you call Wx::Scrolled#do_prepare_dc immediately after device context creation, as in the example above, this problem doesn't arise, of course, so it is customary to do it like this.
@@ -171,18 +186,21 @@ module Wx
     # Enable or disable use of {Wx::Window#scroll_window} for scrolling.
     # By default, when a scrolled window is logically scrolled, {Wx::Window#scroll_window} is called on the underlying window which scrolls the window contents and only invalidates the part of the window newly brought into view. If false is passed as an argument, then this "physical scrolling" is disabled and the window is entirely invalidated whenever it is scrolled by calling {Wx::Window#refresh}.
     # It should be rarely necessary to disable physical scrolling, so this method shouldn't be called in normal circumstances.
-    # @param xScrolling [true,false]  If true, enables physical scrolling in the x direction.
-    # @param yScrolling [true,false]  If true, enables physical scrolling in the y direction.
+    # @param xScrolling [Boolean]  If true, enables physical scrolling in the x direction.
+    # @param yScrolling [Boolean]  If true, enables physical scrolling in the y direction.
     # @return [void]
     def enable_scrolling(xScrolling, yScrolling) end
     
     # Set the scrollbar visibility.
     # By default the scrollbar in the corresponding direction is only shown if it is needed, i.e. if the virtual size of the scrolled window in this direction is greater than the current physical window size. Using this function the scrollbar visibility can be changed to be:
-    # - {Wx::ScrollbarVisibility::SHOW_SB_ALWAYS}: To always show the scrollbar, even if it is not needed currently ({Wx::ALWAYS_SHOW_SB} style can be used during the window creation to achieve the same effect but it applies in both directions).- {Wx::ScrollbarVisibility::SHOW_SB_NEVER}: To never show the scrollbar at all. In this case the program should presumably provide some other way for the user to scroll the window.- {Wx::ScrollbarVisibility::SHOW_SB_DEFAULT}: To restore the default behaviour described above.
+    # 
+    # - {Wx::ScrollbarVisibility::SHOW_SB_ALWAYS}: To always show the scrollbar, even if it is not needed currently ({Wx::ALWAYS_SHOW_SB} style can be used during the window creation to achieve the same effect but it applies in both directions).
+    # - {Wx::ScrollbarVisibility::SHOW_SB_NEVER}: To never show the scrollbar at all. In this case the program should presumably provide some other way for the user to scroll the window.
+    # - {Wx::ScrollbarVisibility::SHOW_SB_DEFAULT}: To restore the default behaviour described above.
     # 
     # Note that the window must be created before calling this method.
-    # @param horz [ScrollbarVisibility]  The desired visibility for the horizontal scrollbar.
-    # @param vert [ScrollbarVisibility]  The desired visibility for the vertical scrollbar.
+    # @param horz [Wx::ScrollbarVisibility]  The desired visibility for the horizontal scrollbar.
+    # @param vert [Wx::ScrollbarVisibility]  The desired visibility for the vertical scrollbar.
     # @return [void]
     def show_scrollbars(horz, vert) end
     
@@ -208,7 +226,7 @@ module Wx
     alias_method :virtual_size, :get_virtual_size
     
     # Motif only: true if the window has a backing bitmap.
-    # @return [true,false]
+    # @return [Boolean]
     def is_retained; end
     alias_method :retained?, :is_retained
     
@@ -243,8 +261,8 @@ module Wx
     # The first pair of parameters give the number of pixels per 'scroll step', i.e. amount moved when the up or down scroll arrows are pressed. The second pair gives the length of scrollbar in scroll steps, which sets the size of the virtual window.
     # xPos and yPos optionally specify a position to scroll to immediately.
     # For example, the following gives a window horizontal and vertical scrollbars with 20 pixels per scroll step, and a size of 50 steps (1000 pixels) in each direction: 
-    # ```
-    #   window->SetScrollbars(20, 20, 50, 50);
+    # ```ruby
+    #   window.set_scrollbars(20, 20, 50, 50)
     # ```
     # 
     # {Wx::Scrolled} manages the page size itself, using the current client window size as the page size.
@@ -256,7 +274,7 @@ module Wx
     # @param noUnitsY [Integer]  Number of units in the vertical direction.
     # @param xPos [Integer]  Position to initialize the scrollbars in the horizontal direction, in scroll units.
     # @param yPos [Integer]  Position to initialize the scrollbars in the vertical direction, in scroll units.
-    # @param noRefresh [true,false]  Will not refresh window if true.
+    # @param noRefresh [Boolean]  Will not refresh window if true.
     # @return [void]
     def set_scrollbars(pixelsPerUnitX, pixelsPerUnitY, noUnitsX, noUnitsY, xPos=0, yPos=0, noRefresh=false) end
     
@@ -313,7 +331,7 @@ module Wx
     def adjust_scrollbars; end
     
     # Are we generating the autoscroll events?
-    # @return [true,false]
+    # @return [Boolean]
     def is_auto_scrolling; end
     alias_method :auto_scrolling?, :is_auto_scrolling
     
@@ -321,12 +339,6 @@ module Wx
     # @return [void]
     def stop_auto_scrolling; end
     
-    # This method can be overridden in a derived class to forbid sending the auto scroll events - note that unlike Wx::Scrolled#stop_auto_scrolling it doesn't stop the timer, so it will be called repeatedly and will typically return different values depending on the current mouse position.
-    # The base class version just returns true.
-    # @param event [Wx::ScrollWinEvent] 
-    # @return [true,false]
-    def send_auto_scroll_events(event) end
-    
   end # ScrolledWindow