wxruby3 1.2.1 → 1.3.1

data/lib/wx/core/sizer.rb

@@ -6,57 +6,184 @@
 # Copyright 2004-2007, wxRuby development team
 # released under the MIT-like wxRuby2 license
 
-# Class for automatically managing layouts
+# Classes for automatically managing layouts
 
-class Wx::Sizer
-  # Generic method to add items, supporting positional and named
-  # arguments
-  ADD_ITEM_PARAMS = [ Wx::Parameter[ :index, -1 ], 
-                      Wx::Parameter[ :proportion, 0 ],
-                      Wx::Parameter[ :flag, 0 ],
-                      Wx::Parameter[ :border, 0 ] ]
-  
-  def add_item(item, *mixed_args)
+module Wx
+  class Sizer
+    # Generic method to add items, supporting positional and named
+    # arguments
+    ADD_ITEM_PARAMS = [Wx::Parameter[:index, -1],
+                       Wx::Parameter[:proportion, 0],
+                       Wx::Parameter[:flag, 0],
+                       Wx::Parameter[:border, 0]]
 
-    begin
-      args = Wx::args_as_list(ADD_ITEM_PARAMS, *mixed_args)
-    rescue => err
-      err.set_backtrace(caller)
-      Kernel.raise err
+    def add_item(item, *mixed_args)
+
+      begin
+        args = Wx::args_as_list(ADD_ITEM_PARAMS, *mixed_args)
+      rescue => err
+        err.set_backtrace(caller)
+        Kernel.raise err
+      end
+
+      full_args = []
+
+      # extract the width and the height in the case of a spacer
+      # defined as an array
+      if item.kind_of?(Array)
+        Kernel.raise ArgumentError,
+                     "Invalid Sizer specification : [width, height] expected" if item.size != 2
+        full_args << item[0] << item[1]
+      else
+        full_args << item
+      end
+
+      # update the full arguments list with the optional arguments (except index)
+      idx = args.shift
+      full_args.concat(args)
+
+      # Call add to append if default position
+      if idx == -1
+        add(*full_args)
+      else
+        insert(idx, *full_args)
+      end
+    end
+
+    # Overload to provide Enumerator without block
+    wx_each_child = instance_method :each_child
+    define_method :each_child do |&block|
+      if block
+        wx_each_child.bind(self).call(&block)
+      else
+        ::Enumerator.new { |y| wx_each_child.bind(self).call { |c| y << c } }
+      end
+    end
+
+  end
+
+  class BoxSizer < Sizer
+
+    wx_initialize = instance_method :initialize
+    define_method :initialize do |*args, &block|
+      wx_initialize.bind(self).call(*args)
+      if block
+        if block.arity == -1 or block.arity == 0
+          self.instance_eval(&block)
+        elsif block.arity == 1
+          block.call(self)
+        else
+          Kernel.raise ArgumentError,
+                       "Block to initialize should accept a single argument or none"
+        end
+      end
+    end
+
+  end
+
+  class WrapSizer < BoxSizer
+
+    wx_initialize = instance_method :initialize
+    define_method :initialize do |*args, &block|
+      wx_initialize.bind(self).call(*args)
+      if block
+        if block.arity == -1 or block.arity == 0
+          self.instance_eval(&block)
+        elsif block.arity == 1
+          block.call(self)
+        else
+          Kernel.raise ArgumentError,
+                       "Block to initialize should accept a single argument or none"
+        end
+      end
     end
 
-    full_args = []
+  end
+
+  class StaticBoxSizer < BoxSizer
 
-    # extract the width and the height in the case of a spacer
-    # defined as an array
-    if item.kind_of?(Array)
-      Kernel.raise ArgumentError,
-        "Invalid Sizer specification : [width, height] expected" if item.size != 2
-      full_args << item[0] << item[1]
-    else
-      full_args << item
+    wx_initialize = instance_method :initialize
+    define_method :initialize do |*args, &block|
+      wx_initialize.bind(self).call(*args)
+      if block
+        if block.arity == -1 or block.arity == 0
+          self.instance_eval(&block)
+        elsif block.arity == 1
+          block.call(self)
+        else
+          Kernel.raise ArgumentError,
+                       "Block to initialize should accept a single argument or none"
+        end
+      end
     end
 
-    # update the full arguments list with the optional arguments (except index)
-    idx = args.shift
-    full_args.concat(args)
+  end
 
-    # Call add to append if default position
-    if idx == -1
-      add(*full_args)
-    else
-      insert(idx, *full_args)
+  class StdDialogButtonSizer < BoxSizer
+
+    wx_initialize = instance_method :initialize
+    define_method :initialize do |*args, &block|
+      wx_initialize.bind(self).call(*args)
+      if block
+        if block.arity == -1 or block.arity == 0
+          self.instance_eval(&block)
+        elsif block.arity == 1
+          block.call(self)
+        else
+          Kernel.raise ArgumentError,
+                       "Block to initialize should accept a single argument or none"
+        end
+      end
     end
+
   end
 
-  # Overload to provide Enumerator without block
-  wx_each_child = instance_method :each_child
-  define_method :each_child do |&block|
-    if block
-      wx_each_child.bind(self).call(&block)
-    else
-      ::Enumerator.new { |y| wx_each_child.bind(self).call { |c| y << c } }
+  class GridSizer < Sizer
+
+    wx_initialize = instance_method :initialize
+    define_method :initialize do |*args, &block|
+      wx_initialize.bind(self).call(*args)
+      self.instance_eval(&block) if block
     end
+
+  end
+
+  class FlexGridSizer < GridSizer
+
+    wx_initialize = instance_method :initialize
+    define_method :initialize do |*args, &block|
+      wx_initialize.bind(self).call(*args)
+      if block
+        if block.arity == -1 or block.arity == 0
+          self.instance_eval(&block)
+        elsif block.arity == 1
+          block.call(self)
+        else
+          Kernel.raise ArgumentError,
+                       "Block to initialize should accept a single argument or none"
+        end
+      end
+    end
+
+  end
+
+  class GridBagSizer < FlexGridSizer
+
+    wx_initialize = instance_method :initialize
+    define_method :initialize do |*args, &block|
+      wx_initialize.bind(self).call(*args)
+      if block
+        if block.arity == -1 or block.arity == 0
+          self.instance_eval(&block)
+        elsif block.arity == 1
+          block.call(self)
+        else
+          Kernel.raise ArgumentError,
+                       "Block to initialize should accept a single argument or none"
+        end
+      end
+    end
+
   end
 
 end

data/lib/wx/core/variant.rb

@@ -8,62 +8,119 @@
 
 require 'date'
 
-class Wx::Variant
-  include ::Enumerable
+module Wx
 
-  # add a proper enumerator method
-  def each
-    if block_given?
-      get_count.times { |i| yield self[i] }
-    else
-      ::Enumerator.new { |y| get_count.times { |i| y << self[i] } }
+  class Variant
+    include ::Enumerable
+
+    # add a proper enumerator method
+    def each
+      if block_given?
+        get_count.times { |i| yield self[i] }
+      else
+        ::Enumerator.new { |y| get_count.times { |i| y << self[i] } }
+      end
     end
-  end
 
-  # make assign return self and add it's handy alias
-  wx_assign = instance_method :assign
-  define_method :assign do |v|
-    wx_assign.bind(self).call(v)
-    self
-  end
-  alias :<< :assign
-
-  # extend to_s to arraylist and list (easier in pure Ruby)
-
-  wx_to_s = instance_method :to_s
-  define_method :to_s do
-    unless null?
-      case type
-      when 'list'
-        return "[#{each.collect { |v| v.string? ? %Q{"#{v.to_s}"} : v.to_s }.join(', ')}]"
-      when 'arrstring'
-        return array_string.to_s
-      when 'wxFont'
-        return font.to_s
-      when 'wxColour'
-        return colour.to_s
-      when 'wxColourPropertyValue'
-        return colour_property_value.to_s
+    # make assign return self and add it's handy alias
+    wx_assign = instance_method :assign
+    define_method :assign do |v|
+      wx_assign.bind(self).call(v)
+      self
+    end
+    alias :<< :assign
+
+    # extend to_s to arraylist and list (easier in pure Ruby)
+
+    wx_to_s = instance_method :to_s
+    define_method :to_s do
+      unless null?
+        case type
+        when 'list'
+          return "[#{each.collect { |v| v.string? ? %Q{"#{v.to_s}"} : v.to_s }.join(', ')}]"
+        when 'arrstring'
+          return array_string.to_s
+        when 'wxFont'
+          return font.to_s
+        when 'wxColour'
+          return colour.to_s
+        when 'wxColourPropertyValue'
+          return colour_property_value.to_s
+        end
       end
+      wx_to_s.bind(self).call
+    end
+
+    # extend with more Ruby-like type checking
+
+    def string?
+      !null? && is_type('string');
+    end
+
+    def bool?
+      !null? && is_type('bool');
+    end
+
+    def long?
+      !null? && is_type('long');
+    end
+
+    def long_long?
+      !null? && is_type('longlong');
+    end
+
+    def u_long_long?
+      !null? && is_type('ulonglong');
+    end
+
+    def integer?
+      !null? && (long? || long_long? || u_long_long?);
+    end
+
+    def date_time?
+      !null? && is_type('datetime');
     end
-    wx_to_s.bind(self).call
+
+    def double?
+      !null? && is_type('double');
+    end
+
+    def numeric?
+      !null? && (integer? || double?);
+    end
+
+    def list?
+      !null? && is_type('list');
+    end
+
+    def array_string?
+      !null? && is_type('arrstring');
+    end
+
+    def font?
+      !null? && is_type('wxFont');
+    end
+
+    def colour?
+      !null? && is_type('wxColour');
+    end
+
+    def colour_property_value?
+      !null? && is_type('wxColourPropertyValue');
+    end
+
+    def object?(klass = Object)
+      !null? && is_type('WXRB_VALUE') && klass === object;
+    end
+
+    def dup
+      self.class.new(self)
+    end
+
+    def clone
+      dup
+    end
+
   end
 
-  # extend with more Ruby-like type checking
-
-  def string?; !null? && is_type('string'); end
-  def bool?; !null? && is_type('bool'); end
-  def long?; !null? && is_type('long'); end
-  def long_long?; !null? && is_type('longlong'); end
-  def u_long_long?; !null? && is_type('ulonglong'); end
-  def integer?; !null? && (long? || long_long? || u_long_long?); end
-  def date_time?; !null? && is_type('datetime'); end
-  def double?; !null? && is_type('double'); end
-  def numeric?; !null? && (integer? || double?); end
-  def list?; !null? && is_type('list'); end
-  def array_string?; !null? && is_type('arrstring'); end
-  def font?; !null? && is_type('wxFont'); end
-  def colour?; !null? && is_type('wxColour'); end
-  def colour_property_value?; !null? && is_type('wxColourPropertyValue'); end
-  def object?(klass=Object) !null? && is_type('WXRB_VALUE') && klass === object; end
 end

data/lib/wx/core/vboxsizer.rb

@@ -9,14 +9,34 @@
 # Just a shortcut version for creating a vertical box sizer
 
 class Wx::VBoxSizer < Wx::BoxSizer
-  def initialize
-    super(Wx::VERTICAL)
+  def initialize(&block)
+    super(Wx::VERTICAL, &nil)
+    if block
+      if block.arity == -1 or block.arity == 0
+        self.instance_eval(&block)
+      elsif block.arity == 1
+        block.call(self)
+      else
+        Kernel.raise ArgumentError,
+                     "Block to initialize should accept a single argument or none"
+      end
+    end
   end
 end
 
 # Just a shortcut version for creating a vertical wrap sizer
 class Wx::VWrapSizer < Wx::WrapSizer
-  def initialize(flags=Wx::WRAPSIZER_DEFAULT_FLAGS)
-    super(Wx::VERTICAL)
+  def initialize(flags=Wx::WRAPSIZER_DEFAULT_FLAGS, &block)
+    super(Wx::VERTICAL, &nil)
+    if block
+      if block.arity == -1 or block.arity == 0
+        self.instance_eval(&block)
+      elsif block.arity == 1
+        block.call(self)
+      else
+        Kernel.raise ArgumentError,
+                     "Block to initialize should accept a single argument or none"
+      end
+    end
   end
 end

data/lib/wx/doc/array_ext.rb

@@ -27,6 +27,7 @@ module Wx
     # The array is not altered.
     # @return [Wx::RealPoint]
     def to_real_point; end
+    alias :to_real :to_real_point
 
   end
 

data/lib/wx/doc/aui/auimanager.rb

@@ -12,7 +12,9 @@ module Wx
     class AuiManager
 
       # Yield each pane to the given block.
+      # If no block passed returns an Enumerator.
       # @yieldparam [Wx::AUI::AuiPaneInfo] pane the Aui pane info yielded
+      # @return [::Object, ::Enumerator] result of last block execution or enumerator
       def each_pane; end
 
       # Returns an array of all panes managed by the frame manager.

data/lib/wx/doc/colour.rb

@@ -9,4 +9,16 @@ module Wx
 
   TRANSPARENT_COLOUR = Wx::Colour.new(0, 0, 0, Wx::ALPHA_TRANSPARENT)
 
+  class Colour < Object
+
+    # Returns a copy-constructed Colour object.
+    # @return [Wx::Colour] the duplicated Colour object
+    def dup; end
+
+    # Calls #dup.
+    # @return [Wx::Colour]
+    def clone; end
+
+  end
+
 end

data/lib/wx/doc/enum.rb

@@ -18,6 +18,32 @@ module Wx
   # type safety for arguments requiring the specific enum class.
   class Enum < Numeric
 
+    class << self
+
+      # Sets a class specific list of enumerator ids (symbols) that should be considered
+      # non-distinctive enum values (examples would be convenience constants combining
+      # multiple distinctive enumerators or enumerators denoting the first/lowest and/or last/highest
+      # distinctive enumerators). Mostly useful for bitmask enum classes.
+      # @param [Array<Symbol>] lst
+      def set_non_distinct(lst) end
+      alias :non_distinct= :set_non_distinct
+
+      # Returns the class specific list of enumerator ids (symbols) that should be considered
+      # non-distinctive enum values. Returns nil if not set.
+      # @see set_non_distinct
+      # @return [Array<Symbol>,nil]
+      def non_distinct; end
+
+      # Returns a hash table with enumerator value : enumerator id (symbol) pairs for the enum class.
+      # @param [Array<Symbol>, nil] excludes list of enumerator ids (symbols) to exclude (by default the non_distinct list is used if defined)
+      # @return [Hash(Integer, Symbol)]
+      def enumerators(excludes = nil) end
+
+      # Returns the enumerator for the given enumerator symbol or nil if no such enumerator exists.
+      # @return [Wx::Enum, nil]
+      def [](enum_name) end
+    end
+
     # Initialize a new enum value.
     # @param [Integer] val enum integer value
     def initialize(val)end

data/lib/wx/doc/evthandler.rb

@@ -142,6 +142,12 @@ module Wx
     # @yield [*args] optional arguments
     def call_after(meth = nil, *args, &block) end
 
+    # Process a {Wx::EVT_HOTKEY} event.
+    # @param [Integer] id hotkey id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::KeyEvent] event the event to handle
+    def evt_hotkey(id, meth = nil, &block) end
+
   end
 
 end

data/lib/wx/doc/functions.rb

@@ -158,9 +158,41 @@ module Wx
   # @!group Dialog shortcuts
 
   # @return [Array<Integer>] Selected choices
-  def self.get_selected_choices(message, caption, choices,
-                                parent = nil, x = Wx::DEFAULT_COORD, y = Wx::DEFAULT_COORD,
-                                centre = true, width = Wx::CHOICE_WIDTH, height = Wx::CHOICE_HEIGHT) end
+
+  # Get the user selection as a string.
+  # @param [String] message
+  # @param [String] caption
+  # @param [Array<String>] choices choice strings
+  # @param [Wx::Window,nil] parent
+  # @param [Integer] initial_selection initial choice index
+  # @param [Wx::Point,Array(Integer,Integer)] pos
+  # @return [String] selected choice or '' if cancelled
+  def self.get_single_choice(message, caption, choices, parent = nil,
+                             initial_selection: 0,
+                             pos:  Wx::DEFAULT_POSITION) end
+
+  # Get the user selection as an index.
+  # @param [String] message
+  # @param [String] caption
+  # @param [Array<String>] choices choice strings
+  # @param [Wx::Window,nil] parent
+  # @param [Integer] initial_selection
+  # @param [Wx::Point,Array(Integer,Integer)] pos
+  # @return [Integer] selected choice index or -1 if cancelled
+  def self.get_single_choice_index(message, caption, choices, parent = nil,
+                                   initial_selection: 0,
+                                   pos:  Wx::DEFAULT_POSITION) end
+
+  # @param [String] message
+  # @param [String] caption
+  # @param [Array<String>] choices choice strings
+  # @param [Wx::Window,nil] parent
+  # @param [Array<Integer>] initial_selections array of initial choice indexes
+  # @param [Wx::Point,Array(Integer,Integer)] pos
+  # @return [Array<Integer>,nil] selected choice indexes (can be empty array if none selected) or nil if cancelled
+  def self.get_selected_choices(message, caption, choices, parent = nil,
+                                initial_selections: [],
+                                pos:  Wx::DEFAULT_POSITION) end
 
   # Pops up a file selector box.
   #

data/lib/wx/doc/gdi_common.rb

@@ -209,6 +209,7 @@ module Wx
     # Returns self.
     # @return [self]
     def to_real_point; end
+    alias :to_real :to_real_point
 
     # Set this point to the given point's x,y values
     # @param [Wx::RealPoint] pt

data/lib/wx/doc/gdi_object.rb

@@ -0,0 +1,22 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  class GDIObject < Object
+
+    # Returns a copy-constructed GDI object.
+    # @return [Wx::GDIObject] the duplicated GDI object
+    def dup; end
+
+    # Calls #dup.
+    # @return [Wx::GDIObject]
+    def clone; end
+
+  end
+
+end

data/lib/wx/doc/object.rb

@@ -0,0 +1,24 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  class Object
+
+    # By default Wx:::Object derived classes cannot be #dup-licated.
+    # Some derived classes (like GDIObject-s) may provide functional overloads.
+    # @return [nil]
+    def dup; end
+
+    # By default Wx::Object derived class instances cannot be cloned but instead return self.
+    # Derived classes (like the Event classes) may provide functional overloads.
+    # @return [self]
+    def clone; end
+
+  end
+
+end

data/lib/wx/doc/variant.rb

@@ -168,6 +168,14 @@ module Wx
     # @return [true,false]
     def object?(klass=Object) end
 
+    # Copy constructs a Variant instance.
+    # @return [Wx::Variant]
+    def dup; end
+
+    # Calls #dup.
+    # @return [Wx::Variant]
+    def clone; end
+
   end
 
 end

data/lib/wx/helpers.rb

@@ -27,9 +27,8 @@ module Wx
       out_args = []
       param_spec.each_with_index do | param, i |
         # has supplied list arg or the keyword arg?
-        if (arg = mixed_args[i]) || kwa.key?(param.name)
-          arg = kwa.delete(param.name) unless arg
-        end
+        arg = mixed_args[i]
+        arg = kwa.delete(param.name) if arg.nil? && kwa.key?(param.name)
         if Proc === param.default_or_proc
           arg = param.default_or_proc.call(arg) # provides default or converts arg
         elsif arg.nil?

data/lib/wx/keyword_defs.rb

@@ -267,6 +267,13 @@ Wx::define_keyword_ctors(Wx::PropertySheetDialog) do
   wx_ctor_params :name => Wx::DIALOG_NAME_STR
 end
 
+# Credentials entry dialog
+Wx::define_keyword_ctors(Wx::CredentialEntryDialog) do
+  wx_ctor_params :message => ''
+  wx_ctor_params :title => 'Enter credentials'
+  wx_ctor_params :cred => ->(cred) { cred || Wx::WebCredentials.new }
+end
+
 ### CONTROLS
 
 # Push button control, displaying text

data/lib/wx/version.rb

@@ -3,5 +3,5 @@
 # This software is released under the MIT license.
 
 module Wx
-  WXRUBY_VERSION    = '1.2.1'
+  WXRUBY_VERSION    = '1.3.1'
 end

data/rakelib/lib/config.rb

@@ -360,7 +360,7 @@ module WXRuby3
             test = File.join(Config.instance.test_dir, test)
             test = Dir.glob(test+'.rb').shift || test unless File.exist?(test)
           end
-          Rake.sh(Config.instance.exec_env, *make_ruby_cmd(test)) { |ok,status| errors += 1 unless ok }
+          Rake.sh(Config.instance.exec_env.merge({'RUBYLIB'=>rb_lib_path}), FileUtils::RUBY, test) { |ok,status| errors += 1 unless ok }
         end
       end
       fail "ERRORS: ##{errors} test scripts failed." if errors>0