wxruby3 0.9.1 → 0.9.3

data/lib/wx/core/generic_validator.rb

@@ -0,0 +1,312 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+module Wx
+
+  if has_feature?(:USE_VALIDATORS)
+
+  class GenericValidator < Wx::Validator
+
+    class << self
+      def handlers
+        @handlers ||= ::Hash.new(Proc.new { |win, *rest| raise NotImplementedError, "#{win.class} not supported" })
+      end
+
+      def define_handler(klass, meth=nil, &block)
+        raise ArgumentError, 'Expected a Class for arg 1' unless klass.is_a?(::Class)
+        h = if block and not meth
+              block
+            else
+              case meth
+              when Proc, Method
+                meth
+              else
+                raise ArgumentError, 'Expected a Proc or Method for arg 2'
+              end
+            end
+        handlers[klass] = h
+      end
+    end
+
+    def initialize(*arg)
+      super
+      @value = arg.empty? ? nil : arg.first.value
+      @handler = nil
+      @klass = nil
+    end
+
+    attr_accessor :value
+
+    private
+
+    def do_transfer_from_window
+      get_handler.call(get_window)
+    end
+
+    def do_transfer_to_window(val)
+      get_handler.call(get_window, val) unless val.nil?
+      true
+    end
+
+    def do_on_transfer_from_window(data)
+      super(@value = data)
+    end
+
+    def do_on_transfer_to_window
+      @value = super || @value
+    end
+
+    def get_handler
+      if @handler && @klass == get_window.class
+        @handler
+      else
+        @klass = get_window.class
+        @handler = GenericValidator.handlers[@klass] || GenericValidator.handlers.each_key.detect { |k| k > klass }
+        @handler || ::Kernel.raise(NotImplementedError, "#{@klass} not supported")
+      end
+    end
+
+  end # GenericValidator
+
+  # define standard handlers
+
+  # boolean controls
+  if Wx.has_feature?(:USE_CHECKBOX)
+
+    GenericValidator.define_handler(Wx::CheckBox) do |win, *val|
+      if val.empty?
+        !!win.get_value
+      else
+        win.set_value(!!val.shift)
+      end
+    end
+
+  end
+  if Wx.has_feature?(:USE_RADIOBTN)
+
+    GenericValidator.define_handler(Wx::RadioButton) do |win, *val|
+      if val.empty?
+        !!win.get_value
+      else
+        win.set_value(!!val.shift)
+      end
+    end
+
+  end
+  if Wx.has_feature?(:USE_TOGGLEBTN)
+    # also covers Wx::BitmapToggleButton
+    GenericValidator.define_handler(Wx::ToggleButton) do |win, *val|
+      if val.empty?
+        !!win.get_value
+      else
+        win.set_value(!!val.shift)
+      end
+    end
+
+  end
+
+  # integer controls
+  if Wx.has_feature?(:USE_GAUGE)
+
+    GenericValidator.define_handler(Wx::Gauge) do |win, *val|
+      if val.empty?
+        win.get_value
+      else
+        win.set_value(val.shift)
+      end
+    end
+
+  end
+  if Wx.has_feature?(:USE_RADIOBOX)
+
+    GenericValidator.define_handler(Wx::RadioBox) do |win, *val|
+      if val.empty?
+        win.get_selection
+      else
+        win.set_selection(val.shift)
+      end
+    end
+
+  end
+  if Wx.has_feature?(:USE_SCROLLBAR)
+
+    GenericValidator.define_handler(Wx::ScrollBar) do |win, *val|
+      if val.empty?
+        win.get_thumb_position
+      else
+        win.set_thumb_position(val.shift)
+      end
+    end
+
+  end
+  if Wx.has_feature?(:USE_SPINCTRL)
+
+    GenericValidator.define_handler(Wx::SpinCtrl) do |win, *val|
+      if val.empty?
+        win.get_value
+      else
+        win.set_value(val.shift)
+      end
+    end
+
+  end
+  if Wx.has_feature?(:USE_SPINBTN)
+
+    GenericValidator.define_handler(Wx::SpinButton) do |win, *val|
+      if val.empty?
+        win.get_value
+      else
+        win.set_value(val.shift)
+      end
+    end
+
+  end
+  if Wx.has_feature?(:USE_SLIDER)
+
+    GenericValidator.define_handler(Wx::Slider) do |win, *val|
+      if val.empty?
+        win.get_value
+      else
+        win.set_value(val.shift)
+      end
+    end
+
+  end
+  if Wx.has_feature?(:USE_CHOICE)
+
+    GenericValidator.define_handler(Wx::Choice) do |win, *val|
+      if val.empty?
+        win.get_selection
+      else
+        win.set_selection(val.shift)
+      end
+    end
+
+  end
+  if Wx.has_feature?(:USE_COMBOBOX)
+
+    GenericValidator.define_handler(Wx::ComboBox) do |win, *val|
+      if val.empty?
+        if (win.get_window_style & Wx::CB_READONLY) == Wx::CB_READONLY
+          win.get_selection
+        else
+          win.get_string_selection
+        end
+      else
+        if (win.get_window_style & Wx::CB_READONLY) == Wx::CB_READONLY
+          win.set_selection(val.shift)
+        else
+          win.set_string_selection(val.shift)
+        end
+      end
+    end
+
+  end
+
+  # date/time controls
+  if Wx.has_feature?(:USE_DATEPICKCTRL)
+
+    GenericValidator.define_handler(Wx::DatePickerCtrl) do |win, *val|
+      if val.empty?
+        win.get_value
+      else
+        win.set_value(val.shift)
+      end
+    end
+
+  end
+  if Wx.has_feature?(:USE_TIMEPICKCTRL)
+
+    GenericValidator.define_handler(Wx::TimePickerCtrl) do |win, *val|
+      if val.empty?
+        win.get_value
+      else
+        win.set_value(val.shift)
+      end
+    end
+
+  end
+
+  # string controls
+  if Wx.has_feature?(:USE_BUTTON)
+
+    GenericValidator.define_handler(Wx::Button) do |win, *val|
+      if val.empty?
+        win.get_label
+      else
+        win.set_label(val.shift)
+      end
+    end
+
+  end
+  if Wx.has_feature?(:USE_STATTEXT)
+
+    GenericValidator.define_handler(Wx::StaticText) do |win, *val|
+      if val.empty?
+        win.get_label
+      else
+        win.set_label(val.shift)
+      end
+    end
+
+  end
+  if Wx.has_feature?(:USE_TEXTCTRL)
+
+    GenericValidator.define_handler(Wx::TextCtrl) do |win, *val|
+      if val.empty?
+        win.get_value
+      else
+        win.set_value(val.shift)
+      end
+    end
+
+  end
+
+  # array controls
+  if Wx.has_feature?(:USE_CHECKLISTBOX)
+
+    GenericValidator.define_handler(Wx::CheckListBox) do |win, *val|
+      if val.empty?
+        if (win.get_window_style & Wx::LB_SINGLE) == Wx::LB_SINGLE
+          win.get_checked_items.first
+        else
+          win.get_checked_items
+        end
+      else
+        if (win.get_window_style & Wx::LB_SINGLE) == Wx::LB_SINGLE
+          win.check(val.shift, true)
+        else
+          win.get_count.times { |i| win.check(i, false) }
+          [val].flatten.each { |i| win.check(i, true) }
+        end
+      end
+    end
+
+  end
+  if Wx.has_feature?(:USE_LISTBOX)
+
+    GenericValidator.define_handler(Wx::ListBox) do |win, *val|
+      if val.empty?
+        # test this the hard since on WXOSX LB_SINGLE is default but does get set
+        # by default i.e. on WXOSX no selection type bit set == LB_SINGLE
+        if (win.get_window_style & (Wx::LB_MULTIPLE|Wx::LB_EXTENDED)) == 0
+          win.get_selection
+        else
+          win.get_selections
+        end
+      else
+        if (win.get_window_style & (Wx::LB_MULTIPLE|Wx::LB_EXTENDED)) == 0
+          win.set_selection(val.shift)
+        else
+          win.get_count.times { |i| win.deselect(i) }
+          [val].flatten.each { |i| win.set_selection(i) }
+        end
+      end
+    end
+
+  end
+
+  end # if USE_VALIDATORS
+
+end

data/lib/wx/core/listbox.rb

@@ -9,6 +9,6 @@
 require_relative './controlwithitems'
 
 class Wx::ListBox
-  alias :get_item_data :get_client_data
-  alias :set_item_data :set_client_data
+  alias :get_item_data :get_client_object
+  alias :set_item_data :set_client_object
 end

data/lib/wx/core/log.rb

@@ -71,7 +71,7 @@ module Wx
       # first log info instance of a repeating message sequence
 
       # format message
-      msg = fmt % args
+      msg = args.empty? ? fmt : fmt % args
       log_info = {
         filename: if filename
                     filename.to_s

data/lib/wx/core/menu.rb

@@ -26,6 +26,16 @@ class Wx::Menu
     end
   end
 
+  # Overload to provide Enumerator without block
+  wx_each_item = instance_method :each_item
+  define_method :each_item do |&block|
+    if block
+      wx_each_item.bind(self).call(&block)
+    else
+      ::Enumerator.new { |y| wx_each_item.bind(self).call { |mi| y << mi } }
+    end
+  end
+
   # In the standard WxWidgets API, the methods append, prepend, insert
   # (and their variants) require a constant integer id as the identifier
   # of the menu item. This is then used in event handling. 

data/lib/wx/core/notebook.rb

@@ -11,8 +11,12 @@
 class Wx::Notebook
   # Convenience method for iterating pages
   def each_page
-    0.upto(get_page_count - 1) do | i |
-      yield get_page(i)
+    if block_given?
+      0.upto(get_page_count - 1) do | i |
+        yield get_page(i)
+      end
+    else
+      ::Enumerator.new { |y| each_page { |pg| y << pg } }
     end
   end
 end

data/lib/wx/core/owner_drawn_combobox.rb

@@ -0,0 +1,45 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+module Wx
+
+  class OwnerDrawnComboBox
+
+    # make sure to honor the inherited common overloads
+    wx_get_client_object = instance_method :get_client_object
+    define_method :get_client_object do |*args|
+      if args.empty?
+        super()
+      else
+        wx_get_client_object.bind(self).call(*args)
+      end
+    end
+    wx_set_client_object = instance_method :set_client_object
+    define_method :set_client_object do |*args|
+      if args.size < 2
+        super(*args)
+      else
+        wx_set_client_object.bind(self).call(*args)
+      end
+    end
+    # redefine aliases
+    alias :client_object :get_client_object
+    alias :client_object= :set_client_object
+
+    alias :get_client_data :get_client_object
+    alias :set_client_data :set_client_object
+
+    # Overload to provide Enumerator without block
+    wx_each_string = instance_method :each_string
+    define_method :each_string do |&block|
+      if block
+        wx_each_string.bind(self).call(&block)
+      else
+        ::Enumerator.new { |y| wx_each_string.bind(self).call { |ln| y << ln } }
+      end
+    end
+
+  end
+
+end

data/lib/wx/core/size.rb

@@ -13,8 +13,12 @@ class Wx::Size
   # provide compatibility methods
   alias :get_x :get_width
   alias :x :get_width
+  alias :set_x :set_width
+  alias :x= :set_width
   alias :get_y :get_height
   alias :y :get_height
+  alias :set_y :set_height
+  alias :y= :set_height
 
   # More informative output for inspect etc
   def to_s

data/lib/wx/core/sizer.rb

@@ -14,8 +14,7 @@ class Wx::Sizer
   ADD_ITEM_PARAMS = [ Wx::Parameter[ :index, -1 ], 
                       Wx::Parameter[ :proportion, 0 ],
                       Wx::Parameter[ :flag, 0 ],
-                      Wx::Parameter[ :border, 0 ],
-                      Wx::Parameter[ :user_data, nil ] ]
+                      Wx::Parameter[ :border, 0 ] ]
   
   def add_item(item, *mixed_args)
 
@@ -49,4 +48,15 @@ class Wx::Sizer
       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

data/lib/wx/core/standard_paths.rb

@@ -0,0 +1,22 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+
+module Wx
+
+  class StandardPaths
+
+    class << self
+
+      wx_get = instance_method :get
+      define_method :get do
+        # cache the global singleton
+        @instance ||= wx_get.bind(self).call
+      end
+
+    end
+
+  end
+
+end

data/lib/wx/core/task_bar_button.rb

@@ -0,0 +1,19 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+
+module Wx
+
+  if Wx::PLATFORM == 'WXMSW'
+    class TaskBarButton
+
+      wx_remove_thumb_bar_button = instance_method :remove_thumb_bar_button
+      define_method :remove_thumb_bar_button do |button|
+        button = button.get_id if button.is_a?(Wx::ThumbBarButton)
+        wx_remove_thumb_bar_button.bind(self).call(button)
+      end
+
+    end
+  end
+end

data/lib/wx/core/text_entry.rb

@@ -13,7 +13,10 @@ module Wx
     wx_auto_complete = instance_method :auto_complete
     define_method :auto_complete do |completer|
       if wx_auto_complete.bind(self).call(completer)
-        @completer = completer # keep the Ruby object alive
+        @completer = completer.is_a?(Wx::TextCompleter) ? completer : nil # keep the Ruby object alive or cleanup
+        true
+      else
+        false
       end
     end
 

data/lib/wx/core/textctrl.rb

@@ -59,10 +59,20 @@ module Wx
   class TextCtrl
     wx_op_append = instance_method :<<
     define_method :<< do |o|
-      wx_op_append.bind(self).call(o)
+      wx_op_append.bind(self).call(o.to_s)
       self
     end
 
+    # Overload to provide Enumerator without block
+    wx_each_line = instance_method :each_line
+    define_method :each_line do |&block|
+      if block
+        wx_each_line.bind(self).call(&block)
+      else
+        ::Enumerator.new { |y| wx_each_line.bind(self).call { |ln| y << ln } }
+      end
+    end
+
     if Wx.has_feature?(:USE_SPELLCHECK)
 
       protected :do_enable_proof_check

data/lib/wx/core/{treectrl.rb → tree_ctrl.rb}

@@ -9,22 +9,41 @@
 # Hierarchical control with items
 
 class Wx::TreeCtrl
-  # Make these ruby enumerables so find, find_all, map etc are available
-  include Enumerable
+
+  # Overload to provide Enumerator without block
+  wx_traverse = instance_method :traverse
+  define_method :traverse do |start_id=nil, &block|
+    if block
+      wx_traverse.bind(self).call(start_id, &block)
+    else
+      ::Enumerator.new { |y| wx_traverse.bind(self).call(start_id) { |c| y << c } }
+    end
+  end
+
   # Iterate over all items
   alias :each :traverse
 
-  # Return the children of +parent+ as an array of TreeItemIDs.
-  def get_children(parent)
-    kids = []
-    kid, _ = get_first_child(parent)
-    return [] unless kid.ok?
-    kids << kid
-
-    while kid = get_next_sibling(kids.last) and kid.ok?
-      kids << kid
+  # Make these ruby enumerables so find, find_all, map etc are available
+  include Enumerable
+
+  # Iterate all children of parent_id
+  def each_item_child(parent_id, &block)
+    if block
+      rc = nil
+      child_id, cookie = get_first_child(parent_id)
+      while child_id && child_id.ok?
+        rc = block.call(child_id)
+        child_id, cookie = get_next_child(parent_id, cookie)
+      end
+      rc
+    else
+      ::Enumerator.new { |y| each_item_child(parent_id) { |child_id| y << child_id } }
     end
-    kids
+  end
+
+  # Return the children of +parent+ as an array of TreeItemIDs.
+  def get_item_children(parent_id)
+    each_item_child(parent_id).to_a
   end
 
   # Returns a Wx::Rect corresponding to the edges of an individual tree

data/lib/wx/core/validator.rb

@@ -1,15 +1,80 @@
 # Copyright (c) 2023 M.J.N. Corino, The Netherlands
 #
 # This software is released under the MIT license.
-# 
-# Some parts are
-# Copyright 2004-2007, wxRuby development team
-# released under the MIT-like wxRuby2 license
 
 class Wx::Validator
+
   # Default implementation of clone, may need to be over-ridden if
   # custom subclasses should state variables that need to be copied
+  # NOTE: There is no way to copy the bindings here so do NOT
   def clone
-    self.class.new
+    begin
+      self.class.new(self)
+    rescue
+      p $!
+      raise
+    end
+  end
+
+  # overload for customized functionality
+  def do_transfer_from_window
+    nil # by default just return nil
   end
+  protected :do_transfer_from_window
+
+  # overload for customized functionality
+  def do_transfer_to_window(_data)
+    true # by default just return true
+  end
+  protected :do_transfer_to_window
+
+  protected :do_on_transfer_from_window
+  protected :do_on_transfer_to_window
+
+  module Binding
+    def self.included(base)
+      wx_on_transfer_from_window = base.instance_method :on_transfer_from_window
+      base.define_method :on_transfer_from_window do |meth = nil, &block|
+        proc = if block and not meth
+                 block
+               elsif meth and not block
+                 h_meth = case meth
+                          when Symbol, String then self.method(meth)
+                          when Proc then meth
+                          when Method then meth
+                          end
+                 # check arity == 1
+                 if h_meth.arity != 1
+                   Kernel.raise ArgumentError,
+                                "on_transfer_from_window handler should accept a single argument"
+                 end
+                 h_meth
+               end
+        wx_on_transfer_from_window.bind(self).call(proc)
+      end
+
+      wx_on_transfer_to_window = base.instance_method :on_transfer_to_window
+      base.define_method :on_transfer_to_window do |meth = nil, &block|
+        proc = if block and not meth
+                 block
+               elsif meth and not block
+                 h_meth = case meth
+                          when Symbol, String then self.method(meth)
+                          when Proc then meth
+                          when Method then meth
+                          end
+                 # check arity == 0
+                 if h_meth.arity != 0
+                   Kernel.raise ArgumentError,
+                                "on_transfer_to_window handler should not accept any argument"
+                 end
+                 h_meth
+               end
+        wx_on_transfer_to_window.bind(self).call(proc)
+      end
+    end
+  end
+
+  include Binding
+
 end

data/lib/wx/core/window.rb

@@ -26,13 +26,9 @@ class Wx::Window
   # In case a more explicit option is preferred.
   alias :wx_id :get_id
 
-  # The name of Wx::Window#raise conflicts with Ruby's core Kernel#raise
-  # method. This can cause unexpected errors when undecorated #raise is
-  # used inside a Window method. For wxRuby 2.0 it's too late to remove
-  # Window#raise completely, but for now, offer alternatives to
-  # raise/lower that could replace them in future versions.
-  alias :bring_to_front :raise
-  alias :send_to_back :lower
+  # Z-order alternatives
+  alias :bring_to_front :raise_window
+  alias :send_to_back :lower_window
 
   # Recursively searches all windows below +self+ and returns the first
   # window which has the id +an_id+. This corresponds to the find_window
@@ -79,6 +75,16 @@ class Wx::Window
     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
+
   # implement non-static variants of these
 
   def from_dip(*args)