wxruby3 0.9.1-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

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

@@ -7,12 +7,17 @@
 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.
   # 
-  # See Wx::Scrolled#create if you want to use {Wx::Scrolled} with a custom class.
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>See Wx::Scrolled#create if you want to use {Wx::Scrolled} with a custom class.
+  # </p>
+  # </div>
   # 
   # Starting from version 2.4 of wxWidgets, there are several ways to use a {Wx::ScrolledWindow} (and now {Wx::Scrolled}). In particular, 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::Scrolled#set_scrollbars. This is the way it used to be in any previous version of wxWidgets and it will be kept for backwards compatibility.
@@ -26,7 +31,7 @@ module Wx
   # If you don't wish to calculate your own scrolling, you must call Wx::Scrolled#do_prepare_dc when not drawing from within Wx::Scrolled#on_draw, to set the device origin for the device context according to the current scroll position.
   # A {Wx::Scrolled} 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::Scrolled#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).
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -38,7 +43,7 @@ module Wx
   # 
   # - {Wx::RETAINED}: Uses a backing pixmap to speed refreshes. Motif only. 
   # 
-  # === Events emitted by this class
+  # ### 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:
@@ -61,11 +66,17 @@ module Wx
   # 
   # - {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}.
-  # 
-  # 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.
+  # <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::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>
   # 
   # Category:  Miscellaneous Windows
   # @see Wx::ScrollBar
@@ -84,7 +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.
-    #   The window is initially created without visible scrollbars. Call Wx::Scrolled#set_scrollbars to specify how big the virtual window size should be.
+    #   
+    #   <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>
     #   @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.
@@ -96,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] 
@@ -108,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] 
@@ -119,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] 
@@ -131,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
@@ -164,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.
@@ -172,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).
@@ -185,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 
@@ -198,7 +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).
-    # Use {Wx::DC#device_to_logical_x} and {Wx::DC#device_to_logical_y} to translate these units to logical units.
+    # 
+    # <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::Scrolled#set_scrollbars
     # @see  Wx::Scrolled#get_scroll_pixels_per_unit 
     # @return [Array(Integer,Integer)]
@@ -211,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]
@@ -218,7 +248,12 @@ module Wx
     
     # @overload scroll(x, y)
     #   Scrolls a window so the view start is at the given point.
-    #   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).
+    #   
+    #   <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::Scrolled#set_scrollbars
     #   @see  Wx::Scrolled#get_scroll_pixels_per_unit 
     #   @param x [Integer]  The x position to scroll to, in scroll units.
@@ -231,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] 
@@ -238,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: 
@@ -259,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,12 +27,17 @@ 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.
   # - {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.
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>See Wx::Scrolled#create if you want to use {Wx::Scrolled} with a custom class.
+  # </p>
+  # </div>
   # 
   # Starting from version 2.4 of wxWidgets, there are several ways to use a {Wx::ScrolledWindow} (and now {Wx::Scrolled}). In particular, 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::Scrolled#set_scrollbars. This is the way it used to be in any previous version of wxWidgets and it will be kept for backwards compatibility.
@@ -46,7 +51,7 @@ module Wx
   # If you don't wish to calculate your own scrolling, you must call Wx::Scrolled#do_prepare_dc when not drawing from within Wx::Scrolled#on_draw, to set the device origin for the device context according to the current scroll position.
   # A {Wx::Scrolled} 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::Scrolled#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).
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -58,7 +63,7 @@ module Wx
   # 
   # - {Wx::RETAINED}: Uses a backing pixmap to speed refreshes. Motif only. 
   # 
-  # === Events emitted by this class
+  # ### 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:
@@ -81,11 +86,17 @@ module Wx
   # 
   # - {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}.
-  # 
-  # 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.
+  # <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::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>
   # 
   # Category:  Miscellaneous Windows
   # @see Wx::ScrollBar
@@ -104,7 +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.
-    #   The window is initially created without visible scrollbars. Call Wx::Scrolled#set_scrollbars to specify how big the virtual window size should be.
+    #   
+    #   <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>
     #   @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.
@@ -116,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] 
@@ -128,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] 
@@ -139,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] 
@@ -151,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
@@ -184,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.
@@ -192,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).
@@ -205,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 
@@ -218,7 +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).
-    # Use {Wx::DC#device_to_logical_x} and {Wx::DC#device_to_logical_y} to translate these units to logical units.
+    # 
+    # <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::Scrolled#set_scrollbars
     # @see  Wx::Scrolled#get_scroll_pixels_per_unit 
     # @return [Array(Integer,Integer)]
@@ -231,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]
@@ -238,7 +268,12 @@ module Wx
     
     # @overload scroll(x, y)
     #   Scrolls a window so the view start is at the given point.
-    #   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).
+    #   
+    #   <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::Scrolled#set_scrollbars
     #   @see  Wx::Scrolled#get_scroll_pixels_per_unit 
     #   @param x [Integer]  The x position to scroll to, in scroll units.
@@ -251,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] 
@@ -258,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: 
@@ -279,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] 

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

@@ -15,9 +15,10 @@ module Wx
   EVT_SEARCH = 10130
   
   # 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 (although it does in the generic version). Only the methods defined in {Wx::TextEntry} interface class are guaranteed to be available under all platforms.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -27,13 +28,13 @@ module Wx
   # 
   # - {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_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_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
+  # ### 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). 
@@ -42,15 +43,14 @@ module Wx
   # 
   # - {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
+  # 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
@@ -61,6 +61,7 @@ module Wx
     # @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 NULL.
@@ -91,6 +92,7 @@ module Wx
     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
@@ -102,6 +104,7 @@ module Wx
     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]
@@ -109,12 +112,14 @@ module Wx
     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] 

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

@@ -7,12 +7,12 @@
 module Wx
 
   # {Wx::Simplebook} is a control showing exactly one of its several pages.
+  # 
   # It implements {Wx::BookCtrlBase} class interface but doesn't allow the user to change the page being displayed, unlike all the other book control classes, only the program can do it.
   # This class is created in the same manner as any other {Wx::BookCtrl} but then the program will typically call {Wx::Simplebook#change_selection} to show different pages. See the Notebook Sample for an example of {Wx::Simplebook} in action.
   # Notice that it is often convenient to use {Wx::Simplebook#show_new_page} instead of the base class {Wx::Simplebook#add_page}.
   # There are no special styles defined for this class as it has no visual appearance of its own.
   # There are also no special events, this class reuses {Wx::EVT_BOOKCTRL_PAGE_CHANGING} and {Wx::EVT_BOOKCTRL_PAGE_CHANGED} events for the events it generates if the program calls {Wx::Simplebook#set_selection}.
-  # === 
   # 
   # Category:  Book Controls
   # @see Wx::BookCtrl
@@ -20,10 +20,12 @@ module Wx
   # @see  Notebook Sample
   # 
   # 
+  # @wxrb_require USE_AUI|USE_NOTEBOOK|USE_LISTBOOK|USE_CHOICEBOOK|USE_TOOLBOOK|USE_TREEBOOK
   class Simplebook < BookCtrlBase
   
     # @overload initialize()
     #   Default constructor.
+    #   
     #   Use {Wx::Simplebook#create} later to really create the control.
     #   @return [Wx::Simplebook]
     # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=(''))
@@ -48,6 +50,7 @@ module Wx
     def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=('')) end
     
     # Set the effects to use for showing and hiding the pages.
+    # 
     # This method allows specifying the effects passed to {Wx::Window#show_with_effect} and {Wx::Window#hide_with_effect} respectively when the pages need to be shown or hidden.
     # By default, no effects are used, but as the pages are only changed by the program and not the user himself, it may be useful to use some visual effects to make the changes more noticeable.
     # @see Wx::Simplebook#set_effects_timeouts 
@@ -57,6 +60,7 @@ module Wx
     def set_effects(showEffect, hideEffect) end
     
     # Set the same effect to use for both showing and hiding the pages.
+    # 
     # This is the same as <code>SetEffects(effect, effect)</code>.
     # @see Wx::Simplebook#set_effect_timeout 
     # @param effect [Wx::ShowEffect] 
@@ -65,6 +69,7 @@ module Wx
     alias_method :effect=, :set_effect
     
     # Set the effect timeout to use for showing and hiding the pages.
+    # 
     # This method allows configuring the timeout arguments passed to {Wx::Window#show_with_effect} and {Wx::Window#hide_with_effect} if a non-default effect is used.
     # If this method is not called, default, system-dependent timeout is used.
     # @see Wx::Simplebook#set_effects 
@@ -74,6 +79,7 @@ module Wx
     def set_effects_timeouts(showTimeout, hideTimeout) end
     
     # Set the same effect timeout to use for both showing and hiding the pages.
+    # 
     # This is the same as <code>SetEffectsTimeouts(timeout, timeout)</code>.
     # @see Wx::Simplebook#set_effect 
     # @param timeout [unsigned] 
@@ -82,6 +88,7 @@ module Wx
     alias_method :effect_timeout=, :set_effect_timeout
     
     # Add a new page and show it immediately.
+    # 
     # This is simply a thin wrapper around the base class {Wx::BookCtrlBase#add_page} method using empty label (which is unused by this class anyhow) and selecting the new page immediately.
     # @param page [Wx::Window] 
     # @return [Boolean]

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

@@ -16,8 +16,9 @@ module Wx
   CHOICEDLG_STYLE = 536877141
   
   # This class represents a dialog that shows a list of strings, and allows the user to select one.
+  # 
   # Double-clicking on a list item is equivalent to single-clicking and then pressing OK.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -27,17 +28,21 @@ module Wx
   # 
   # - {Wx::GeometryCentre::CENTRE}: Centre the message. 
   # 
-  # === 
-  # 
   # Category:  Common Dialogs
   # @see wxSingleChoiceDialog Overview
   # @see  Wx::MultiChoiceDialog 
   # 
   # 
+  # @wxrb_require USE_CHOICEDLG
   class SingleChoiceDialog < Dialog
   
     # Constructor, taking an array of {Wx::String} choices and optional client data.
-    # Use {Wx::SingleChoiceDialog#show_modal} to show the dialog.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Use {Wx::SingleChoiceDialog#show_modal} to show the dialog.
+    # </p>
+    # </div>
     # @param parent [Wx::Window]  Parent window.
     # @param message [String]  Message to show on the dialog.
     # @param caption [String]  The dialog caption.