wxruby3 0.9.0-x64-mingw-ucrt → 0.9.2-x64-mingw-ucrt

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

@@ -151,7 +151,7 @@ module Wx
   # All controls, top level windows and so on are windows. Sizers and device contexts are not, however, as they don't appear on screen themselves.
   # Please note that all children of the window will be deleted automatically by the destructor before the window itself is deleted which means that you don't have to worry about deleting them manually. Please see the window deletion overview for more information.
   # Also note that in this, and many others, wxWidgets classes some <code>GetXXX()</code> methods may be overloaded (as, for example, {Wx::Window#get_size} or {Wx::Window#get_client_size}). In this case, the overloads are non-virtual because having multiple virtual functions with the same name results in a virtual function name hiding at the derived class level (in English, this means that the derived class has to override all overloaded variants if it overrides any of them). To allow overriding them in the derived class, wxWidgets uses a unique protected virtual <code>DoGetXXX()</code> method and all <code>GetXXX()</code> ones are forwarded to it, so overriding the former changes the behaviour of the latter.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -183,13 +183,13 @@ module Wx
   # 
   # - {Wx::HSCROLL}: Use this style to enable a horizontal scrollbar. The same limitations as for {Wx::VSCROLL} apply to this style. 
   # 
-  # - {Wx::ALWAYS_SHOW_SB}: If a window has scrollbars, disable them instead of hiding them when they are not needed (i.e. when the size of the window is big enough to not require the scrollbars to navigate it). This style is currently implemented for wxMSW, wxGTK and {Wx::Universal} and does nothing on the other platforms. 
+  # - {Wx::ALWAYS_SHOW_SB}: If a window has scrollbars, disable them instead of hiding them when they are not needed (i.e. when the size of the window is big enough to not require the scrollbars to navigate it). This style is currently implemented for WXMSW, WXGTK and {Wx::Universal} and does nothing on the other platforms. 
   # 
   # - {Wx::CLIP_CHILDREN}: Use this style to eliminate flicker caused by the background being repainted, then children being painted over them. Windows only. 
   # 
   # - {Wx::FULL_REPAINT_ON_RESIZE}: Use this style to force a complete redraw of the window whenever it is resized instead of redrawing just the part of the window affected by resizing. Note that this was the behaviour by default before 2.5.1 release and that if you experience redraw problems with code which previously used to work you may want to try this. Currently this style applies on GTK+ 2 and Windows only, and full repainting is always done on other platforms. 
   # 
-  # === Extra Styles
+  # ### Extra Styles
   # 
   # This class supports the following extra styles:
   # 
@@ -203,7 +203,7 @@ module Wx
   # 
   # - {Wx::WS_EX_PROCESS_UI_UPDATES}: This window should always process UI update events, even if the mode set by {Wx::UpdateUIEvent.set_mode} is {Wx::UpdateUIMode::UPDATE_UI_PROCESS_SPECIFIED}. 
   # 
-  # === Events emitted by this class
+  # ### Events emitted by this class
   # 
   # Event handler methods for events emitted by this class:
   # 
@@ -255,8 +255,6 @@ module Wx
   # 
   # - {Wx::EvtHandler#evt_sys_colour_changed}(meth = nil, &block): Process a {Wx::EVT_SYS_COLOUR_CHANGED} event. See {Wx::SysColourChangedEvent}. 
   # 
-  # === 
-  # 
   # Category:  Miscellaneous Windows
   # @see Events and Event Handling
   # @see  Window Sizing Overview 
@@ -401,7 +399,11 @@ module Wx
     def reparent(newParent) end
     
     # Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling.
-    # This function is currently not implemented.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This function is currently not implemented. 
+    # </p>
+    # </div>>
     # @param hflag [Boolean]  Whether the horizontal scroll bar should always be visible.
     # @param vflag [Boolean]  Whether the vertical scroll bar should always be visible.
     # @return [void]
@@ -455,7 +457,11 @@ module Wx
     # Scrolls the window by the given number of lines down (if lines is positive) or up.
     # Returns true if the window was scrolled, false if it was already on top/bottom and nothing was done.
     # 
-    # This function is currently only implemented under MSW and {Wx::TextCtrl} under wxGTK (it also works for {Wx::Scrolled} classes under all platforms).
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This function is currently only implemented under MSW and {Wx::TextCtrl} under WXGTK (it also works for {Wx::Scrolled} classes under all platforms).
+    # </p>
+    # </div>>
     # @see Wx::Window#scroll_pages 
     # @param lines [Integer] 
     # @return [Boolean]
@@ -464,17 +470,25 @@ module Wx
     # Scrolls the window by the given number of pages down (if pages is positive) or up.
     # Returns true if the window was scrolled, false if it was already on top/bottom and nothing was done.
     # 
-    # This function is currently only implemented under MSW and wxGTK.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This function is currently only implemented under MSW and WXGTK.
+    # </p>
+    # </div>>
     # @see Wx::Window#scroll_lines 
     # @param pages [Integer] 
     # @return [Boolean]
     def scroll_pages(pages) end
     
     # Physically scrolls the pixels in the window and move child windows accordingly.
-    # Note that you can often use {Wx::Scrolled} instead of using this function directly.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Note that you can often use {Wx::Scrolled} instead of using this function directly. 
+    # </p>
+    # </div>>
     # @param dx [Integer]  Amount to scroll horizontally.
     # @param dy [Integer]  Amount to scroll vertically.
-    # @param rect [Wx::Rect]  Rectangle to scroll, if it is NULL, the whole window is scrolled (this is always the case under wxGTK which doesn't support this parameter)
+    # @param rect [Wx::Rect]  Rectangle to scroll, if it is NULL, the whole window is scrolled (this is always the case under WXGTK which doesn't support this parameter)
     # @return [void]
     def scroll_window(dx, dy, rect=nil) end
     
@@ -495,7 +509,11 @@ module Wx
     def page_down; end
     
     # Sets the position of one of the built-in scrollbars.
-    # This function does not directly affect the contents of the window: it is up to the application to take note of scrollbar attributes and redraw contents accordingly.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This function does not directly affect the contents of the window: it is up to the application to take note of scrollbar attributes and redraw contents accordingly.
+    # </p>
+    # </div>>
     # @see Wx::Window#set_scrollbar
     # @see  Wx::Window#get_scroll_pos
     # @see  Wx::Window#get_scroll_thumb
@@ -508,11 +526,15 @@ module Wx
     def set_scroll_pos(orientation, pos, refresh=true) end
     
     # Sets the scrollbar properties of a built-in scrollbar.
-    # 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: 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Let's say you wish to display 50 lines of text, using the same font. The window is sized so that you can only see 16 lines at a time. You would use: 
     # ```ruby
     #   set_scrollbar(Wx::VERTICAL, 0, 16, 50)
     # ```
     #  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 SetScrollbar call into a function named AdjustScrollbars, which can be called initially and also from your {Wx::SizeEvent} handler function.
+    # </p>
+    # </div>>
     # @see Scrolled Windows
     # @see  Wx::ScrollBar
     # @see  Wx::Scrolled
@@ -520,7 +542,7 @@ module Wx
     # @param orientation [Integer]  Determines the scrollbar whose page size is to be set. May be {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL}.
     # @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. Value of -1 can be used to ask for the scrollbar to be shown but in the disabled state: this can be used to avoid removing the scrollbar even when it is not needed (currently this is only implemented in wxMSW port).
+    # @param range [Integer]  The maximum position of the scrollbar. Value of -1 can be used to ask for the scrollbar to be shown but in the disabled state: this can be used to avoid removing the scrollbar even when it is not needed (currently this is only implemented in WXMSW port).
     # @param refresh [Boolean]  true to redraw the scrollbar, false otherwise.
     # @return [void]
     def set_scrollbar(orientation, position, thumbSize, range, refresh=true) end
@@ -847,7 +869,12 @@ module Wx
     # Returns the factor mapping logical pixels of this window to physical pixels.
     # This function can be used to portably determine the number of physical pixels in a window of the given size, by multiplying the window size by the value returned from it. I.e. it returns the factor converting window coordinates to "content view" coordinates, where the view can be just a simple window displaying a {Wx::Bitmap} or {Wx::GLCanvas} or any other kind of window rendering arbitrary "content" on screen.
     # For the platforms not doing any pixel mapping, i.e. where logical and physical pixels are one and the same, this function always returns 1.0 and so using it is, in principle, unnecessary and could be avoided by using preprocessor check for {Wx::HAS_DPI_INDEPENDENT_PIXELS} not being defined, however using this function unconditionally under all platforms is usually simpler and so preferable.
-    # Current behaviour of this function is compatible with wxWidgets 3.0, but different from its behaviour in versions 3.1.0 to 3.1.3, where it returned the same value as {Wx::Window#get_dpi_scale_factor}. Please use the other function if you need to use a scaling factor greater than 1.0 even for the platforms without {Wx::HAS_DPI_INDEPENDENT_PIXELS}, such as wxMSW.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Current behaviour of this function is compatible with wxWidgets 3.0, but different from its behaviour in versions 3.1.0 to 3.1.3, where it returned the same value as {Wx::Window#get_dpi_scale_factor}. Please use the other function if you need to use a scaling factor greater than 1.0 even for the platforms without {Wx::HAS_DPI_INDEPENDENT_PIXELS}, such as WXMSW.
+    # </p>
+    # </div>
     # @return [Float]
     def get_content_scale_factor; end
     alias_method :content_scale_factor, :get_content_scale_factor
@@ -990,7 +1017,11 @@ module Wx
     
     # @overload set_size(x, y, width, height, sizeFlags=Wx::SIZE_AUTO)
     #   Sets the size of the window in pixels.
-    #   This overload sets the position and optionally size, of the window. Parameters may be {Wx::DEFAULT_COORD} to indicate either that a default should be supplied by wxWidgets, or that the current value of the dimension should be used.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>This overload sets the position and optionally size, of the window. Parameters may be {Wx::DEFAULT_COORD} to indicate either that a default should be supplied by wxWidgets, or that the current value of the dimension should be used.
+    #   </p>
+    #   </div>>
     #   @see Wx::Window#move
     #   @see  Window Sizing Overview 
     #   @param x [Integer]  Required x position in pixels, or {Wx::DEFAULT_COORD} to indicate that the existing value should be used.
@@ -1009,7 +1040,12 @@ module Wx
     # @overload set_size(rect)
     #   Sets the size of the window in pixels.
     #   The size is specified using a {Wx::Rect}, {Wx::Size} or by a couple of int objects.
-    #   This form must be used with non-default width and height values.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>This form must be used with non-default width and height values.
+    #   </p>
+    #   </div>>
     #   @see Wx::Window#move
     #   @see  Window Sizing Overview 
     #   @param rect [Wx::Rect] 
@@ -1067,7 +1103,11 @@ module Wx
     def center_on_parent(dir=Wx::Orientation::BOTH) end
     
     # Centres the window.
-    # If the window is a top level one (i.e. doesn't have a parent), it will be centred relative to the screen anyhow.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>If the window is a top level one (i.e. doesn't have a parent), it will be centred relative to the screen anyhow.
+    # </p>
+    # </div>>
     # @see Wx::Window#center 
     # @param direction [Integer]  Specifies the direction for the centring. May be {Wx::Orientation::HORIZONTAL}, {Wx::Orientation::VERTICAL} or {Wx::Orientation::BOTH}. It may also include the {Wx::CENTRE_ON_SCREEN} flag if you want to centre the window on the entire screen and not on its parent window.
     # @return [void]
@@ -1076,7 +1116,11 @@ module Wx
     # Centres the window on its parent.
     # This is a more readable synonym for {Wx::Window#centre}.
     # 
-    # This methods provides for a way to centre top level windows over their parents instead of the entire screen. If there is no parent or if the window is not a top level window, then behaviour is the same as {Wx::Window#centre}.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This methods provides for a way to centre top level windows over their parents instead of the entire screen. If there is no parent or if the window is not a top level window, then behaviour is the same as {Wx::Window#centre}.
+    # </p>
+    # </div>>
     # @see Wx::TopLevelWindow#centre_on_screen 
     # @param direction [Integer]  Specifies the direction for the centring. May be {Wx::Orientation::HORIZONTAL}, {Wx::Orientation::VERTICAL} or {Wx::Orientation::BOTH}.
     # @return [void]
@@ -1122,10 +1166,15 @@ module Wx
     
     # @overload move(x, y, flags=Wx::SIZE_USE_EXISTING)
     #   Moves the window to the given position.
-    #   Implementations of SetSize can also implicitly implement the {Wx::Window#move} function, which is defined in the base {Wx::Window} class as the call: 
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>Implementations of SetSize can also implicitly implement the {Wx::Window#move} function, which is defined in the base {Wx::Window} class as the call: 
     #   ```ruby
     #     set_size(x, y, Wx::DEFAULT_COORD, Wx::DEFAULT_COORD, Wx::SIZE_USE_EXISTING)
     #   ```
+    #   
+    #   </p>
+    #   </div>>
     #   @see Wx::Window#set_size 
     #   @param x [Integer]  Required x position.
     #   @param y [Integer]  Required y position.
@@ -1133,10 +1182,15 @@ module Wx
     #   @return [void]
     # @overload move(pt, flags=Wx::SIZE_USE_EXISTING)
     #   Moves the window to the given position.
-    #   Implementations of {Wx::Window#set_size} can also implicitly implement the {Wx::Window#move} function, which is defined in the base {Wx::Window} class as the call: 
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>Implementations of {Wx::Window#set_size} can also implicitly implement the {Wx::Window#move} function, which is defined in the base {Wx::Window} class as the call: 
     #   ```ruby
     #     set_size(x, y, Wx::DEFAULT_COORD, Wx::DEFAULT_COORD, Wx::SIZE_USE_EXISTING)
     #   ```
+    #   
+    #   </p>
+    #   </div>>
     #   @see Wx::Window#set_size 
     #   @param pt [Array(Integer, Integer), Wx::Point]  {Wx::Point} object representing the position.
     #   @param flags [Integer]  See {Wx::Window#set_size} for more info about this parameter.
@@ -1158,7 +1212,12 @@ module Wx
     # @overload convert_dialog_to_pixels(pt)
     #   Converts a point or size from dialog units to pixels.
     #   For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.
-    #   Dialog units are used for maintaining a dialog's proportions even if the font changes. You can also use these functions programmatically.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>Dialog units are used for maintaining a dialog's proportions even if the font changes. You can also use these functions programmatically.  
+    #   </p>
+    #   </div>>
     #   @see Wx::Window#convert_pixels_to_dialog 
     #   @param pt [Array(Integer, Integer), Wx::Point] 
     #   @return [Wx::Point]
@@ -1171,7 +1230,12 @@ module Wx
     # @overload convert_pixels_to_dialog(pt)
     #   Converts a point or size from pixels to dialog units.
     #   For the x dimension, the pixels are multiplied by 4 and then divided by the average character width. For the y dimension, the pixels are multiplied by 8 and then divided by the average character height.
-    #   Dialog units are used for maintaining a dialog's proportions even if the font changes.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>Dialog units are used for maintaining a dialog's proportions even if the font changes.
+    #   </p>
+    #   </div>>
     #   @see Wx::Window#convert_dialog_to_pixels 
     #   @param pt [Array(Integer, Integer), Wx::Point] 
     #   @return [Wx::Point]
@@ -1195,7 +1259,7 @@ module Wx
     # Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.
     # {Wx::Window#thaw} must be called to re-enable window redrawing. Calls to these two functions may be nested but to ensure that the window is properly repainted again, you must thaw it exactly as many times as you froze it.
     # If the window has any children, they are recursively frozen too.
-    # This method is useful for visual appearance optimization (for example, it is a good idea to use it before doing many large text insertions in a row into a {Wx::TextCtrl} under wxGTK) but is not implemented on all platforms nor for all controls so it is mostly just a hint to wxWidgets and not a mandatory directive.
+    # This method is useful for visual appearance optimization (for example, it is a good idea to use it before doing many large text insertions in a row into a {Wx::TextCtrl} under WXGTK) but is not implemented on all platforms nor for all controls so it is mostly just a hint to wxWidgets and not a mandatory directive.
     # @see Wx::WindowUpdateLocker
     # @see  Wx::Window#thaw
     # @see  Wx::Window#is_frozen 
@@ -1272,7 +1336,11 @@ module Wx
     alias_method :font, :get_font
     
     # Returns the foreground colour of the window.
-    # The meaning of foreground colour varies according to the window class; it may be the text colour or other colour, or it may not be used at all.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>The meaning of foreground colour varies according to the window class; it may be the text colour or other colour, or it may not be used at all.
+    # </p>
+    # </div>>
     # @see Wx::Window#set_foreground_colour
     # @see  Wx::Window#set_background_colour
     # @see  Wx::Window#get_background_colour 
@@ -1329,7 +1397,11 @@ module Wx
     # Notice that as with {Wx::Window#set_foreground_colour}, setting the background colour of a native control may not affect the entire control and could be not supported at all depending on the control and platform.
     # Please see {Wx::Window#inherit_attributes} for explanation of the difference between this method and {Wx::Window#set_own_background_colour}.
     # 
-    # The background colour is usually painted by the default {Wx::EraseEvent} event handler function under Windows and automatically under GTK. Note that setting the background colour does not cause an immediate refresh, so you may wish to call {Wx::Window#clear_background} or {Wx::Window#refresh} after calling this function. Using this function will disable attempts to use themes for this window, if the system supports them. Use with care since usually the themes represent the appearance chosen by the user to be used for all applications on the system.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>The background colour is usually painted by the default {Wx::EraseEvent} event handler function under Windows and automatically under GTK. Note that setting the background colour does not cause an immediate refresh, so you may wish to call {Wx::Window#clear_background} or {Wx::Window#refresh} after calling this function. Using this function will disable attempts to use themes for this window, if the system supports them. Use with care since usually the themes represent the appearance chosen by the user to be used for all applications on the system.
+    # </p>
+    # </div>>
     # 
     # true if the colour was really changed, false if it was already set to this colour and nothing was done.
     # @see Wx::Window#get_background_colour
@@ -1347,7 +1419,7 @@ module Wx
     # Sets the background style of the window.
     # The default background style is {Wx::BackgroundStyle::BG_STYLE_ERASE} which indicates that the window background may be erased in EVT_ERASE_BACKGROUND handler. This is a safe, compatibility default; however you may want to change it to {Wx::BackgroundStyle::BG_STYLE_SYSTEM} if you don't define any erase background event handlers at all, to avoid unnecessary generation of erase background events and always let system erase the background. And you should change the background style to {Wx::BackgroundStyle::BG_STYLE_PAINT} if you define an EVT_PAINT handler which completely overwrites the window background as in this case erasing it previously, either in EVT_ERASE_BACKGROUND handler or in the system default handler, would result in flicker as the background pixels will be repainted twice every time the window is redrawn. Do ensure that the background is entirely erased by your EVT_PAINT handler in this case however as otherwise garbage may be left on screen.
     # Notice that in previous versions of wxWidgets a common way to work around the above mentioned flickering problem was to define an empty EVT_ERASE_BACKGROUND handler. Setting background style to {Wx::BackgroundStyle::BG_STYLE_PAINT} is a simpler and more efficient solution to the same problem.
-    # Under wxGTK and wxOSX, you can use {Wx::BackgroundStyle::BG_STYLE_TRANSPARENT} to obtain full transparency of the window background. Note that wxGTK supports this only since GTK 2.12 with a compositing manager enabled, call {Wx::Window#is_transparent_background_supported} to check whether this is the case, see the example of doing it in the shapedsample".
+    # Under WXGTK and WXOSX, you can use {Wx::BackgroundStyle::BG_STYLE_TRANSPARENT} to obtain full transparency of the window background. Note that WXGTK supports this only since GTK 2.12 with a compositing manager enabled, call {Wx::Window#is_transparent_background_supported} to check whether this is the case, see the example of doing it in the shapedsample".
     # Also, in order for <code>SetBackgroundStyle(wxBG_STYLE_TRANSPARENT)</code> to work, it must be called before {Wx::Window#create}. If you're using your own {Wx::Window}-derived class you should write your code in the following way: 
     # ```ruby
     #   class MyWidget < Wx::Window
@@ -1666,26 +1738,39 @@ module Wx
     # 
     # Returns true if the focus was moved to another window or false if nothing changed.
     # 
-    # You may wish to call this from a text control custom keypress handler to do the default navigation behaviour for the tab key, since the standard default behaviour for a multiline text control with the {Wx::TE_PROCESS_TAB} style is to insert a tab and not navigate to the next control. See also {Wx::NavigationKeyEvent} and HandleAsNavigationKey.
-    # @param flags [Integer]  A combination of {Wx::NavigationKeyEvent::IsForward} and {Wx::NavigationKeyEvent::WinChange}.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>You may wish to call this from a text control custom keypress handler to do the default navigation behaviour for the tab key, since the standard default behaviour for a multiline text control with the {Wx::TE_PROCESS_TAB} style is to insert a tab and not navigate to the next control. See also {Wx::NavigationKeyEvent} and HandleAsNavigationKey. 
+    # </p>
+    # </div>>
+    # @param flags [Integer]  A combination of {Wx::NavigationKeyEvent::NavigationKeyEventFlags::IsForward} and {Wx::NavigationKeyEvent::NavigationKeyEventFlags::WinChange}.
     # @return [Boolean]
-    def navigate(flags=Wx::NavigationKeyEvent::IsForward) end
+    def navigate(flags=NavigationKeyEvent::IsForward) end
     
     # Performs a keyboard navigation action inside this window.
     # See {Wx::Window#navigate} for more information.
     # @param flags [Integer] 
     # @return [Boolean]
-    def navigate_in(flags=Wx::NavigationKeyEvent::IsForward) end
+    def navigate_in(flags=NavigationKeyEvent::IsForward) end
     
     # Lowers the window to the bottom of the window hierarchy (Z-order).
-    # This function only works for {Wx::TopLevelWindow}-derived classes.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This function only works for {Wx::TopLevelWindow}-derived classes.
+    # </p>
+    # </div>>
     # @see Wx::Window#raise 
     # @return [void]
     def lower; end
     
     # Raises the window to the top of the window hierarchy (Z-order).
     # Notice that this function only requests the window manager to raise this window to the top of Z-order. Depending on its configuration, the window manager may raise the window, not do it at all or indicate that a window requested to be raised in some other way, e.g. by flashing its icon if it is minimized.
-    # This function only works for {Wx::TopLevelWindow}-derived classes.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This function only works for {Wx::TopLevelWindow}-derived classes.
+    # </p>
+    # </div>>
     # @see Wx::Window#lower 
     # @return [void]
     def raise; end
@@ -1783,7 +1868,11 @@ module Wx
     def show(show=true) end
     
     # This function shows a window, like {Wx::Window#show}, but using a special visual effect if possible.
-    # Currently this function is only implemented in wxMSW and wxOSX and does the same thing as {Wx::Window#show} in the other ports.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Currently this function is only implemented in WXMSW and WXOSX and does the same thing as {Wx::Window#show} in the other ports.
+    # </p>
+    # </div>
     # @see Wx::Window#hide_with_effect 
     # @param effect [Wx::ShowEffect]  The effect to use.
     # @param timeout [Integer]  The timeout parameter specifies the time of the animation, in milliseconds. If the default value of 0 is used, the default animation time for the current platform is used.
@@ -1851,7 +1940,7 @@ module Wx
     #   This function shows a popup menu at the given position in this window and returns the selected id.
     #   It can be more convenient than the general purpose {Wx::Window#popup_menu} function for simple menus proposing a choice in a list of strings to the user.
     #   Notice that to avoid unexpected conflicts between the (usually consecutive range of) ids used by the menu passed to this function and the existing EVT_UPDATE_UI() handlers, this function temporarily disables UI updates for the window, so you need to manually disable (or toggle or ...) any items which should be disabled in the menu before showing it.
-    #   The parameter menu is the menu to show. The parameter pos (or the parameters x and y) is the position at which to show the menu in client coordinates. It is recommended to not explicitly specify coordinates when calling this method in response to mouse click, because some of the ports (namely, wxGTK) can do a better job of positioning the menu in that case.
+    #   The parameter menu is the menu to show. The parameter pos (or the parameters x and y) is the position at which to show the menu in client coordinates. It is recommended to not explicitly specify coordinates when calling this method in response to mouse click, because some of the ports (namely, WXGTK) can do a better job of positioning the menu in that case.
     #   The selected menu item id or {Wx::StandardID::ID_NONE} if none selected or an error occurred.
     #   @param menu [Wx::Menu] 
     #   @param pos [Array(Integer, Integer), Wx::Point] 
@@ -1871,7 +1960,12 @@ module Wx
     #   menu is the menu to pop up.
     #   The position where the menu will appear can be specified either as a {Wx::Point} pos or by two integers (x and y).
     #   Note that this function switches focus to this window before showing the menu.
-    #   Just before the menu is popped up, {Wx::Menu::UpdateUI} is called to ensure that the menu items are in the correct state. The menu does not get deleted by the window. It is recommended to not explicitly specify coordinates when calling PopupMenu in response to mouse click, because some of the ports (namely, wxGTK) can do a better job of positioning the menu in that case.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>Just before the menu is popped up, {Wx::Menu::UpdateUI} is called to ensure that the menu items are in the correct state. The menu does not get deleted by the window. It is recommended to not explicitly specify coordinates when calling PopupMenu in response to mouse click, because some of the ports (namely, WXGTK) can do a better job of positioning the menu in that case.
+    #   </p>
+    #   </div>>
     #   @see Wx::Menu 
     #   @param menu [Wx::Menu] 
     #   @param pos [Array(Integer, Integer), Wx::Point] 
@@ -1906,7 +2000,11 @@ module Wx
     def validate; end
     
     # Returns the identifier of the window.
-    # Each window has an integer identifier. If the application has not provided one (or the default {Wx::StandardID::ID_ANY}) a unique identifier with a negative value will be generated.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Each window has an integer identifier. If the application has not provided one (or the default {Wx::StandardID::ID_ANY}) a unique identifier with a negative value will be generated.
+    # </p>
+    # </div>>
     # @see Wx::Window#set_id
     # @see  Window IDs 
     # @return [Integer]
@@ -1914,7 +2012,11 @@ module Wx
     alias_method :id, :get_id
     
     # Generic way of getting a label from any window, for identification purposes.
-    # The interpretation of this function differs from class to class. For frames and dialogs, the value returned is the title. For buttons or static text controls, it is the button text. This function can be useful for meta-programs (such as testing tools or special-needs access programs) which need to identify windows by name.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>The interpretation of this function differs from class to class. For frames and dialogs, the value returned is the title. For buttons or static text controls, it is the button text. This function can be useful for meta-programs (such as testing tools or special-needs access programs) which need to identify windows by name. 
+    # </p>
+    # </div>>
     # @return [String]
     def get_label; end
     alias_method :label, :get_label
@@ -1932,7 +2034,11 @@ module Wx
     def adjust_for_layout_direction(x, width, widthTotal) end
     
     # Returns the window's name.
-    # This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate name in the window constructor or via {Wx::Window#set_name}.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate name in the window constructor or via {Wx::Window#set_name}.
+    # </p>
+    # </div>>
     # @see Wx::Window#set_name 
     # @return [String]
     def get_name; end
@@ -1944,7 +2050,11 @@ module Wx
     alias_method :window_variant, :get_window_variant
     
     # Sets the identifier of the window.
-    # Each window has an integer identifier. If the application has not provided one, an identifier will be generated. Normally, the identifier should be provided on creation and should not be modified subsequently.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Each window has an integer identifier. If the application has not provided one, an identifier will be generated. Normally, the identifier should be provided on creation and should not be modified subsequently.
+    # </p>
+    # </div>>
     # @see Wx::Window#get_id
     # @see  Window IDs 
     # @param winid [Integer] 
@@ -1989,6 +2099,12 @@ module Wx
     def get_accelerator_table; end
     alias_method :accelerator_table, :get_accelerator_table
     
+    # Returns the accessible object for this window, if any.
+    # See also {Wx::Accessible}.
+    # @return [Wx::Accessible]
+    def get_accessible; end
+    alias_method :accessible, :get_accessible
+    
     # Sets the accelerator table for this window.
     # See {Wx::AcceleratorTable}.
     # @param accel [Wx::AcceleratorTable] 
@@ -2008,7 +2124,11 @@ module Wx
     # 
     # true if the event was handled and not vetoed, false otherwise.
     # 
-    # Close calls the close handler for the window, providing an opportunity for the window to choose whether to destroy the window. Usually it is only used with the top level windows ({Wx::Frame} and {Wx::Dialog} classes) as the others are not supposed to have any special OnClose() logic. The close handler should check whether the window is being deleted forcibly, using {Wx::CloseEvent#can_veto}, in which case it should destroy the window using {Wx::Window#destroy}. Note that calling Close does not guarantee that the window will be destroyed; but it provides a way to simulate a manual close of a window, which may or may not be implemented by destroying the window. The default implementation of {Wx::Dialog::OnCloseWindow} does not necessarily delete the dialog, since it will simply simulate a {Wx::StandardID::ID_CANCEL} event which is handled by the appropriate button event handler and may do anything at all. To guarantee that the window will be destroyed, call {Wx::Window#destroy} instead
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Close calls the close handler for the window, providing an opportunity for the window to choose whether to destroy the window. Usually it is only used with the top level windows ({Wx::Frame} and {Wx::Dialog} classes) as the others are not supposed to have any special OnClose() logic. The close handler should check whether the window is being deleted forcibly, using {Wx::CloseEvent#can_veto}, in which case it should destroy the window using {Wx::Window#destroy}. Note that calling Close does not guarantee that the window will be destroyed; but it provides a way to simulate a manual close of a window, which may or may not be implemented by destroying the window. The default implementation of {Wx::Dialog::OnCloseWindow} does not necessarily delete the dialog, since it will simply simulate a {Wx::StandardID::ID_CANCEL} event which is handled by the appropriate button event handler and may do anything at all. To guarantee that the window will be destroyed, call {Wx::Window#destroy} instead
+    # </p>
+    # </div>>
     # @see Window Deletion Overview
     # @see  Wx::Window#destroy
     # @see  Wx::CloseEvent 
@@ -2047,7 +2167,11 @@ module Wx
     alias_method :drop_target=, :set_drop_target
     
     # Enables or disables eligibility for drop file events (OnDropFiles).
-    # Windows only until version 2.8.9, available on all platforms since 2.8.10. Cannot be used together with {Wx::Window#set_drop_target} on non-Windows platforms.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Windows only until version 2.8.9, available on all platforms since 2.8.10. Cannot be used together with {Wx::Window#set_drop_target} on non-Windows platforms.
+    # </p>
+    # </div>>
     # @see Wx::Window#set_drop_target 
     # @param accept [Boolean]  If true, the window is eligible for drop file events. If false, the window will not accept drop file events.
     # @return [void]
@@ -2067,7 +2191,11 @@ module Wx
     # The window will then own the object, and will take care of its deletion. If an existing layout constraints object is already owned by the window, it will be deleted if the deleteOld parameter is true.
     # Note that this function will also call {Wx::Window#set_auto_layout} implicitly with true parameter if the sizer is non-NULL and false otherwise so that the sizer will be effectively used to layout the window children whenever it is resized.
     # 
-    # SetSizer enables and disables Layout automatically.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>SetSizer enables and disables Layout automatically. 
+    # </p>
+    # </div>>
     # @param sizer [Wx::Sizer]  The sizer to set. Pass NULL to disassociate and conditionally delete the window's sizer. See below.
     # @return [void]
     def set_sizer(sizer) end
@@ -2162,7 +2290,11 @@ module Wx
     alias_method :cursor=, :set_cursor
     
     # Moves the pointer to the given position on the window.
-    # Apple Human Interface Guidelines forbid moving the mouse cursor programmatically so you should avoid using this function in Mac applications (and probably avoid using it under the other platforms without good reason as well).
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Apple Human Interface Guidelines forbid moving the mouse cursor programmatically so you should avoid using this function in Mac applications (and probably avoid using it under the other platforms without good reason as well).
+    # </p>
+    # </div>
     # @param x [Integer]  The new x position for the cursor.
     # @param y [Integer]  The new y position for the cursor.
     # @return [void]
@@ -2254,7 +2386,11 @@ module Wx
     alias_method :double_buffered=, :set_double_buffered
     
     # Returns true if the window is retained, false otherwise.
-    # Retained windows are only available on X platforms.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Retained windows are only available on X platforms. 
+    # </p>
+    # </div>>
     # @return [Boolean]
     def is_retained; end
     alias_method :retained?, :is_retained
@@ -2282,21 +2418,31 @@ module Wx
     # 
     # true if the hotkey was registered successfully. false if some other application already registered a hotkey with this modifier/virtualKeyCode combination.
     # 
-    # Use EVT_HOTKEY(hotkeyId, fnc) in the event table to capture the event. This function is currently only implemented under MSW and macOS and always returns false in the other ports.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Use EVT_HOTKEY(hotkeyId, fnc) in the event table to capture the event. This function is currently only implemented under MSW and macOS and always returns false in the other ports.
+    # </p>
+    # </div>>
     # @see Wx::Window#unregister_hot_key 
     # @param hotkeyId [Integer]  Numeric identifier of the hotkey. For applications this must be between 0 and 0xBFFF. If this function is called from a shared DLL, it must be a system wide unique identifier between 0xC000 and 0xFFFF. This is a MSW specific detail.
     # @param modifiers [Integer]  A bitwise combination of {Wx::KeyModifier::MOD_SHIFT}, {Wx::KeyModifier::MOD_CONTROL}, {Wx::KeyModifier::MOD_ALT} or {Wx::KeyModifier::MOD_WIN} specifying the modifier keys that have to be pressed along with the key.
     # @param virtualKeyCode [Integer]  The key code of the hotkey, e.g. an ASCII character such as <code>'K'</code> or one of elements of {Wx::KeyCode} enum.
     # @return [Boolean]
+    # @wxrb_require USE_HOTKEY
     def register_hot_key(hotkeyId, modifiers, virtualKeyCode) end
     
     # Unregisters a system wide hotkey.
     # true if the hotkey was unregistered successfully, false if the id was invalid.
     # 
-    # This function is currently only implemented under MSW.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This function is currently only implemented under MSW.
+    # </p>
+    # </div>>
     # @see Wx::Window#register_hot_key 
     # @param hotkeyId [Integer]  Numeric identifier of the hotkey. Must be the same id that was passed to {Wx::Window#register_hot_key}.
     # @return [Boolean]
+    # @wxrb_require USE_HOTKEY
     def unregister_hot_key(hotkeyId) end
     
     # This function sends one or more {Wx::UpdateUIEvent} to the window.
@@ -2331,7 +2477,11 @@ module Wx
     def self.get_class_default_attributes(variant=Wx::WindowVariant::WINDOW_VARIANT_NORMAL) end
     
     # Finds the window or control which currently has the keyboard focus.
-    # Note that this is a static function, so it can be called without needing a {Wx::Window} pointer.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Note that this is a static function, so it can be called without needing a {Wx::Window} pointer.
+    # </p>
+    # </div>>
     # @see Wx::Window#set_focus
     # @see  Wx::Window#has_focus 
     # @return [Wx::Window]
@@ -2403,7 +2553,7 @@ module Wx
     # @overload initialize()
     #   Default constructor.
     #   @return [Wx::Window]
-    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::PanelNameStr)
+    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::PANEL_NAME_STR)
     #   Constructs a window, which can be a child of a frame, dialog or any other non-control window.
     #   @param parent [Wx::Window]  Pointer to a parent window.
     #   @param id [Integer]  Window identifier. If {Wx::StandardID::ID_ANY}, will automatically create an identifier. See Window IDs for more information about IDs.
@@ -2467,7 +2617,7 @@ module Wx
     # @param style [Integer] 
     # @param name [String] 
     # @return [Boolean]
-    def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::PanelNameStr) end
+    def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::PANEL_NAME_STR) end
     
   end # Window
   

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

@@ -11,7 +11,6 @@ module Wx
   # To draw on a window from inside an EVT_PAINT() handler, construct a {Wx::PaintDC} object instead.
   # To draw on the client area of a window from outside an EVT_PAINT() handler, construct a {Wx::ClientDC} object.
   # A {Wx::WindowDC} object is initialized to use the same font and colours as the window it is associated with.
-  # === 
   # 
   # Category:  Device Contexts
   # @see Wx::DC

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

@@ -8,9 +8,12 @@ module Wx
 
   # This class disables all top level windows of the application (maybe with the exception of one of them) in its constructor and enables them back in its destructor.
   # This is useful when you want to indicate to the user that the application is currently busy and cannot respond to user input.
-  # When instantiated, this affects only windows shown on the screen and not already disabled.
   # 
-  # === 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>When instantiated, this affects only windows shown on the screen and not already disabled.
+  # </p>
+  # </div>
   # 
   # Category:  {Wx::Miscellaneous}
   # @see Wx::BusyCursor 

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

@@ -11,7 +11,12 @@ module Wx
   # The icon index can either be a special value NO_IMAGE to indicate that an item doesn't use an image at all or a small positive integer to specify the index of the icon in the list of images maintained by this class. Note that for many controls, either none of the items should have an icon or all of them should have one, i.e. mixing the items with and without an icon doesn't always work well and may result in less than ideal appearance.
   # To initialize the list of icons used, call {Wx::WithImages#set_images} method passing it a vector of {Wx::BitmapBundle} objects which can, in the simplest case, be just {Wx::Bitmap} or {Wx::Icon} objects  however, as always with {Wx::BitmapBundle}, either more than one bitmap or icon needs to be specified or the bitmap bundle needs to be created from SVG to obtain better appearance in high DPI.
   # Alternative, traditional API which was the only one available until wxWidgets 3.1.6, is based on the use of {Wx::ImageList} class. To use it, you need to create an object of this class and then call either {Wx::WithImages#assign_image_list} to set this image list and give the control its ownership or {Wx::WithImages#set_image_list} to retain the ownership of the image list, which can be useful if the same image list is shared by multiple controls, but requires deleting the image list later.
-  # {Wx::ImageList}-based API is not formally deprecated, but its use is discouraged because it is more complicated than simply providing a vector of bitmaps and it doesn't allow specifying multiple images or using SVG, which is required for good high DPI support. Please don't use {Wx::WithImages#assign_image_list} and {Wx::WithImages#set_image_list} in the new code and use {Wx::WithImages#set_images} instead.
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>{Wx::ImageList}-based API is not formally deprecated, but its use is discouraged because it is more complicated than simply providing a vector of bitmaps and it doesn't allow specifying multiple images or using SVG, which is required for good high DPI support. Please don't use {Wx::WithImages#assign_image_list} and {Wx::WithImages#set_image_list} in the new code and use {Wx::WithImages#set_images} instead. 
+  # </p>
+  # </div>
   # 
   # 
   # @note  In wxRuby this is a mixin module instead of a (base) class.