wxruby3 0.9.0.pre.beta.1-x64-mingw-ucrt-3.2

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

@@ -0,0 +1,357 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  SP_NOBORDER = 0
+  
+  # 
+  SP_THIN_SASH = 0
+  
+  # 
+  SP_NOSASH = 16
+  
+  # 
+  SP_PERMIT_UNSPLIT = 64
+  
+  # 
+  SP_LIVE_UPDATE = 128
+  
+  # 
+  SP_3DSASH = 256
+  
+  # 
+  SP_3DBORDER = 512
+  
+  # 
+  SP_NO_XP_THEME = 1024
+  
+  # 
+  SP_BORDER = 512
+  
+  # 
+  SP_3D = 768
+  
+  # 
+  # 
+  # 
+  # 
+  class SplitMode < Wx::Enum
+  
+    # 
+    # 
+    SPLIT_HORIZONTAL = Wx::SplitMode.new(1)
+    
+    # 
+    # 
+    SPLIT_VERTICAL = Wx::SplitMode.new(2)
+    
+  end # SplitMode
+  
+  # 
+  # 
+  SPLIT_DRAG_NONE = 0
+  
+  # 
+  # 
+  SPLIT_DRAG_DRAGGING = 1
+  
+  # 
+  # 
+  SPLIT_DRAG_LEFT_DOWN = 2
+  
+  # 
+  # 
+  EVT_SPLITTER_SASH_POS_CHANGED = 10092
+  
+  # 
+  # 
+  EVT_SPLITTER_SASH_POS_CHANGING = 10093
+  
+  # 
+  # 
+  EVT_SPLITTER_SASH_POS_RESIZE = 10094
+  
+  # 
+  # 
+  EVT_SPLITTER_DOUBLECLICKED = 10095
+  
+  # 
+  # 
+  EVT_SPLITTER_UNSPLIT = 10096
+  
+  # This class manages up to two subwindows.
+  # The current view can be split into two programmatically (perhaps from a menu command), and unsplit either programmatically or via the {Wx::SplitterWindow} user interface.
+  # === Styles
+  # 
+  # This class supports the following styles:
+  #  
+  # - {Wx::SP_3D}: Draws a 3D effect border and sash. 
+  # - {Wx::SP_THIN_SASH}: Draws a thin sash. 
+  # - {Wx::SP_3DSASH}: Draws a 3D effect sash (part of default style). 
+  # - {Wx::SP_3DBORDER}: Synonym for {Wx::SP_BORDER}. 
+  # - {Wx::SP_BORDER}: Draws a standard border. 
+  # - {Wx::SP_NOBORDER}: No border (default). 
+  # - {Wx::SP_NO_XP_THEME}: Under Windows, switches off the attempt to draw the splitter using Windows theming, so the borders and sash will take on the pre-XP look. 
+  # - {Wx::SP_PERMIT_UNSPLIT}: Always allow to unsplit, even with the minimum pane size other than zero. 
+  # - {Wx::SP_LIVE_UPDATE}: Don't draw XOR line but resize the child windows immediately. 
+  # 
+  # === Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SplitterEvent} events.
+  # Event handler methods for events emitted by this class:
+  # - {Wx::EvtHandler#evt_splitter_sash_pos_changing}(id, meth = nil, &block): The sash position is in the process of being changed. May be used to modify the position of the tracking bar to properly reflect the position that would be set if the drag were to be completed at this point. Processes a {Wx::EVT_SPLITTER_SASH_POS_CHANGING} event. 
+  # - {Wx::EvtHandler#evt_splitter_sash_pos_resize}(id, meth = nil, &block): The sash position is in the process of being updated. May be used to modify the position of the tracking bar to properly reflect the position that would be set if the update were to be completed. This can happen e.g. when the window is resized and the sash is moved according to the gravity setting. This event is sent when the window is resized and allows the application to select the desired new sash position. If it doesn't process the event, the position is determined by the gravity setting. Processes a {Wx::EVT_SPLITTER_SASH_POS_RESIZE} event and is only available in wxWidgets 3.1.6 or newer. 
+  # - {Wx::EvtHandler#evt_splitter_sash_pos_changed}(id, meth = nil, &block): The sash position was changed. May be used to modify the sash position before it is set, or to prevent the change from taking place. Processes a {Wx::EVT_SPLITTER_SASH_POS_CHANGED} event. 
+  # - {Wx::EvtHandler#evt_splitter_unsplit}(id, meth = nil, &block): The splitter has been just unsplit. Processes a {Wx::EVT_SPLITTER_UNSPLIT} event. 
+  # - {Wx::EvtHandler#evt_splitter_dclick}(id, meth = nil, &block): The sash was double clicked. The default behaviour is to unsplit the window when this happens (unless the minimum pane size has been set to a value greater than zero). Processes a {Wx::EVT_SPLITTER_DOUBLECLICKED} event. 
+  # 
+  # === 
+  # 
+  # Category:  Miscellaneous Windows
+  # @see Wx::SplitterEvent
+  # @see  wxSplitterWindow Overview 
+  # 
+  # 
+  class SplitterWindow < Window
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [SplitterWindow]
+    # @overload initialize(parent, id=Wx::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=wxSP_3D, name=("Wx::SPLITTER_WINDOW"))
+    #   Constructor for creating the window.
+    #   After using this constructor, you must create either one or two subwindows with the splitter window as parent, and then call one of {Wx::SplitterWindow#initialize}, {Wx::SplitterWindow#split_vertically} and {Wx::SplitterWindow#split_horizontally} in order to set the pane(s). You can create two windows, with one hidden when not being shown; or you can create and delete the second pane on demand.
+    #   @see Wx::SplitterWindow#initialize
+    #   @see  Wx::SplitterWindow#split_vertically
+    #   @see  Wx::SplitterWindow#split_horizontally
+    #   @see  Wx::SplitterWindow#create 
+    #   @param parent [Wx::Window]  The parent of the splitter window.
+    #   @param id [Integer]  The window identifier.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  The window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  The window size.
+    #   @param style [Integer]  The window style. See {Wx::SplitterWindow}.
+    #   @param name [String]  The window name.
+    #   @return [SplitterWindow]
+    def initialize(*args) end
+    
+    # Creation function, for two-step construction.
+    # See {Wx::SplitterWindow#splitter_window} for details.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param point [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @param name [String] 
+    # @return [true,false]
+    def create(parent, id=Wx::ID_ANY, point=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=wxSP_3D, name=("Wx::SPLITTER")) end
+    
+    # Returns the current minimum pane size (defaults to zero).
+    # 
+    # @see Wx::SplitterWindow#set_minimum_pane_size 
+    # @return [Integer]
+    def get_minimum_pane_size; end
+    alias_method :minimum_pane_size, :get_minimum_pane_size
+    
+    # Returns the current sash gravity.
+    # 
+    # @see Wx::SplitterWindow#set_sash_gravity 
+    # @return [Float]
+    def get_sash_gravity; end
+    alias_method :sash_gravity, :get_sash_gravity
+    
+    # Returns the current sash position.
+    # 
+    # @see Wx::SplitterWindow#set_sash_position 
+    # @return [Integer]
+    def get_sash_position; end
+    alias_method :sash_position, :get_sash_position
+    
+    # Returns the default sash size in pixels or 0 if it is invisible.
+    # 
+    # @see Wx::SplitterWindow#get_default_sash_size
+    # @see  Wx::SplitterWindow#is_sash_invisible 
+    # @return [Integer]
+    def get_sash_size; end
+    alias_method :sash_size, :get_sash_size
+    
+    # Returns the default sash size in pixels.
+    # The size of the sash is its width for a vertically split window and its height for a horizontally split one. Its other direction is the same as the client size of the window in the corresponding direction.
+    # The default sash size is platform-dependent because it conforms to the current platform look-and-feel and cannot be changed.
+    # @return [Integer]
+    def get_default_sash_size; end
+    alias_method :default_sash_size, :get_default_sash_size
+    
+    # Gets the split mode.
+    # 
+    # @see Wx::SplitterWindow#set_split_mode
+    # @see  Wx::SplitterWindow#split_vertically
+    # @see  Wx::SplitterWindow#split_horizontally. 
+    # @return [SplitMode]
+    def get_split_mode; end
+    alias_method :split_mode, :get_split_mode
+    
+    # Returns the left/top or only pane.
+    # @return [Wx::Window]
+    def get_window1; end
+    alias_method :window1, :get_window1
+    
+    # Returns the right/bottom pane.
+    # @return [Wx::Window]
+    def get_window2; end
+    alias_method :window2, :get_window2
+    
+    # Initializes the splitter window to have one pane.
+    # The child window is shown if it is currently hidden.
+    # 
+    # This should be called if you wish to initially view only a single pane in the splitter window.
+    # @see Wx::SplitterWindow#split_vertically
+    # @see  Wx::SplitterWindow#split_horizontally 
+    # @param window [Wx::Window]  The pane for the unsplit window.
+    # @return [void]
+    def init(window) end
+    
+    # Returns true if the sash is invisible even when the window is split, false otherwise.
+    # This is a shortcut for HasFlag({Wx::SP_NOSASH})
+    # @see Wx::SplitterWindow#set_sash_invisible
+    # @return [true,false]
+    def is_sash_invisible; end
+    alias_method :sash_invisible?, :is_sash_invisible
+    
+    # Returns true if the window is split, false otherwise.
+    # @return [true,false]
+    def is_split; end
+    alias_method :split?, :is_split
+    
+    # Application-overridable function called when the sash is double-clicked with the left mouse button.
+    # The default implementation of this function calls Unsplit if the minimum pane size is zero.
+    # @see Wx::SplitterWindow#unsplit 
+    # @param x [Integer]  The x position of the mouse cursor.
+    # @param y [Integer]  The y position of the mouse cursor.
+    # @return [void]
+    def on_double_click_sash(x, y) end
+    
+    # Application-overridable function called when the sash position is changed by user.
+    # It may return false to prevent the change or true to allow it.
+    # 
+    # The default implementation of this function verifies that the sizes of both panes of the splitter are greater than minimum pane size.
+    # @param newSashPosition [Integer]  The new sash position (always positive or zero)
+    # @return [true,false]
+    def on_sash_position_change(newSashPosition) end
+    
+    # Application-overridable function called when the window is unsplit, either programmatically or using the {Wx::SplitterWindow} user interface.
+    # The default implementation of this function simply hides removed. You may wish to delete the window.
+    # @param removed [Wx::Window]  The window being removed.
+    # @return [void]
+    def on_unsplit(removed) end
+    
+    # This function replaces one of the windows managed by the {Wx::SplitterWindow} with another one.
+    # It is in general better to use it instead of calling {Wx::SplitterWindow#unsplit} and then resplitting the window back because it will provoke much less flicker (if any). It is valid to call this function whether the splitter has two windows or only one.
+    # Both parameters should be non-NULL and winOld must specify one of the windows managed by the splitter. If the parameters are incorrect or the window couldn't be replaced, false is returned. Otherwise the function will return true, but please notice that it will not delete the replaced window and you may wish to do it yourself.
+    # @see Wx::SplitterWindow#get_minimum_pane_size 
+    # @param winOld [Wx::Window] 
+    # @param winNew [Wx::Window] 
+    # @return [true,false]
+    def replace_window(winOld, winNew) end
+    
+    # Sets the minimum pane size.
+    # The default minimum pane size is zero, which means that either pane can be reduced to zero by dragging the sash, thus removing one of the panes. To prevent this behaviour (and veto out-of-range sash dragging), set a minimum size, for example 20 pixels. If the {Wx::SP_PERMIT_UNSPLIT} style is used when a splitter window is created, the window may be unsplit even if minimum size is non-zero.
+    # @see Wx::SplitterWindow#get_minimum_pane_size 
+    # @param paneSize [Integer]  Minimum pane size in pixels.
+    # @return [void]
+    def set_minimum_pane_size(paneSize) end
+    alias_method :minimum_pane_size=, :set_minimum_pane_size
+    
+    # Sets the sash gravity.
+    # Gravity is real factor which controls position of sash while resizing {Wx::SplitterWindow}. Gravity tells {Wx::SplitterWindow} how much will left/top window grow while resizing. Example values:
+    # - 0.0: only the bottom/right window is automatically resized- 0.5: both windows grow by equal size- 1.0: only left/top window grows Gravity should be a real value between 0.0 and 1.0. Default value of sash gravity is 0.0. That value is compatible with previous (before gravity was introduced) behaviour of {Wx::SplitterWindow}.
+    # 
+    # Notice that when sash gravity for a newly created splitter window, it is often necessary to explicitly set the splitter size using {Wx::SplitterWindow#set_size} to ensure that is big enough for its initial sash position. Otherwise, i.e. if the window is created with the default tiny size and only resized to its correct size later, the initial sash position will be affected by the gravity and typically result in sash being at the rightmost position for the gravity of 1. See the example code creating {Wx::SplitterWindow} in the splitter sample for more details.
+    # @see Wx::SplitterWindow#get_sash_gravity 
+    # @param gravity [Float]  The sash gravity. Value between 0.0 and 1.0.
+    # @return [void]
+    def set_sash_gravity(gravity) end
+    alias_method :sash_gravity=, :set_sash_gravity
+    
+    # Sets the sash position.
+    # Does not currently check for an out-of-range value.
+    # @see Wx::SplitterWindow#get_sash_position 
+    # @param position [Integer]  The sash position in pixels.
+    # @param redraw [true,false]  If true, resizes the panes and redraws the sash and border.
+    # @return [void]
+    def set_sash_position(position, redraw=true) end
+    alias_method :sash_position=, :set_sash_position
+    
+    # Sets the split mode.
+    # Only sets the internal variable; does not update the display.
+    # @see Wx::SplitterWindow#get_split_mode
+    # @see  Wx::SplitterWindow#split_vertically
+    # @see  Wx::SplitterWindow#split_horizontally. 
+    # @param mode [Integer]  Can be {Wx::SplitMode::SPLIT_VERTICAL} or {Wx::SplitMode::SPLIT_HORIZONTAL}.
+    # @return [void]
+    def set_split_mode(mode) end
+    alias_method :split_mode=, :set_split_mode
+    
+    # Sets whether the sash should be invisible, even when the window is split.
+    # When the sash is invisible, it doesn't appear on the screen at all and, in particular, doesn't allow the user to resize the windows.
+    # Only sets the internal variable; does not update the display.
+    # @see Wx::SplitterWindow#is_sash_invisible
+    # @param invisible [true,false]  If true, the sash is always invisible, else it is shown when the window is split.
+    # @return [void]
+    def set_sash_invisible(invisible=true) end
+    alias_method :sash_invisible=, :set_sash_invisible
+    
+    # Initializes the top and bottom panes of the splitter window.
+    # The child windows are shown if they are currently hidden.
+    # 
+    # true if successful, false otherwise (the window was already split).
+    # 
+    # This should be called if you wish to initially view two panes. It can also be called at any subsequent time, but the application should check that the window is not currently split using {Wx::SplitterWindow#is_split}.
+    # @see Wx::SplitterWindow#split_vertically
+    # @see  Wx::SplitterWindow#is_split
+    # @see  Wx::SplitterWindow#unsplit 
+    # @param window1 [Wx::Window]  The top pane.
+    # @param window2 [Wx::Window]  The bottom pane.
+    # @param sashPosition [Integer]  The initial position of the sash. If this value is positive, it specifies the size of the upper pane. If it is negative, its absolute value gives the size of the lower pane. Finally, specify 0 (default) to choose the default position (half of the total window height).
+    # @return [true,false]
+    def split_horizontally(window1, window2, sashPosition=0) end
+    
+    # Initializes the left and right panes of the splitter window.
+    # The child windows are shown if they are currently hidden.
+    # 
+    # true if successful, false otherwise (the window was already split).
+    # 
+    # This should be called if you wish to initially view two panes. It can also be called at any subsequent time, but the application should check that the window is not currently split using {Wx::SplitterWindow#is_split}.
+    # @see Wx::SplitterWindow#split_horizontally
+    # @see  Wx::SplitterWindow#is_split
+    # @see  Wx::SplitterWindow#unsplit. 
+    # @param window1 [Wx::Window]  The left pane.
+    # @param window2 [Wx::Window]  The right pane.
+    # @param sashPosition [Integer]  The initial position of the sash. If this value is positive, it specifies the size of the left pane. If it is negative, it is absolute value gives the size of the right pane. Finally, specify 0 (default) to choose the default position (half of the total window width).
+    # @return [true,false]
+    def split_vertically(window1, window2, sashPosition=0) end
+    
+    # Unsplits the window.
+    # true if successful, false otherwise (the window was not split).
+    # 
+    # This call will not actually delete the pane being removed; it calls {Wx::SplitterWindow#on_unsplit} which can be overridden for the desired behaviour. By default, the pane being removed is hidden.
+    # @see Wx::SplitterWindow#split_horizontally
+    # @see  Wx::SplitterWindow#split_vertically
+    # @see  Wx::SplitterWindow#is_split
+    # @see  Wx::SplitterWindow#on_unsplit 
+    # @param toRemove [Wx::Window]  The pane to remove, or NULL to remove the right or bottom pane.
+    # @return [true,false]
+    def unsplit(toRemove=nil) end
+    
+    # Causes any pending sizing of the sash and child panes to take place immediately.
+    # Such resizing normally takes place in idle time, in order to wait for layout to be completed. However, this can cause unacceptable flicker as the panes are resized after the window has been shown. To work around this, you can perform window layout (for example by sending a size event to the parent window), and then call this function, before showing the top-level window.
+    # @return [void]
+    def update_size; end
+    
+  end # SplitterWindow
+  
+
+end

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

@@ -0,0 +1,126 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A static bitmap control displays a bitmap.
+  # Native implementations on some platforms are only meant for display of the small icons in the dialog boxes.
+  # If you want to display larger images portably, you may use generic implementation {Wx::GenericStaticBitmap} declared in <wx/generic/statbmpg.h>.
+  # Notice that for the best results, the size of the control should be the same as the size of the image displayed in it, as happens by default if it's not resized explicitly. Otherwise, behaviour depends on the platform: under MSW, the bitmap is drawn centred inside the control, while elsewhere it is drawn at the origin of the control. You can use {Wx::StaticBitmap#set_scale_mode} to control how the image is scaled inside the control.
+  # === 
+  # 
+  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> {Wx::MSW} Appearance
+  #   </td><td> {Wx::GTK} Appearance
+  #   </td><td> {Wx::OSX} Appearance
+  #   </td></tr></table></div>
+  # @see Wx::Bitmap 
+  # 
+  # 
+  class StaticBitmap < Control
+  
+    # Specify how the bitmap should be scaled in the control.
+    # 
+    # 
+    # @see Wx::StaticBitmap#set_scale_mode
+    # @see  Wx::StaticBitmap#get_scale_mode 
+    # 
+    # 
+    class ScaleMode < Wx::Enum
+    
+      # The bitmap is displayed in original size.
+      # 
+      Scale_None = Wx::StaticBitmap::ScaleMode.new(0)
+      
+      # Scale the bitmap to fit the size of the control by changing the aspect ratio of the bitmap if necessary.
+      # 
+      Scale_Fill = Wx::StaticBitmap::ScaleMode.new(1)
+      
+      # Scale the bitmap to fit the size of the control by maintaining the aspect ratio.
+      # 
+      Scale_AspectFit = Wx::StaticBitmap::ScaleMode.new(2)
+      
+      # Scale the bitmap to fill the size of the control.
+      # 
+      Scale_AspectFill = Wx::StaticBitmap::ScaleMode.new(3)
+      
+    end # ScaleMode
+    
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [StaticBitmap]
+    # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::STATIC_BITMAP_NAME_STR)
+    #   Constructor, creating and showing a static bitmap control.
+    #   
+    #   @see Wx::StaticBitmap#create 
+    #   @param parent [Wx::Window]  Parent window. Should not be NULL.
+    #   @param id [Integer]  Control identifier. A value of -1 denotes a default value.
+    #   @param label [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  Bitmap label.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size.
+    #   @param style [Integer]  Window style. See {Wx::StaticBitmap}.
+    #   @param name [String]  Window name.
+    #   @return [StaticBitmap]
+    def initialize(*args) end
+    
+    # Creation function, for two-step construction.
+    # For details see {Wx::StaticBitmap#static_bitmap}.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param label [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @param name [String] 
+    # @return [true,false]
+    def create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::STATIC_BITMAP_NAME_STR) end
+    
+    # Returns the bitmap currently used in the control.
+    # Notice that this method can be called even if {Wx::StaticBitmap#set_icon} had been used.
+    # @see Wx::StaticBitmap#set_bitmap 
+    # @return [Wx::Bitmap]
+    def get_bitmap; end
+    alias_method :bitmap, :get_bitmap
+    
+    # Returns the icon currently used in the control.
+    # Notice that this method can only be called if {Wx::StaticBitmap#set_icon} had been used: an icon can't be retrieved from the control if a bitmap had been set (using {Wx::StaticBitmap#set_bitmap}).
+    # @see Wx::StaticBitmap#set_icon 
+    # @return [Wx::Icon]
+    def get_icon; end
+    alias_method :icon, :get_icon
+    
+    # Sets the bitmap label.
+    # 
+    # @see Wx::StaticBitmap#get_bitmap 
+    # @param label [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  The new bitmap.
+    # @return [void]
+    def set_bitmap(label) end
+    alias_method :bitmap=, :set_bitmap
+    
+    # Sets the label to the given icon.
+    # @param label [Wx::Icon]  The new icon.
+    # @return [void]
+    def set_icon(label) end
+    alias_method :icon=, :set_icon
+    
+    # Sets the scale mode.
+    # Currently only the generic implementation supports all scaling modes. You may use generic implementation {Wx::GenericStaticBitmap} declared in <wx/generic/statbmpg.h> in all ports.
+    # @see Wx::StaticBitmap#get_scale_mode
+    # @param scaleMode [ScaleMode]  Controls how the bitmap is scaled inside the control.
+    # @return [void]
+    def set_scale_mode(scaleMode) end
+    alias_method :scale_mode=, :set_scale_mode
+    
+    # Returns the scale mode currently used in the control.
+    # 
+    # @see Wx::StaticBitmap#set_scale_mode
+    # @return [ScaleMode]
+    def get_scale_mode; end
+    alias_method :scale_mode, :get_scale_mode
+    
+  end # StaticBitmap
+  
+
+end

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

@@ -0,0 +1,123 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A static box is a rectangle drawn around other windows to denote a logical grouping of items.
+  # Note that while the previous versions required that windows appearing inside a static box be created as its siblings (i.e. use the same parent as the static box itself), since wxWidgets 2.9.1 it is possible to create them as children of {Wx::StaticBox} itself and doing this is strongly recommended and avoids several different repainting problems that could happen when creating the other windows as siblings of the box.
+  # So the recommended way to create static box and the controls inside it is: 
+  # 
+  #   void MyFrame::CreateControls()
+  #   {
+  #       wxPanel *panel = new wxPanel(this);
+  #       wxStaticBox *box = new wxStaticBox(panel, wxID_ANY, "StaticBox");
+  #   
+  #       new wxStaticText(box, wxID_ANY, "This window is a child of the staticbox");
+  #       ...
+  #   }
+  # 
+  # Creating the windows with the static box parent (i.e. panel in the example above) as parent still works but can result in refresh and repaint problems.
+  # Also note that there is a specialized {Wx::Sizer} class ({Wx::StaticBoxSizer}) which can be used as an easier way to pack items into a static box.
+  # === 
+  # 
+  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> {Wx::MSW} Appearance
+  #   </td><td> {Wx::GTK} Appearance
+  #   </td><td> {Wx::OSX} Appearance
+  #   </td></tr></table></div>
+  # @see Wx::StaticText
+  # @see  Wx::StaticBoxSizer 
+  # 
+  # 
+  class StaticBox < Control
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [StaticBox]
+    # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::STATIC_BOX_NAME_STR)
+    #   Constructor, creating and showing a static box.
+    #   
+    #   @see Wx::StaticBox#create 
+    #   @param parent [Wx::Window]  Parent window. Must not be NULL.
+    #   @param id [Integer]  Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param label [String]  Text to be displayed in the static box, the empty string for no label.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Window position. If {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Checkbox size. If {Wx::DEFAULT_SIZE} is specified then a default size is chosen.
+    #   @param style [Integer]  Window style. There are no {Wx::StaticBox}-specific styles, but generic {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE_HORIZONTAL} and {Wx::Alignment::ALIGN_RIGHT} can be used here to change the position of the static box label when using {Wx::GTK} (these styles are ignored under the other platforms currently).
+    #   @param name [String]  Window name.
+    #   @return [StaticBox]
+    # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::STATIC_BOX_NAME_STR)
+    #   Constructor for a static box using the given window as label.
+    #   This constructor takes a pointer to an arbitrary window (although usually a {Wx::CheckBox} or a {Wx::RadioButton}) instead of just the usual text label and puts this window at the top of the box at the place where the label would be shown.
+    #   The label window must be a non-null, fully created window and will become a child of this {Wx::StaticBox}, i.e. it will be owned by this control and will be deleted when the {Wx::StaticBox} itself is deleted.
+    #   An example of creating a {Wx::StaticBox} with window as a label: 
+    #   
+    #     void MyFrame::CreateControls()
+    #     {
+    #         wxPanel* panel = new wxPanel(this);
+    #         wxCheckBox* checkbox = new wxCheckBox(panel, wxID_ANY, "Box checkbox");
+    #         wxStaticBox* box = new wxStaticBox(panel, wxID_ANY, checkbox);
+    #         ...
+    #     }
+    #   
+    #   Currently this constructor is only available in {Wx::GTK} and {Wx::MSW}, use {Wx::HAS_WINDOW_LABEL_IN_STATIC_BOX} to check whether it can be used at compile-time.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param label [Wx::Window] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @return [StaticBox]
+    def initialize(*args) end
+    
+    # @overload create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::STATIC_BOX_NAME_STR)
+    #   Creates the static box for two-step construction.
+    #   See {Wx::StaticBox#static_box} for further details.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param label [String] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @return [true,false]
+    # @overload create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::STATIC_BOX_NAME_STR)
+    #   Creates the static box with the window as a label.
+    #   This method can only be called for an object created using its default constructor.
+    #   See the constructor documentation for more details.
+    #   Currently this overload is only available in {Wx::GTK} and {Wx::MSW}, use {Wx::HAS_WINDOW_LABEL_IN_STATIC_BOX} to check whether it can be used at compile-time.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param label [Wx::Window] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @return [true,false]
+    def create(*args) end
+    
+    # Enables or disables the box without affecting its label window, if any.
+    # {Wx::StaticBox} overrides {Wx::Window#enable} in order to avoid disabling the control used as a label, if this box is using one. This is done in order to allow using a {Wx::CheckBox}, for example, label and enable or disable the box according to the state of the checkbox: if disabling the box also disabled the checkbox in this situation, it would make it impossible for the user to re-enable the box after disabling it, so the checkbox stays enabled even if <code>box->Enable(false)</code> is called.
+    # However with the actual behaviour, implemented in this overridden method, the following code (shown using C++11 only for convenience, this behaviour is not C++11-specific): 
+    # 
+    #   auto check = new wxCheckBox(parent, wxID_ANY, "Use the box");
+    #   auto box = new wxStaticBox(parent, wxID_ANY, check);
+    #   check->Bind(wxEVT_CHECKBOX,
+    #               [box](wxCommandEvent& event) {
+    #                   box->Enable(event.IsChecked());
+    #               });
+    #  does work as expected.
+    # Please note that overriding {Wx::StaticBox#enable} to not actually disable this window itself has two possibly unexpected consequences:
+    # 
+    # - The box retains its enabled status, i.e. {Wx::StaticBox#is_enabled} still returns true, after calling <code>Enable(false)</code>.- The box children are enabled or disabled when the box is, which can result in the loss of their original state. E.g. if a box child is initially disabled, then the box itself is disabled and, finally, the box is enabled again, this child will end up being enabled too (this wouldn't happen with any other parent window as its children would inherit the disabled state from the parent instead of being really disabled themselves when it is disabled). To avoid this problem, consider using {Wx::EVT_UPDATE_UI} to ensure that the child state is always correct or restoring it manually after re-enabling the box.
+    # @param enable [true,false] 
+    # @return [true,false]
+    def enable(enable=true) end
+    
+  end # StaticBox
+  
+
+end

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

@@ -0,0 +1,67 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # {Wx::StaticBoxSizer} is a sizer derived from {Wx::BoxSizer} but adds a static box around the sizer.
+  # The static box may be either created independently or the sizer may create it itself as a convenience. In any case, the sizer owns the {Wx::StaticBox} control and will delete it in the {Wx::StaticBoxSizer} destructor.
+  # Note that since wxWidgets 2.9.1 you are strongly encouraged to create the windows which are added to {Wx::StaticBoxSizer} as children of {Wx::StaticBox} itself, see this class documentation for more details.
+  # Example of use of this class: 
+  # 
+  #   void MyFrame::CreateControls()
+  #   {
+  #       wxPanel *panel = new wxPanel(this);
+  #       ...
+  #       wxStaticBoxSizer *sz = new wxStaticBoxSizer(wxVERTICAL, panel, "Box");
+  #       sz->Add(new wxStaticText(sz->GetStaticBox(), wxID_ANY,
+  #                                "This window is a child of the staticbox"));
+  #       ...
+  #   }
+  # 
+  # === 
+  # 
+  # Category:  Window Layout
+  # @see Wx::Sizer
+  # @see  Wx::StaticBox
+  # @see  Wx::BoxSizer
+  # @see  Sizers Overview 
+  # 
+  # 
+  class StaticBoxSizer < BoxSizer
+  
+    # @overload initialize(box, orient)
+    #   This constructor uses an already existing static box.
+    #   @param box [Wx::StaticBox]  The static box to associate with the sizer (which will take its ownership).
+    #   @param orient [Integer]  Can be either {Wx::Orientation::VERTICAL} or {Wx::Orientation::HORIZONTAL}.
+    #   @return [StaticBoxSizer]
+    # @overload initialize(orient, parent, label=Wx::EMPTY_STRING)
+    #   This constructor creates a new static box with the given label and parent window.
+    #   @param orient [Integer] 
+    #   @param parent [Wx::Window] 
+    #   @param label [String] 
+    #   @return [StaticBoxSizer]
+    def initialize(*args) end
+    
+    # Returns the static box associated with the sizer.
+    # @return [Wx::StaticBox]
+    def get_static_box; end
+    alias_method :static_box, :get_static_box
+    
+    # Implements the calculation of a box sizer's minimal.
+    # It is used internally only and must not be called by the user. Documented for information.
+    # @return [Wx::Size]
+    def calc_min; end
+    
+    # Method which must be overridden in the derived sizer classes.
+    # The implementation should reposition the children using the current total size available to the sizer (m_size) and the size computed by the last call to {Wx::StaticBoxSizer#calc_min}.
+    # @param minSize [Array(Integer, Integer), Wx::Size] 
+    # @return [void]
+    def reposition_children(minSize) end
+    
+  end # StaticBoxSizer
+  
+
+end