wxruby3 0.9.0.pre.beta.14-x64-mingw-ucrt → 0.9.0.pre.rc.1-x64-mingw-ucrt

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9566b98341d3e7555931975c60c3facd1b10060b45187705b5603b86d084aff
-  data.tar.gz: 71b138ada2a3a20d5db75ba119afba4a6096685bde9d7e0c3d456b6b2070619e
+  metadata.gz: 3b0789682f3f41499d529e24441bcff8b0ec200db6b1a84cbac198e445f73f33
+  data.tar.gz: f48166b2c460c774916a7d2b177b73bdc353c0c7f3f35c760de3d6aa9a66dd57
 SHA512:
-  metadata.gz: '09a36c57dffb1c98acb5203f4336b00c1863df09334f3d6e323b197f51e3661bafde7a3adf6951abd748d5ccb64130114f06b86a0251326892e3caf882b1a118'
-  data.tar.gz: 17f1643a1e7e22fa74b7ccc6f1ed3dae336e33a6a40702831dc46c318166f6de52b1dfd5445938de4dd1fd143a3e4d5555312b77ccc58aaf0fe904986d913b07
+  metadata.gz: 8f817d5543dcf138ff6c21b161beff6e8e93677db8922d37da6bcebb4a2940a44400c16b9800ee44ccce4b574eecd1eb2c0db909ab464bcbfb0a0cb89870063c
+  data.tar.gz: 113af98388e9253f223fb5176f9722a61b7485f7a4a56dd79080a6eb55aafc3c6929522977d95e0564e7761e4655c8fdc3dde22796a108f8c5ba853329ca4ee0

data/.yardopts

@@ -1,6 +1,7 @@
 --load rakelib/yard/yard-relative_markdown_links.rb
 --load rakelib/yard/yard-custom-templates.rb
 --charset UTF-8
+--markup markdown
 --readme README.md
 --title "wxRuby3 API Documentation"
 --output-dir rdoc

data/README.md

@@ -13,12 +13,53 @@ Reviving wxRuby
 
 ## Introduction
 
-wxRuby3 is a cross-platform GUI library for Ruby, based on the [wxWidgets](https://wxwidgets.org)
+wxRuby3 is a cross-platform GUI library for Ruby, based on the mature [wxWidgets](https://wxwidgets.org)
 GUI toolkit for C++. It uses native widgets wherever possible, providing
 the correct look, feel and behaviour to GUI applications on Windows, OS
 X and Linux/GTK. wxRuby aims to provide a comprehensive solution to
 developing professional-standard desktop applications in Ruby. 
 
+## Usage examples
+
+### Hello world
+
+wxRuby3 is very easy to use.
+
+```ruby
+require 'wx'
+
+Wx::App.run do
+  Wx::Frame.new(nil, title: 'Hello world!').show
+end
+```
+
+![Hello_World](assets/hello_world.png "Hello World sample")
+
+### Hello Button
+
+Anyone who is familiar with wxWidgets should feel right at home since the API may be Ruby-fied, it is still easily 
+recognizable (but being Ruby-fied allowing for elegant and compact coding). And for those that do not have previous 
+experience do not fear, wxRuby3 comes with detailed [documentation](https://mcorino.github.io/wxRuby3/file.00_starting.html) and lots of examples and test.    
+
+```ruby
+require 'wx'
+
+class TheFrame < Wx::Frame
+  def initialize(title)
+    super(nil, title: title)
+    panel = Wx::Panel.new(self)
+    button = Wx::Button.new(panel, label: 'Click me')
+    button.evt_button(Wx::ID_ANY) { Wx.message_box('Hello. Thanks for clicking me!', 'Hello Button sample') }
+  end
+end
+
+Wx::App.run { TheFrame.new('Hello world!').show }
+```
+
+![Hello_Button](assets/hello_button.png "Hello Button sample")
+![Hello_Button_Clicked](assets/hello_button_clicked.png "Hello Button sample clicked")
+
+
 ## wxRuby3 licence
 
 wxRuby3 is free and open-source. It is distributed under the liberal
@@ -54,8 +95,10 @@ of these products.
 
 Currently the following are fully supported:
 
-* Windows 10 (RubyInstaller MSYS2-DevKit) / Ruby >= 2.5 / wxWidgets >= 3.2
-* Linux (i686 + AMD-64) / Ruby >= 2.5 / wxWidgets >= 3.2
+| Platform                                                                   | Ruby version(s) | wxWidgets version(s) |
+|----------------------------------------------------------------------------|-----------------| --- |
+| Windows 10 (tested)<br>(most likely also Windows 11)                       | Ruby >= 2.5<br>(RubyInstaller MSYS2-DevKit) | wxWidgets >= 3.2 |
+| Linux (tested; any AMD-64 distribution)<br>(most likely also i686 and ARM) | Ruby >= 2.5 | wxWidgets >= 3.2 |
 
 Support for other platforms is not being actively developed at present,
 but patches are welcome. It is likely to be much simpler to get wxRuby
@@ -109,7 +152,7 @@ which may be relevant.
 
 ### What wxWidgets features are supported by wxRuby3?
 
-wxRuby supports almost all of the wxWidgets 3.x GUI API, providing over
+wxRuby supports almost all of the wxWidgets 3.2+ GUI API, providing over
 600 classes in total. wxWidgets classes that provide general and/or non-GUI 
 programming support features, such as strings, networking, threading, database
 access and such are not and will never be ported, as it's assumed that 

data/lib/wx/core/art_locator.rb

@@ -54,7 +54,7 @@ module Wx
       private :search_paths
 
       def add_search_path(*paths)
-        paths.flatten.each { |p| paths << s.to_s unless paths.include?(s.to_s) }
+        paths.flatten.each { |p| search_paths << p.to_s unless search_paths.include?(p.to_s) }
       end
       alias :add_search_paths :add_search_path
 
@@ -74,7 +74,7 @@ module Wx
 
       def find_art(art_name, art_type: nil, art_path: nil, art_section: nil, bmp_type: nil)
         unless art_path
-          caller_path = caller_locations(1).first.absolute_path
+          caller_path = caller_locations(1).first.absolute_path || caller_locations(1).first.path
           art_path = File.dirname(caller_path)
           art_section ||= File.basename(caller_path, '.*')
         end

data/lib/wx/core/artprovider.rb

@@ -7,7 +7,7 @@ class Wx::ArtProvider
     wx_push_back = instance_method(:push_back)
     define_method(:push_back) do | art_prov |
       wx_push_back.bind(self).call(art_prov)
-      @__art_provs.unshift(art_prov)
+      @__art_provs.push(art_prov)
     end
 
     wx_pop = instance_method(:pop)
@@ -19,7 +19,7 @@ class Wx::ArtProvider
     wx_push = instance_method(:push)
     define_method(:push) do | art_prov |
       wx_push.bind(self).call(art_prov)
-      @__art_provs.push(art_prov)
+      @__art_provs.unshift(art_prov)
     end
 
     wx_delete = instance_method(:delete)

data/lib/wx/core/bitmap.rb

@@ -86,15 +86,16 @@ module Wx
     # Accepts a block, which will be passed a device context which can be
     # used to draw upon the Bitmap
     def draw
-      dc = Wx::MemoryDC.new
-      dc.select_object(self)
-      yield dc
-      dc.select_object( Wx::NULL_BITMAP )
+      return unless block_given?
+      Wx::MemoryDC.draw_on(self) do |dc|
+        dc.select_object(self)
+        yield dc
+      end
     end
   end
 
   def self.Bitmap(name, bmp_type = nil)
-    art_path = File.dirname(caller_path = caller_locations(1).first.absolute_path)
+    art_path = File.dirname(caller_path = caller_locations(1).first.absolute_path || caller_locations(1).first.path)
     art_owner = File.basename(caller_path, '.*')
     art_file = ArtLocator.find_art(name, art_type: :bitmap, art_path: art_path, art_section: art_owner, bmp_type: bmp_type)
     ::Kernel.raise ArgumentError, "Cannot locate art file for #{name}:Bitmap" unless art_file

data/lib/wx/core/bitmap_combobox.rb

@@ -0,0 +1,34 @@
+
+module Wx
+
+  class BitmapCombobox < Wx::ComboBox
+
+    # We need to cache client data in Ruby variables as we cannot access items
+    # during the GC mark phase as for some platforms (WXMSW at least) that would
+    # involve calling methods that would break in that phase.
+
+    wx_append = instance_method :append
+    define_method :append do |item, bitmap=Wx::NULL_BITMAP, data=nil|
+      itm_pos = if data
+                  wx_append.bind(self).call(item, bitmap, data)
+                else
+                  wx_append.bind(self).call(item, bitmap)
+                end
+      client_data_store.insert(itm_pos, data)
+      itm_pos
+    end
+
+    wx_insert = instance_method :insert
+    define_method :insert do |item, bitmap, pos, data=nil|
+      itm_pos = if data
+                  wx_insert.bind(self).call(item, bitmap, pos, data)
+                else
+                  wx_insert.bind(self).call(item, bitmap, pos)
+                end
+      client_data_store.insert(itm_pos, data)
+      itm_pos
+    end
+
+  end
+
+end

data/lib/wx/core/controlwithitems.rb

@@ -32,6 +32,7 @@ class Wx::ControlWithItems
 
   wx_append = instance_method :append
   define_method :append do |item, data=nil|
+    itm_pos = -1
     if data
       if ::Array === item
         if !(::Array === data)
@@ -39,21 +40,42 @@ class Wx::ControlWithItems
         elsif data.size != item.size
           ::Kernel.raise ::ArgumentError.new("item and data array must be equal size")
         end
-        offs = get_count
-        wx_append.bind(self).call(item)
-        item.size.times { |ix| set_client_data(offs+ix, data[ix]) }
+        if sorted?
+          item.each_with_index do |itm, ix|
+            itm_pos = wx_append.bind(self).call(itm, data[ix])
+            client_data_store.insert(itm_pos, data[ix])
+          end
+        else
+          offs = get_count
+          itm_pos = wx_append.bind(self).call(item)
+          item.size.times { |ix| set_client_data(offs+ix, data[ix]) }
+        end
       else
-        wx_append.bind(self).call(item, data)
-        client_data_store[get_count-1] = data
+        itm_pos = wx_append.bind(self).call(item, data)
+        client_data_store.insert(itm_pos, data)
       end
     else
-      wx_append.bind(self).call(item)
-      # no changes to data store
+      if ::Array === item
+        if sorted?
+          item.each_with_index do |itm, ix|
+            itm_pos = wx_append.bind(self).call(itm, data[ix])
+            client_data_store.insert(itm_pos, nil)
+          end
+        else
+          itm_pos = wx_append.bind(self).call(item)
+          client_data_store.concat(::Array.new(item.size))
+        end
+      else
+        itm_pos = wx_append.bind(self).call(item)
+        client_data_store.insert(itm_pos, nil)
+      end
     end
+    itm_pos
   end
 
   wx_insert = instance_method :insert
   define_method :insert do |item, pos, data=nil|
+    itm_pos = -1
     if data
       if ::Array === item
         if !(::Array === data)
@@ -61,21 +83,37 @@ class Wx::ControlWithItems
         elsif data.size != item.size
           ::Kernel.raise ::ArgumentError.new("item and data array must be equal size")
         end
-        wx_insert.bind(self).call(item, pos)
-        client_data_store.insert(pos, *::Array.new(item.size))
-        item.size.times { |ix| set_client_data(pos+ix, data[ix]) }
+        if sorted?
+          item.each_with_index do |itm, ix|
+            itm_pos = wx_insert.bind(self).call(itm, data[ix])
+            client_data_store.insert(itm_pos, data[ix])
+          end
+        else
+          itm_pos = wx_insert.bind(self).call(item, pos)
+          client_data_store.insert(pos, *::Array.new(item.size))
+          item.size.times { |ix| set_client_data(pos+ix, data[ix]) }
+        end
       else
-        wx_insert.bind(self).call(item, pos, data)
-        client_data_store.insert(pos, data)
+        itm_pos = wx_insert.bind(self).call(item, pos, data)
+        client_data_store.insert(itm_pos, data)
       end
     else
-      wx_insert.bind(self).call(item, pos)
       if ::Array === item
-        client_data_store.insert(pos, *::Array.new(item.size))
+        if sorted?
+          item.each_with_index do |itm, ix|
+            itm_pos = wx_insert.bind(self).call(itm)
+            client_data_store.insert(itm_pos, nil)
+          end
+        else
+          itm_pos = wx_insert.bind(self).call(item, pos)
+          client_data_store.insert(pos, *::Array.new(item.size))
+        end
       else
+        itm_pos = wx_insert.bind(self).call(item, pos)
         client_data_store.insert(pos, nil)
       end
     end
+    itm_pos
   end
 
   wx_set = instance_method :set

data/lib/wx/core/cursor.rb

@@ -2,7 +2,7 @@
 module Wx
 
   def self.Cursor(name, bmp_type = nil, *rest)
-    art_path = File.dirname(caller_path = caller_locations(1).first.absolute_path)
+    art_path = File.dirname(caller_path = caller_locations(1).first.absolute_path || caller_locations(1).first.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}:Cursor" unless art_file

data/lib/wx/core/dc.rb

@@ -69,24 +69,4 @@ module Wx
 
   end
 
-  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
-
 end

data/lib/wx/core/event_blocker.rb

@@ -0,0 +1,14 @@
+
+module Wx
+
+  class EventBlocker
+
+    class << self
+
+      alias :block_for :blocked_for
+
+    end
+
+  end
+
+end

data/lib/wx/core/events/evt_list.rb

@@ -1180,6 +1180,7 @@ class Wx::EvtHandler
       Wx::EVT_COMBOBOX_CLOSEUP,
       Wx::CommandEvent
     ] if Wx.const_defined?(:EVT_COMBOBOX_CLOSEUP)
+  # from wxBitmapComboBox
   # from wxRadioBox
   # from wxPanel
   # from wxNotebook
@@ -1195,6 +1196,17 @@ class Wx::EvtHandler
     ] if Wx.const_defined?(:EVT_NOTEBOOK_PAGE_CHANGING)
   # from wxListBox
   # from wxChoice
+  # from wxSearchCtrl
+  self.register_event_type EventType[
+      'evt_search', 1,
+      Wx::EVT_SEARCH,
+      Wx::CommandEvent
+    ] if Wx.const_defined?(:EVT_SEARCH)
+  self.register_event_type EventType[
+      'evt_search_cancel', 1,
+      Wx::EVT_SEARCH_CANCEL,
+      Wx::CommandEvent
+    ] if Wx.const_defined?(:EVT_SEARCH_CANCEL)
   # from wxCollapsiblePane
   # from wxSlider
   # from wxScrollBar

data/lib/wx/core/evthandler.rb

@@ -17,9 +17,45 @@ class Wx::EvtHandler
 
   # Fast look-up hash to map event type ids to ruby event classes
   EVENT_TYPE_CLASS_MAP = {}
+  private_constant :EVENT_TYPE_CLASS_MAP
   # Hash to look up EVT constants from symbol names of evt handler
   # methods; used internally by disconnect (see EvtHandler.i)
   EVENT_NAME_TYPE_MAP = {}
+  private_constant :EVENT_NAME_TYPE_MAP
+
+  class << self
+
+    def get_event_type_class_map
+      EVENT_TYPE_CLASS_MAP
+    end
+    private :get_event_type_class_map
+
+    # Add caching for added event filters as we need to keep these alive
+    # for as long as they are registered
+
+    def event_filters
+      @event_filters ||= []
+    end
+    private :event_filters
+
+    wx_add_filter = instance_method :add_filter
+    define_method :add_filter do |filter|
+      wx_add_filter.bind(self).call(filter)
+      event_filters << filter
+    end
+
+    wx_remove_filter = instance_method :remove_filter
+    define_method :remove_filter do |filter|
+      wx_remove_filter.bind(self).call(filter)
+      event_filters.delete(filter)
+    end
+
+    def clear_filters
+      event_filters.each { |f| remove_filter(f) }
+      event_filters.clear
+    end
+
+  end
 
   # Given a Wx EventType id (eg Wx::EVT_MENU), returns a WxRuby Event
   # class which should be passed to event handler blocks. The actual

data/lib/wx/core/find_replace_dialog.rb

@@ -0,0 +1,24 @@
+
+module Wx
+
+  class FindReplaceDialog < Wx::Dialog
+
+    # add caching for FindReplaceData object
+    # dialog does not take over ownership but does allow referencing
+    # the data object so we need to keep it alive here
+
+    wx_initialize = instance_method :initialize
+    define_method :initialize do |parent, data, *args|
+      wx_initialize.bind(self).call(parent, data, *args)
+      @fr_data = data
+    end
+
+    wx_set_data = instance_method :set_data
+    define_method :set_data do |data|
+      wx_set_data.bind(self).call(data)
+      @fr_data = data
+    end
+
+  end
+
+end

data/lib/wx/core/icon.rb

@@ -51,7 +51,7 @@ module Wx
   end
 
   def self.Icon(name, bmp_type = nil, *rest)
-    art_path = File.dirname(caller_path = caller_locations(1).first.absolute_path)
+    art_path = File.dirname(caller_path = caller_locations(1).first.absolute_path || caller_locations(1).first.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

data/lib/wx/core/image.rb

@@ -69,7 +69,7 @@ module Wx
   end
 
   def self.Image(name, bmp_type = nil, *rest)
-    art_path = File.dirname(caller_path = caller_locations(1).first.absolute_path)
+    art_path = File.dirname(caller_path = caller_locations(1).first.absolute_path || caller_locations(1).first.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

data/lib/wx/core/paintdc.rb

@@ -0,0 +1,8 @@
+
+class Wx::PaintDC
+
+  def self.draw_on(win, &block)
+    win.paint(&block) if block
+  end
+
+end

data/lib/wx/core/text_entry.rb

@@ -0,0 +1,15 @@
+
+module Wx
+
+  module TextEntry
+
+    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
+      end
+    end
+
+  end
+
+end

data/lib/wx/core/v_list_box.rb

@@ -0,0 +1,13 @@
+
+class Wx::VListBox
+
+  wx_each_selected = instance_method :each_selected
+  define_method :each_selected do |&block|
+    if block
+      wx_each_selected.bind(self).call(&block)
+    else
+      ::Enumerator.new { |y| wx_each_selected.bind(self).call { |sel| y << sel } }
+    end
+  end
+
+end

data/lib/wx/core/window.rb

@@ -49,7 +49,7 @@ class Wx::Window
   # This modified version of evt_paint sets a variable indicating that a
   # paint event is being handled just before running the event
   # handler. This ensures that any call to Window#paint within the
-  # handler will supply a Wx::PaintDC (see swig/Window.i).
+  # handler will supply a Wx::PaintDC (see Window SWIG director).
   def evt_paint(meth = nil, &block)
     paint_proc = acquire_handler(meth, block)
     wrapped_block = proc do | event |

data/lib/wx/doc/busy_info.rb

@@ -0,0 +1,21 @@
+
+module Wx
+
+  class BusyInfo
+
+    # @overload busy(message, parent=nil)
+    #   Shows busy info window with message, blocks event handling and calls the given block
+    #   passing the BusyInfo instance as argument.
+    #   @param [String] message
+    #   @param [Wx::Window,nil] parent
+    #   @yieldparam [Wx::BusyInfo] bi BusyInfo instance
+    # @overload busy(busy_info)
+    #   Shows busy info window according to busy_info settings, blocks event handling and calls the given block
+    #   passing the BusyInfo instance as argument.
+    #   @param [Wx::BusyInfoFlags] busy_info
+    #   @yieldparam [Wx::BusyInfo] bi BusyInfo instance
+    def self.busy(*args) end
+
+  end
+
+end

data/lib/wx/doc/client_dc.rb

@@ -0,0 +1,28 @@
+
+module Wx
+
+  class ClientDC < Wx::DC
+
+    # Executes the given block providing a temporary (client) dc as
+    # 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
+    def self.draw_on(win) end
+
+  end
+
+  class PaintDC < Wx::ClientDC
+
+    # Executes the given block providing a temporary dc as
+    # it's single argument.
+    # Pass a pointer to the window on which you wish to paint.
+    # @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
+    def self.draw_on(win) end
+
+  end
+
+end

data/lib/wx/doc/controlwithitems.rb

@@ -0,0 +1,11 @@
+
+class Wx::ControlWithItems
+
+  # Returns true if the items in the control are sorted
+  # (style Wx::LB_SORT for list boxes or Wx::CB_SORT for combo boxes).
+  # This method is mostly meant for internal use only.
+  # @return [Boolean] true is sorted, false otherwise
+  def is_sorted; end
+  alias :sorted? :is_sorted
+
+end

data/lib/wx/doc/dc.rb

@@ -49,18 +49,4 @@ module Wx
 
   end
 
-  class MemoryDC
-
-    # Creates a Memory DC and passes that to the given block to draw on.
-    # Automatically unselects any source object of the MemoryDC after the block finishes.
-    # @overload self.draw_on(bitmap)
-    #   @param [Wx::Bitmap]
-    #   @yieldparam [WxMemoryDC] dc
-    # @overload self.draw_on(dc)
-    #   @param [Wx::DC]
-    #   @yieldparam [WxMemoryDC] dc
-    def self.draw_on(arg, &block) end
-
-  end
-
 end