wxruby3 0.9.0.pre.beta.8

data/lib/wx/doc/system_settings.rb

@@ -0,0 +1,29 @@
+
+class Wx::SystemSettings
+
+  # Return the name of the current system appearance if available or empty string otherwise.
+  #
+  # This is currently only implemented for macOS and returns a not necessarily user-readable
+  # string such as "NSAppearanceNameAqua" there and an empty string under all the other platforms.
+  # @return [String]
+  def get_appearance_name; end
+  alias :appearance_name :get_appearance_name
+
+  # Return true if the current system there is explicitly recognized as being a dark theme or if
+  # the default window background is dark.
+  #
+  # This method should be used to check whether custom colours more appropriate for the default (light)
+  # or dark appearance should be used.
+  # return [true,false]
+  def is_appearance_dark; end
+  alias :appearance_dark? :is_appearance_dark
+
+  # Return true if the default window background is significantly darker than foreground.
+  #
+  # This is used by #is_appearance_dark if there is no platform-specific way to determine whether a dark
+  # mode is being used and is generally not very useful to call directly.
+  # return [true,false]
+  def is_appearance_using_dark_background; end
+  alias :appearance_using_dark_background? :is_appearance_using_dark_background
+
+end

data/lib/wx/doc/treebook.rb

@@ -0,0 +1,9 @@
+
+class Wx::Treebook
+
+  # Returns the Wx::TreeCtrl used for this Treebook
+  # @return [Wx::TreeCtrl] the tree control
+  def get_tree_ctrl; end
+  alias :tree_ctrl :get_tree_ctrl
+
+end

data/lib/wx/doc/variant.rb

@@ -0,0 +1,163 @@
+
+class Wx::Variant
+
+  include ::Enumerable
+
+  # When a block is given iterates all items of a variant list passing
+  # each item to the block.
+  # Returns an enumerator when no block is given.
+  # @overload each(&block)
+  #   @yieldparam item [Wx::Variant] variant list item
+  #   @return [Object] result of last block execution
+  # @overload each
+  #   @return [Enumerator] an enumerator
+  def each; end
+
+  # Replaces the value of the current variant with the given value
+  # @overload assign(value)
+  #   Equality test operator.
+  #   @param value [Wx::Variant]
+  #   @return [self]
+  # @overload assign(value)
+  #   Equality test operator.
+  #   @param value [String]
+  #   @return [self]
+  # @overload assign(value)
+  #   Equality test operator.
+  #   @param value [Integer]
+  #   @return [self]
+  # @overload assign(value)
+  #   Equality test operator.
+  #   @param value [true,false]
+  #   @return [self]
+  # @overload assign(value)
+  #   Equality test operator.
+  #   @param value [Float]
+  #   @return [self]
+  # @overload assign(value)
+  #   Equality test operator.
+  #   @param value [Integer]
+  #   @return [self]
+  # @overload assign(value)
+  #   Equality test operator.
+  #   @param value [Integer]
+  #   @return [self]
+  # @overload assign(value)
+  #   Equality test operator.
+  #   @param value [Object]
+  #   @return [self]
+  # @overload assign(value)
+  #   Equality test operator.
+  #   @param value [Wx::Object]
+  #   @return [self]
+  # @overload assign(value)
+  #   Equality test operator.
+  #   @param value [Array<Wx::Variant>]
+  #   @return [self]
+  # @overload assign(value)
+  #   Equality test operator.
+  #   @param value [Array<String>]
+  #   @return [self]
+  # @overload assign(value)
+  #   Equality test operator.
+  #   @param value [Time,Date,DateTime]
+  #   @return [self]
+  def assign(*args) end
+  alias :<< :assign
+
+  # Convert contained object to integer value if possible.
+  # Raises TypeError exception if incompatible.
+  # @return [Integer] integer value
+  def to_i; end
+
+  # Convert contained object to floating point value if possible.
+  # Raises TypeError exception if incompatible.
+  # @return [Float] floating point value
+  def to_f; end
+
+  # Convert contained object to string value if possible.
+  # Raises TypeError exception if incompatible.
+  # @return [String] string value
+  def to_s; end
+
+  # Checks if Variant contains a String value (not null).
+  # @return [true,false]
+  def string?; end
+
+  # Checks if Variant contains a boolean value (not null).
+  # @return [true,false]
+  def bool?; end
+
+  # Checks if Variant contains a long value (not null).
+  # @return [true,false]
+  def long?; end
+
+  # Checks if Variant contains a long long value (not null).
+  # @return [true,false]
+  def long_long?; end
+
+  # Checks if Variant contains an unsigned long long value (not null).
+  # @return [true,false]
+  def u_long_long?; end
+
+  # Checks if Variant contains an integer value (long|long long|unsigned long long).
+  # @return [true,false]
+  def integer?; end
+
+  # Checks if Variant contains a (wx)DateTime value (not null).
+  # (Note that the DateTime values in question concern wxDateTime
+  # and not the Ruby DateTime class; in fact wxDateTime is normally
+  # returned as a Ruby Time value)
+  # @return [true,false]
+  def date_time?; end
+
+  # Checks if Variant contains a double value (not null).
+  # @return [true,false]
+  def double?; end
+
+  # Checks if Variant contains an integer value (integer | double).
+  # @return [true,false]
+  def numeric?; end
+
+  # Checks if Variant contains a VariantList (array of Variant) value (not null).
+  # @return [true,false]
+  def list?; end
+
+  # Checks if Variant contains an ArrayString (array of String) value (not null).
+  # @return [true,false]
+  def array_string?; end
+
+  # Checks if Variant contains a Font value (not null).
+  # @return [true,false]
+  def font?; end
+
+  # Returns font value.
+  # @return [Wx::Font]
+  def get_font; end
+  alias :font :get_font
+
+  # Checks if Variant contains a Colour value (not null).
+  # @return [true,false]
+  def colour?; end
+
+  # Returns colour value.
+  # @return [Wx::Colour]
+  def get_colour; end
+  alias :colour :get_colour
+
+  # Checks if Variant contains a ColourPropertyValue value (not null).
+  # @return [true,false]
+  def colour_property_value?; end
+
+  # Returns colour property value.
+  # @return [Wx::PG::ColourPropertyValue]
+  def get_colour_property_value; end
+  alias :colour_property_value :get_colour_property_value
+
+  # Checks if Variant contains an unspecified Ruby object (not null or
+  # nil and not one of the other value types).
+  # @param [Class] klass the (base) class of the Ruby object to check
+  # @return [true,false]
+  def object?(klass=Object) end
+
+end

data/lib/wx/doc/xml_resource.rb

@@ -0,0 +1,19 @@
+# Wx Xml Resource
+#
+# Documentation stubs for Wx Xml Resource classes
+
+
+module Wx
+
+  # Abstract base class for XRC subclass factories.
+  # Derived classes **must** override the #create method (base implementation returns nil).
+  class XmlSubclassFactory
+
+    # Factory method to create an object of the specified subclass.
+    # @param [String] subclass subclass name
+    # @return [Wx::Object] created subclass instance
+    def create(subclass) end
+
+  end
+
+end

data/lib/wx/global_const.rb

@@ -0,0 +1,84 @@
+# Global constant compatibility helper for wxRuby3
+# Copyright (c) M.J.N. Corino, The Netherlands
+
+module WxGlobalConstants
+
+  class << self
+    def search_nested(mod, sym)
+      # check any nested modules and/or (enum) classes
+      const_val = nil
+      mod.constants.each do |c|
+        case cv = mod.const_get(c)
+        when ::Class
+          if cv < Wx::Enum
+            # the only thing of interest in Enum classes are the enum values
+            const_val = cv[sym]
+          elsif cv.name.start_with?('Wx::') # only search Wx namespace
+            # prevent const_missing being triggered here since that may lead to unexpected results
+            const_val = cv.const_get(sym) if cv.constants.include?(sym)
+            const_val = search_nested(cv, sym) unless const_val
+          end
+        when ::Module
+          if cv.name.start_with?('Wx::') # only search Wx namespace
+            const_val = cv.const_get(sym) rescue nil
+          end
+        end unless mod == cv # watch out for infinite recursion
+        break if const_val
+      end
+      const_val
+    end
+  end
+
+  def self.included(mod)
+    # provides backwards compatibility by looking up
+    # nested constants as if everything is globally
+    # scoped
+    def mod.const_missing(sym)
+      # check for delayed constants
+      Wx.check_delayed_constant(self, sym)
+      # check any nested modules and/or (enum) classes
+      WxGlobalConstants.search_nested(self, sym) || super
+    end
+  end
+
+end
+
+module WxEnumConstants
+
+  class << self
+    def search_nested(mod, sym)
+      # check any nested enum classes
+      const_val = nil
+      mod.constants.each do |c|
+        if ::Class === (cv = mod.const_get(c)) && cv < Wx::Enum
+          # the only thing of interest in Enum classes are the enum values
+          const_val = cv[sym]
+        end
+        break if const_val
+      end
+      const_val
+    end
+  end
+
+  def self.included(mod)
+    # provides lookup for unscoped enum values
+    def mod.const_missing(sym)
+      # check any nested enum classes
+      WxEnumConstants.search_nested(self, sym) || super
+    end
+  end
+
+end
+
+# also take care of things when the Wx module itself is included somewhere
+module Wx
+  def self.included(mod)
+    def mod.const_missing(sym)
+      begin
+        return ::Wx.const_get(sym)
+      rescue NameError
+      end
+      super
+    end
+  end
+end

data/lib/wx/grid/grid.rb

@@ -0,0 +1,7 @@
+# A data-oriented editable table control.
+class Wx::GRID::Grid
+
+  alias :set_table :assign_table
+  alias :table= :assign_table
+
+end

data/lib/wx/grid/keyword_defs.rb

@@ -0,0 +1,10 @@
+# = WxSugar - Keyword Constructors Classes
+# Wx::Grid sub package for wxRuby3
+# Copyright (c) M.J.N. Corino, The Netherlands
+
+
+# wxGrid 	A grid (table) window
+Wx::define_keyword_ctors(Wx::GRID::Grid) do
+  wx_ctor_params :id, :pos, :size, :style => Wx::WANTS_CHARS
+  wx_ctor_params :name => 'grid'
+end

data/lib/wx/grid/require.rb

@@ -0,0 +1,9 @@
+# Wx::Grid sub package for wxRuby3
+# Copyright (c) M.J.N. Corino, The Netherlands
+
+#require_relative './ext'
+require_relative './events/evt_list'
+require_relative './keyword_defs'
+require_relative './grid'
+
+Wx::Dialog.setup_dialog_functors(Wx::GRID)

data/lib/wx/grid.rb

@@ -0,0 +1,14 @@
+# Wx::GRID sub package loader for wxRuby3
+# Copyright (c) M.J.N. Corino, The Netherlands
+
+
+require 'wx/core'
+
+require 'wxruby_grid'
+
+require_relative './grid/require'
+
+::Wx.include(WxRubyStyleAccessors)
+
+::Wx.include(::Wx::GRID) if defined?(::WX_GLOBAL_CONSTANTS) && ::WX_GLOBAL_CONSTANTS
+::Wx::GRID.include((defined?(::WX_GLOBAL_CONSTANTS) && ::WX_GLOBAL_CONSTANTS) ? WxGlobalConstants : WxEnumConstants)

data/lib/wx/helpers.rb

@@ -0,0 +1,65 @@
+# Various non-GUI helper functions for wxRuby3
+# Copyright (c) M.J.N. Corino, The Netherlands
+
+
+module Wx
+
+  # A named parameter in a Wx named-arg parameter list
+  Parameter = Struct.new( :name, :default_or_proc )
+
+  # Convert mixed positional / named args into a list to be passed to
+  # an underlying API method. +param_spec+ is an Array of Parameter
+  # structs containing the keyword name and default value for each
+  # possible argument. +mixed_args+ is an array which may optionally end
+  # with a set of named arguments
+  def self.args_as_list(param_spec, *mixed_args)
+
+    begin
+      # get keyword arguments from mixed args if supplied, else empty
+      kwa = mixed_args.last.kind_of?(Hash) ? mixed_args.pop : {}
+      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
+        if Proc === param.default_or_proc
+          arg = param.default_or_proc.call(arg) # provides default or converts arg
+        elsif arg.nil?
+          arg = param.default_or_proc # simple default value
+        end
+        out_args << arg
+      end
+    rescue
+      Kernel.raise ArgumentError, 
+                 "Bad arg composition of #{mixed_args.inspect}"
+    end
+
+    unless kwa.empty?
+      Kernel.raise ArgumentError, 
+                 "Unknown keyword argument(s) : #{kwa.keys.inspect}"
+    end
+
+    out_args
+  end
+
+  # Given an integer constant +int_const+, returns an array Wx constant
+  # names which have this value. If a string +prefix+ is supplied, find
+  # only constants whose names begin with this prefix. For example,
+  # passing "EVT" would return only constants with a name like
+  # Wx::EVT_XXX
+  # 
+  # This is primarily useful for debugging, when an unknown constant is
+  # returned, eg as an event type id.
+  def self.find_const(sought, prefix = "")
+    consts = constants.grep(/\A#{prefix}/)
+    consts.find_all do | c | 
+      c_val = const_get(c)
+      c_val.instance_of?(Fixnum) and c_val == sought
+    end
+  end
+
+  def self.has_feature?(featsym)
+    Wx::Setup.const_defined?(featsym) && !!Wx::Setup.const_get(featsym)
+  end
+end

data/lib/wx/html/htmlhelpcontroller.rb

@@ -0,0 +1,6 @@
+
+class Wx::HTML::HtmlHelpController
+  def self.instance(*args)
+    @instance ||= new(*args)
+  end
+end

data/lib/wx/html/htmlwindow.rb

@@ -0,0 +1,19 @@
+
+class Wx::HTML::HtmlWindow
+
+  # Need to override HtmlWindow.add_filter to provide cashing
+  # for the added custom html filters to prevent premature GC
+  class << self
+    def html_filters
+      @html_filters ||= []
+    end
+    private :html_filters
+
+    wx_add_filter = instance_method(:add_filter)
+    define_method(:add_filter) do |filter|
+      html_filters << filter
+      wx_add_filter.bind(self).call(filter)
+    end
+  end
+
+end

data/lib/wx/html/keyword_defs.rb

@@ -0,0 +1,22 @@
+# = WxSugar - Keyword Constructors Classes
+# Wx::HTML sub package for wxRuby3
+# Copyright (c) M.J.N. Corino, The Netherlands
+
+
+# wxHtmlWindow - Control for displaying HTML
+Wx::define_keyword_ctors(Wx::HTML::HtmlWindow) do
+  wx_ctor_params :id, :pos, :size, :style => Wx::HTML::HW_DEFAULT_STYLE
+  wx_ctor_params :name => 'htmlWindow'
+end
+
+# wxHtmlListBox 	A listbox showing HTML content
+# wxListBox 	A list of strings for single or multiple selection
+Wx::define_keyword_ctors('ListBox') do
+  wx_ctor_params :id, :pos, :size, :choices => []
+  wx_ctor_params :style
+  wx_ctor_params :validator, :name => 'listBox'
+end
+
+Wx::define_keyword_ctors('HtmlListBox') do
+  wx_ctor_params :id, :pos, :size, :style, :name => 'HtmlListBoxNameStr'
+end

data/lib/wx/html/require.rb

@@ -0,0 +1,10 @@
+# Wx::HTML sub package for wxRuby3
+# Copyright (c) M.J.N. Corino, The Netherlands
+
+#require_relative './ext'
+require_relative './events/evt_list'
+require_relative './keyword_defs'
+require_relative './htmlwindow'
+require_relative './htmlhelpcontroller'
+
+Wx::Dialog.setup_dialog_functors(Wx::HTML)

data/lib/wx/html.rb

@@ -0,0 +1,15 @@
+# Wx::HTML sub package loader for wxRuby3
+# Copyright (c) M.J.N. Corino, The Netherlands
+
+
+require 'wx/core'
+require 'wx/prt' if Wx.has_feature?(:USE_PRINTING_ARCHITECTURE)
+
+require 'wxruby_html'
+
+require_relative './html/require'
+
+::Wx.include(WxRubyStyleAccessors)
+
+::Wx.include(::Wx::HTML) if defined?(::WX_GLOBAL_CONSTANTS) && ::WX_GLOBAL_CONSTANTS
+::Wx::HTML.include((defined?(::WX_GLOBAL_CONSTANTS) && ::WX_GLOBAL_CONSTANTS) ? WxGlobalConstants : WxEnumConstants)