wxruby3 1.6.0 → 1.7.0

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

@@ -0,0 +1,430 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Possible values for the second argument of Wx::Scrolled#show_scrollbars.
+  # 
+  # 
+  # 
+  class ScrollbarVisibility < Wx::Enum
+  
+    # Never show the scrollbar at all.
+    # 
+    SHOW_SB_NEVER = Wx::ScrollbarVisibility.new(-1)
+    
+    # Show scrollbar only if it is needed.
+    # 
+    SHOW_SB_DEFAULT = Wx::ScrollbarVisibility.new(0)
+    
+    # Always show scrollbar, even if not needed.
+    # 
+    SHOW_SB_ALWAYS = Wx::ScrollbarVisibility.new(1)
+    
+  end # ScrollbarVisibility
+  
+  # The Wx::ScrolledXXX classes manage scrolling for their client areas, 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 specializations of this class:
+  # 
+  # - {Wx::ScrolledWindow} derives 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} 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.
+  # 
+  # In addition the Wx::ScrolledControl specialization is also used internally in wxWidgets. Like with {Wx::Control} itself though (and for the same reasons), it is not advised to use this template specialization as a base class for custom scrolling controls. Use {Wx::ScrolledCanvas} instead.
+  # 
+  # There are three ways to set the size of the scrolling area:
+  # One way is to set the scrollbars directly using a call to {Wx::ScrolledWindow#set_scrollbars}. This is the way it used to be in any previous version of wxWidgets and it will be kept for backwards compatibility.
+  # An additional method of manual control, which requires a little less computation of your own, is to set the total size of the scrolling area by calling either {Wx::Window#set_virtual_size}, or {Wx::Window#fit_inside}, and setting the scrolling increments for it by calling {Wx::ScrolledWindow#set_scroll_rate}. Scrolling in some orientation is enabled by setting a non-zero increment for it.
+  # The most automatic and newest way is to simply let sizers determine the scrolling area. This is now the default when you set an interior sizer into a {Wx::ScrolledWindow} with {Wx::Window#set_sizer}. The scrolling area will be set to the size requested by the sizer and the scrollbars will be assigned for each orientation according to the need for them and the scrolling increment set by {Wx::ScrolledWindow#set_scroll_rate}. As above, scrolling is only enabled in orientations with a non-zero increment. Note that if you add or remove any elements to the sizer, you need to call {Wx::Sizer#fit_inside} to adjust the virtual size to the new contents.
+  # As with all windows, an application can draw onto a {Wx::ScrolledWindow} using a device context.
+  # You have the option of handling the OnPaint handler or overriding the {Wx::ScrolledWindow#on_draw} function, which is passed a pre-scrolled device context (prepared by {Wx::ScrolledWindow#do_prepare_dc}).
+  # If you don't wish to calculate your own scrolling, you must call {Wx::ScrolledWindow#prepare_dc} or {Wx::ScrolledWindow#prepare_read_only_dc} when not drawing from within {Wx::ScrolledWindow#on_draw}, to set the device origin for the device context according to the current scroll position.
+  # A {Wx::ScrolledWindow} will normally scroll itself and therefore its child windows as well. It might however be desired to scroll a different window than itself: e.g. when designing a spreadsheet, you will normally only have to scroll the (usually white) cell area, whereas the (usually grey) label area will scroll very differently. For this special purpose, you can call {Wx::ScrolledWindow#set_target_window} which means that pressing the scrollbars will scroll a different window.
+  # Note that the underlying system knows nothing about scrolling coordinates, so that all system functions (mouse events, expose events, refresh calls etc) as well as the position of subwindows are relative to the "physical" origin of the scrolled window. If the user insert a child window at position (10,10) and scrolls the window down 100 pixels (moving the child window out of the visible area), the child window will report a position of (10,-90).
+  # 
+  # ## Automatic scrolling
+  # Scrolled windows implement automatic scrolling behaviour: when the mouse is captured by the application and the user holds the mouse button down, the window may start and keep scrolling even if the mouse doesn't move, provided that it is in the "autoscroll zone". This is convenient to allow extending selection to the parts of the window currently outside of the visible area, for example.
+  # By default, autoscrolling is triggered when the mouse is anywhere outside of the window, i.e. the window starts scrolling when the (captured) mouse pointer leaves the window and stops when it re-enters the window. However, this behaviour can be customized using {Wx::ScrolledWindow#enable_auto_scroll_inside} and {Wx::ScrolledWindow#disable_auto_scroll_outside} functions. The first of them allows to enable autoscrolling even when mouse is inside the window, but close to its border, while the second one allows to disable autoscrolling when mouse is outside the window.
+  # To disable autoscrolling completely, call {Wx::ScrolledWindow#disable_auto_scroll_outside} without calling {Wx::ScrolledWindow#enable_auto_scroll_inside}.
+  # ### 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::ScrolledWindow#show_scrollbars}. 
+  # 
+  # ### 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. 
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>Don't confuse {Wx::ScrollWinEvents} generated by this class with {Wx::ScrollEvent} objects generated by {Wx::ScrollBar} and {Wx::Slider}.
+  # </p>
+  # </div>
+  # 
+  # <div class="wxrb-remark">
+  # <b>Remark:</b>
+  # <p>Use {Wx::ScrolledWindow} for applications where the user scrolls by a fixed amount, and where a 'page' can be interpreted to be the current visible portion of the window. For more sophisticated applications, use the {Wx::ScrolledWindow} implementation as a guide to build your own scroll behaviour or use {Wx::VScrolledWindow} or its variants.
+  # </p>
+  # </div>
+  # 
+  # Category:  Miscellaneous Windows
+  # @see Wx::ScrollBar
+  # @see  Wx::ClientDC
+  # @see  Wx::PaintDC
+  # @see  Wx::VScrolledWindow
+  # @see  Wx::HScrolledWindow
+  # @see  Wx::HVScrolledWindow
+  # @see  
+  # 
+  # 
+  class ScrolledWindow < Panel
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Wx::ScrolledWindow]
+    # @overload initialize(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("SCROLLED_WINDOW"))
+    #   Constructor.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>The window is initially created without visible scrollbars. Call {Wx::ScrolledWindow#set_scrollbars} to specify how big the virtual window size should be. 
+    #   </p>
+    #   </div>
+    #   @param parent [Wx::Window]  Parent window.
+    #   @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 a position of {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
+    #   @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::ScrolledWindow}.
+    #   @param name [String]  Window name.
+    #   @return [Wx::ScrolledWindow]
+    # @overload initialize(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("SCROLLED_WINDOW"), &block)
+    #   Constructor.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>The window is initially created without visible scrollbars. Call {Wx::ScrolledWindow#set_scrollbars} to specify how big the virtual window size should be. 
+    #   </p>
+    #   </div>
+    #   @param parent [Wx::Window]  Parent window.
+    #   @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 a position of {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
+    #   @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::ScrolledWindow}.
+    #   @param name [String]  Window name.
+    #   @yieldparam [Wx::ScrolledWindow] win new instance
+    #   @return [Wx::ScrolledWindow]
+    def initialize(*args) end
+    
+    # @overload calc_scrolled_position(x, y)
+    #   Translates the logical coordinates to the device ones.
+    #   
+    #   For example, if a window is scrolled 10 pixels to the bottom, the device coordinates of the origin are (0, 0) (as always), but the logical coordinates are (0, 10) and so the call to CalcScrolledPosition(0, 10, xx, yy) will return 0 in yy.
+    #   @see {Wx::ScrolledWindow#calc_unscrolled_position} 
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @return [Array(Integer,Integer)]
+    # @overload calc_scrolled_position(pt)
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @return [Wx::Point]
+    def calc_scrolled_position(*args) end
+    
+    # @overload calc_unscrolled_position(x, y)
+    #   Translates the device coordinates to the logical ones.
+    #   
+    #   For example, if a window is scrolled 10 pixels to the bottom, the device coordinates of the origin are (0, 0) (as always), but the logical coordinates are (0, 10) and so the call to CalcUnscrolledPosition(0, 0, xx, yy) will return 10 in yy.
+    #   @see {Wx::ScrolledWindow#calc_scrolled_position} 
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @return [Array(Integer,Integer)]
+    # @overload calc_unscrolled_position(pt)
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @return [Wx::Point]
+    def calc_unscrolled_position(*args) end
+    
+    # Creates the window for two-step construction.
+    # @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 name [String] 
+    # @return [Boolean]
+    def create(parent, id=-1, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::HSCROLL|Wx::VSCROLL), name=("SCROLLED_WINDOW")) end
+    
+    # Disable use of keyboard keys for scrolling.
+    # 
+    # By default cursor movement keys (including Home, End, Page Up and Down) are used to scroll the window appropriately. If the derived class uses these keys for something else, e.g. changing the currently selected item, this function can be used to disable this behaviour as it's not only not necessary then but can actually be actively harmful if another object forwards a keyboard event corresponding to one of the above keys to us using ProcessWindowEvent() because the event will always be processed which can be undesirable.
+    # @return [void]
+    def disable_keyboard_scrolling; end
+    
+    # Call this function to prepare the device context for drawing a scrolled image.
+    # 
+    # It sets the device origin according to the current scroll position and also changes the device scale according to the current scaling factor set by {Wx::ScrolledWindow#set_scale}.
+    # {Wx::ScrolledWindow#do_prepare_dc} is called automatically within the default {Wx::EVT_PAINT} event handler, so your {Wx::ScrolledWindow#on_draw} override will be passed an already 'pre-scrolled' device context. However, if you wish to draw from outside of {Wx::ScrolledWindow#on_draw} (e.g. from your own {Wx::EVT_PAINT} handler), you must call this function yourself.
+    # Note that this function can be used only with {Wx::PaintDC}, but not {Wx::InfoDC}, while {Wx::ScrolledWindow#do_prepare_read_only_dc} can be used with either of these classes.
+    # @param dc [Wx::DC] 
+    # @return [void]
+    def do_prepare_dc(dc) end
+    
+    # Call this function to adjust any device context used with this window.
+    # 
+    # It sets the device origin according to the current scroll position and also changes the device scale according to the current scaling factor set by {Wx::ScrolledWindow#set_scale}.
+    # Unlike {Wx::ScrolledWindow#do_prepare_dc}, this function can be used with {Wx::InfoDC}, which makes it useful when computing the coordinates of mouse events, for example:
+    # 
+    # ```
+    #   void MyWindow::OnEvent(wxMouseEvent& event)
+    #   {
+    #     wxInfoDC dc(this);
+    #     DoPrepareReadOnlyDC(dc);
+    #   
+    #     if ( event.Dragging() )
+    #     {
+    #       m_lastDragPosition = event.GetLogicalPosition(dc);
+    #       Refresh();
+    #     }
+    #   }
+    # ```
+    # 
+    # 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 it or, if you do, reset it to (0, 0) later. If you call this function 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.
+    # @param dc [Wx::DC] 
+    # @return [void]
+    def do_prepare_read_only_dc(dc) end
+    
+    # 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 [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.
+    # 
+    # Note that the window must be created before calling this method.
+    # @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
+    
+    # Get the number of pixels per scroll unit (line), in each direction, as set by {Wx::ScrolledWindow#set_scrollbars}.
+    # 
+    # A value of zero indicates no scrolling in that direction.
+    # @see {Wx::ScrolledWindow#set_scrollbars}
+    # @see  {Wx::ScrolledWindow#get_virtual_size} 
+    # @return [Array(Integer,Integer)]
+    def get_scroll_pixels_per_unit; end
+    alias_method :scroll_pixels_per_unit, :get_scroll_pixels_per_unit
+    
+    # This is a simple overload of GetViewStart(int*,int*); see that function for more info.
+    # @return [Wx::Point]
+    def get_view_start; end
+    alias_method :view_start, :get_view_start
+    
+    # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    # @return [Wx::Point]
+    def get_view_start_pixels; end
+    alias_method :view_start_pixels, :get_view_start_pixels
+    
+    # Gets the size in device units of the scrollable window area (as opposed to the client size, which is the area of the window currently visible).
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Use {Wx::DC#device_to_logical_x} and {Wx::DC#device_to_logical_y} to translate these units to logical units.
+    # </p>
+    # </div>
+    # @see {Wx::ScrolledWindow#set_scrollbars}
+    # @see  {Wx::ScrolledWindow#get_scroll_pixels_per_unit} 
+    # @return [Array(Integer,Integer)]
+    def get_virtual_size; end
+    alias_method :virtual_size, :get_virtual_size
+    
+    # This function is overridden to call {Wx::ScrolledWindow#do_prepare_dc}.
+    # 
+    # It may be more convenient to call this function in the code which only has {Wx::Window} pointer, as this function is available in the base class too, unlike {Wx::ScrolledWindow#do_prepare_dc}.
+    # Note that, if necessary, you should only override {Wx::ScrolledWindow#do_prepare_dc}, or {Wx::ScrolledWindow#do_prepare_read_only_dc}, and not this function.
+    # @see {Wx::ScrolledWindow#prepare_read_only_dc} 
+    # @param dc [Wx::DC] 
+    # @return [void]
+    def prepare_dc(dc) end
+    
+    # This function is overridden to call {Wx::ScrolledWindow#do_prepare_read_only_dc}.
+    # 
+    # It may be more convenient to call this function in the code which only has {Wx::Window} pointer, as this function is available in the base class too, unlike {Wx::ScrolledWindow#do_prepare_read_only_dc}.
+    # Note that, if necessary, you should only override {Wx::ScrolledWindow#do_prepare_read_only_dc}, and not this function.
+    # @param dc [Wx::ReadOnlyDC] 
+    # @return [void]
+    def prepare_read_only_dc(dc) end
+    
+    # @overload scroll(x, y)
+    #   Scrolls a window so the view start is at the given point.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>The positions are in scroll units, not pixels, so to convert to pixels you will have to multiply by the number of pixels per scroll increment. If either parameter is {Wx::DEFAULT_COORD} (-1), that position will be ignored (no change in that direction).
+    #   </p>
+    #   </div>
+    #   @see {Wx::ScrolledWindow#set_scrollbars}
+    #   @see  {Wx::ScrolledWindow#get_scroll_pixels_per_unit} 
+    #   @param x [Integer]  The x position to scroll to, in scroll units.
+    #   @param y [Integer]  The y position to scroll to, in scroll units.
+    #   @return [void]
+    # @overload scroll(pt)
+    #   This is an overload of {Wx::ScrolledWindow#scroll}(int,int); see that function for more info.
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @return [void]
+    def scroll(*args) end
+    
+    # Set the horizontal and vertical scrolling increment only.
+    # 
+    # See the pixelsPerUnit parameter in {Wx::ScrolledWindow#set_scrollbars}.
+    # @param xstep [Integer] 
+    # @param ystep [Integer] 
+    # @return [void]
+    def set_scroll_rate(xstep, ystep) end
+    
+    # Sets up vertical and/or horizontal scrollbars.
+    # 
+    # 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: 
+    # ```ruby
+    #   window.set_scrollbars(20, 20, 50, 50)
+    # ```
+    # 
+    # {Wx::ScrolledWindow} manages the page size itself, using the current client window size as the page size.
+    # Note that for more sophisticated scrolling applications, for example where scroll steps may be variable according to the position in the document, it will be necessary to derive a new class from {Wx::Window}, overriding OnSize() and adjusting the scrollbars appropriately.
+    # @see Wx::Window#set_virtual_size 
+    # @param pixelsPerUnitX [Integer]  Pixels per scroll unit in the horizontal direction.
+    # @param pixelsPerUnitY [Integer]  Pixels per scroll unit in the vertical direction.
+    # @param noUnitsX [Integer]  Number of units in the horizontal direction.
+    # @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 [Boolean]  Will not refresh window if true.
+    # @return [void]
+    def set_scrollbars(pixelsPerUnitX, pixelsPerUnitY, noUnitsX, noUnitsY, xPos=0, yPos=0, noRefresh=false) end
+    
+    # Call this function to tell {Wx::ScrolledWindow} to perform the actual scrolling on a different window (and not on itself).
+    # 
+    # This method is useful when only a part of the window should be scrolled. A typical example is a control consisting of a fixed header and the scrollable contents window: the scrollbars are attached to the main window itself, hence it, and not the contents window must be derived from {Wx::ScrolledWindow}, but only the contents window scrolls when the scrollbars are used. To implement such setup, you need to call this method with the contents window as argument.
+    # Notice that if this method is used, {Wx::ScrolledWindow#get_size_available_for_scroll_target} method must be overridden.
+    # @param window [Wx::Window] 
+    # @return [void]
+    def set_target_window(window) end
+    alias_method :target_window=, :set_target_window
+    
+    # @return [Wx::Window]
+    def get_target_window; end
+    alias_method :target_window, :get_target_window
+    
+    # @param rect [Wx::Rect] 
+    # @return [void]
+    def set_target_rect(rect) end
+    alias_method :target_rect=, :set_target_rect
+    
+    # @return [Wx::Rect]
+    def get_target_rect; end
+    alias_method :target_rect, :get_target_rect
+    
+    # @param orient [Integer] 
+    # @return [Integer]
+    def get_scroll_page_size(orient) end
+    alias_method :scroll_page_size, :get_scroll_page_size
+    
+    # @param orient [Integer] 
+    # @param pageSize [Integer] 
+    # @return [void]
+    def set_scroll_page_size(orient, pageSize) end
+    
+    # @param orient [Integer] 
+    # @return [Integer]
+    def get_scroll_lines(orient) end
+    alias_method :scroll_lines, :get_scroll_lines
+    
+    # Set the width of the autoscroll zone inside the window rectangle.
+    # 
+    # Setting inner scroll zone to a non-zero value enables autoscrolling if the distance between the mouse and the closest edge of the window rectangle is less than the given value.
+    # By default, autoscrolling is not triggered when the mouse is inside the window.
+    # @see Automatic scrolling
+    # @see  SetOuterScrollZone()
+    # @param insideWidth [Integer]  The width of the inner scroll zone in pixels. If this parameter is set to 0, there is no inner scroll zone and autoscrolling may be triggered only when the mouse is outside of the window (unless it is disabled too). (Negative values, including {Wx::DEFAULT_COORD}, are forbidden.)
+    # @return [void]
+    def enable_auto_scroll_inside(insideWidth) end
+    
+    # By default, autoscrolling is triggered when the mouse is anywhere outside of the window.
+    # 
+    # This function disables autoscrolling when the mouse is outside the window. (Autoscrolling could still be enabled when the mouse is inside the window.)
+    # @see Automatic scrolling
+    # @see  {Wx::ScrolledWindow#enable_auto_scroll_inside}
+    # @return [void]
+    def disable_auto_scroll_outside; end
+    
+    # Set the scaling factor for the window.
+    # 
+    # This method can be used to scale the window contents, provided that {Wx::ScrolledWindow#do_prepare_dc} or {Wx::ScrolledWindow#do_prepare_read_only_dc} is called.
+    # @see {Wx::ScrolledWindow#get_scale_x}
+    # @see  {Wx::ScrolledWindow#get_scale_y} 
+    # @param xs [Float]  The horizontal scaling factor.
+    # @param ys [Float]  The vertical scaling factor.
+    # @return [void]
+    def set_scale(xs, ys) end
+    
+    # @return [Float]
+    def get_scale_x; end
+    alias_method :scale_x, :get_scale_x
+    
+    # @return [Float]
+    def get_scale_y; end
+    alias_method :scale_y, :get_scale_y
+    
+    # @return [void]
+    def adjust_scrollbars; end
+    
+    # Are we generating the autoscroll events?
+    # @return [Boolean]
+    def is_auto_scrolling; end
+    alias_method :auto_scrolling?, :is_auto_scrolling
+    
+    # Stop generating the scroll events when mouse is held outside the window.
+    # @return [void]
+    def stop_auto_scrolling; end
+    
+  end # ScrolledWindow
+  
+
+end

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

@@ -0,0 +1,159 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  # 
+  EVT_SEARCH_CANCEL = 10204
+  
+  # 
+  # 
+  EVT_SEARCH = 10205
+  
+  # A search control is a composite control with a search button, a text control, and a cancel button.
+  # 
+  # This control is implemented natively under macOS and GTK 3.6 or later and generically for all the other platforms.
+  # Please note that this class provides many {Wx::TextCtrl}-like methods, but does not necessarily derive from {Wx::TextCtrl} in all ports (it actually only does so in the MacOSX version currently). Only the methods defined in the {Wx::TextEntry} interface class are guaranteed to be available under all platforms.
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::TE_PROCESS_TAB}: The control will receive {Wx::EVT_CHAR} events for TAB pressed - normally, TAB is used for passing to the next control in a dialog instead. For the control created with this style, you can still use Ctrl-Enter to pass to the next control from the keyboard. 
+  # 
+  # - {Wx::TE_NOHIDESEL}: By default, the Windows text control doesn't show the selection when it doesn't have focus - use this style to force it to always show it. It doesn't do anything under other platforms. 
+  # 
+  # - {Wx::TE_LEFT}: The text in the control will be left-justified (default). 
+  # 
+  # - {Wx::TE_CENTRE}: The text in the control will be centered (currently WXMSW and WXGTK2 only). 
+  # 
+  # - {Wx::TE_RIGHT}: The text in the control will be right-justified (currently WXMSW and WXGTK2 only). 
+  # 
+  # - {Wx::TE_CAPITALIZE}: On PocketPC and Smartphone, causes the first letter to be capitalized. 
+  # 
+  # ### Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CommandEvent} events.
+  # Event handler methods for events emitted by this class:{Wx::TextCtrl}. However it is recommended to use {Wx::EVT_SEARCH} to actually start searching to avoid doing it too soon, while the user is still typing (note that {Wx::EVT_SEARCH} is also triggered by pressing Enter in the control). 
+  # 
+  # - {Wx::EvtHandler#evt_search}(id, meth = nil, &block): Respond to a {Wx::EVT_SEARCH} event, generated when the search button is clicked. Note that this does not initiate a search on its own, you need to perform the appropriate action in your event handler. You may use 
+  # 
+  # - {Wx::EvtHandler#evt_search_cancel}(id, meth = nil, &block): Respond to a {Wx::EVT_SEARCH_CANCEL} event, generated when the cancel button is clicked. 
+  # 
+  # 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 Wx::TextCtrl 
+  # 
+  # 
+  # @wxrb_require USE_SEARCHCTRL
+  class SearchCtrl < Control
+  
+    include Wx::TextEntry
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Wx::SearchCtrl]
+    # @overload initialize(parent, id, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SEARCH_CTRL_NAME_STR)
+    #   Constructor, creating and showing a text control.
+    #   
+    #   
+    #   @see Wx::TextCtrl#create
+    #   @see  Wx::Validator 
+    #   @param parent [Wx::Window]  Parent window. Should not be nil.
+    #   @param id [Integer]  Control identifier. A value of -1 denotes a default value.
+    #   @param value [String]  Default text value.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Text control position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Text control size.
+    #   @param style [Integer]  Window style. See {Wx::SearchCtrl}.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @return [Wx::SearchCtrl]
+    # @overload initialize(parent, id, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SEARCH_CTRL_NAME_STR, &block)
+    #   Constructor, creating and showing a text control.
+    #   
+    #   
+    #   @see Wx::TextCtrl#create
+    #   @see  Wx::Validator 
+    #   @param parent [Wx::Window]  Parent window. Should not be nil.
+    #   @param id [Integer]  Control identifier. A value of -1 denotes a default value.
+    #   @param value [String]  Default text value.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Text control position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Text control size.
+    #   @param style [Integer]  Window style. See {Wx::SearchCtrl}.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @yieldparam [Wx::SearchCtrl] win new instance
+    #   @return [Wx::SearchCtrl]
+    def initialize(*args) end
+    
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param value [String] 
+    # @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, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SEARCH_CTRL_NAME_STR) end
+    
+    # Returns a pointer to the search control's menu object or nil if there is no menu attached.
+    # @return [Wx::Menu]
+    def get_menu; end
+    alias_method :menu, :get_menu
+    
+    # Returns the search button visibility value.
+    # 
+    # If there is a menu attached, the search button will be visible regardless of the search button visibility value.
+    # @return [Boolean]
+    def is_search_button_visible; end
+    alias_method :search_button_visible?, :is_search_button_visible
+    
+    # Returns the cancel button's visibility state.
+    # @return [Boolean]
+    def is_cancel_button_visible; end
+    alias_method :cancel_button_visible?, :is_cancel_button_visible
+    
+    # Sets the search control's menu object.
+    # 
+    # If there is already a menu associated with the search control it is deleted.
+    # @param menu [Wx::Menu]  Menu to attach to the search control.
+    # @return [void]
+    def set_menu(menu) end
+    alias_method :menu=, :set_menu
+    
+    # Shows or hides the cancel button.
+    # 
+    # Note that this function does nothing in the native GTK version of the control: "Cancel" button is always shown automatically if the control is not empty and hidden if it is empty.
+    # @param show [Boolean] 
+    # @return [void]
+    def show_cancel_button(show) end
+    
+    # Sets the search button visibility value on the search control.
+    # 
+    # If there is a menu attached, the search button will be visible regardless of the search button visibility value.
+    # Note that this function does nothing in the native GTK version of the control: "Search" button is always shown there.
+    # @param show [Boolean] 
+    # @return [void]
+    def show_search_button(show) end
+    
+    # Set the text to be displayed in the search control when the user has not yet typed anything in it.
+    # @param text [String] 
+    # @return [void]
+    def set_descriptive_text(text) end
+    alias_method :descriptive_text=, :set_descriptive_text
+    
+    # Return the text displayed when there is not yet any user input.
+    # @return [String]
+    def get_descriptive_text; end
+    alias_method :descriptive_text, :get_descriptive_text
+    
+  end # SearchCtrl
+  
+
+end