wxruby3 0.9.0.pre.beta.11 → 0.9.0.pre.beta.13

data/lib/wx/core/dc.rb

@@ -1,68 +1,92 @@
-# Class for drawing primitives and bitmaps on various outputs (screen, paper)
-class Wx::DC
-  # provide Ruby-style convenience methods supporting wxDCxxxChanger-like functionality
 
-  def with_brush(brush)
-    begin
-      old_brush = self.brush
-      self.brush = brush
-      yield(self) if block_given?
-    ensure
-      self.brush = old_brush
+module Wx
+  # Class for drawing primitives and bitmaps on various outputs (screen, paper)
+  class DC
+    # provide Ruby-style convenience methods supporting wxDCxxxChanger-like functionality
+
+    def with_brush(brush)
+      begin
+        old_brush = self.brush
+        self.brush = brush
+        yield(self) if block_given?
+      ensure
+        self.brush = old_brush
+      end
     end
-  end
 
-  def with_pen(pen)
-    begin
-      old_pen = self.pen
-      self.pen = pen
-      yield(self) if block_given?
-    ensure
-      self.pen = old_pen
+    def with_pen(pen)
+      begin
+        old_pen = self.pen
+        self.pen = pen
+        yield(self) if block_given?
+      ensure
+        self.pen = old_pen
+      end
     end
-  end
 
-  def with_font(font)
-    begin
-      old_font = self.font
-      self.font = font
-      yield(self) if block_given?
-    ensure
-      self.font = old_font
+    def with_font(font)
+      begin
+        old_font = self.font
+        self.font = font
+        yield(self) if block_given?
+      ensure
+        self.font = old_font
+      end
     end
-  end
 
-  def with_text_foreground(clr)
-    begin
-      old = self.get_text_foreground
-      self.text_foreground = clr
-      yield(self) if block_given?
-    ensure
-      self.text_foreground = old
+    def with_text_foreground(clr)
+      begin
+        old = self.get_text_foreground
+        self.text_foreground = clr
+        yield(self) if block_given?
+      ensure
+        self.text_foreground = old
+      end
     end
-  end
-  alias :with_text_fg :with_text_foreground
+    alias :with_text_fg :with_text_foreground
 
-  def with_text_background(clr)
-    begin
-      old = self.get_text_background
-      self.text_background = clr
-      yield(self) if block_given?
-    ensure
-      self.text_background = old
+    def with_text_background(clr)
+      begin
+        old = self.get_text_background
+        self.text_background = clr
+        yield(self) if block_given?
+      ensure
+        self.text_background = old
+      end
     end
+    alias :with_text_bg :with_text_background
+
+    def with_background_mode(mode)
+      begin
+        old = self.get_background_mode
+        self.background_mode = mode
+        yield(self) if block_given?
+      ensure
+        self.background_mode = old
+      end
+    end
+    alias :with_bg_mode :with_background_mode
+
   end
-  alias :with_text_bg :with_text_background
 
-  def with_background_mode(mode)
-    begin
-      old = self.get_background_mode
-      self.background_mode = mode
-      yield(self) if block_given?
-    ensure
-      self.background_mode = old
+  class MemoryDC
+
+    # convenience method for drawing on a temporary memory DC
+    def self.draw_on(arg)
+      dc = case arg
+           when Wx::Bitmap, Wx::DC
+             self.new(arg)
+           else
+             ::Kernel.raise ArgumentError, 'Expected Wx::Bitmap or Wx::DC'
+           end
+      begin
+        yield(dc) if block_given?
+      ensure
+        dc.select_object(Wx::NULL_BITMAP)
+      end
+      nil
     end
+
   end
-  alias :with_bg_mode :with_background_mode
 
 end

data/lib/wx/core/enum.rb

@@ -25,4 +25,8 @@ class Wx::Enum
     self.to_i == 0
   end
 
+  def hash
+    @value.hash
+  end
+
 end

data/lib/wx/core/event.rb

@@ -1,10 +1,43 @@
-# Base class for all events
-class Wx::Event
-  # Get the Wx id, not Ruby's deprecated Object#id
-  alias :id :get_id
-end
+
+require_relative './evthandler'
 
 module Wx
+
+  # Base class for all events
+  class Event
+
+    # overload the #initialize method to add a check on a
+    # correct match between EventType and event class
+    wx_init = self.instance_method(:initialize)
+    define_method :initialize do |evt_type = Wx::EVT_NULL, *rest|
+      evt_klass = Wx::EvtHandler.event_class_for_type(evt_type)
+      if evt_klass >= self.class
+        wx_init.bind(self).call(evt_type, *rest)
+      else
+        ::Kernel.raise ArgumentError, "Invalid event type #{Wx::EvtHandler.event_name_for_type(evt_type)}:#{evt_type} for class #{self.class}"
+      end
+    end
+
+    # Get the Wx id, not Ruby's deprecated Object#id
+    alias :id :get_id
+  end
+
+  class Wx::CommandEvent
+
+    # overload the #initialize method to add a check on a
+    # correct match between EventType and event class
+    wx_init = self.instance_method(:initialize)
+    define_method :initialize do |evt_type = Wx::EVT_NULL, *rest|
+      evt_klass = Wx::EvtHandler.event_class_for_type(evt_type)
+      if evt_klass >= self.class
+        wx_init.bind(self).call(evt_type, *rest)
+      else
+        ::Kernel.raise ArgumentError, "Invalid event type #{Wx::EvtHandler.event_name_for_type(evt_type)}:#{evt_type} for class #{self.class}"
+      end
+    end
+
+  end
+
   # reduce mapping warnings for this unpublished event class
   NcPaintEvent = Wx::Event
 

data/lib/wx/core/evthandler.rb

@@ -195,32 +195,73 @@ class Wx::EvtHandler
   end
 
   # Convenience evt_handler to listen to all mouse events.
-  def evt_mouse_events(&block)
-    evt_left_down(&block)
-    evt_left_up(&block)
-    evt_middle_down(&block)
-    evt_middle_up(&block)
-    evt_right_down(&block)
-    evt_right_up(&block)
-    evt_motion(&block)
-    evt_left_dclick(&block)
-    evt_middle_dclick(&block)
-    evt_right_dclick(&block)
-    evt_leave_window(&block)
-    evt_enter_window(&block)
-    evt_mousewheel(&block)
+  def evt_mouse_events(*args, &block)
+    evt_left_down(*args, &block)
+    evt_left_up(*args, &block)
+    evt_middle_down(*args, &block)
+    evt_middle_up(*args, &block)
+    evt_right_down(*args, &block)
+    evt_right_up(*args, &block)
+    evt_motion(*args, &block)
+    evt_left_dclick(*args, &block)
+    evt_middle_dclick(*args, &block)
+    evt_right_dclick(*args, &block)
+    evt_leave_window(*args, &block)
+    evt_enter_window(*args, &block)
+    evt_mousewheel(*args, &block)
   end
 
   # Convenience evt handler to listen to all scrollwin events.
-  def evt_scrollwin(&block)
-    evt_scrollwin_top(&block)
-    evt_scrollwin_bottom(&block)
-    evt_scrollwin_lineup(&block)
-    evt_scrollwin_linedown(&block)
-    evt_scrollwin_pageup(&block)
-    evt_scrollwin_pagedown(&block)
-    evt_scrollwin_thumbtrack(&block)
-    evt_scrollwin_thumbrelease(&block)
+  def evt_scrollwin(meth = nil, &block)
+    evt_scrollwin_top(meth, &block)
+    evt_scrollwin_bottom(meth, &block)
+    evt_scrollwin_lineup(meth, &block)
+    evt_scrollwin_linedown(meth, &block)
+    evt_scrollwin_pageup(meth, &block)
+    evt_scrollwin_pagedown(meth, &block)
+    evt_scrollwin_thumbtrack(meth, &block)
+    evt_scrollwin_thumbrelease(meth, &block)
+  end
+
+  # Convenience evt handler to listen to all scroll events (Wx::Slider and Wx::ScrollBar)
+  def evt_scroll(meth = nil, &block)
+    evt_scroll_top(meth, &block)
+    evt_scroll_bottom(meth, &block)
+    evt_scroll_lineup(meth, &block)
+    evt_scroll_linedown(meth, &block)
+    evt_scroll_pageup(meth, &block)
+    evt_scroll_pagedown(meth, &block)
+    evt_scroll_thumbtrack(meth, &block)
+    evt_scroll_thumbrelease(meth, &block)
+    evt_scroll_changed(meth, &block)
+  end
+
+  # Convenience evt handler to listen to all scroll command events.
+  def evt_command_scroll(id, meth = nil, &block)
+    evt_command_scroll_top(id, meth, &block)
+    evt_command_scroll_bottom(id, meth, &block)
+    evt_command_scroll_lineup(id, meth, &block)
+    evt_command_scroll_linedown(id, meth, &block)
+    evt_command_scroll_pageup(id, meth, &block)
+    evt_command_scroll_pagedown(id, meth, &block)
+    evt_command_scroll_thumbtrack(id, meth, &block)
+    evt_command_scroll_thumbrelease(id, meth, &block)
+    evt_command_scroll_changed(id, meth, &block)
+  end
+
+  # add missing constants (these are redefinitions of other constants which are not documented themselves)
+  %i[EVT_COMMAND_SCROLL_TOP
+     EVT_COMMAND_SCROLL_BOTTOM
+     EVT_COMMAND_SCROLL_LINEUP
+     EVT_COMMAND_SCROLL_LINEDOWN
+     EVT_COMMAND_SCROLL_PAGEUP
+     EVT_COMMAND_SCROLL_PAGEDOWN
+     EVT_COMMAND_SCROLL_THUMBTRACK
+     EVT_COMMAND_SCROLL_THUMBRELEASE
+     EVT_COMMAND_SCROLL_CHANGED].each do |const|
+    unless Wx.const_defined?(const)
+      Wx.const_set(const, Wx.const_get(const.to_s.sub('EVT_COMMAND_', 'EVT_').to_sym))
+    end
   end
 
   if Wx.const_defined?(:EVT_DESTROY)

data/lib/wx/core/icon.rb

@@ -1,46 +1,61 @@
 # Specific type of platform-dependent image used for frames on Windows and
 # Linux. Normally Bitmap is used
-class Wx::Icon
-  # Load the type-guessing hash from Wx::Bitmap
-  require 'wx/core/bitmap'
-  BITMAP_TYPE_GUESS = Wx::Bitmap::BITMAP_TYPE_GUESS
-
-  # Analogous to Image.from_bitmap
-  def self.from_bitmap(bmp)
-    ico = new
-    ico.copy_from_bitmap(bmp)
-    ico
-  end
 
-  def to_bitmap
-    # for WXMSW platform Icon is not derived from Bitmap
-    return self unless Wx::PLATFORM == 'WXMSW' || Wx::PLATFORM == 'WXOSX'
-    bm = Wx::Bitmap.new
-    bm.copy_from_icon(self)
-    bm
-  end
+require_relative './art_locator'
+
+module Wx
 
-  if Wx::PLATFORM == 'WXMSW' || Wx::PLATFORM == 'WXOSX'
-    def convert_to_image
-      to_bitmap.convert_to_image
+  class Icon
+    # Load the type-guessing hash from Wx::Bitmap
+    require 'wx/core/bitmap'
+    BITMAP_TYPE_GUESS = Wx::Bitmap::BITMAP_TYPE_GUESS
+
+    # Analogous to Image.from_bitmap
+    def self.from_bitmap(bmp)
+      ico = new
+      ico.copy_from_bitmap(bmp)
+      ico
+    end
+
+    def to_bitmap
+      # for WXMSW platform Icon is not derived from Bitmap
+      return self unless Wx::PLATFORM == 'WXMSW' || Wx::PLATFORM == 'WXOSX'
+      bm = Wx::Bitmap.new
+      bm.copy_from_icon(self)
+      bm
     end
-  end
 
-  # Redefine the initialize method so it raises an exception if a
-  # non-existent file is given to the constructor; otherwise, wx Widgets
-  # just carries on with an empty icon, which may cause faults
-  # later. Also guess icon type from filename, if not specified.
-  wx_init = self.instance_method(:initialize)
-  define_method(:initialize) do | *args |
-    if args[0].kind_of? String
-      if not File.exist?( File.expand_path(args[0]) )
-        Kernel.raise(ArgumentError, "Icon file does not exist: #{args[0]}")
+    if Wx::PLATFORM == 'WXMSW' || Wx::PLATFORM == 'WXOSX'
+      def convert_to_image
+        to_bitmap.convert_to_image
       end
-      # If type not specified, try to guess it from the file extension
-      if not args[1] and ( file_ext = args[0][/\w+$/] )
-        args[1] = BITMAP_TYPE_GUESS[file_ext.downcase]
+    end
+
+    # Redefine the initialize method so it raises an exception if a
+    # non-existent file is given to the constructor; otherwise, wx Widgets
+    # just carries on with an empty icon, which may cause faults
+    # later. Also guess icon type from filename, if not specified.
+    wx_init = self.instance_method(:initialize)
+    define_method(:initialize) do | *args |
+      if args[0].kind_of? String
+        if not File.exist?( File.expand_path(args[0]) )
+          Kernel.raise(ArgumentError, "Icon file does not exist: #{args[0]}")
+        end
+        # If type not specified, try to guess it from the file extension
+        if not args[1] and ( file_ext = args[0][/\w+$/] )
+          args[1] = BITMAP_TYPE_GUESS[file_ext.downcase]
+        end
       end
+      wx_init.bind(self).call(*args)
     end
-    wx_init.bind(self).call(*args)
   end
+
+  def self.Icon(name, bmp_type = nil, *rest)
+    art_path = File.dirname(caller_path = caller_locations(1).first.absolute_path)
+    art_owner = File.basename(caller_path, '.*')
+    art_file = ArtLocator.find_art(name, art_type: :icon, art_path: art_path, art_section: art_owner, bmp_type: bmp_type)
+    ::Kernel.raise ArgumentError, "Cannot locate art file for #{name}:Icon" unless art_file
+    Icon.new(art_file, bmp_type, *rest)
+  end
+
 end

data/lib/wx/core/id_helper.rb

@@ -0,0 +1,32 @@
+
+module Wx
+
+  # Mixin module to provide convenience method for defining Windows/Control ids.
+  # @example Define an ID module
+  #   module MyIDS
+  #     include Wx::IDHelper
+  #     # by default the offset for the next id is Wx::ID_HIGHEST which makes 'Wx::ID_HIGHEST+1'
+  #     # the first id value returned.
+  #     MY_FIRST_ID = self.next_id
+  #     MY_SECOND_ID = self.next_id   # MY_SECOND_ID will have value Wx::ID_HIGHEST+2
+  #
+  #     # optionally a user defined offset can be specified like this:
+  #     MY_OTHER_ID = self.next_id(MY_FIRST_ID+1000)  # MY_OTHER_ID will have value MY_FIRST_ID+1001
+  #     MY_OTHER_ID2 = self.next_id                   # MY_OTHER_ID2 will have value MY_FIRST_ID+1002
+  #   end
+  #
+  module IDHelper
+
+    def self.included(base)
+      base.singleton_class.class_eval do
+        def next_id(offset = nil)
+          # set the offset if @next_id still unset or a user defined offset has been specified
+          @next_id = (offset || Wx::ID_HIGHEST) if @next_id.nil? || offset
+          @next_id += 1 # increment and return next id
+        end
+      end
+    end
+
+  end
+
+end

data/lib/wx/core/image.rb

@@ -1,68 +1,78 @@
 # A platform-independent image; can be manipulated more extensively than
 # Bitmap, but must be converted to a Bitmap for drawing.
-class Wx::Image
+module Wx
+  class Image
 
-  # restore the overloaded method
-  def set_rgb_data(data, *size)
-    if size.empty?
-      height = self.get_size.height
-      width = self.get_size.width
-    else
-      width, height = size
-      if Wx::Size === width
-        height = width.height
-        width = width.width
+    # restore the overloaded method
+    def set_rgb_data(data, *size)
+      if size.empty?
+        height = self.get_size.height
+        width = self.get_size.width
+      else
+        width, height = size
+        if Wx::Size === width
+          height = width.height
+          width = width.width
+        end
       end
+      set_rgb_data_with_size(data, width, height)
     end
-    set_rgb_data_with_size(data, width, height)
-  end
 
-  # alias for backward compatibility
-  alias :get_data :get_rgb_data
-  alias :set_data :set_rgb_data
-  
-  # Load the type-guessing hash from Wx::Bitmap
-  require_relative './bitmap'
-  BITMAP_TYPE_GUESS = Wx::Bitmap::BITMAP_TYPE_GUESS
+    # alias for backward compatibility
+    alias :get_data :get_rgb_data
+    alias :set_data :set_rgb_data
 
-  # Load a new image from an IO-like object that supports "read"
-  def self.read(an_io, type_or_mime, index = -1)
-    img = new
-    img.load_stream(an_io, type_or_mime, index)
-    img
-  end
+    # Load the type-guessing hash from Wx::Bitmap
+    require_relative './bitmap'
+    BITMAP_TYPE_GUESS = Wx::Bitmap::BITMAP_TYPE_GUESS
 
-  # Create a new image from Wx::Bitmap, preserving mask information
-  def self.from_bitmap(bmp)
-    bmp.convert_to_image
-  end
+    # Load a new image from an IO-like object that supports "read"
+    def self.read(an_io, type_or_mime, index = -1)
+      img = new
+      img.load_stream(an_io, type_or_mime, index)
+      img
+    end
 
-  # Ruby methods that switch class are conventionally named to_foo
-  def to_bitmap
-    Wx::Bitmap.from_image(self)
-  end
+    # Create a new image from Wx::Bitmap, preserving mask information
+    def self.from_bitmap(bmp)
+      bmp.convert_to_image
+    end
 
-  # Redefine the initialize method so it raises an exception if a
-  # non-existent file is given to the constructor; otherwise, wx Widgets
-  # just carries on with an invalid image, which may cause faults
-  # later. Also, if loading from a file, and the type is not specified,
-  # try to guess it from the filename extension
-  wx_init = self.instance_method(:initialize)
-  define_method(:initialize) do | *args |
-    if args[0].kind_of? String
-      if not File.exist?( File.expand_path(args[0]) )
-        Kernel.raise(ArgumentError, "Image file does not exist: #{args[0]}")
-      end
-      # If type not specified, try to guess it from the file extension
-      if not args[1] and file_ext = args[0][/\w+$/]
-        args[1] = BITMAP_TYPE_GUESS[file_ext.downcase]
+    # Ruby methods that switch class are conventionally named to_foo
+    def to_bitmap
+      Wx::Bitmap.from_image(self)
+    end
+
+    # Redefine the initialize method so it raises an exception if a
+    # non-existent file is given to the constructor; otherwise, wx Widgets
+    # just carries on with an invalid image, which may cause faults
+    # later. Also, if loading from a file, and the type is not specified,
+    # try to guess it from the filename extension
+    wx_init = self.instance_method(:initialize)
+    define_method(:initialize) do | *args |
+      if args[0].kind_of? String
+        if not File.exist?( File.expand_path(args[0]) )
+          Kernel.raise(ArgumentError, "Image file does not exist: #{args[0]}")
+        end
+        # If type not specified, try to guess it from the file extension
+        if not args[1] and file_ext = args[0][/\w+$/]
+          args[1] = BITMAP_TYPE_GUESS[file_ext.downcase]
+        end
       end
+      wx_init.bind(self).call(*args)
+    end
+
+    # Convert to bitmap
+    def convert_to_bitmap
+      Wx::Bitmap.from_image(self)
     end
-    wx_init.bind(self).call(*args)
   end
-  
-  # Convert to bitmap
-  def convert_to_bitmap
-    Wx::Bitmap.from_image(self)
+
+  def self.Image(name, bmp_type = nil, *rest)
+    art_path = File.dirname(caller_path = caller_locations(1).first.absolute_path)
+    art_owner = File.basename(caller_path, '.*')
+    art_file = ArtLocator.find_art(name, art_type: :image, art_path: art_path, art_section: art_owner, bmp_type: bmp_type)
+    ::Kernel.raise ArgumentError, "Cannot locate art file for #{name}:Image" unless art_file
+    Image.new(art_file, bmp_type, *rest)
   end
 end

data/lib/wx/core/point.rb

@@ -100,4 +100,18 @@ class Wx::Point
     Wx::RealPoint.new(self.x.to_f, self.y.to_f)
   end
   alias :to_real :to_real_point
+
+  def to_point
+    self
+  end
+
+  def dup
+    Wx::Point.new(self.x, self.y)
+  end
+
+  def assign(pt)
+    self.x = pt.x
+    self.y = pt.y
+    self
+  end
 end

data/lib/wx/core/real_point.rb

@@ -96,8 +96,22 @@ class Wx::RealPoint
     end
   end
 
-
   def to_point
     Wx::Point.new(self.x.to_i, self.y.to_i)
   end
+
+  def to_real_point
+    self
+  end
+
+  def dup
+    Wx::RealPoint.new(self.x, self.y)
+  end
+
+  def assign(pt)
+    self.x = pt.x
+    self.y = pt.y
+    self
+  end
+
 end

data/lib/wx/core/rect.rb

@@ -36,15 +36,40 @@ class Wx::Rect
     end
   end
 
-  # make sure union and intersect are constant operations, i.e. not changing self
-  wx_union = instance_method :union
-  define_method :union do |rect|
-    wx_union.bind(Wx::Rect.new(*self.to_ary)).call(rect)
+  # provide both constant and non-constant versions of union/intersect/inflate/deflate/offset
+
+  # first alias the wrapped (non-constant) versions with correct names
+  alias :union! :union
+  alias :intersect! :intersect
+  alias :inflate! :inflate
+  alias :deflate! :deflate
+
+  # redefine offset as offset! returning self
+  wx_offset = instance_method :offset
+  define_method :offset! do |*args|
+    wx_offset.bind(self).call(*args)
+    self
+  end
+
+  # next provide new constant versions
+  def offset(*args)
+    self.dup.offset!(*args)
+  end
+
+  def union(rect)
+    self.dup.union!(rect)
+  end
+
+  def intersect(rect)
+    self.dup.intersect!(rect)
+  end
+
+  def inflate(*args)
+    self.dup.inflate!(*args)
   end
 
-  wx_intersect = instance_method :intersect
-  define_method :intersect do |rect|
-    wx_intersect.bind(Wx::Rect.new(*self.to_ary)).call(rect)
+  def deflate(*args)
+    self.dup.deflate!(*args)
   end
 
   alias :+ :add
@@ -54,4 +79,14 @@ class Wx::Rect
 
   # More ruby-ish names
   alias :contains? :contains
+
+  def dup
+    Wx::Rect.new(self.x, self.y, self.width, self.height)
+  end
+
+  def assign(rct)
+    self.position = rct.position
+    self.size = rct.size
+    self
+  end
 end