wxruby3 1.5.4 → 1.6.1

data/lib/wx/doc/hboxsizer.rb

@@ -11,8 +11,39 @@ module Wx
   class HBoxSizer < Wx::BoxSizer
 
     # Constructor for a {Wx::HBoxSizer}.
-    # @return [Wx::HBoxSizer]
-    def initialize; end
+    # @overload initialize(&block)
+    #   @yieldparam [Wx::HBoxSizer] sizer new HBoxSizer instance
+    #   @return [Wx::HBoxSizer]
+    # @overload initialize()
+    #   @return [Wx::HBoxSizer]
+    def initialize(*) end
+
+  end
+
+  # Just a shortcut version for creating a horizontal staticbox sizer
+  class HStaticBoxSizer < StaticBoxSizer
+
+    # @overload initialize(box, &block)
+    #   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).
+    #   @yieldparam [Wx::HStaticBoxSizer] sizer new HStaticBoxSizer instance
+    #   @return [Wx::HStaticBoxSizer]
+    # @overload initialize(box)
+    #   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).
+    #   @return [Wx::HStaticBoxSizer]
+    # @overload initialize(parent, label=(''), &block)
+    #   This constructor creates a new static box with the given label and parent window.
+    #   @param parent [Wx::Window]
+    #   @param label [String]
+    #   @yieldparam [Wx::HStaticBoxSizer] sizer new HStaticBoxSizer instance
+    #   @return [Wx::HStaticBoxSizer]
+    # @overload initialize(parent, label=(''))
+    #   This constructor creates a new static box with the given label and parent window.
+    #   @param parent [Wx::Window]
+    #   @param label [String]
+    #   @return [Wx::HStaticBoxSizer]
+    def initialize(*args) end
 
   end
 
@@ -24,9 +55,14 @@ module Wx
     # item on each line to use any remaining space on that line and {Wx::REMOVE_LEADING_SPACES} which removes any spacer
     # elements from the beginning of a row.
     # Both of these flags are on by default.
-    # @param flags [Integer]
-    # @return [Wx::HWrapSizer]
-    def initialize(flags=Wx::WRAPSIZER_DEFAULT_FLAGS) end
+    # @overload initialize(flags=Wx::WRAPSIZER_DEFAULT_FLAGS, &block)
+    #   @param flags [Integer]
+    #   @yieldparam [Wx::HWrapSizer] sizer new HWrapSizer instance
+    #   @return [Wx::HWrapSizer]
+    # @overload initialize(flags=Wx::WRAPSIZER_DEFAULT_FLAGS)
+    #   @param flags [Integer]
+    #   @return [Wx::HWrapSizer]
+    def initialize(flags) end
 
   end
 

data/lib/wx/doc/list_ctrl.rb

@@ -12,15 +12,21 @@ module Wx
     include Enumerable
 
     # Iterates all items in the list control passing each item (id) to the given block.
-    # @yieldparam [Integer] item
-    # @return [::Object] result of last block iteration
-    def each(&block) end
+    # @overload each(&block)
+    #   @yieldparam [Integer] item
+    #   @return [::Object] result of last block iteration
+    # @overload each()
+    #   @return [::Enumerator] enumerator
+    def each(*) end
 
     # Iterates all selected items in the list control (like #get_next_item(item, Wx::LIST_NEXT_ALL, Wx::LIST_STATE_SELECTED))
     # passing each item (id) to the given block.
-    # @yieldparam [Integer] item
-    # @return [::Object] result of last block iteration
-    def each_selected(&block) end
+    # @overload each_selected(&block)
+    #   @yieldparam [Integer] item
+    #   @return [::Object] result of last block iteration
+    # @overload each_selected()
+    #   @return [::Enumerator] enumerator
+    def each_selected(*) end
 
     # Returns array of selected items.
     # @return [Array<Integer>] selected items

data/lib/wx/doc/menu.rb

@@ -11,9 +11,12 @@ module Wx
 
     # Yield each menu item to the given block.
     # Returns an Enumerator if no block given.
-    # @yieldparam [Wx::MenuItem] item the menu item yielded
-    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
-    def each_item; end
+    # @overload each_item(&block)
+    #   @yieldparam [Wx::MenuItem] item the menu item yielded
+    #   @return [Object] last result of block
+    # @overload each_item()
+    #   @return [Enumerator] enumerator
+    def each_item(*) end
 
   end
 

data/lib/wx/doc/notebook.rb

@@ -12,9 +12,12 @@ module Wx
     # Iterate each notebook page.
     # Passes each page to the given block.
     # Returns an Enumerator if no block given.
-    # @yieldparam [Wx::Window] page notebook page
-    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
-    def each_page; end
+    # @overload each_page(&block)
+    #   @yieldparam [Wx::Window] page notebook page
+    #   @return [Object] last result of block
+    # @overload each_page()
+    #   @return [Enumerator] enumerator
+    def each_page(*) end
 
   end
 

data/lib/wx/doc/pg/pg_property.rb

@@ -11,14 +11,22 @@ module Wx::PG
 
   PG_DEFAULT_IMAGE_SIZE = Wx::DEFAULT_SIZE
 
+  # Shifts mask << 16.
+  # @param [Wx::Enum, Integer]
+  # @return [Wx::Enum, Integer]
+  def self.PG_IT_CHILDREN(mask) end
+
   class PGProperty
 
     # Iterate each attribute.
     # Passes the variant for each attribute to the given block.
     # Returns an Enumerator if no block given.
-    # @yieldparam [Wx::Variant] variant attribute's variant
-    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
-    def each_attribute; end
+    # @overload each_attribute(&block)
+    #   @yieldparam [Wx::Variant] variant attribute's variant
+    #   @return [Object] last result of block
+    # @overload each_attribute()
+    #   @return [Enumerator] enumerator
+    def each_attribute(*) end
 
   end
 
@@ -27,16 +35,22 @@ module Wx::PG
     # Iterate each label.
     # Passes each label string to the given block.
     # Returns an Enumerator if no block given.
-    # @yieldparam [String] label label string
-    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
-    def each_label; end
+    # @overload each_label(&block)
+    #   @yieldparam [String] label label string
+    #   @return [Object] last result of block
+    # @overload each_label()
+    #   @return [Enumerator] enumerator
+    def each_label(*) end
 
     # Iterate each choice entry.
     # Passes each choice entry to the given block.
     # Returns an Enumerator if no block given.
-    # @yieldparam [Wx::PG::ChoiceEntry] entry choice entry
-    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
-    def each_entry; end
+    # @overload each_entry(&block)
+    #   @yieldparam [Wx::PG::ChoiceEntry] entry choice entry
+    #   @return [Object] last result of block
+    # @overload each_entry()
+    #   @return [Enumerator] enumerator
+    def each_entry(*) end
 
   end
 

data/lib/wx/doc/pg/property_grid_interface.rb

@@ -13,18 +13,18 @@ module Wx::PG
     # each property to the block.
     # Returns an enumerator when no block is given.
     # The start position defaults to Wx::TOP for forward iteration and Wx::BOTTOM for reverse iteration.
-    # @overload each_property(flags, start, reverse: , &block)
+    # @overload each_property(flags, start, reverse, &block)
     #   @param flags [Integer] flags specifying iteration (see {Wx::PG::PG_ITERATOR_FLAGS})
     #   @param start [Integer,Wx::PG::Property] start position (either {Wx::Direction::TOP} or {Wx::Direction::BOTTOM} or the property to start at)
     #   @param reverse [true,false] iterate properties in reverse
     #   @yieldparam item [Wx::PG::PGProperty] property
     #   @return [::Object] result of last block execution
-    # @overload each_property(flags, start, reverse:)
+    # @overload each_property(flags, start, reverse)
     #   @param flags [Integer] flags specifying iteration (see {Wx::PG::PG_ITERATOR_FLAGS})
     #   @param start [Integer,Wx::PG::Property] start position (either {Wx::Direction::TOP} or {Wx::Direction::BOTTOM} or the property to start at)
     #   @param reverse [true,false] iterate properties in reverse
     #   @return [Enumerator] an enumerator
-    def each_property(flags = Wx::PG::PG_ITERATE_DEFAULT, start = nil, reverse: false, &block) end
+    def each_property(flags = Wx::PG::PG_ITERATE_DEFAULT, start = nil, reverse = false, &block) end
     alias :properties :each_property
 
     # Convenience method to perform reverse iteration.
@@ -54,7 +54,7 @@ module Wx::PG
     # @overload each_property_attribute(id)
     #   @param id [String,Wx::PG::PGProperty] (name of) property to iterate attributes of
     #   @return [Enumerator] an enumerator
-    def each_property_attribute; end
+    def each_property_attribute(id) end
     alias :property_attributes :each_property_attribute
 
     # Returns the current grid state.

data/lib/wx/doc/region_iterator.rb

@@ -34,7 +34,7 @@ module Wx
     #   @return [::Object]
     # @overload each()
     #   @return [Enumerator]
-    def each; end
+    def each(*) end
 
   end
 

data/lib/wx/doc/rtc/rich_text_composite_object.rb

@@ -13,9 +13,12 @@ module Wx
 
       # Yield each child object to the given block.
       # Returns an Enumerator if no block given.
-      # @yieldparam [Wx::RTC::RichTextObject] child the child object yielded
-      # @return [Object,Enumerator] last result of block or Enumerator if no block given.
-      def each_child; end
+      # @overload each_child(&block)
+      #   @yieldparam [Wx::RTC::RichTextObject] child the child object yielded
+      #   @return [Object] last result of block
+      # @overload each_child()
+      #   @return [Enumerator] enumerator
+      def each_child(*) end
 
     end
 

data/lib/wx/doc/rtc/rich_text_ctrl.rb

@@ -13,9 +13,12 @@ module Wx
 
       # Yield each line to the given block.
       # Returns an Enumerator if no block given.
-      # @yieldparam [String] line the line yielded
-      # @return [Object,Enumerator] last result of block or Enumerator if no block given.
-      def each_line; end
+      # @overload each_line(&block)
+      #   @yieldparam [String] line the line yielded
+      #   @return [Object] last result of block
+      # @overload each_line()
+      #   @return [Enumerator] enumerator
+      def each_line(*) end
 
     end
 

data/lib/wx/doc/rtc/rich_text_paragraph.rb

@@ -13,9 +13,12 @@ module Wx
 
       # Yield each line to the given block.
       # Returns an Enumerator if no block given.
-      # @yieldparam [Wx::RTC::RichTextLine] line the line yielded
-      # @return [Object,Enumerator] last result of block or Enumerator if no block given.
-      def each_line; end
+      # @overload each_line(&block)
+      #   @yieldparam [Wx::RTC::RichTextLine] line the line yielded
+      #   @return [Object] last result of block
+      # @overload each_line()
+      #   @return [Enumerator] enumerator
+      def each_line(*) end
 
     end
 

data/lib/wx/doc/sizer.rb

@@ -11,9 +11,12 @@ module Wx
 
     # Yield each child item to the given block.
     # Returns an Enumerator if no block given.
-    # @yieldparam [Wx::SizerItem] child the child item yielded
-    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
-    def each_child; end
+    # @overload each_child(&block)
+    #   @yieldparam [Wx::SizerItem] child the child item yielded
+    #   @return [Object] last result of block
+    # @overload each_child()
+    #   @return [Enumerator] enumerator
+    def each_child(*) end
 
   end
 

data/lib/wx/doc/stc/styled_text_ctrl.rb

@@ -13,9 +13,12 @@ module Wx
 
       # Yield each line to the given block.
       # Returns an Enumerator if no block given.
-      # @yieldparam [String] line the line yielded
-      # @return [Object,Enumerator] last result of block or Enumerator if no block given.
-      def each_line; end
+      # @overload each_line(&block)
+      #   @yieldparam [String] line the line yielded
+      #   @return [Object] last result of block
+      # @overload each_line()
+      #   @return [Enumerator] enumerator
+      def each_line(*) end
 
     end
 

data/lib/wx/doc/textctrl.rb

@@ -68,9 +68,12 @@ module Wx
 
     # Yield each line to the given block.
     # Returns an Enumerator if no block given.
-    # @yieldparam [String] line the line yielded
-    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
-    def each_line; end
+    # @overload each_line(&block)
+    #   @yieldparam [String] line the line yielded
+    #   @return [Object] last result of block
+    # @overload each_line()
+    #   @return [Enumerator] enumerator
+    def each_line(*) end
 
     # @overload enable_proof_check(text_proof_options = Wx::TextProofOptions.default)
     #   Enable or disable native spell checking on this text control if it is available on the current platform.

data/lib/wx/doc/tree_ctrl.rb

@@ -43,9 +43,13 @@ module Wx
 
     # Iterate all child items of the given parent and yield it's id to the given block.
     # Returns an Enumerator if no block given.
-    # @param [Wx::TreeItemId] parent_id
-    # @yieldparam [Wx::TreeItemId] child_id the child tree item id yielded
-    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+    # @overload each_item_child(parent_id, &block)
+    #   @param [Wx::TreeItemId] parent_id
+    #   @yieldparam [Wx::TreeItemId] child_id the child tree item id yielded
+    #   @return [Object] last result of block
+    # @overload each_item_child(parent_id)
+    #   @param [Wx::TreeItemId] parent_id
+    #   @return [Enumerator] enumerator
     def each_item_child(parent_id) end
 
     # Returns an array of tree item ids of the child items of the given parent.

data/lib/wx/doc/v_list_box.rb

@@ -10,9 +10,12 @@ module Wx
   class VListBox
 
     # Iterate selected items. Returns Enumerator if no block given.
-    # @yieldparam [Integer] sel selected item index
-    # @return [Enumerator,Object] if block given returns last return value of block, Enumerator otherwise
-    def each_selected; end
+    # @overload each_selected(&block)
+    #   @yieldparam [Integer] sel selected item index
+    #   @return [Object] last return value of block
+    # @overload each_selected()
+    #   @return [Enumerator] enumerator
+    def each_selected(*) end
 
   end
 

data/lib/wx/doc/variant.rb

@@ -11,13 +11,35 @@ module Wx
 
     include ::Enumerable
 
+    # @overload initialize(val, name=(''))
+    #   Constructs a variant from a Array<Integer>.
+    #   @param val [Array<Integer>]
+    #   @param name [String]
+    #   @return [Wx::Variant]
+    # @overload initialize(val, name=(''))
+    #   Constructs a variant from a {Wx::Font}.
+    #   @param val [Wx::Font]
+    #   @param name [String]
+    #   @return [Wx::Variant]
+    # @overload initialize(val, name=(''))
+    #   Constructs a variant from a {Wx::Colour}.
+    #   @param val [Wx::Colour]
+    #   @param name [String]
+    #   @return [Wx::Variant]
+    # @overload initialize(val, name=(''))
+    #   Constructs a variant from a {Wx::ColourPropertyValue}.
+    #   @param val [Wx::ColourPropertyValue]
+    #   @param name [String]
+    #   @return [Wx::Variant]
+    def initialize(*args) end
+
     # When a block is given iterates all items of a variant list passing
     # each item to the block.
     # Returns an enumerator when no block is given.
     # @overload each(&block)
     #   @yieldparam item [Wx::Variant] variant list item
     #   @return [::Object] result of last block execution
-    # @overload each
+    # @overload each()
     #   @return [Enumerator] an enumerator
     def each; end
 
@@ -68,6 +90,10 @@ module Wx
     #   @return [self]
     # @overload assign(value)
     #   Equality test operator.
+    #   @param value [Array<Integer>]
+    #   @return [self]
+    # @overload assign(value)
+    #   Equality test operator.
     #   @param value [Time,Date,DateTime]
     #   @return [self]
     def assign(*args) end
@@ -135,6 +161,10 @@ module Wx
     # @return [true,false]
     def array_string?; end
 
+    # Checks if Variant contains an ArrayInt (array of integer) value (not null).
+    # @return [true,false]
+    def array_int?; end
+
     # Checks if Variant contains a Font value (not null).
     # @return [true,false]
     def font?; end

data/lib/wx/doc/vboxsizer.rb

@@ -11,8 +11,39 @@ module Wx
   class VBoxSizer < Wx::BoxSizer
 
     # Constructor for a {Wx::VBoxSizer}.
-    # @return [Wx::VBoxSizer]
-    def initialize; end
+    # @overload initialize(&block)
+    #   @yieldparam [Wx::VBoxSizer] sizer new VBoxSizer instance
+    #   @return [Wx::VBoxSizer]
+    # @overload initialize()
+    #   @return [Wx::VBoxSizer]
+    def initialize(*) end
+
+  end
+
+  # Just a shortcut version for creating a vertical staticbox sizer
+  class VStaticBoxSizer < StaticBoxSizer
+
+    # @overload initialize(box, &block)
+    #   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).
+    #   @yieldparam [Wx::VStaticBoxSizer] sizer new VStaticBoxSizer instance
+    #   @return [Wx::VStaticBoxSizer]
+    # @overload initialize(box)
+    #   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).
+    #   @return [Wx::VStaticBoxSizer]
+    # @overload initialize(parent, label=(''), &block)
+    #   This constructor creates a new static box with the given label and parent window.
+    #   @param parent [Wx::Window]
+    #   @param label [String]
+    #   @yieldparam [Wx::VStaticBoxSizer] sizer new VStaticBoxSizer instance
+    #   @return [Wx::VStaticBoxSizer]
+    # @overload initialize(parent, label=(''))
+    #   This constructor creates a new static box with the given label and parent window.
+    #   @param parent [Wx::Window]
+    #   @param label [String]
+    #   @return [Wx::VStaticBoxSizer]
+    def initialize(*args) end
 
   end
 
@@ -24,9 +55,14 @@ module Wx
     # item on each line to use any remaining space on that line and {Wx::REMOVE_LEADING_SPACES} which removes any spacer
     # elements from the beginning of a row.
     # Both of these flags are on by default.
-    # @param flags [Integer]
-    # @return [Wx::VWrapSizer]
-    def initialize(flags=Wx::WRAPSIZER_DEFAULT_FLAGS) end
+    # @overload initialize(flags=Wx::WRAPSIZER_DEFAULT_FLAGS, &block)
+    #   @param flags [Integer]
+    #   @yieldparam [Wx::VWrapSizer] sizer new VWrapSizer instance
+    #   @return [Wx::VWrapSizer]
+    # @overload initialize(flags=Wx::WRAPSIZER_DEFAULT_FLAGS)
+    #   @param flags [Integer]
+    #   @return [Wx::VWrapSizer]
+    def initialize(flags) end
 
   end
 

data/lib/wx/doc/window.rb

@@ -56,9 +56,12 @@ module Wx
 
     # Yield each child window to the given block.
     # Returns an Enumerator if no block given.
-    # @yieldparam [Wx::Window] child the child window yielded
-    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
-    def each_child; end
+    # @overload each_child(&block)
+    #   @yieldparam [Wx::Window] child the child window yielded
+    #   @return [Object] last result of block
+    # @overload each_child()
+    #   @return [Enumerator] enumerator
+    def each_child(*) end
 
     # Locks the window from updates while executing the given block.
     # @param [Proc] block

data/lib/wx/helpers.rb

@@ -66,4 +66,32 @@ module Wx
   def self.has_feature?(featsym)
     Wx::Setup.const_defined?(featsym) && !!Wx::Setup.const_get(featsym)
   end
+
+  # returns true if WXWIDGETS_VERSION >= ver
+  # ver can be string or array of 3 integers
+  def self.at_least_wxwidgets?(ver)
+    ver = ver.split('.').collect {|s| s.to_i } unless ::Array === ver
+    ([ Wx::WXWIDGETS_MAJOR_VERSION, Wx::WXWIDGETS_MINOR_VERSION, Wx::WXWIDGETS_RELEASE_NUMBER ] <=> ver) >= 0
+  end
+
+  # returns true if WXWIDGETS_VERSION <= ver
+  # ver can be string or array of 3 integers
+  def self.up_to_wxwidgets?(ver)
+    ver = ver.split('.').collect {|s| s.to_i } unless ::Array === ver
+    ([ Wx::WXWIDGETS_MAJOR_VERSION, Wx::WXWIDGETS_MINOR_VERSION, Wx::WXWIDGETS_RELEASE_NUMBER ] <=> ver) <= 0
+  end
+
+  # returns true if WXWIDGETS_VERSION < ver
+  # ver can be string or array of 3 integers
+  def self.before_wxwidgets?(ver)
+    ver = ver.split('.').collect {|s| s.to_i } unless ::Array === ver
+    ([ Wx::WXWIDGETS_MAJOR_VERSION, Wx::WXWIDGETS_MINOR_VERSION, Wx::WXWIDGETS_RELEASE_NUMBER ] <=> ver) < 0
+  end
+
+  # returns true if WXWIDGETS_VERSION > ver
+  # ver can be string or array of 3 integers
+  def self.after_wxwidgets?(ver)
+    ver = ver.split('.').collect {|s| s.to_i } unless ::Array === ver
+    ([ Wx::WXWIDGETS_MAJOR_VERSION, Wx::WXWIDGETS_MINOR_VERSION, Wx::WXWIDGETS_RELEASE_NUMBER ] <=> ver) > 0
+  end
 end

data/lib/wx/keyword_ctors.rb

@@ -71,7 +71,7 @@ module Wx
     # by the Rails #class_attribute method.
     module ParamSpec
 
-      if RUBY_VERSION < '2.7.0'
+      if (RUBY_VERSION.split('.').collect {|v| v.to_i} <=> [2,7,0]) < 0
         PARAM_SPEC_ARG = [:param_spec]
       else
         PARAM_SPEC_ARG = [:param_spec, false]
@@ -164,7 +164,7 @@ module Wx
         end
       end
 
-      if RUBY_VERSION < '3.0.0'
+      if (RUBY_VERSION.split('.').collect {|v| v.to_i} <=> [3,0,0]) <= 0
         def args_as_list(*mixed_args)
           Wx::args_as_list(param_spec, *mixed_args)
         end

data/lib/wx/keyword_defs.rb

@@ -389,8 +389,7 @@ end
 
 # wxGenericDirCtrl 	A control for displaying a directory tree
 Wx::define_keyword_ctors(Wx::GenericDirCtrl) do
-  # TODO :dir => Wx::DIR_DIALOG_DEFAULT_FOLDER_STR
-  wx_ctor_params :id, :dir => ''
+  wx_ctor_params :id, :dir => Wx::DIR_DIALOG_DEFAULT_FOLDER_STR
   wx_ctor_params :pos, :size,
                  :style => Wx::DIRCTRL_3D_INTERNAL|Wx::SUNKEN_BORDER
   wx_ctor_params :filter => ''
@@ -517,6 +516,16 @@ Wx::define_keyword_ctors(Wx::HyperlinkCtrl) do
   wx_ctor_params :name => Wx::HYPERLINK_CTRL_NAME_STR
 end
 
+# HyperlinkCtrl is identical to GenericHyperlinkCtrl on MacOS
+unless Wx::PLATFORM == 'WXOSX'
+  Wx::define_keyword_ctors(Wx::GenericHyperlinkCtrl) do
+    wx_ctor_params :id, :label => ''
+    wx_ctor_params :url => ''
+    wx_ctor_params :pos, :size, :style => Wx::HL_DEFAULT_STYLE
+    wx_ctor_params :name => Wx::HYPERLINK_CTRL_NAME_STR
+  end
+end
+
 Wx::define_keyword_ctors(Wx::CollapsiblePane) do
   wx_ctor_params :id, :label => ''
   wx_ctor_params :pos, :size, :style => 0