wxruby3 1.3.1 → 1.4.2

data/rakelib/lib/generate/doc/evt_handler.yaml

@@ -6,23 +6,42 @@
         - :pattern: !ruby/regexp /.*/
           :replace: ''
     :post:
-      - :pattern: !ruby/regexp /This\s+implies\s+that\s+the\s+event\s+should\s+be\s+allocated\s+on\s+the\s+heap\s+and/
-        :subst: 'This implies'
-      - :pattern: !ruby/regexp /\{Wx::EvtHandler#queue_event\}.*For\s+example:/
+      - :pattern: !ruby/regexp /\,\s+i\.e\.\s+it\s+will\s+delete\s+it\s+itself/
         :subst: ''
-      - :pattern: !ruby/regexp /Note.*problem:/
+      - :pattern: !ruby/regexp /This\s+implies\s+that\s+the\s+event\s+should\s+be\s+allocated.*deleted\s+at\s+any\s+moment\)/
+        :subst: "This implies that the event (or any of it's member objects) should not be used/changed after the function returns (as it can be handled and subsequently discarded at any moment)"
+      - :pattern: !ruby/regexp /\{Wx::EvtHandler#queue_event\}.*not\s+used\s+by\s+the\s+calling\s+thread\s+any\s+more\./
+        :subst: ''
+      - :pattern: !ruby/regexp /Care\s+should\s+still\s+be\s+taken\s+to\s+avoid\s+that\s+some\s+fields.*/
+        :subst: ''
+      - :pattern: !ruby/regexp /Example:/
+        :subst: ''
+      - :pattern: !ruby/regexp /Note\s+that\s+if\s+you\s+want\s+to\s+pass\s+more\s+data.*/
+        :subst: ''
+      - :pattern: !ruby/regexp /Reimplemented\s+in.*/
+        :subst: ''
+:wxEvtHandler.AddPendingEvent:
+  :detail:
+    :post:
+      - :pattern: !ruby/regexp /This\s+function\s+is\s+similar\s+to\s+\{Wx::EvtHandler#queue_event\}.*/
+        :subst: 'This function is similar to {Wx::EvtHandler#queue_event}.'
+      - :pattern: !ruby/regexp /A\s+copy\s+of\s+event\s+is\s+made\s+by\s+the\s+function,.*/
+        :subst: 'Other than {Wx::EvtHandler#queue_event} this method creates a (shallow) copy of event before queueing the copied event. In case (user defined) event classes require deep copying of Ruby member object these classes should override the #initialize_clone method (**NOT** #clone as wxRuby3 does not currently support overriding event class #clone methods).'
+      - :pattern: !ruby/regexp /Reimplemented\s+in.*/
         :subst: ''
 :wxEvtHandler.SetNextHandler:
+  :brief:
+    :post:
+      - :pattern: !ruby/regexp /Sets\s+the\s+pointer\s+to\s+the\s+next\s+handler\./
+        :subst: 'Inserts the given handler as the next handler in the chain.'
   :detail:
     :pre:
-      :programlisting:
-        - :pattern: !ruby/regexp /.*/
-          :replace: |
-            
-            ```ruby
-              handlerA.set_next_handler(handlerB)
-              handlerB.set_previous_handler(handlerA)
-            ```
+      :para:
+        - :pattern: !ruby/regexp /See.*ProcessEvent\(\)/
+          :replace:  |
+            In wxRuby this fully handles double linking, i.e. wxRuby will take care of pointing the handler given
+            back to this handler as well. There is no need to call set_previous_handler so this method is not supported 
+            in wxRuby3.
 :wxEvtHandler.TryBefore:
   :detail:
     :pre:

data/rakelib/lib/specs/interfaces.rb

@@ -201,6 +201,7 @@ module WXRuby3
     Director.Spec(pkg, 'wxDragDrop', requirements: %w[USE_DRAG_AND_DROP])
     Director.Spec(pkg, 'wxContextHelpButton', requirements: %w[USE_HELP])
     Director.Spec(pkg, 'wxHelpProvider', requirements: %w[USE_HELP])
+    Director.Spec(pkg, 'wxTipWindow', requirements: %w[USE_HELP])
     Director.Spec(pkg, 'wxHelpController', requirements: %w[USE_HELP])
     Director.Spec(pkg, 'wxExtHelpController', director: Director::HelpController, requirements: %w[USE_HELP])
     Director.Spec(pkg, 'wxTaskBarIconEvent', director: Director::Event, requirements: %w[USE_TASKBARICON])

data/tests/test_combo_ctrl.rb

@@ -23,6 +23,7 @@ class ComboCtrlCtrlTests < WxRuby::Test::GUITests
     end
 
     def create(parent)
+      GC.start
       # need to finish creating the list view here
       # as calling super here would just call Wx::ComboPopup#create and not Wx::ListView#create
       # we need to use Ruby magic

data/tests/test_event_handling.rb

@@ -10,6 +10,14 @@ class EventHandlingTests < Test::Unit::TestCase
     EVT_TEST_EVENT = Wx::EvtHandler.register_class(self, nil, 'evt_test_event', 0)
     def initialize(id=0)
       super(EVT_TEST_EVENT, id)
+      @value = nil
+    end
+
+    attr_accessor :value
+
+    def initialize_clone(org)
+      super
+      self.value = org.value.dup if org.value
     end
   end
 
@@ -53,15 +61,18 @@ class EventHandlingTests < Test::Unit::TestCase
       super(nil, size: [300,300])
       @child = Child.new(self)
       @test_event = false
+      @test_event_value = nil
       @test_cmd_event = false
+      @focus_event = false
       @called_after = false
 
-      evt_test_event { |evt| @test_event = true }
+      evt_test_event { |evt| @test_event = true; @test_event_value = evt.value }
       evt_test_cmd_event { |evt| @test_cmd_event = true }
+      evt_set_focus { |evt| @focus_event = true }
     end
 
     attr_reader :child
-    attr_reader :test_event, :test_cmd_event
+    attr_reader :test_event, :test_event_value, :test_cmd_event, :focus_event
     attr_accessor :called_after
 
     def reset
@@ -76,16 +87,20 @@ class EventHandlingTests < Test::Unit::TestCase
     win = TestFrame.new
     assert(!win.test_event)
     assert(!win.child.test_event)
-    win.child.event_handler.process_event(TestEvent.new)
+    win.child.process_event(TestEvent.new)
     assert(!win.test_event)
     assert(win.child.test_event)
     win.reset
-    win.child.event_handler.process_event(TestEvent.new(1))
+    win.child.process_event(TestEvent.new(1))
     assert(!win.test_event)
     assert(win.child.test_event)
     win.reset
-    win.event_handler.process_event(TestEvent.new)
+    evt = TestEvent.new
+    evt.value = 'Something happened'.dup
+    win.process_event(evt)
+    evt.value << ' again'
     assert(win.test_event)
+    assert_equal('Something happened again', win.test_event_value)
     assert(!win.child.test_event)
     win.destroy
     Wx.get_app.yield
@@ -95,43 +110,72 @@ class EventHandlingTests < Test::Unit::TestCase
     win = TestFrame.new
     assert_false(win.test_cmd_event)
     assert_false(win.child.test_cmd_event)
-    win.child.event_handler.process_event(TestCmdEvent.new)
+    win.child.process_event(TestCmdEvent.new)
     assert_false(win.test_cmd_event)
     assert_true(win.child.test_cmd_event)
     assert_false(win.child.test_client_data)
     win.reset
-    win.child.event_handler.process_event(TestCmdEvent.new(1))
+    win.child.process_event(TestCmdEvent.new(1))
     assert_true(win.test_cmd_event)
     assert_true(win.child.test_cmd_event)
     assert_true(win.child.test_client_data)
     win.reset
-    win.event_handler.process_event(TestCmdEvent.new)
+    win.process_event(TestCmdEvent.new)
     assert_true(win.test_cmd_event)
     assert_false(win.child.test_cmd_event)
     win.destroy
     Wx.get_app.yield
   end
 
+  def test_queue_focus_event
+    win = TestFrame.new
+    assert_false(win.focus_event)
+    win.queue_event(Wx::FocusEvent.new(Wx::EVT_SET_FOCUS))
+    Wx.get_app.yield
+    assert_true(win.focus_event)
+    win.destroy
+    Wx.get_app.yield
+  end
+
   def test_queue_event
     win = TestFrame.new
     assert_false(win.test_cmd_event)
     assert_false(win.child.test_cmd_event)
-    win.child.event_handler.queue_event(TestCmdEvent.new)
+    win.child.queue_event(TestCmdEvent.new)
     Wx.get_app.yield
     assert_false(win.test_cmd_event)
     assert_true(win.child.test_cmd_event)
     assert_false(win.child.test_client_data)
     win.reset
-    win.child.event_handler.queue_event(TestCmdEvent.new(1))
+    win.child.queue_event(TestCmdEvent.new(1))
     Wx.get_app.yield
     assert_true(win.test_cmd_event)
     assert_true(win.child.test_cmd_event)
     assert_true(win.child.test_client_data)
     win.reset
-    win.event_handler.queue_event(TestCmdEvent.new)
+    win.queue_event(TestCmdEvent.new)
     Wx.get_app.yield
     assert_true(win.test_cmd_event)
     assert_false(win.child.test_cmd_event)
+    win.reset
+    evt = TestEvent.new
+    evt.value = 'Something happened'.dup
+    win.queue_event(evt)
+    evt.value << ' again'
+    Wx.get_app.yield
+    assert_true(win.test_event)
+    assert_equal('Something happened again', win.test_event_value)
+    assert_false(win.child.test_event)
+    win.destroy
+    Wx.get_app.yield
+  end
+
+  def test_pending_focus_event
+    win = TestFrame.new
+    assert_false(win.focus_event)
+    win.add_pending_event(Wx::FocusEvent.new(Wx::EVT_SET_FOCUS))
+    Wx.get_app.yield
+    assert_true(win.focus_event)
     win.destroy
     Wx.get_app.yield
   end
@@ -140,22 +184,31 @@ class EventHandlingTests < Test::Unit::TestCase
     win = TestFrame.new
     assert_false(win.test_cmd_event)
     assert_false(win.child.test_cmd_event)
-    win.child.event_handler.add_pending_event(TestCmdEvent.new)
+    win.child.add_pending_event(TestCmdEvent.new)
     Wx.get_app.yield
     assert_false(win.test_cmd_event)
     assert_true(win.child.test_cmd_event)
     assert_false(win.child.test_client_data)
     win.reset
-    win.child.event_handler.add_pending_event(TestCmdEvent.new(1))
+    win.child.add_pending_event(TestCmdEvent.new(1))
     Wx.get_app.yield
     assert_true(win.test_cmd_event)
     assert_true(win.child.test_cmd_event)
     assert_true(win.child.test_client_data)
     win.reset
-    win.event_handler.add_pending_event(TestCmdEvent.new)
+    win.add_pending_event(TestCmdEvent.new)
     Wx.get_app.yield
     assert_true(win.test_cmd_event)
     assert_false(win.child.test_cmd_event)
+    win.reset
+    evt = TestEvent.new
+    evt.value = 'Something happened'.dup
+    win.add_pending_event(evt)
+    evt.value << ' again'
+    Wx.get_app.yield
+    assert_true(win.test_event)
+    assert_equal('Something happened', win.test_event_value)
+    assert_false(win.child.test_event)
     win.destroy
     Wx.get_app.yield
   end
@@ -164,19 +217,19 @@ class EventHandlingTests < Test::Unit::TestCase
     win = TestFrame.new
     assert_false(win.test_cmd_event)
     assert_false(win.child.test_cmd_event)
-    Wx.post_event(win.child.event_handler, TestCmdEvent.new)
+    Wx.post_event(win.child, TestCmdEvent.new)
     Wx.get_app.yield
     assert_false(win.test_cmd_event)
     assert_true(win.child.test_cmd_event)
     assert_false(win.child.test_client_data)
     win.reset
-    Wx.post_event(win.child.event_handler, TestCmdEvent.new(1))
+    Wx.post_event(win.child, TestCmdEvent.new(1))
     Wx.get_app.yield
     assert_true(win.test_cmd_event)
     assert_true(win.child.test_cmd_event)
     assert_true(win.child.test_client_data)
     win.reset
-    Wx.post_event(win.event_handler, TestCmdEvent.new)
+    Wx.post_event(win, TestCmdEvent.new)
     Wx.get_app.yield
     assert_true(win.test_cmd_event)
     assert_false(win.child.test_cmd_event)
@@ -187,11 +240,11 @@ class EventHandlingTests < Test::Unit::TestCase
   def test_call_after
     win = TestFrame.new
     assert(!win.called_after)
-    win.event_handler.call_after { win.called_after = true }
+    win.call_after { win.called_after = true }
     Wx.get_app.yield
     assert(win.called_after)
     win.reset
-    win.child.event_handler.call_after { win.called_after = true }
+    win.child.call_after { win.called_after = true }
     Wx.get_app.yield
     assert(win.called_after)
     win.destroy
@@ -201,31 +254,105 @@ class EventHandlingTests < Test::Unit::TestCase
   def test_event_blocker
     win = TestFrame.new
     assert(!win.test_event)
-    win.event_handler.process_event(TestEvent.new)
+    win.process_event(TestEvent.new)
     assert(win.test_event)
     win.reset
     Wx::EventBlocker.blocked_for(win) do |blkr|
-      win.event_handler.process_event(TestEvent.new(1))
+      win.process_event(TestEvent.new(1))
     end
     assert(!win.test_event)
-    win.event_handler.process_event(TestEvent.new)
+    win.process_event(TestEvent.new)
     assert(win.test_event)
     win.reset
     Wx::EventBlocker.blocked_for(win, TestEvent::EVT_TEST_EVENT) do |blkr|
-      win.event_handler.process_event(TestEvent.new(1))
+      win.process_event(TestEvent.new(1))
     end
     assert(!win.test_event)
-    win.event_handler.process_event(TestEvent.new)
+    win.process_event(TestEvent.new)
     assert(win.test_event)
     win.reset
     Wx::EventBlocker.blocked_for(win, Wx::EVT_ACTIVATE) do |blkr|
-      win.event_handler.process_event(TestEvent.new(1))
+      win.process_event(TestEvent.new(1))
     end
     assert(win.test_event)
     win.destroy
     Wx.get_app.yield
   end
 
+  class MyEventHandler < Wx::EvtHandler
+
+    def initialize
+      super
+      @test_event = false
+      @test_cmd_event = false
+      evt_test_event :on_test_event
+      evt_test_cmd_event :on_test_cmd_event
+    end
+
+    attr_reader :test_event, :test_cmd_event
+
+    def on_test_event(_evt)
+      @test_event = true
+    end
+
+    def on_test_cmd_event(evt)
+      @test_cmd_event = true
+    end
+  end
+
+  class EventSnooper < Wx::EvtHandler
+
+    def initialize
+      super
+      @test_event = false
+      @test_cmd_event = false
+      evt_test_event :on_test_event
+      evt_test_cmd_event :on_test_cmd_event
+    end
+
+    attr_reader :test_event, :test_cmd_event
+
+    def on_test_event(_evt)
+      @test_event = true
+    end
+
+    def on_test_cmd_event(evt)
+      @test_cmd_event = true
+      evt.skip # make sure other handler(s) get this too
+    end
+
+  end
+
+  def test_chained_event_handler
+    snooper = EventSnooper.new
+    my_handler = MyEventHandler.new
+    snooper.set_next_handler(my_handler)
+    assert_false(my_handler.test_event)
+    assert_false(snooper.test_event)
+    snooper.process_event(TestEvent.new)
+    assert_false(my_handler.test_event)
+    assert_true(snooper.test_event)
+  end
+
+  def test_pushed_event_handler
+    win = TestFrame.new
+    snooper = EventSnooper.new
+    win.push_event_handler(snooper)
+    assert_false(win.test_event)
+    assert_false(snooper.test_event)
+    win.process_event(TestEvent.new)
+    assert_false(win.test_event)
+    assert_true(snooper.test_event)
+    win.reset
+    assert_false(win.test_cmd_event)
+    assert_false(snooper.test_cmd_event)
+    win.process_event(TestCmdEvent.new)
+    assert_true(win.test_cmd_event)
+    assert_true(snooper.test_cmd_event)
+    win.destroy
+    Wx.get_app.yield
+  end
+
   class MyEventFilter < Wx::EventFilter
     def initialize
       super
@@ -245,16 +372,16 @@ class EventHandlingTests < Test::Unit::TestCase
     assert_nothing_raised { Wx::EvtHandler.add_filter(filter) }
     GC.start
     win = TestFrame.new
-    win.child.event_handler.process_event(TestEvent.new)
+    win.child.process_event(TestEvent.new)
     GC.start
     assert(filter.filtered)
     filter.filtered = false
-    win.child.event_handler.process_event(TestCmdEvent.new)
+    win.child.process_event(TestCmdEvent.new)
     GC.start
     assert(!filter.filtered)
     assert_nothing_raised { Wx::EvtHandler.remove_filter(filter) }
     GC.start
-    win.child.event_handler.process_event(TestEvent.new)
+    win.child.process_event(TestEvent.new)
     assert(!filter.filtered)
     GC.start
     win.destroy
@@ -277,16 +404,16 @@ class EventHandlingTests < Test::Unit::TestCase
     assert_nothing_raised { Wx::EvtHandler.add_filter(MyEventFilter2.new) }
     GC.start
     win = TestFrame.new
-    win.child.event_handler.process_event(TestEvent.new)
+    win.child.process_event(TestEvent.new)
     GC.start
     assert(MyEventFilter2.filtered)
     MyEventFilter2.filtered = false
-    win.child.event_handler.process_event(TestCmdEvent.new)
+    win.child.process_event(TestCmdEvent.new)
     GC.start
     assert(!MyEventFilter2.filtered)
     assert_nothing_raised { Wx::EvtHandler.clear_filters }
     GC.start
-    win.child.event_handler.process_event(TestEvent.new)
+    win.child.process_event(TestEvent.new)
     assert(!MyEventFilter2.filtered)
     GC.start
     win.destroy

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: wxruby3
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.2
 platform: ruby
 authors:
 - Martin Corino
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-08 00:00:00.000000000 Z
+date: 2024-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -205,6 +204,7 @@ files:
 - lib/wx/core/menu.rb
 - lib/wx/core/menu_bar.rb
 - lib/wx/core/menuitem.rb
+- lib/wx/core/module_ext.rb
 - lib/wx/core/notebook.rb
 - lib/wx/core/object.rb
 - lib/wx/core/owner_drawn_combobox.rb
@@ -339,6 +339,7 @@ files:
 - lib/wx/doc/system_settings.rb
 - lib/wx/doc/text_validator.rb
 - lib/wx/doc/textctrl.rb
+- lib/wx/doc/tip_window.rb
 - lib/wx/doc/top_level_window.rb
 - lib/wx/doc/tree_ctrl.rb
 - lib/wx/doc/tree_event.rb
@@ -667,6 +668,7 @@ files:
 - rakelib/lib/director/time_picker_ctrl.rb
 - rakelib/lib/director/timer.rb
 - rakelib/lib/director/tip_provider.rb
+- rakelib/lib/director/tip_window.rb
 - rakelib/lib/director/toggle_button.rb
 - rakelib/lib/director/tool_bar.rb
 - rakelib/lib/director/tool_tip.rb
@@ -1207,8 +1209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: wxWidgets extension for Ruby
 test_files: []