wxruby3 0.9.2 → 0.9.4

data/lib/wx/core/controlwithitems.rb

@@ -9,149 +9,59 @@
 # Superclass of a variety of controls that display lists of items (eg
 # Choice, ListBox, CheckListBox)
 
-class Wx::ControlWithItems
+module Wx
 
-  # 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
-
-  # We need to cache client data in Ruby variables as we cannot access items
-  # during the GC mark phase as for some platforms (WXMSW at least) that would
-  # involve calling methods that would break in that phase.
-
-  def client_data_store
-    @client_data ||= []
-  end
-  private :client_data_store
-
-  wx_set_client_data = instance_method :set_client_data
-  define_method :set_client_data do |item, data|
-    item = item.to_i
-    wx_set_client_data.bind(self).call(item, data)
-    client_data_store[item] = data
-  end
-
-  def get_client_data(item)
-    client_data_store[item.to_i]
-  end
+  class ControlWithItems
 
-  wx_append = instance_method :append
-  define_method :append do |item, data=nil|
-    itm_pos = -1
-    if data
-      if ::Array === item
-        if !(::Array === data)
-          ::Kernel.raise ::TypeError.new("Expected Array for argument 3")
-        elsif data.size != item.size
-          ::Kernel.raise ::ArgumentError.new("item and data array must be equal size")
-        end
-        if sorted?
-          item.each_with_index do |itm, ix|
-            itm_pos = wx_append.bind(self).call(itm, data[ix])
-            client_data_store.insert(itm_pos, data[ix])
-          end
-        else
-          offs = get_count
-          itm_pos = wx_append.bind(self).call(item)
-          item.size.times { |ix| set_client_data(offs+ix, data[ix]) }
-        end
+    # 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
-        itm_pos = wx_append.bind(self).call(item, data)
-        client_data_store.insert(itm_pos, data)
+        wx_get_client_object.bind(self).call(*args)
       end
-    else
-      if ::Array === item
-        if sorted?
-          item.each_with_index do |itm, ix|
-            itm_pos = wx_append.bind(self).call(itm, data[ix])
-            client_data_store.insert(itm_pos, nil)
-          end
-        else
-          itm_pos = wx_append.bind(self).call(item)
-          client_data_store.concat(::Array.new(item.size))
-        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
-        itm_pos = wx_append.bind(self).call(item)
-        client_data_store.insert(itm_pos, nil)
+        wx_set_client_object.bind(self).call(*args)
       end
     end
-    itm_pos
-  end
+    # redefine aliases
+    alias :client_object :get_client_object
+    alias :client_object= :set_client_object
 
-  wx_insert = instance_method :insert
-  define_method :insert do |item, pos, data=nil|
-    itm_pos = -1
-    if data
-      if ::Array === item
-        if !(::Array === data)
-          ::Kernel.raise ::TypeError.new("Expected Array for argument 3")
-        elsif data.size != item.size
-          ::Kernel.raise ::ArgumentError.new("item and data array must be equal size")
-        end
-        if sorted?
-          item.each_with_index do |itm, ix|
-            itm_pos = wx_insert.bind(self).call(itm, data[ix])
-            client_data_store.insert(itm_pos, data[ix])
-          end
-        else
-          itm_pos = wx_insert.bind(self).call(item, pos)
-          client_data_store.insert(pos, *::Array.new(item.size))
-          item.size.times { |ix| set_client_data(pos+ix, data[ix]) }
-        end
-      else
-        itm_pos = wx_insert.bind(self).call(item, pos, data)
-        client_data_store.insert(itm_pos, data)
-      end
-    else
-      if ::Array === item
-        if sorted?
-          item.each_with_index do |itm, ix|
-            itm_pos = wx_insert.bind(self).call(itm)
-            client_data_store.insert(itm_pos, nil)
-          end
-        else
-          itm_pos = wx_insert.bind(self).call(item, pos)
-          client_data_store.insert(pos, *::Array.new(item.size))
-        end
+    alias :get_client_data :get_client_object
+    alias :set_client_data :set_client_object
+
+    alias :has_client_data :has_client_object_data
+    alias :has_client_data? :has_client_object_data
+
+    alias :get_item_data :get_client_object
+    alias :set_item_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
-        itm_pos = wx_insert.bind(self).call(item, pos)
-        client_data_store.insert(pos, nil)
+        ::Enumerator.new { |y| wx_each_string.bind(self).call { |ln| y << ln } }
       end
     end
-    itm_pos
-  end
 
-  wx_set = instance_method :set
-  define_method :set do |items, data=nil|
-    if data
-      if !(::Array === data)
-        ::Kernel.raise ::TypeError.new("Expected Array for argument 2")
-      elsif data.size != items.size
-        ::Kernel.raise ::ArgumentError.new("items and data array must be equal size")
-      end
-    end
-    wx_set.bind(self).call(items)
-    client_data_store.clear
-    if data
-      items.each_with_index { |item, ix| set_client_data(item, data[ix]) }
-    end
-  end
+    # define these aliases so controls like ComboBox and OwnerDrawnComboBox and the like all end up with
+    # similar methods
 
-  wx_clear = instance_method :clear
-  define_method :clear do
-    wx_clear.bind(self).call
-    client_data_store.clear
-  end
+    alias :get_list_selection :get_selection
+    alias :set_list_selection :set_selection
+
+    alias :get_list_string_selection :get_string_selection
+    alias :set_list_string_selection :set_string_selection
 
-  wx_delete = instance_method :delete
-  define_method :delete do |item|
-    wx_delete.bind(self).call(item.to_i)
-    client_data_store.slice!(item.to_i)
   end
+
 end

data/lib/wx/core/enum.rb

@@ -29,11 +29,27 @@ class Wx::Enum
   end
 
   def !
-    self.to_i == 0
+    to_i == 0
+  end
+
+  def allbits?(mask)
+    to_i.allbits?(mask)
+  end
+
+  def anybits?(mask)
+    to_i.anybits?(mask)
+  end
+
+  def nobits?(mask)
+    to_i.nobits?(mask)
   end
 
   def hash
     @value.hash
   end
 
+  def to_s
+    to_i.to_s
+  end
+
 end

data/lib/wx/core/event.rb

@@ -29,7 +29,7 @@ module Wx
     alias :id :get_id
   end
 
-  class Wx::CommandEvent
+  class CommandEvent
 
     # overload the #initialize method to add a check on a
     # correct match between EventType and event class
@@ -43,6 +43,11 @@ module Wx
       end
     end
 
+    alias :set_client_data :set_client_object
+    alias :client_data= :set_client_object
+    alias :get_client_data :get_client_object
+    alias :client_data :get_client_object
+
   end
 
   # reduce mapping warnings for this unpublished event class

data/lib/wx/core/evthandler.rb

@@ -10,6 +10,12 @@
 # EvtHandler. This includes all Wx::Window subclasses and Wx::App.
 
 class Wx::EvtHandler
+
+  alias :set_client_data :set_client_object
+  alias :client_data= :set_client_object
+  alias :get_client_data :get_client_object
+  alias :client_data :get_client_object
+
   # EventType is an internal class that's used to set up event handlers
   # and mappings.
   # * 'name' is the name of the event handler method in ruby
@@ -182,7 +188,7 @@ class Wx::EvtHandler
       # check arity <= 1
       if h_meth.arity>1
         Kernel.raise ArgumentError,
-                     "Event handler should not accept more than at most a single argument"
+                     "Event handler should not accept more than at most a single argument",
                      caller
       end
       # wrap method without any argument in anonymous proc to prevent strict argument checking
@@ -193,7 +199,7 @@ class Wx::EvtHandler
       end
     else
       Kernel.raise ArgumentError,
-                  "Specify event handler with a method, name, proc OR block"
+                  "Specify event handler with a method, name, proc OR block",
                   caller
     end
   end

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/notebook.rb

@@ -8,15 +8,17 @@
 
 # Displays a set of pages in parallel using tabs
 
-class Wx::Notebook
-  # Convenience method for iterating pages
-  def each_page
-    if block_given?
-      0.upto(get_page_count - 1) do | i |
-        yield get_page(i)
+module Wx
+  class Notebook
+    # Convenience method for iterating pages
+    def each_page
+      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
-    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/peristent_object.rb

@@ -0,0 +1,15 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+module Wx
+
+  class PersistentObject
+
+    # make these protected
+    protected :save_value
+    protected :restore_value
+
+  end
+
+end