wxruby3 0.9.2-x64-mingw-ucrt → 0.9.4-x64-mingw-ucrt

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

@@ -61,6 +61,7 @@ module Wx
   EVT_CALCULATE_LAYOUT = 10012
   
   # {Wx::SashLayoutWindow} responds to OnCalculateLayout events generated by {Wx::LayoutAlgorithm}.
+  # 
   # It allows the application to use simple accessors to specify how the window should be laid out, rather than having to respond to events.
   # The fact that the class derives from {Wx::SashWindow} allows sashes to be used if required, to allow the windows to be user-resizable.
   # The documentation for {Wx::LayoutAlgorithm} explains the purpose of this class in more detail.
@@ -111,12 +112,14 @@ module Wx
     alias_method :orientation, :get_orientation
     
     # The default handler for the event that is generated by {Wx::LayoutAlgorithm}.
+    # 
     # The implementation of this function calls {Wx::CalculateLayoutEvent#set_rect} to shrink the provided size according to how much space this window takes up. For further details, see {Wx::LayoutAlgorithm} and {Wx::CalculateLayoutEvent}.
     # @param event [Wx::CalculateLayoutEvent] 
     # @return [void]
     def on_calculate_layout(event) end
     
     # The default handler for the event that is generated by OnCalculateLayout to get size, alignment and orientation information for the window.
+    # 
     # The implementation of this function uses member variables as set by accessors called by the application.
     # For further details, see {Wx::LayoutAlgorithm} and {Wx::QueryLayoutInfoEvent}.
     # @param event [Wx::QueryLayoutInfoEvent] 
@@ -124,6 +127,7 @@ module Wx
     def on_query_layout_info(event) end
     
     # Sets the alignment of the window (which edge of the available parent client area the window is attached to).
+    # 
     # alignment is one of {Wx::LayoutAlignment::LAYOUT_TOP}, {Wx::LayoutAlignment::LAYOUT_LEFT}, {Wx::LayoutAlignment::LAYOUT_RIGHT}, {Wx::LayoutAlignment::LAYOUT_BOTTOM}.
     # @param alignment [Wx::LayoutAlignment] 
     # @return [void]
@@ -131,6 +135,7 @@ module Wx
     alias_method :alignment=, :set_alignment
     
     # Sets the default dimensions of the window.
+    # 
     # The dimension other than the orientation will be fixed to this value, and the orientation dimension will be ignored and the window stretched to fit the available space.
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @return [void]
@@ -138,6 +143,7 @@ module Wx
     alias_method :default_size=, :set_default_size
     
     # Sets the orientation of the window (the direction the window will stretch in, to fill the available parent client area).
+    # 
     # orientation is one of {Wx::LayoutOrientation::LAYOUT_HORIZONTAL}, {Wx::LayoutOrientation::LAYOUT_VERTICAL}.
     # @param orientation [Wx::LayoutOrientation] 
     # @return [void]
@@ -147,6 +153,7 @@ module Wx
   end # SashLayoutWindow
   
   # {Wx::LayoutAlgorithm} implements layout of subwindows in MDI or SDI frames.
+  # 
   # It sends a {Wx::CalculateLayoutEvent} event to children of the frame, asking them for information about their size. For MDI parent frames, the algorithm allocates the remaining space to the MDI client window (which contains the MDI child frames).
   # For SDI (normal) frames, a 'main' window is specified as taking up the remaining space.
   # Because the event system is used, this technique can be applied to any windows, which are not necessarily 'aware' of the layout classes (no virtual functions in {Wx::Window} refer to {Wx::LayoutAlgorithm} or its events). However, you may wish to use {Wx::SashLayoutWindow} for your subwindows since this class provides handlers for the required events, and accessors to specify the desired size of the window. The sash behaviour in the base class can be used, optionally, to make the windows user-resizable.
@@ -186,6 +193,7 @@ module Wx
     def initialize; end
     
     # Lays out the children of a normal frame.
+    # 
     # mainWindow is set to occupy the remaining space. This function simply calls {Wx::LayoutAlgorithm#layout_window}.
     # @param frame [Wx::Frame] 
     # @param mainWindow [Wx::Window] 
@@ -193,6 +201,7 @@ module Wx
     def layout_frame(frame, mainWindow=nil) end
     
     # Lays out the children of an MDI parent frame.
+    # 
     # If rect is non-NULL, the given rectangle will be used as a starting point instead of the frame's client area. The MDI client window is set to occupy the remaining space.
     # @param frame [Wx::MDIParentFrame] 
     # @param rect [Wx::Rect] 
@@ -200,6 +209,7 @@ module Wx
     def layout_mdi_frame(frame, rect=nil) end
     
     # Lays out the children of a normal frame or other window.
+    # 
     # mainWindow is set to occupy the remaining space. If this is not specified, then the last window that responds to a calculate layout event in query mode will get the remaining space (that is, a non-query OnCalculateLayout event will not be sent to this window and the window will be set to the remaining size).
     # @param parent [Wx::Window] 
     # @param mainWindow [Wx::Window] 

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

@@ -7,6 +7,7 @@
 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
@@ -75,6 +76,7 @@ module Wx
     
     # Returns true if a sash is visible on the given edge, false otherwise.
     # 
+    # 
     # @see Wx::SashWindow#set_sash_visible 
     # @param edge [Wx::SashEdgePosition]  Edge. One of {Wx::SashEdgePosition::SASH_TOP}, {Wx::SashEdgePosition::SASH_RIGHT}, {Wx::SashEdgePosition::SASH_BOTTOM}, {Wx::SashEdgePosition::SASH_LEFT}.
     # @return [Boolean]
@@ -107,6 +109,7 @@ module Wx
     
     # Call this function to make a sash visible or invisible on a particular edge.
     # 
+    # 
     # @see Wx::SashWindow#get_sash_visible 
     # @param edge [Wx::SashEdgePosition]  Edge to change. One of {Wx::SashEdgePosition::SASH_TOP}, {Wx::SashEdgePosition::SASH_RIGHT}, {Wx::SashEdgePosition::SASH_BOTTOM}, {Wx::SashEdgePosition::SASH_LEFT}.
     # @param visible [Boolean]  true to make the sash visible, false to make it invisible.

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

@@ -7,6 +7,7 @@
 module Wx
 
   # A {Wx::ScreenDC} can be used to paint on the screen.
+  # 
   # This should normally be constructed as a temporary stack object; don't store a {Wx::ScreenDC} object.
   # When using multiple monitors, {Wx::ScreenDC} corresponds to the entire virtual screen composed of all of them. Notice that coordinates on {Wx::ScreenDC} can be negative in this case, see Wx::Display#get_geometry for more.
   # 

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

@@ -7,13 +7,14 @@
 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>>
+  # </div>
   # 
   # ### Styles
   # 
@@ -92,6 +93,7 @@ module Wx
     # @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.
@@ -105,6 +107,7 @@ module Wx
     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] 
@@ -117,6 +120,7 @@ module Wx
     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]
@@ -125,6 +129,7 @@ module Wx
     
     # Returns the length of the scrollbar.
     # 
+    # 
     # @see Wx::ScrollBar#set_scrollbar 
     # @return [Integer]
     def get_range; end
@@ -132,6 +137,7 @@ module Wx
     
     # Returns the current position of the scrollbar thumb.
     # 
+    # 
     # @see Wx::ScrollBar#set_thumb_position 
     # @return [Integer]
     def get_thumb_position; end
@@ -139,12 +145,14 @@ module Wx
     
     # 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: 
@@ -153,7 +161,7 @@ module Wx
     # ```
     #  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>>
+    # </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.
@@ -164,6 +172,7 @@ module Wx
     
     # Sets the position of the scrollbar.
     # 
+    # 
     # @see Wx::ScrollBar#get_thumb_position 
     # @param viewStart [Integer]  The position of the scrollbar thumb.
     # @return [void]

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

@@ -7,6 +7,7 @@
 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.
@@ -75,7 +76,7 @@ module Wx
   # <b>Remark:</b>
   # <p>Use {Wx::Scrolled} 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::Scrolled} implementation as a guide to build your own scroll behaviour or use {Wx::VScrolledWindow} or its variants.
   # </p>
-  # </div>>
+  # </div>
   # 
   # Category:  Miscellaneous Windows
   # @see Wx::ScrollBar
@@ -94,11 +95,12 @@ module Wx
     #   @return [Wx::ScrolledCanvas]
     # @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::Scrolled#set_scrollbars to specify how big the virtual window size should be. 
     #   </p>
-    #   </div>>
+    #   </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.
@@ -110,6 +112,7 @@ module Wx
     
     # @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::Scrolled#calc_unscrolled_position 
     #   @param x [Integer] 
@@ -122,6 +125,7 @@ module Wx
     
     # @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::Scrolled#calc_scrolled_position 
     #   @param x [Integer] 
@@ -133,6 +137,7 @@ module Wx
     def calc_unscrolled_position(*args) end
     
     # Creates the window for two-step construction.
+    # 
     # Derived classes should call or replace this function. If it is not replaced, bear in mind that it calls T::Create() through the global function {create_scrolled} so if T::Create() has a different signature than Wx::Scrolled#create you should implement overloaded {create_scrolled} which would call T::Create() in the correct manner.
     # @see Wx::Scrolled#initialize and create_scrolled for details. 
     # @param parent [Wx::Window] 
@@ -145,11 +150,13 @@ module Wx
     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. 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: 
     # ```ruby
@@ -178,6 +185,7 @@ module Wx
     def do_prepare_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.
@@ -186,6 +194,7 @@ module Wx
     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).
@@ -199,6 +208,7 @@ module Wx
     def show_scrollbars(horz, vert) end
     
     # Get the number of pixels per scroll unit (line), in each direction, as set by Wx::Scrolled#set_scrollbars.
+    # 
     # A value of zero indicates no scrolling in that direction.
     # @see Wx::Scrolled#set_scrollbars
     # @see  Wx::Scrolled#get_virtual_size 
@@ -212,11 +222,12 @@ module Wx
     alias_method :view_start, :get_view_start
     
     # 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>>
+    # </div>
     # @see Wx::Scrolled#set_scrollbars
     # @see  Wx::Scrolled#get_scroll_pixels_per_unit 
     # @return [Array(Integer,Integer)]
@@ -229,6 +240,7 @@ module Wx
     alias_method :retained?, :is_retained
     
     # This function is for backwards compatibility only and simply calls Wx::Scrolled#do_prepare_dc now.
+    # 
     # Notice that it is not called by the default paint event handle (Wx::Scrolled#do_prepare_dc is), so overriding this method in your derived class is useless.
     # @param dc [Wx::DC] 
     # @return [void]
@@ -236,11 +248,12 @@ module Wx
     
     # @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>>
+    #   </div>
     #   @see Wx::Scrolled#set_scrollbars
     #   @see  Wx::Scrolled#get_scroll_pixels_per_unit 
     #   @param x [Integer]  The x position to scroll to, in scroll units.
@@ -253,6 +266,7 @@ module Wx
     def scroll(*args) end
     
     # Set the horizontal and vertical scrolling increment only.
+    # 
     # See the pixelsPerUnit parameter in Wx::Scrolled#set_scrollbars.
     # @param xstep [Integer] 
     # @param ystep [Integer] 
@@ -260,6 +274,7 @@ module Wx
     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: 
@@ -281,6 +296,7 @@ module Wx
     def set_scrollbars(pixelsPerUnitX, pixelsPerUnitY, noUnitsX, noUnitsY, xPos=0, yPos=0, noRefresh=false) end
     
     # Call this function to tell {Wx::Scrolled} 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::Scrolled}, 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::Scrolled#get_size_available_for_scroll_target method must be overridden.
     # @param window [Wx::Window] 

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

@@ -7,6 +7,7 @@
 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.
@@ -75,7 +76,7 @@ module Wx
   # <b>Remark:</b>
   # <p>Use {Wx::Scrolled} 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::Scrolled} implementation as a guide to build your own scroll behaviour or use {Wx::VScrolledWindow} or its variants.
   # </p>
-  # </div>>
+  # </div>
   # 
   # Category:  Miscellaneous Windows
   # @see Wx::ScrollBar
@@ -94,11 +95,12 @@ module Wx
     #   @return [Wx::ScrolledControl]
     # @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::Scrolled#set_scrollbars to specify how big the virtual window size should be. 
     #   </p>
-    #   </div>>
+    #   </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.
@@ -110,6 +112,7 @@ module Wx
     
     # @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::Scrolled#calc_unscrolled_position 
     #   @param x [Integer] 
@@ -122,6 +125,7 @@ module Wx
     
     # @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::Scrolled#calc_scrolled_position 
     #   @param x [Integer] 
@@ -133,6 +137,7 @@ module Wx
     def calc_unscrolled_position(*args) end
     
     # Creates the window for two-step construction.
+    # 
     # Derived classes should call or replace this function. If it is not replaced, bear in mind that it calls T::Create() through the global function {create_scrolled} so if T::Create() has a different signature than Wx::Scrolled#create you should implement overloaded {create_scrolled} which would call T::Create() in the correct manner.
     # @see Wx::Scrolled#initialize and create_scrolled for details. 
     # @param parent [Wx::Window] 
@@ -145,11 +150,13 @@ module Wx
     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. 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: 
     # ```ruby
@@ -178,6 +185,7 @@ module Wx
     def do_prepare_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.
@@ -186,6 +194,7 @@ module Wx
     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).
@@ -199,6 +208,7 @@ module Wx
     def show_scrollbars(horz, vert) end
     
     # Get the number of pixels per scroll unit (line), in each direction, as set by Wx::Scrolled#set_scrollbars.
+    # 
     # A value of zero indicates no scrolling in that direction.
     # @see Wx::Scrolled#set_scrollbars
     # @see  Wx::Scrolled#get_virtual_size 
@@ -212,11 +222,12 @@ module Wx
     alias_method :view_start, :get_view_start
     
     # 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>>
+    # </div>
     # @see Wx::Scrolled#set_scrollbars
     # @see  Wx::Scrolled#get_scroll_pixels_per_unit 
     # @return [Array(Integer,Integer)]
@@ -229,6 +240,7 @@ module Wx
     alias_method :retained?, :is_retained
     
     # This function is for backwards compatibility only and simply calls Wx::Scrolled#do_prepare_dc now.
+    # 
     # Notice that it is not called by the default paint event handle (Wx::Scrolled#do_prepare_dc is), so overriding this method in your derived class is useless.
     # @param dc [Wx::DC] 
     # @return [void]
@@ -236,11 +248,12 @@ module Wx
     
     # @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>>
+    #   </div>
     #   @see Wx::Scrolled#set_scrollbars
     #   @see  Wx::Scrolled#get_scroll_pixels_per_unit 
     #   @param x [Integer]  The x position to scroll to, in scroll units.
@@ -253,6 +266,7 @@ module Wx
     def scroll(*args) end
     
     # Set the horizontal and vertical scrolling increment only.
+    # 
     # See the pixelsPerUnit parameter in Wx::Scrolled#set_scrollbars.
     # @param xstep [Integer] 
     # @param ystep [Integer] 
@@ -260,6 +274,7 @@ module Wx
     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: 
@@ -281,6 +296,7 @@ module Wx
     def set_scrollbars(pixelsPerUnitX, pixelsPerUnitY, noUnitsX, noUnitsY, xPos=0, yPos=0, noRefresh=false) end
     
     # Call this function to tell {Wx::Scrolled} 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::Scrolled}, 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::Scrolled#get_size_available_for_scroll_target method must be overridden.
     # @param window [Wx::Window] 

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

@@ -27,6 +27,7 @@ module Wx
   end # ScrollbarVisibility
   
   # 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.
@@ -95,7 +96,7 @@ module Wx
   # <b>Remark:</b>
   # <p>Use {Wx::Scrolled} 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::Scrolled} implementation as a guide to build your own scroll behaviour or use {Wx::VScrolledWindow} or its variants.
   # </p>
-  # </div>>
+  # </div>
   # 
   # Category:  Miscellaneous Windows
   # @see Wx::ScrollBar
@@ -114,11 +115,12 @@ module Wx
     #   @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::Scrolled#set_scrollbars to specify how big the virtual window size should be. 
     #   </p>
-    #   </div>>
+    #   </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.
@@ -130,6 +132,7 @@ module Wx
     
     # @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::Scrolled#calc_unscrolled_position 
     #   @param x [Integer] 
@@ -142,6 +145,7 @@ module Wx
     
     # @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::Scrolled#calc_scrolled_position 
     #   @param x [Integer] 
@@ -153,6 +157,7 @@ module Wx
     def calc_unscrolled_position(*args) end
     
     # Creates the window for two-step construction.
+    # 
     # Derived classes should call or replace this function. If it is not replaced, bear in mind that it calls T::Create() through the global function {create_scrolled} so if T::Create() has a different signature than Wx::Scrolled#create you should implement overloaded {create_scrolled} which would call T::Create() in the correct manner.
     # @see Wx::Scrolled#initialize and create_scrolled for details. 
     # @param parent [Wx::Window] 
@@ -165,11 +170,13 @@ module Wx
     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. 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: 
     # ```ruby
@@ -198,6 +205,7 @@ module Wx
     def do_prepare_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.
@@ -206,6 +214,7 @@ module Wx
     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).
@@ -219,6 +228,7 @@ module Wx
     def show_scrollbars(horz, vert) end
     
     # Get the number of pixels per scroll unit (line), in each direction, as set by Wx::Scrolled#set_scrollbars.
+    # 
     # A value of zero indicates no scrolling in that direction.
     # @see Wx::Scrolled#set_scrollbars
     # @see  Wx::Scrolled#get_virtual_size 
@@ -232,11 +242,12 @@ module Wx
     alias_method :view_start, :get_view_start
     
     # 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>>
+    # </div>
     # @see Wx::Scrolled#set_scrollbars
     # @see  Wx::Scrolled#get_scroll_pixels_per_unit 
     # @return [Array(Integer,Integer)]
@@ -249,6 +260,7 @@ module Wx
     alias_method :retained?, :is_retained
     
     # This function is for backwards compatibility only and simply calls Wx::Scrolled#do_prepare_dc now.
+    # 
     # Notice that it is not called by the default paint event handle (Wx::Scrolled#do_prepare_dc is), so overriding this method in your derived class is useless.
     # @param dc [Wx::DC] 
     # @return [void]
@@ -256,11 +268,12 @@ module Wx
     
     # @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>>
+    #   </div>
     #   @see Wx::Scrolled#set_scrollbars
     #   @see  Wx::Scrolled#get_scroll_pixels_per_unit 
     #   @param x [Integer]  The x position to scroll to, in scroll units.
@@ -273,6 +286,7 @@ module Wx
     def scroll(*args) end
     
     # Set the horizontal and vertical scrolling increment only.
+    # 
     # See the pixelsPerUnit parameter in Wx::Scrolled#set_scrollbars.
     # @param xstep [Integer] 
     # @param ystep [Integer] 
@@ -280,6 +294,7 @@ module Wx
     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: 
@@ -301,6 +316,7 @@ module Wx
     def set_scrollbars(pixelsPerUnitX, pixelsPerUnitY, noUnitsX, noUnitsY, xPos=0, yPos=0, noRefresh=false) end
     
     # Call this function to tell {Wx::Scrolled} 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::Scrolled}, 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::Scrolled#get_size_available_for_scroll_target method must be overridden.
     # @param window [Wx::Window]