wxruby3 0.9.0.pre.rc.3-x64-mingw-ucrt → 0.9.0-x64-mingw-ucrt

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

@@ -152,14 +152,14 @@ module Wx
     def initialize(*args) end
     
     # Creation function, for two-step construction.
-    # See {Wx::SplitterWindow#splitter_window} for details.
+    # See {Wx::SplitterWindow#initialize} 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]
+    # @return [Boolean]
     def create(parent, id=Wx::StandardID::ID_ANY, point=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=wxSP_3D, name=("splitter")) end
     
     # Returns the current minimum pane size (defaults to zero).
@@ -203,7 +203,7 @@ module Wx
     # @see Wx::SplitterWindow#set_split_mode
     # @see  Wx::SplitterWindow#split_vertically
     # @see  Wx::SplitterWindow#split_horizontally. 
-    # @return [SplitMode]
+    # @return [Wx::SplitMode]
     def get_split_mode; end
     alias_method :split_mode, :get_split_mode
     
@@ -230,12 +230,12 @@ module Wx
     # 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]
+    # @return [Boolean]
     def is_sash_invisible; end
     alias_method :sash_invisible?, :is_sash_invisible
     
     # Returns true if the window is split, false otherwise.
-    # @return [true,false]
+    # @return [Boolean]
     def is_split; end
     alias_method :split?, :is_split
     
@@ -252,7 +252,7 @@ module Wx
     # 
     # 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]
+    # @return [Boolean]
     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.
@@ -267,7 +267,7 @@ module Wx
     # @see Wx::SplitterWindow#get_minimum_pane_size 
     # @param winOld [Wx::Window] 
     # @param winNew [Wx::Window] 
-    # @return [true,false]
+    # @return [Boolean]
     def replace_window(winOld, winNew) end
     
     # Sets the minimum pane size.
@@ -296,7 +296,11 @@ module Wx
     # 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.
+    #   
+    #    Note that a position of 0 will set the sash to the middle of the window.
+    #   
+    #    A negative value will "wrap around" the sash's position. For example, <code>-10</code> will place the sash at 10 units from right of the splitter window.
+    # @param redraw [Boolean]  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
@@ -315,7 +319,7 @@ module Wx
     # 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.
+    # @param invisible [Boolean]  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
@@ -332,7 +336,7 @@ module Wx
     # @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]
+    # @return [Boolean]
     def split_horizontally(window1, window2, sashPosition=0) end
     
     # Initializes the left and right panes of the splitter window.
@@ -347,7 +351,7 @@ module Wx
     # @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]
+    # @return [Boolean]
     def split_vertically(window1, window2, sashPosition=0) end
     
     # Unsplits the window.
@@ -359,7 +363,7 @@ module Wx
     # @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]
+    # @return [Boolean]
     def unsplit(toRemove=nil) end
     
     # Causes any pending sizing of the sash and child panes to take place immediately.

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

@@ -66,7 +66,7 @@ module Wx
     def initialize(*args) end
     
     # Creation function, for two-step construction.
-    # For details see {Wx::StaticBitmap#static_bitmap}.
+    # For details see {Wx::StaticBitmap#initialize}.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
     # @param label [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
@@ -74,7 +74,7 @@ module Wx
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param style [Integer] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::StaticBitmapNameStr) end
     
     # Returns the bitmap currently used in the control.
@@ -108,7 +108,7 @@ module Wx
     # 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.
+    # @param scaleMode [Wx::wxStaticBitmap::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
@@ -116,7 +116,7 @@ module Wx
     # Returns the scale mode currently used in the control.
     # 
     # @see Wx::StaticBitmap#set_scale_mode
-    # @return [ScaleMode]
+    # @return [Wx::wxStaticBitmap::ScaleMode]
     def get_scale_mode; end
     alias_method :scale_mode, :get_scale_mode
     

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

@@ -83,7 +83,7 @@ module Wx
     
     # @overload create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::StaticBoxNameStr)
     #   Creates the static box for two-step construction.
-    #   See {Wx::StaticBox#static_box} for further details.
+    #   See {Wx::StaticBox#initialize} for further details.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
     #   @param label [String] 
@@ -91,7 +91,7 @@ module Wx
     #   @param size [Array(Integer, Integer), Wx::Size] 
     #   @param style [Integer] 
     #   @param name [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::StaticBoxNameStr)
     #   Creates the static box with the window as a label.
     #   This method can only be called for an object created using its default constructor.
@@ -104,7 +104,7 @@ module Wx
     #   @param size [Array(Integer, Integer), Wx::Size] 
     #   @param style [Integer] 
     #   @param name [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def create(*args) end
     
     # Enables or disables the box without affecting its label window, if any.
@@ -120,8 +120,8 @@ module Wx
     # 
     # - 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]
+    # @param enable [Boolean] 
+    # @return [Boolean]
     def enable(enable=true) end
     
   end # StaticBox

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

@@ -41,18 +41,18 @@ module Wx
     def initialize(*args) end
     
     # Creates the static line for two-step construction.
-    # See {Wx::StaticLine#static_line} for further details.
+    # See {Wx::StaticLine#initialize} for further details.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
     # @param pos [Array(Integer, Integer), Wx::Point] 
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param style [Integer] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::LI_HORIZONTAL, name=Wx::StaticLineNameStr) end
     
     # Returns true if the line is vertical, false if horizontal.
-    # @return [true,false]
+    # @return [Boolean]
     def is_vertical; end
     alias_method :vertical?, :is_vertical
     

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

@@ -68,7 +68,7 @@ module Wx
     def initialize(*args) end
     
     # Creation function, for two-step construction.
-    # For details see {Wx::StaticText#static_text}.
+    # For details see {Wx::StaticText#initialize}.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
     # @param label [String] 
@@ -76,11 +76,11 @@ module Wx
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param style [Integer] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::StaticTextNameStr) end
     
     # Returns true if the window styles for this control contains one of the {Wx::ST_ELLIPSIZE_START}, {Wx::ST_ELLIPSIZE_MIDDLE} or {Wx::ST_ELLIPSIZE_END} styles.
-    # @return [true,false]
+    # @return [Boolean]
     def is_ellipsized; end
     alias_method :ellipsized?, :is_ellipsized
     

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

@@ -85,19 +85,19 @@ module Wx
     def initialize(*args) end
     
     # Creates the window, for two-step construction.
-    # See {Wx::StatusBar#status_bar} for details.
+    # See {Wx::StatusBar#initialize} for details.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
     # @param style [Integer] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id=Wx::StandardID::ID_ANY, style=Wx::STB_DEFAULT_STYLE, name=Wx::StatusBarNameStr) end
     
     # Returns the size and position of a field's internal bounding rectangle.
     # true if the field index is valid, false otherwise.
     # @see Wx::Rect 
     # @param i [Integer]  The field in question.
-    # @return [Array(true,false,Wx::Rect)]
+    # @return [Array(Boolean,Wx::Rect)]
     def get_field_rect(i) end
     alias_method :field_rect, :get_field_rect
     
@@ -127,14 +127,14 @@ module Wx
     alias_method :status_text, :get_status_text
     
     # Returns the width of the n-th field.
-    # See Wx::StatusBarPane#get_width for more info.
+    # See {Wx::StatusBarPane#get_width} for more info.
     # @param n [Integer] 
     # @return [Integer]
     def get_status_width(n) end
     alias_method :status_width, :get_status_width
     
     # Returns the style of the n-th field.
-    # See Wx::StatusBarPane#get_style for more info.
+    # See {Wx::StatusBarPane#get_style} for more info.
     # @param n [Integer] 
     # @return [Integer]
     def get_status_style(n) end
@@ -203,5 +203,39 @@ module Wx
     
   end # StatusBar
   
+  # A status bar pane data container used by {Wx::StatusBar}.
+  # === 
+  # 
+  # Category:  Data Structures
+  # @see Wx::StatusBar 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class StatusBarPane < ::Object
+  
+    # Constructs the pane with the given style and width.
+    # @param style [Integer] 
+    # @param width [Integer] 
+    # @return [Wx::StatusBarPane]
+    def initialize(style=Wx::SB_NORMAL, width=0) end
+    
+    # Returns the pane width; it maybe negative, indicating a variable-width field.
+    # @return [Integer]
+    def get_width; end
+    alias_method :width, :get_width
+    
+    # Returns the pane style.
+    # @return [Integer]
+    def get_style; end
+    alias_method :style, :get_style
+    
+    # Returns the text currently shown in this pane.
+    # @return [String]
+    def get_text; end
+    alias_method :text, :get_text
+    
+  end # StatusBarPane
+  
 
 end