wxruby3 0.9.0.pre.rc.3 → 0.9.0

data/lib/wx/core/window.rb

@@ -1,3 +1,11 @@
+# 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
+
 # Copyright 2004-2007 by Kevin Smith
 # Copyright 2022 by Martin Corino
 # released under the MIT(-style) wxruby2/3 license

data/lib/wx/core/window_update_locker.rb

@@ -1,5 +1,14 @@
+# 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
+
 # Emulates the wxWidgets WindowUpdateLocker class, by providing a scope within
 # which window can be updated without refreshing
+
 class Wx::WindowUpdateLocker
   # Only one class method accepting a window that will be
   # frozen while the block is executed

data/lib/wx/core/xmlresource.rb

@@ -1,3 +1,11 @@
+# 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::XmlResource
   class << self
     wx_get = self.instance_method(:get)

data/lib/wx/core.rb

@@ -1,5 +1,8 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
 # Wx core package loader for wxRuby3
-# Copyright (c) M.J.N. Corino, The Netherlands
 
 require_relative './startup' if File.exist?(File.join(__dir__, 'startup.rb'))
 

data/lib/wx/doc/app.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::App
 
@@ -37,4 +43,4 @@ class Wx::App
   def get_mac_exit_menu_itemid(id) end
   alias :mac_exit_menu_itemid :get_mac_exit_menu_itemid
   
-end
+end

data/lib/wx/doc/array_ext.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 

data/lib/wx/doc/art_locator.rb

@@ -1,7 +1,14 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
 
 
 # This module provides and standardizes support for locating application art files.
 #
+# :startdoc:
+
+
 module Wx::ArtLocator
 
   # Default name of art folder.

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

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::AUI::AuiManager
 

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

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::AUI::AuiNotebook
 

data/lib/wx/doc/bitmap.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 
@@ -11,13 +17,15 @@ module Wx
   # Searches for an art file with basename 'name' and creates a Bitmap if found.
   # Raises an ArgumentError if not found.
   # Wx::ArtLocator::find_art is used to look up the art file using ::Kernel#caller_locations to
-  # determine the values for the 'art_path' and 'art_owner' arguments ('art_path' is set to the
-  # absolute path to the folder holding the caller's code and 'art_owner' to the basename of the
-  # caller's source file). The 'art_type' argument is set to <code>:icon</code>.
+  # determine the values for the 'art_path' and 'art_section' arguments if not specified here
+  # ('art_path' is set to the absolute path to the folder holding the caller's code and 'art_section'
+  # to the basename of the caller's source file). The 'art_type' argument is set to <code>:bitmap</code>.
   # @param [String,Symbol] name base name of art file
   # @param [Wx::BitmapType,nil] bmp_type bitmap type for art file (nil means any supported type)
+  # @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
   # @return [Wx::Bitmap]
   # @see Wx::ArtLocator::find_art
-  def self.Bitmap(name, bmp_type = nil); end
+  def self.Bitmap(name, bmp_type = nil, art_path: nil, art_section: nil); end
 
 end

data/lib/wx/doc/brush.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 

data/lib/wx/doc/busy_info.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 

data/lib/wx/doc/client_dc.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 

data/lib/wx/doc/clipboard.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::Clipboard
 

data/lib/wx/doc/colour_dialog.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::ColourDialog
 

data/lib/wx/doc/config.rb

@@ -0,0 +1,190 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  # {Wx::ConfigBase} defines the basic interface of all config classes.
+  # In Ruby this class is an empty placeholder providing access to the static
+  # {Wx::ConfigBase.create}, {Wx::ConfigBase.set} and {Wx::ConfigBase.get}
+  # methods as well as providing the base for a similar inheritance hierarchy
+  # 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.
+    # 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
+
+    # 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
+    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
+    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
+      # @yieldparam [Boolean,String,Integer,Float] value entry value
+      # @return [Object,Enumerator] either the last result of the executed block or an enumerator if no block given
+      def each_entry(&block) end
+
+      # Iterate all group 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
+      # @yieldparam [Wx::Config::Group] value entry value
+      # @return [Object,Enumerator] either the last result of the executed block or an enumerator if no block given
+      def each_group(&block) end
+
+      # Returns the total number of value 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_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
+
+      # 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
+      # relative segments embedded ('.' and '..' are supported).
+      # @param [String] path_str entry path
+      # @return [Boolean] true if entry exists, false otherwise
+      def has_entry?(path_str) end
+
+      # Returns if a group entry exists matching the given path string.
+      # Path strings can be absolute (starting with {SEPARATOR}) or relative to the current object and can have
+      # relative segments embedded ('.' and '..' are supported).
+      # @param [String] path_str entry path
+      # @return [Boolean] true if entry exists, false otherwise
+      def has_group?(path_str) end
+
+      # Returns a value for an entry at the current object identified by `key`.
+      # @param [String] key entry key
+      # @return [Boolean,String,Integer,Float,Wx::Config::Group,nil] value entry value
+      def get(key) end
+
+      # Sets a value for an entry at the current object identified by `key` or deletes the entry if `val` is nil.
+      # Returns the new value for the entry.
+      # Group entries can be set using Hash values (entry values in the hash will be sanitized).
+      # @param [String] key entry key
+      # @param [Boolean,String,Integer,Float,Hash,nil] val entry value
+      # @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
+      # @return [Boolean,String,Integer,Float,Hash,nil] entry value
+      def delete(key) 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
+      # @param [String] new_key new entry key
+      # @return [Boolean] true if the entry was renamed, false otherwise
+      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.
+      # @param [String] path_str
+      # @return [Boolean,String,Integer,Float,Wx::Config::Group,nil] value entry value
+      def [](path_str) end
+
+      # Sets a value for an entry from the configuration identified by `path_str` or deletes the entry if `val` is nil.
+      # Returns the new value for the entry.
+      # Group entries can be set using Hash values (entry values in the hash will be sanitized).
+      # @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
+
+      # Returns the path string for the current configuration object.
+      # @return [String]
+      def to_s; end
+
+      # Returns the Hash object used to store the settings for the current configuration object.
+      # @return [Hash]
+      def to_h; end
+
+      # Returns true if the current configuration object is the root (Wx::Config) object, false otherwise
+      # (for Wx::Config::Group objects).
+      # @return [Boolean]
+      def root?; end
+
+      # Returns the root (Wx::Config) object
+      # @return [Wx::Config] root configuration object
+      def root; end
+
+      # Returns the path segment array for the current configuration object.
+      # @return [Array<String>] path array
+      def path; end
+
+      # Returns the parent configuration object or nil if this for the root object.
+      # @return [Wx::Config,Wx::Config::Group,nil] root object
+      def parent; end
+
+    end
+
+    class Group
+
+      include Interface
+
+    end
+
+    include Interface
+
+    # Constructor.
+    # @param [Hash] hash optional Hash initializing configuration object
+    # @return [Wx::Config]
+    def initialize(hash = nil)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
+
+  end
+
+end

data/lib/wx/doc/const.rb

@@ -1,3 +1,10 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
 module Wx
 
 =begin

data/lib/wx/doc/controlwithitems.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::ControlWithItems
 

data/lib/wx/doc/core.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 

data/lib/wx/doc/cursor.rb

@@ -1,16 +1,24 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
 
-class Wx::Cursor
+
+class Wx
 
   # Searches for an art file with basename 'name' and creates a Cursor if found.
   # Raises an ArgumentError if not found.
   # Wx::ArtLocator::find_art is used to look up the art file using ::Kernel#caller_locations to
-  # determine the values for the 'art_path' and 'art_owner' arguments ('art_path' is set to the
-  # absolute path to the folder holding the caller's code and 'art_owner' to the basename of the
-  # caller's source file). The 'art_type' argument is set to <code>:icon</code>.
+  # determine the values for the 'art_path' and 'art_section' arguments if not specified here
+  # ('art_path' is set to the absolute path to the folder holding the caller's code and 'art_section'
+  # to the basename of the caller's source file). The 'art_type' argument is set to <code>:cursor</code>.
   # @param [String,Symbol] name base name of art file
   # @param [Wx::BitmapType,nil] bmp_type bitmap type for art file (nil means any supported type)
+  # @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
   # @return [Wx::Cursor]
   # @see Wx::ArtLocator::find_art
-  def self.Cursor(name, bmp_type = nil); end
+  def self.Cursor(name, bmp_type = nil, art_path: nil, art_section: nil); end
 
 end

data/lib/wx/doc/data_object.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 

data/lib/wx/doc/datetime.rb

@@ -0,0 +1,16 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  # Default/Null time (mostly equates to `now`).
+  DEFAULT_DATE_TIME = nil
+
+  # Default/Null time (mostly equates to `now`).
+  DefaultDateTime = DEFAULT_DATE_TIME
+
+end

data/lib/wx/doc/dc.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
   class DC

data/lib/wx/doc/enum.rb

@@ -1,7 +1,14 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+
 ###
 # wxRuby3 Enum class
-# Copyright (c) M.J.N. Corino, The Netherlands
 ###
+# :startdoc:
+
 
 
 module Wx

data/lib/wx/doc/event.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 
@@ -21,4 +27,10 @@ module Wx
 
   end
 
+  # Find a window with the focus, that is also a descendant of the given window.
+  # This is used to determine the window to initially send commands to.
+  # @param [Wx::Window] ancestor
+  # @return [Wx::Window,nil] descendant window of ancestor with focus
+  def self.find_focus_descendant(ancestor) end
+
 end

data/lib/wx/doc/event_blocker.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 

data/lib/wx/doc/event_loop.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 

data/lib/wx/doc/events.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 

data/lib/wx/doc/evthandler.rb

@@ -1,4 +1,12 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+
 # Additional event handler methods documentation stubs.
+# :startdoc:
+
 
 
 class Wx::EvtHandler