wxruby3 0.9.7 → 1.0.0

data/lib/wx/core/colour.rb

@@ -6,37 +6,45 @@
 # Copyright 2004-2007, wxRuby development team
 # released under the MIT-like wxRuby2 license
 
-class Wx::Colour
-  # Redefine the initialize method so it raises an exception if an
-  # invalid colour value is given. This might be an unknown colour
-  # string (eg 'dark blue') or out-of-bounds integer values (<0 or >255)
-  wx_init = self.instance_method(:initialize)
-  define_method(:initialize) do | *args |
-    begin
-      wx_init.bind(self).call(*args)
-    # Invalid integer values raise SWIG 'no matching func'
-    rescue ArgumentError, TypeError
-      Kernel.raise ArgumentError, "Invalid colour values #{args.inspect}"
+require_relative 'ext'
+
+module Wx
+
+  Wx.add_delayed_constant(self, :TRANSPARENT_COLOUR, 'Wx::Colour.new(0, 0, 0, Wx::ALPHA_TRANSPARENT)') { Wx::Colour.new(0, 0, 0, Wx::ALPHA_TRANSPARENT) }
+
+  class Colour
+    # Redefine the initialize method so it raises an exception if an
+    # invalid colour value is given. This might be an unknown colour
+    # string (eg 'dark blue') or out-of-bounds integer values (<0 or >255)
+    wx_init = self.instance_method(:initialize)
+    define_method(:initialize) do | *args |
+      begin
+        wx_init.bind(self).call(*args)
+      # Invalid integer values raise SWIG 'no matching func'
+      rescue ArgumentError, TypeError
+        Kernel.raise ArgumentError, "Invalid colour values #{args.inspect}"
+      end
     end
-  end
 
-  # Missing Standard colour
-  Wx::MAGENTA = new(255, 0, 255)
-
-  # Colours are equal to one another if they have the same red, green
-  # and blue intensity, and the same alpha
-  def ==(other)
-    case other
-    when Wx::Colour
-      [  self.red,  self.green,  self.blue,  self.alpha ] == 
-      [ other.red, other.green, other.blue, other.alpha ]
-    else
-      false
+    # Missing Standard colour
+    Wx::MAGENTA = new(255, 0, 255)
+
+    # Colours are equal to one another if they have the same red, green
+    # and blue intensity, and the same alpha
+    def ==(other)
+      case other
+      when Wx::Colour
+        [  self.red,  self.green,  self.blue,  self.alpha ] ==
+        [ other.red, other.green, other.blue, other.alpha ]
+      else
+        false
+      end
     end
-  end
 
-  # More informative output for inspect etc
-  def to_s
-    "#<Wx::Colour: (#{red}, #{green}, #{blue} *#{alpha})>"
+    # More informative output for inspect etc
+    def to_s
+      "#<Wx::Colour: (#{red}, #{green}, #{blue} *#{alpha})>"
+    end
   end
+
 end

data/lib/wx/core/const.rb

@@ -68,8 +68,14 @@ module Wx
   TREE_LIST_CTRL_NAME_STR = 'wxTreeListCtrl'
   HTML_LIST_BOX_NAME_STR = 'htmlListBox'
   SIMPLE_HTML_LIST_BOX_NAME_STR = 'simpleHtmlListBox'
+  HTML_WINDOW_NAME_STR = 'htmlWindow'
   EDITABLE_LIST_BOX_NAME_STR = 'editableListBox'
   V_LIST_BOX_NAME_STR = 'wxVListBox'
+  ACTIVITY_INDICATOR_NAME_STR = 'activityindicator'
+  TIME_PICKER_CTRL_NAME_STR = 'timectrl'
+  DATE_PICKER_CTRL_NAME_STR = 'datectrl'
+  CALENDAR_NAME_STR = 'CalendarCtrl'
+  SPIN_BUTTON_NAME_STR = 'wxSpinButton'
 
   if Wx::PLATFORM == 'WXMSW'
     # wxMSW only
@@ -80,4 +86,17 @@ module Wx
   PROPERTY_GRID_NAME_STR = 'wxPropertyGrid'
   STC_NAME_STR = 'stcwindow'
 
+  # custom wxRuby addition
+  MEDIA_CTRL_NAME_STR = 'mediaCtrl'
+  SPIN_CTRL_NAME_STR = 'wxSpinCtrl'
+  SPIN_CTRL_DOUBLE_NAME_STR = 'wxSpinCtrlDouble'
+  SPLITTER_WINDOW_NAME_STR = 'splitter'
+  CHOICEBOOK_NAME_STR = 'choicebook'
+  LISTBOOK_NAME_STR = 'listbook'
+  TOOLBOOK_NAME_STR = 'toolbook'
+  TREEBOOK_NAME_STR = 'treebook'
+  SASH_WINDOW_NAME_STR = 'sashWindow'
+  SASH_LAYOUT_WINDOW_NAME_STR = 'layoutWindow'
+  SCROLLED_NAME_STR = 'SCROLLED_WINDOW'
+
 end

data/lib/wx/core/enum.rb

@@ -48,8 +48,24 @@ class Wx::Enum
     @value.hash
   end
 
+  def bitmask_to_s
+    return '' if to_i == 0
+    enums = []
+    mask = to_i
+    self.class.values.each_value do |enum|
+      if enum != 0 && mask.allbits?(enum)
+        enums << enum.to_s
+        mask &= ~enum
+        break if mask == 0
+      end
+    end
+    enums << mask.to_s if mask != 0
+    enums.join('|')
+  end
+  private :bitmask_to_s
+
   def to_s
-    to_i.to_s
+    self.class.values.has_key?(to_i) ? "#{self.class.name}::#{self.class.names_by_value[self]}" : bitmask_to_s
   end
 
 end

data/lib/wx/core/geometry.rb

@@ -0,0 +1,121 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+module Wx
+
+  def self.deg_to_rad(deg)
+    (deg * Math::PI) / 180.0
+  end
+
+  def self.rad_to_deg(rad)
+    (rad * 180.0) / Math::PI
+  end
+
+  class Point2DInt
+
+    alias :x :get_x
+    alias :x= :set_x
+    alias :y :get_y
+    alias :y= :set_y
+
+    # make wrappers private
+    private :add, :sub, :mul, :div
+
+    wx_assign = instance_method :assign
+    define_method :assign do |pt|
+      wx_assign.bind(self).call(pt)
+      self
+    end
+
+    def add!(pt)
+      add(pt)
+      self
+    end
+
+    def sub!(pt)
+      sub(pt)
+      self
+    end
+
+    def mul!(v)
+      mul(v)
+      self
+    end
+
+    def div!(v)
+      div(v)
+      self
+    end
+
+    def +(pt)
+      Point2DInt.new(self).add!(pt)
+    end
+
+    def -(pt)
+      Point2DInt.new(self).sub!(pt)
+    end
+
+    def *(v)
+      Point2DInt.new(self).mul!(v)
+    end
+
+    def /(v)
+      Point2DInt.new(self).div!(v)
+    end
+
+  end
+  class Point2DDouble
+
+    alias :x :get_x
+    alias :x= :set_x
+    alias :y :get_y
+    alias :y= :set_y
+
+    # make wrappers private
+    private :add, :sub, :mul, :div
+
+    wx_assign = instance_method :assign
+    define_method :assign do |pt|
+      wx_assign.bind(self).call(pt)
+      self
+    end
+
+    def add!(pt)
+      add(pt)
+      self
+    end
+
+    def sub!(pt)
+      sub(pt)
+      self
+    end
+
+    def mul!(v)
+      mul(v)
+      self
+    end
+
+    def div!(v)
+      div(v)
+      self
+    end
+
+    def +(pt)
+      Point2DDouble.new(self).add!(pt)
+    end
+
+    def -(pt)
+      Point2DDouble.new(self).sub!(pt)
+    end
+
+    def *(v)
+      Point2DDouble.new(self).mul!(v)
+    end
+
+    def /(v)
+      Point2DDouble.new(self).div!(v)
+    end
+
+  end
+end

data/lib/wx/core/graphics_pen_info.rb

@@ -0,0 +1,18 @@
+# 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::GraphicsPenInfo
+
+  # make Wx::GraphicsPenInfo#dashes return self
+  wx_dashes = instance_method :dashes
+  define_method :dashes do |*args|
+    wx_dashes.bind(self).call(*args)
+    self
+  end
+
+end

data/lib/wx/core/image.rb

@@ -108,6 +108,55 @@ module Wx
       hist_hash.extend Histogram
       hist_hash
     end
+
+    # import flattened nested classes
+    HSVValue = Wx::HSVValue
+    RGBValue = Wx::RGBValue
+
+  end
+
+  class HSVValue
+
+    # More informative output when converted to string
+    def to_s
+      "#<Wx::Image::HSVValue: (#{self.hue}, #{self.saturation}, #{self.value})>"
+    end
+
+    def inspect
+      to_s
+    end
+
+    # make HSVValue usable for parallel assignments like `x, y = pt`
+    def to_ary
+      [self.hue, self.saturation, self.value]
+    end
+
+    def to_rgb
+      Image::hsv_to_rgb(self)
+    end
+
+  end
+
+  class RGBValue
+
+    # More informative output when converted to string
+    def to_s
+      "#<Wx::Image::RGBValue: (#{self.red}, #{self.green}, #{self.blue})>"
+    end
+
+    def inspect
+      to_s
+    end
+
+    # make RGBValue usable for parallel assignments like `x, y = pt`
+    def to_ary
+      [self.red, self.green, self.blue]
+    end
+
+    def to_hsv
+      Image::rgb_to_hsv(self)
+    end
+
   end
 
   def self.Image(name, bmp_type = nil, *rest, art_path: nil, art_section: nil)

data/lib/wx/core/menu_bar.rb

@@ -12,6 +12,17 @@ class Wx::MenuBar
 
   def initialize(*args, &block)
     wx_initialize(*args)
+    if Wx::PLATFORM == 'WXOSX'
+      # OSX's standard Apple/Application menu gets titled with the executables name by default
+      # which is 'ruby' for wxRuby and this title is near impossible to reliably change.
+      # Therefor we implemented (a little stunted) workaround here to deal with Apple's crap.
+      # We insert a disabled item at the start of this menu with the AppDisplayName and follow
+      # it up with a nice separator. This way at least we will always be able to see which wxRuby
+      # app the visible menu belongs to.
+      apple_menu = osx_get_apple_menu
+      apple_menu.insert(0, Wx::ID_NONE, Wx.get_app.get_app_display_name).enable(false)
+      apple_menu.insert_separator(1)
+    end
     if block
       if block.arity == -1 or block.arity == 0
         self.instance_eval(&block)

data/lib/wx/core/paintdc.rb

@@ -6,10 +6,16 @@
 # Copyright 2004-2007, wxRuby development team
 # released under the MIT-like wxRuby2 license
 
-class Wx::PaintDC
+module Wx
+
+  class PaintDC
+
+    def self.draw_on(win, &block)
+      win.paint(&block) if block
+    end
 
-  def self.draw_on(win, &block)
-    win.paint(&block) if block
   end
 
+  AutoBufferedPaintDC = PaintDC.has_native_double_buffer ? Wx::PaintDC : Wx::BufferedPaintDC
+
 end

data/lib/wx/core/secret_store.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+module Wx
+
+  class SecretStore
+
+    # Wipes the secret data.
+    def self.wipe(secret)
+      if ::String === secret
+        secret.bytesize.times { |i| secret.setbyte(i, 0) }
+      end
+    end
+
+  end
+
+  class SecretValue
+
+    # Redefine the initialize method to auto-convert UTF-16/-32 strings to UTF-8 if possible.
+    wx_init = self.instance_method(:initialize)
+    define_method(:initialize) do | *args |
+      if args.size == 1 && ::String === args.first
+        unless args.first.encoding == ::Encoding::UTF_8 || args.first.encoding == ::Encoding::ASCII_8BIT
+          # convert in place unless frozen
+          if !args.first.frozen?
+            args.first.encode!(::Encoding::UTF_8) rescue nil
+          else # create converted copy
+            (args = [args.first.encode(::Encoding::UTF_8)]) rescue nil
+          end
+        end
+      end
+      wx_init.bind(self).call(*args)
+    end
+
+  end
+
+end

data/lib/wx/doc/app.rb

@@ -9,47 +9,103 @@ module Wx
 
   class App
 
-    # Set the menu item id for the About menu item.
-    # Default is {Wx::ID_ABOUT}
-    # @param [Integer] id
-    # @wxrb_require WXOSX
-    def set_mac_about_menu_itemid(id) end
-    alias :mac_about_menu_itemid= :set_mac_about_menu_itemid
-
-    # Get the current menu item id for the About menu item.
-    # Default is {Wx::ID_ABOUT}
-    # @return [Integer]
-    # @wxrb_require WXOSX
-    def get_mac_about_menu_itemid(id) end
-    alias :mac_about_menu_itemid :get_mac_about_menu_itemid
-
-    # Set the menu item id for the Preferences menu item.
-    # Default is {Wx::ID_PREFERENCES}
-    # @param [Integer] id
-    # @wxrb_require WXOSX
-    def set_mac_preferences_menu_itemid(id) end
-    alias :mac_preferences_menu_itemid= :set_mac_preferences_menu_itemid
-
-    # Get the current menu item id for the Preferences menu item.
-    # Default is {Wx::ID_PREFERENCES}
-    # @return [Integer]
-    # @wxrb_require WXOSX
-    def get_mac_preferences_menu_itemid(id) end
-    alias :mac_preferences_menu_itemid :get_mac_preferences_menu_itemid
-
-    # Set the menu item id for the Exit menu item.
-    # Default is {Wx::ID_EXIT}
-    # @param [Integer] id
-    # @wxrb_require WXOSX
-    def set_mac_exit_menu_itemid(id) end
-    alias :mac_exit_menu_itemid= :set_mac_exit_menu_itemid
-
-    # Get the current menu item id for the Exit menu item.
-    # Default is {Wx::ID_EXIT}
-    # @return [Integer]
-    # @wxrb_require WXOSX
-    def get_mac_exit_menu_itemid(id) end
-    alias :mac_exit_menu_itemid :get_mac_exit_menu_itemid
+    # Run the (main loop for) the application instance.
+    # Optionally runs a given block as the applications #on_init callback
+    # if no actual #on_init method has been defined.
+    # A given block will be ignored if an actual #on_init method has been defined.
+    # @yieldreturn [Boolean] return true if init block succeeded, false otherwise
+    # @return [Integer] return code from the #on_exit callback (`0` if no #on_exit defined or called)
+    def run(&block) end
+
+    # Convenience method to instantiate an application object of the class
+    # and call the {Wx::App#run} method for that application object.
+    # @yieldreturn [Boolean] return true if init block succeeded, false otherwise
+    # @return [Integer] return code from {Wx::App#run}
+    def self.run(&block) end
+
+    class << self
+
+      # Set the menu item id for the About menu item.
+      # Default is {Wx::ID_ABOUT}. Setting to {Wx::ID_NONE} will disable moving the About item to the Application menu.
+      # @param [Integer] id
+      # @wxrb_require WXOSX
+      # @see Wx::App.get_mac_about_menu_itemid
+      def set_mac_about_menu_itemid(id) end
+      alias :mac_about_menu_itemid= :set_mac_about_menu_itemid
+
+      # Get the current menu item id for the About menu item.
+      # Default is {Wx::ID_ABOUT}
+      # @return [Integer]
+      # @wxrb_require WXOSX
+      # @see Wx::App.set_mac_about_menu_itemid
+      def get_mac_about_menu_itemid; end
+      alias :mac_about_menu_itemid :get_mac_about_menu_itemid
+
+      # Set the menu item id for the Preferences menu item.
+      # Default is {Wx::ID_PREFERENCES}
+      # @param [Integer] id
+      # @wxrb_require WXOSX
+      # @see Wx::App.get_mac_preferences_menu_itemid
+      def set_mac_preferences_menu_itemid(id) end
+      alias :mac_preferences_menu_itemid= :set_mac_preferences_menu_itemid
+
+      # Get the current menu item id for the Preferences menu item.
+      # Default is {Wx::ID_PREFERENCES}
+      # @return [Integer]
+      # @wxrb_require WXOSX
+      # @see Wx::App.set_mac_preferences_menu_itemid
+      def get_mac_preferences_menu_itemid; end
+      alias :mac_preferences_menu_itemid :get_mac_preferences_menu_itemid
+
+      # Set the menu item id for the Exit menu item.
+      # Default is {Wx::ID_EXIT}.  Setting to {Wx::ID_NONE} will disable hiding the exit item. Standard item will still be added to Application menu.
+      # @param [Integer] id
+      # @wxrb_require WXOSX
+      # @see Wx::App.get_mac_exit_menu_itemid
+      def set_mac_exit_menu_itemid(id) end
+      alias :mac_exit_menu_itemid= :set_mac_exit_menu_itemid
+
+      # Get the current menu item id for the Exit menu item.
+      # Default is {Wx::ID_EXIT}
+      # @return [Integer]
+      # @wxrb_require WXOSX
+      # @see Wx::App.set_mac_exit_menu_itemid
+      def get_mac_exit_menu_itemid; end
+      alias :mac_exit_menu_itemid :get_mac_exit_menu_itemid
+
+      # Set the menu title for the Help menu.
+      # Default is '&Help'
+      # @param [String] title
+      # @wxrb_require WXOSX
+      # @see Wx::App.get_mac_help_menu_title
+      def set_mac_help_menu_title(title) end
+      alias :mac_help_menu_title= :set_mac_help_menu_title
+
+      # Get the current title for the Help menu.
+      # Default is '&Help'
+      # @return [String]
+      # @wxrb_require WXOSX
+      # @see Wx::App.set_mac_help_menu_title
+      def get_mac_help_menu_title; end
+      alias :mac_help_menu_title :get_mac_help_menu_title
+
+      # Set the menu title for the Window menu.
+      # Default is '&Window'
+      # @param [String] title
+      # @wxrb_require WXOSX
+      # @see Wx::App.get_mac_window_menu_title
+      def set_mac_window_menu_title(title) end
+      alias :mac_window_menu_title= :set_mac_window_menu_title
+
+      # Get the current title for the Window menu.
+      # Default is '&Window'
+      # @return [String]
+      # @wxrb_require WXOSX
+      # @see Wx::App.set_mac_window_menu_title
+      def get_mac_window_menu_title; end
+      alias :mac_window_menu_title :get_mac_window_menu_title
+
+    end
 
   end
 

data/lib/wx/doc/bitmap.rb

@@ -14,6 +14,8 @@ module Wx
   # Default BitmapType for current platform. Actual value is platform dependent.
   CURSOR_DEFAULT_TYPE = Wx::BitmapType::BITMAP_TYPE_ANY
 
+  # @!group Art creation methods
+
   # 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
@@ -28,4 +30,6 @@ module Wx
   # @see Wx::ArtLocator::find_art
   def self.Bitmap(name, bmp_type = nil, art_path: nil, art_section: nil); end
 
+  # @!endgroup
+
 end

data/lib/wx/doc/client_dc.rb

@@ -13,7 +13,7 @@ module Wx
     # it's single argument.
     # @param [Wx::Window] win window to draw on
     # @yieldparam [Wx::ClientDC] dc the ClientDC instance to paint on
-    # @return [Object] result of the block
+    # @return [::Object] result of the block
     def self.draw_on(win) end
 
   end
@@ -26,7 +26,7 @@ module Wx
     # @note In wxRuby this method mostly exists to be consistent with the other DC classes. It is however recommended to use Wx::Window#paint instead.
     # @param [Wx::Window] win window to draw on
     # @yieldparam [Wx::PaintDC] dc the PaintDC instance to paint on
-    # @return [Object] result of the block
+    # @return [::Object] result of the block
     def self.draw_on(win) end
 
   end

data/lib/wx/doc/clipboard.rb

@@ -14,7 +14,7 @@ module Wx
 
     # Opens the global clipboard and passes the clipboard object to the block.
     # @yieldparam [Wx::Clipboard] clip the global clipboard object
-    # @return [Object] block result
+    # @return [::Object] block result
     def self.open; end
 
   end

data/lib/wx/doc/colour.rb

@@ -0,0 +1,12 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  TRANSPARENT_COLOUR = Wx::Colour.new(0, 0, 0, Wx::ALPHA_TRANSPARENT)
+
+end

data/lib/wx/doc/const.rb

@@ -71,8 +71,14 @@ module Wx
   TREE_LIST_CTRL_NAME_STR = 'wxTreeListCtrl'
   HTML_LIST_BOX_NAME_STR = 'htmlListBox'
   SIMPLE_HTML_LIST_BOX_NAME_STR = 'simpleHtmlListBox'
+  HTML_WINDOW_NAME_STR = 'htmlWindow'
   EDITABLE_LIST_BOX_NAME_STR = 'editableListBox'
   V_LIST_BOX_NAME_STR = 'wxVListBox'
+  ACTIVITY_INDICATOR_NAME_STR = 'activityindicator'
+  TIME_PICKER_CTRL_NAME_STR = 'timectrl'
+  DATE_PICKER_CTRL_NAME_STR = 'datectrl'
+  CALENDAR_NAME_STR = 'CalendarCtrl'
+  SPIN_BUTTON_NAME_STR = 'wxSpinButton'
 
   # wxMSW only
   MSW_HEADER_CTRL_NAME_STR = 'wxMSWHeaderCtrl'
@@ -81,4 +87,14 @@ module Wx
   PROPERTY_GRID_NAME_STR = 'wxPropertyGrid'
   STC_NAME_STR = 'stcwindow'
 
+  MEDIA_CTRL_NAME_STR = 'mediaCtrl'
+  SPIN_CTRL_NAME_STR = 'spinCtrl'
+  SPIN_CTRL_DOUBLE_NAME_STR = 'wxSpinCtrlDouble'
+  SPLITTER_WINDOW_NAME_STR = 'splitter'
+  TOOLBOOK_NAME_STR = 'toolbook'
+  TREEBOOK_NAME_STR = 'treebook'
+  SASH_WINDOW_NAME_STR = 'sashWindow'
+  SASH_LAYOUT_WINDOW_NAME_STR = 'layoutWindow'
+  SCROLLED_NAME_STR = 'SCROLLED_WINDOW'
+
 end

data/lib/wx/doc/cursor.rb

@@ -7,6 +7,8 @@
 
 class Wx
 
+  # @!group Art creation methods
+
   # 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
@@ -21,4 +23,6 @@ class Wx
   # @see Wx::ArtLocator::find_art
   def self.Cursor(name, bmp_type = nil, art_path: nil, art_section: nil); end
 
+  # @!endgroup
+
 end