wxruby3 0.9.2 → 0.9.4

data/lib/wx/core/persistence_manager.rb

@@ -0,0 +1,39 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+module Wx
+
+  # Function used to create the correct persistent adapter for the given object.
+  def self.create_persistent_object(obj)
+    obj.create_persistent_object
+  end
+
+  # A shorter synonym for {Wx::PersistenceManager#register_and_restore}.
+  def self.persistent_register_and_restore(obj, name=nil)
+    obj.name = name if name && !name.empty?
+    PersistenceManager.get.register_and_restore(obj)
+  end
+
+  class PersistenceManager
+
+    class << self
+
+      # Cache the global instance to keep it safe from GC
+
+      wx_get = instance_method :get
+      define_method :get do
+        @the_manager ||= wx_get.bind(self).call
+      end
+
+      wx_set = instance_method :set
+      define_method :set do |pman|
+        wx_set.bind(self).call(pman)
+        @the_manager = pman
+      end
+
+    end
+
+  end
+
+end

data/lib/wx/core/persistent_window.rb

@@ -0,0 +1,16 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+module Wx
+
+  class PersistentWindowBase < PersistentObject
+
+    alias :get :get_object
+
+  end
+
+  # class alias
+  PersistentWindow = PersistentWindowBase
+
+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)
 

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

@@ -0,0 +1,16 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+module Wx
+
+  class TopLevelWindow
+
+    # create PersistentObject for toplevel windows (incl. Dialog and Frame)
+    def create_persistent_object
+      PersistentTLW.new(self)
+    end
+
+  end
+
+end

data/lib/wx/core/treebook.rb

@@ -0,0 +1,18 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+require_relative './book_ctrl_base'
+
+module Wx
+
+  class Treebook
+
+    # Creates PersistentObject for this treebook control instance.
+    def create_persistent_object
+      PersistentTreeBookCtrl.new(self)
+    end
+
+  end
+
+end

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

data/lib/wx/core.rb

@@ -49,6 +49,10 @@ end
 ::Wx.include(WxRubyStyleAccessors)
 
 ::Wx.include((defined?(::WX_GLOBAL_CONSTANTS) && ::WX_GLOBAL_CONSTANTS) ? WxGlobalConstants : WxEnumConstants)
+# Provide support for finding enumerator constants for nested enums in Wx::Object derived classes without
+# full scoping. This does not cover non Wx::Object derived classes with nested enums in the Wx hierarchy
+# but there should not be too many of those.
+::Wx::Object.include(WxEnumConstants)
 
 # Load in syntax sweeteners
 require 'wx/keyword_defs'

data/lib/wx/doc/art_locator.rb

@@ -59,6 +59,7 @@ module Wx
       # @param [String,nil] art_path base path to look up the art file
       # @param [String,nil] art_section optional owner folder name for art files
       # @param [Wx::BitmapType,nil] bmp_type bitmap type of art file
+      # @return [String,nil] full path of art file or nil if not found
       def find_art(art_name, art_type: nil, art_path: nil, art_section: nil, bmp_type: nil) end
 
     end

data/lib/wx/doc/book_ctrl_base.rb

@@ -0,0 +1,19 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  class BookCtrlBase < Control
+
+    # Creates PersistentObject for this book control instance (incl. ChoiceBook, ListBook and NoteBook).
+    # @see Wx.create_persistent_object
+    # @return [Wx::PersistentBookCtrl]
+    def create_persistent_object; end
+
+  end
+
+end

data/lib/wx/doc/comboctrl.rb

@@ -0,0 +1,18 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  class OwnerDrawnComboBox < ComboCtrl
+
+    alias :get_item_data :get_client_object
+
+    alias :set_item_data :set_client_object
+
+  end
+
+end

data/lib/wx/doc/config.rb

@@ -14,53 +14,35 @@ module Wx
   # as in C++.
   class ConfigBase
 
-    # Create a new config object and sets it as the current one unless a global Ruby config was already created/installed.
+    # Create a new config instance and sets it as the current one unless a global config was already created/installed. If
+    # forced_create is true any existing global config will be replaced by a new config instance.
     # This function will create the most appropriate implementation of Wx::ConfigBase available for the current platform.
-    # In Ruby this means that a Wx::Config instance will created and appropriately wrapped in C++.
-    # @return [Wx::Config] the current configuration object
-    def self.create; end
+    # If use_hash_config is true this means that a Wx::Config instance will created and appropriately wrapped in C++
+    # otherwise the default C++ config for the current/active platform will be used.
+    # @param [Boolean] forced_create specifies to force replacing any existing global config if true
+    # @param [Boolean] use_hash_config specifies to create a Ruby Hash based config when required if true
+    # @return [Wx::ConfigBase] the current configuration object
+    def self.create(forced_create=false, use_hash_config: false) end
 
     # Sets the config object as the current one, returns the previous current object (both the parameter and returned
     # value may be nil).
-    # @param [Wx::Config,nil] config the config object to install
-    # @return [Wx::Config] the previous current configuration object
+    # @param [Wx::ConfigBase,nil] config the config object to install
+    # @return [Wx::ConfigBase] the previous current configuration object
     def self.set(config) end
 
     # Get the current config object.
-    # If there is no current object and create_on_demand is true, this creates one.
-    # @param [Boolean] create_on_demand specifies whether to create a configuration object is none has been created/installed before
-    # @return [Wx::Config,nil] the current configuration object
+    # If there is no current object and create_on_demand is true, this creates a default config instance appropriate for
+    # the current/active platform (registry based for Windows and file based otherwise).
+    # @param [Boolean] create_on_demand specifies whether to create a configuration object if none has been created/installed before
+    # @return [Wx::ConfigBase,nil] the current configuration object
     def self.get(create_on_demand=true) end
 
-  end
-
-  # Configuration class for wxRuby which stores it's settings in a (possibly nested) Hash.
-  # This way configurations can be easily persisted using any commonly used Ruby methods like
-  # YAML or JSON files.
-  #
-  # Wx::Config supports Boolean (true or false), Integer, Float and String values and nested groups
-  # (essentially nested hashes). Any entry values set will be sanitized to match the supported types, i.e.
-  # if the value matches a supported type the value is accepted unaltered otherwise Integer (`to_int`), Float (`to_f`)
-  # or String (`to_s`) coercion are applied (in that order). Hash values are installed as nested groups.
-  #
-  # Like the C++ wxConfigBase derivatives Wx::Config supports arbitrary access using path strings which support
-  # absolute paths ('/xxxx') and relative paths ('xxx/xxx', '../xxx', './xxxx'). Relative segments can also be
-  # embedded in the path strings ('/aaa/bbb/../ccc').
-  class Config < ConfigBase
-
     # Config path separator
     SEPARATOR = '/'
 
     # Common configuration access methods for either the root object or any nested group objects.
     module Interface
 
-      # Iterate all settings at the current object (no recursion).
-      # Passes key/value pairs to the given block or returns an Enumerator is no block given.
-      # @yieldparam [String] key setting key
-      # @yieldparam [Boolean,String,Integer,Float,Wx::Config::Group] value setting value
-      # @return [Object,Enumerator] either the last result of the executed block or an enumerator if no block given
-      def each(&block) end
-
       # Iterate all value entries at the current object (no recursion).
       # Passes key/value pairs to the given block or returns an Enumerator is no block given.
       # @yieldparam [String] key entry key
@@ -79,13 +61,13 @@ module Wx
       # any nested groups (if recurse is true)
       # @param [Boolean] recurse
       # @return [Integer] count
-      def number_of_entries(recurse: false) end
+      def number_of_entries(recurse=false) end
 
       # Returns the total number of group entries at the current object only (if recurse is false) or including
       # any nested groups (if recurse is true)
       # @param [Boolean] recurse
       # @return [Integer] count
-      def number_of_groups(recurse: false) end
+      def number_of_groups(recurse=false) end
 
       # Returns if a value entry exists matching the given path string.
       # Path strings can be absolute (starting with {SEPARATOR}) or relative to the current object and can have
@@ -114,10 +96,10 @@ module Wx
       # @return [Boolean,String,Integer,Float,Wx::Config::Group,nil] value entry value
       def set(key, val) end
 
-      # Removes the entry at the current object identified by `key` if it exists and returns it's value.
-      # @param [String] key entry key
+      # Removes the entry identified by `path_str` if it exists and returns it's value.
+      # @param [String] path_str entry path
       # @return [Boolean,String,Integer,Float,Hash,nil] entry value
-      def delete(key) end
+      def delete(path_str) end
 
       # Changes key for the entry at the current object identified by `old_key` to `new_key` if it exists.
       # @param [String] old_key current entry key
@@ -126,7 +108,17 @@ module Wx
       def rename(old_key, new_key) end
 
       # Returns a value for an entry from the configuration identified by `path_str`.
-      # Allows arbitrary access though the entire configuration using absolute or relative paths.
+      # Provides arbitrary access though the entire configuration using absolute or relative paths.
+      # Supports coercing configuration values to a specified output type (Integer,Float,String,TrueClass,FalseClass).
+      # By default returns un-coerced value.
+      # Raises exception if incompatible coercion is specified.
+      # @param [String] path_str
+      # @param [Class,Proc,nil] output output type (or converter proc) to convert to (with)
+      # @return [Boolean,String,Integer,Float,Wx::Config::Group,nil] value entry value
+      def read(path_str, output=nil) end
+
+      # Returns a value for an entry from the configuration identified by `path_str`.
+      # Provides arbitrary access though the entire configuration using absolute or relative paths.
       # @param [String] path_str
       # @return [Boolean,String,Integer,Float,Wx::Config::Group,nil] value entry value
       def [](path_str) end
@@ -137,7 +129,8 @@ module Wx
       # @param [String] path_str
       # @param [Boolean,String,Integer,Float,Hash,nil] val entry value
       # @return [Boolean,String,Integer,Float,Wx::Config::Group,nil] value entry value
-      def []=(path_str, val) end
+      def write(path_str, val) end
+      alias :[]= :write
 
       # Returns the path string for the current configuration object.
       # @return [String]
@@ -166,25 +159,92 @@ module Wx
 
     end
 
+  end
+
+  # This is an abstract class wrapping the default C++ Config class for the active platform
+  # (on Windows this would be `wxRegConfig` and `wxFileConfig` otherwise).
+  #
+  # Unless {Wx::ConfigBase.create} or {Wx::ConfigBase.set} has been called this is what will be
+  # returned by {Wx::ConfigBase.get}.
+  class ConfigWx < ConfigBase
+
+    class Group
+
+      include ConfigBase::Interface
+
+    end
+
+    include ConfigBase::Interface
+
+    # Deletes all configuration content and returns true if successful.
+    # Also deletes any persisted storage (files or registry entries).
+    # @return [Boolean]
+    def clear; end
+
+    # Replaces the configuration content with the content of the provided Hash.
+    # @param [Hash] hash content to replace configuration
+    # @return [self]
+    def replace(hash) end
+
+    # Returns true if we are expanding environment variables in string values, false otherwise.
+    # @return [Boolean]
+    def is_expanding_env_vars; end
+    alias :expanding_env_vars? :is_expanding_env_vars
+
+    # Determine whether we wish to expand environment variables in string values.
+    # @param [Boolean] flag enables expanding environment variables if true, disables otherwise
+    def set_expand_env_vars(flag) end
+    alias :expand_env_vars :set_expand_env_vars
+
+  end
+
+  # Configuration class for wxRuby which stores it's settings in a (possibly nested) Hash.
+  # This way configurations can be easily persisted using any commonly used Ruby methods like
+  # YAML or JSON files.
+  #
+  # Wx::Config supports Boolean (true or false), Integer, Float and String values and nested groups
+  # (essentially nested hashes). Any entry values set will be sanitized to match the supported types, i.e.
+  # if the value matches a supported type the value is accepted unaltered otherwise Integer (`to_int`), Float (`to_f`)
+  # or String (`to_s`) coercion are applied (in that order). Hash values are installed as nested groups.
+  #
+  # Like the C++ wxConfigBase derivatives Wx::Config supports arbitrary access using path strings which support
+  # absolute paths ('/xxxx') and relative paths ('xxx/xxx', '../xxx', './xxxx'). Relative segments can also be
+  # embedded in the path strings ('/aaa/bbb/../ccc').
+  class Config < ConfigBase
+
     class Group
 
-      include Interface
+      include ConfigBase::Interface
 
     end
 
-    include Interface
+    include ConfigBase::Interface
 
     # Constructor.
     # @param [Hash] hash optional Hash initializing configuration object
     # @return [Wx::Config]
     def initialize(hash = nil)end
 
+    # Deletes all configuration content and returns if successful.
+    # @return [true]
+    def clear; end
+
     # Replaces the configuration content with the content of the provided Hash.
     # Values will be sanitized (see {Wx::Config}).
     # @param [Hash] hash content to replace configuration
     # @return [self]
     def replace(hash) end
 
+    # Returns true if we are expanding environment variables in string values, false otherwise.
+    # @return [Boolean]
+    def is_expanding_env_vars; end
+    alias :expanding_env_vars? :is_expanding_env_vars
+
+    # Determine whether we wish to expand environment variables in string values.
+    # @param [Boolean] flag enables expanding environment variables if true, disables otherwise
+    def set_expand_env_vars(flag) end
+    alias :expand_env_vars :set_expand_env_vars
+
   end
 
 end

data/lib/wx/doc/controlwithitems.rb

@@ -9,6 +9,14 @@ module Wx
 
   class ControlWithItems
 
+    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
+
     # Yield each string to the given block.
     # Returns an Enumerator if no block given.
     # @yieldparam [String] string the string yielded
@@ -22,6 +30,14 @@ module Wx
     def is_sorted; end
     alias :sorted? :is_sorted
 
+    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
+
   end
 
 end

data/lib/wx/doc/date_picker_ctrl.rb

@@ -0,0 +1,23 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  class DatePickerCtrl < Control
+
+    # If the control had been previously limited to a range of dates using #set_range, returns the lower and upper bounds of this range.
+    #
+    # If no range is set (or only one of the bounds is set), dt1 and/or dt2 are set to be invalid.
+    #
+    # Notice that when using a native MSW implementation of this control the lower range is always set, even
+    # if #set_range hadn't been called explicitly, as the native control only supports dates later than year 1601.
+    # @return [Array(Time, Time),nil] a set with the lower and upper range limit or nil if no range previously set
+    def get_range; end
+
+  end
+
+end

data/lib/wx/doc/editable_listbox.rb

@@ -0,0 +1,44 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  class EditableListBox < Panel
+
+    # Returns list control of composite.
+    # @return [Wx::ListCtrl]
+    def get_list_ctrl; end
+    alias :list_ctrl :get_list_ctrl
+
+    # Returns button of composite.
+    # @return [Wx::BitmapButton]
+    def get_del_button; end
+    alias :del_button :get_del_button
+
+    # Returns button of composite.
+    # @return [Wx::BitmapButton]
+    def get_new_button; end
+    alias :new_button :get_new_button
+
+    # Returns button of composite.
+    # @return [Wx::BitmapButton]
+    def get_up_button; end
+    alias :up_button :get_up_button
+
+    # Returns button of composite.
+    # @return [Wx::BitmapButton]
+    def get_down_button; end
+    alias :down_button :get_down_button
+
+    # Returns button of composite.
+    # @return [Wx::BitmapButton]
+    def get_edit_button; end
+    alias :edit_button :get_edit_button
+
+  end
+
+end

data/lib/wx/doc/enum.rb

@@ -68,6 +68,21 @@ module Wx
     # @return [Boolean]
     def !; end
 
+    # Returns true if all bits that are set (=1) in mask are also set in self; returns false otherwise.
+    # @param [Integer] mask
+    # @return [Boolean]
+    def allbits?(mask) end
+
+    # Returns true if any bit that is set (=1) in mask is also set in self; returns false otherwise.
+    # @param [Integer] mask
+    # @return [Boolean]
+    def anybits?(mask) end
+
+    # Returns true if no bit that is set (=1) in mask is also set in self; returns false otherwise.
+    # @param [Integer] mask
+    # @return [Boolean]
+    def nobits?(mask) end
+
     # Return next integer value from enum's value.
     # @return [Integer] next integer value
     def succ; end

data/lib/wx/doc/event.rb

@@ -27,4 +27,16 @@ module Wx
 
   end
 
+  class CommandEvent < Event
+
+    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
+
 end