wxruby3 0.9.2 → 0.9.3

data/samples/xrc/custom_xrc_sample.rb

@@ -11,51 +11,57 @@
 
 require 'wx'
 
-# Basic Frame Class. This creates the dialog window
-class SimpleFrame < Wx::Frame 
-  def initialize
-    super nil, :title => "Custom XRC Dialog Sample", :pos => [50, 50], :size => [300, 300]
-
-    txt = "Choose 'Open Dialog' from the menu to see a dialog made with XRC"
-    Wx::StaticText.new self, :label => txt, :pos => [20, 20]
-
-    # Create a new menu
-    self.menu_bar = Wx::MenuBar.new
-    menu = Wx::Menu.new
-    menu.append Wx::ID_OPEN, "Open Dialog"
-    menu.append Wx::ID_EXIT, "Quit"
-    menu_bar.append(menu,"File")
-    
-    # Assign the menu events
-    evt_menu(Wx::ID_OPEN) { (dlg = $xml.load_dialog(self, 'SAMPLE_DIALOG').setup_dialog).show_modal; dlg.destroy }
-    evt_menu(Wx::ID_EXIT) { close }
+module XrcCustom
+
+  # Basic Frame Class. This creates the dialog window
+  class SimpleFrame < Wx::Frame
+    def initialize
+      super nil, :title => "Custom XRC Dialog Sample", :pos => [50, 50], :size => [300, 300]
+
+      self.icon = Wx.Icon(:sample, Wx::BITMAP_TYPE_XPM, art_path: File.join(__dir__, '..'))
+
+      txt = "Choose 'Open Dialog' from the menu to see a dialog made with XRC"
+      Wx::StaticText.new self, :label => txt, :pos => [20, 20]
+
+      # Create a new menu
+      self.menu_bar = Wx::MenuBar.new
+      menu = Wx::Menu.new
+      menu.append Wx::ID_OPEN, "Open Dialog"
+      menu.append Wx::ID_EXIT, "Quit"
+      menu_bar.append(menu,"File")
+
+      # Assign the menu events
+      evt_menu(Wx::ID_OPEN) { (dlg = $xml.load_dialog(self, 'SAMPLE_DIALOG').setup_dialog).show_modal; dlg.destroy }
+      evt_menu(Wx::ID_EXIT) { close }
+    end
   end
-end
 
-# Dialog subclass. The components within the dialog are loaded from XRC.
-class CustomDialog < Wx::Dialog
-  def setup_dialog
-    # Get the buttons. The xrcid method turns a string identifier
-    # used in an xml file into a numeric identifier as used in
-    # wxruby. 
-    @ok      = find_window_by_id( Wx::xrcid('wxID_OK') )
-    @cancel  = find_window_by_id( Wx::xrcid('wxID_CANCEL') )
-    @message = find_window_by_id( Wx::xrcid('SAMPLE_MESSAGE') )
-
-    # Bind the buttons to event handlers
-    evt_button(@ok) { end_modal(Wx::ID_OK) }
-    evt_button(@cancel) { end_modal(Wx::ID_CANCEL) }
-    evt_button(@message) do
-      Wx::message_box("And now a message from our sponsors.")
+  # Dialog subclass. The components within the dialog are loaded from XRC.
+  class CustomDialog < Wx::Dialog
+    def setup_dialog
+      # Get the buttons. The xrcid method turns a string identifier
+      # used in an xml file into a numeric identifier as used in
+      # wxruby.
+      @ok      = find_window_by_id( Wx::xrcid('wxID_OK') )
+      @cancel  = find_window_by_id( Wx::xrcid('wxID_CANCEL') )
+      @message = find_window_by_id( Wx::xrcid('SAMPLE_MESSAGE') )
+
+      # Bind the buttons to event handlers
+      evt_button(@ok) { end_modal(Wx::ID_OK) }
+      evt_button(@cancel) { end_modal(Wx::ID_CANCEL) }
+      evt_button(@message) do
+        Wx::message_box("And now a message from our sponsors.")
+      end
+      self
     end
-    self
   end
-end
 
-class CustomDialogXmlFactory < Wx::XmlSubclassFactory
-  def create(subclass)
-    subclass == 'CustomDialog' ? CustomDialog.new : nil
+  class CustomDialogXmlFactory < Wx::XmlSubclassFactory
+    def create(subclass)
+      subclass == 'CustomDialog' ? CustomDialog.new : nil
+    end
   end
+
 end
 
 module CustomXrcSample
@@ -71,13 +77,13 @@ module CustomXrcSample
 
   def self.activate
     # add the CustomDialog XML factory
-    Wx::XmlResource.add_subclass_factory(CustomDialogXmlFactory.new)
+    Wx::XmlResource.add_subclass_factory(XrcCustom::CustomDialogXmlFactory.new)
     # Get a new resources object
     xrc_file = File.join( File.dirname(__FILE__), 'custom_dialog.xrc' )
     $xml = Wx::XmlResource.new(xrc_file)
 
     # Show the main frame.
-    main = SimpleFrame.new
+    main = XrcCustom::SimpleFrame.new
     main.show(true)
     main
   end

data/samples/xrc/xrc_sample.rb

@@ -11,56 +11,62 @@
 
 require 'wx'
 
-# Basic Frame Class. This creates the dialog window
-class SimpleFrame < Wx::Frame 
-  def initialize()
-    super nil, :title => "XRC Dialog Sample", :pos => [50, 50], :size => [300, 300]
-
-    txt = "Choose 'Open Dialog' from the menu to see a dialog made with XRC"
-    Wx::StaticText.new self, :label => txt, :pos => [20, 20]
-
-    # Create a new menu
-    self.menu_bar = Wx::MenuBar.new
-    menu = Wx::Menu.new
-    menu.append Wx::ID_OPEN, "Open Dialog"
-    menu.append Wx::ID_EXIT, "Quit"
-    menu_bar.append(menu,"File")
-    
-    # Assign the menu events
-    evt_menu(Wx::ID_OPEN) { SimpleDialog(self) }
-    evt_menu(Wx::ID_EXIT) { close }
+module Xrc
+
+  # Basic Frame Class. This creates the dialog window
+  class SimpleFrame < Wx::Frame
+    def initialize()
+      super nil, :title => "XRC Dialog Sample", :pos => [50, 50], :size => [300, 300]
+
+      self.icon = Wx.Icon(:sample, Wx::BITMAP_TYPE_XPM, art_path: File.join(__dir__, '..'))
+
+      txt = "Choose 'Open Dialog' from the menu to see a dialog made with XRC"
+      Wx::StaticText.new self, :label => txt, :pos => [20, 20]
+
+      # Create a new menu
+      self.menu_bar = Wx::MenuBar.new
+      menu = Wx::Menu.new
+      menu.append Wx::ID_OPEN, "Open Dialog"
+      menu.append Wx::ID_EXIT, "Quit"
+      menu_bar.append(menu,"File")
+
+      # Assign the menu events
+      evt_menu(Wx::ID_OPEN) { Xrc.SimpleDialog(self) }
+      evt_menu(Wx::ID_EXIT) { close }
+    end
   end
-end
 
-# Dialog subclass. The components within the dialog are loaded from XRC.
-class SimpleDialog < Wx::Dialog
-  def initialize(parent)
-    # To load a layout defined in XRC into a Ruby subclass of Dialog,
-    # first call the empty constructor. All the details of size,
-    # title, position and so on are loaded from the XRC by the call to 
-    # load_frame_subclass. Using a non-empty constructor will cause
-    # errors on GTK.
-    super()
-    
-    # Load the dialog from XRC. We define $xml in on_init.
-    # We could use XmlResource.get() over and over again, but
-    # honestly, thats just too much work.
-    $xml.load_dialog_subclass(self,parent,'SAMPLE_DIALOG')
-
-    # Get the buttons. The xrcid method turns a string identifier
-    # used in an xml file into a numeric identifier as used in
-    # wxruby. 
-    @ok      = find_window_by_id( Wx::xrcid('wxID_OK') )
-    @cancel  = find_window_by_id( Wx::xrcid('wxID_CANCEL') )
-    @message = find_window_by_id( Wx::xrcid('SAMPLE_MESSAGE') )
-
-    # Bind the buttons to event handlers
-    evt_button(@ok) { end_modal(Wx::ID_OK) }
-    evt_button(@cancel) { end_modal(Wx::ID_CANCEL) }
-    evt_button(@message) do
-      Wx::message_box("And now a message from our sponsors.")
+  # Dialog subclass. The components within the dialog are loaded from XRC.
+  class SimpleDialog < Wx::Dialog
+    def initialize(parent)
+      # To load a layout defined in XRC into a Ruby subclass of Dialog,
+      # first call the empty constructor. All the details of size,
+      # title, position and so on are loaded from the XRC by the call to
+      # load_frame_subclass. Using a non-empty constructor will cause
+      # errors on GTK.
+      super()
+
+      # Load the dialog from XRC. We define $xml in on_init.
+      # We could use XmlResource.get() over and over again, but
+      # honestly, that's just too much work.
+      $xml.load_dialog_subclass(self,parent,'SAMPLE_DIALOG')
+
+      # Get the buttons. The xrcid method turns a string identifier
+      # used in an xml file into a numeric identifier as used in
+      # wxruby.
+      @ok      = find_window_by_id( Wx::xrcid('wxID_OK') )
+      @cancel  = find_window_by_id( Wx::xrcid('wxID_CANCEL') )
+      @message = find_window_by_id( Wx::xrcid('SAMPLE_MESSAGE') )
+
+      # Bind the buttons to event handlers
+      evt_button(@ok) { end_modal(Wx::ID_OK) }
+      evt_button(@cancel) { end_modal(Wx::ID_CANCEL) }
+      evt_button(@message) do
+        Wx::message_box("And now a message from our sponsors.")
+      end
     end
   end
+
 end
 
 module XrcSample
@@ -79,7 +85,7 @@ module XrcSample
     $xml = Wx::XmlResource.new(xrc_file)
 
     # Show the main frame.
-    main = SimpleFrame.new()
+    main = Xrc::SimpleFrame.new()
     main.show(true)
     main
   end

data/tests/test_event_handling.rb

@@ -13,10 +13,13 @@ class EventHandlingTests < Test::Unit::TestCase
     end
   end
 
+  CLIENT_DATA = {one: 'first'}
+
   class TestCmdEvent < Wx::CommandEvent
     EVT_TEST_CMD_EVENT = Wx::EvtHandler.register_class(self, nil, 'evt_test_cmd_event', 0)
     def initialize(id=0)
       super(EVT_TEST_CMD_EVENT, id)
+      set_client_object(CLIENT_DATA.dup) if id > 0
     end
   end
 
@@ -27,11 +30,18 @@ class EventHandlingTests < Test::Unit::TestCase
         super(parent)
         @test_event = false
         @test_cmd_event = false
+        @test_client_data = false
 
         evt_test_event { |evt| @test_event = true; evt.skip if evt.id > 0 }
-        evt_test_cmd_event { |evt| @test_cmd_event = true; evt.skip if evt.id > 0 }
+        evt_test_cmd_event do |evt|
+          @test_cmd_event = true
+          if evt.id > 0
+            @test_client_data = (evt.get_client_data == CLIENT_DATA)
+            evt.skip
+          end
+        end
       end
-      attr_reader :test_event, :test_cmd_event
+      attr_reader :test_event, :test_cmd_event, :test_client_data
 
       def reset
         @test_event = false
@@ -83,85 +93,93 @@ class EventHandlingTests < Test::Unit::TestCase
 
   def test_cmd_event
     win = TestFrame.new
-    assert(!win.test_cmd_event)
-    assert(!win.child.test_cmd_event)
+    assert_false(win.test_cmd_event)
+    assert_false(win.child.test_cmd_event)
     win.child.event_handler.process_event(TestCmdEvent.new)
-    assert(!win.test_cmd_event)
-    assert(win.child.test_cmd_event)
+    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))
-    assert(win.test_cmd_event)
-    assert(win.child.test_cmd_event)
+    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)
-    assert(win.test_cmd_event)
-    assert(!win.child.test_cmd_event)
+    assert_true(win.test_cmd_event)
+    assert_false(win.child.test_cmd_event)
     win.destroy
     Wx.get_app.yield
   end
 
   def test_queue_event
     win = TestFrame.new
-    assert(!win.test_cmd_event)
-    assert(!win.child.test_cmd_event)
+    assert_false(win.test_cmd_event)
+    assert_false(win.child.test_cmd_event)
     win.child.event_handler.queue_event(TestCmdEvent.new)
     Wx.get_app.yield
-    assert(!win.test_cmd_event)
-    assert(win.child.test_cmd_event)
+    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))
     Wx.get_app.yield
-    assert(win.test_cmd_event)
-    assert(win.child.test_cmd_event)
+    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)
     Wx.get_app.yield
-    assert(win.test_cmd_event)
-    assert(!win.child.test_cmd_event)
+    assert_true(win.test_cmd_event)
+    assert_false(win.child.test_cmd_event)
     win.destroy
     Wx.get_app.yield
   end
 
   def test_pending_event
     win = TestFrame.new
-    assert(!win.test_cmd_event)
-    assert(!win.child.test_cmd_event)
+    assert_false(win.test_cmd_event)
+    assert_false(win.child.test_cmd_event)
     win.child.event_handler.add_pending_event(TestCmdEvent.new)
     Wx.get_app.yield
-    assert(!win.test_cmd_event)
-    assert(win.child.test_cmd_event)
+    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))
     Wx.get_app.yield
-    assert(win.test_cmd_event)
-    assert(win.child.test_cmd_event)
+    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)
     Wx.get_app.yield
-    assert(win.test_cmd_event)
-    assert(!win.child.test_cmd_event)
+    assert_true(win.test_cmd_event)
+    assert_false(win.child.test_cmd_event)
     win.destroy
     Wx.get_app.yield
   end
 
   def test_post_event
     win = TestFrame.new
-    assert(!win.test_cmd_event)
-    assert(!win.child.test_cmd_event)
+    assert_false(win.test_cmd_event)
+    assert_false(win.child.test_cmd_event)
     Wx.post_event(win.child.event_handler, TestCmdEvent.new)
     Wx.get_app.yield
-    assert(!win.test_cmd_event)
-    assert(win.child.test_cmd_event)
+    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.get_app.yield
-    assert(win.test_cmd_event)
-    assert(win.child.test_cmd_event)
+    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.get_app.yield
-    assert(win.test_cmd_event)
-    assert(!win.child.test_cmd_event)
+    assert_true(win.test_cmd_event)
+    assert_false(win.child.test_cmd_event)
     win.destroy
     Wx.get_app.yield
   end

data/tests/test_events.rb

@@ -20,19 +20,26 @@ class EventTests < Test::Unit::TestCase
   end
 
   def test_command_event
+    GC.start
     evt = Wx::CommandEvent.new(100, 1)
+    evt.set_client_object({one: 'first'})
     assert_equal(100, evt.event_type)
     assert_equal(1, evt.id)
+    assert_equal({one: 'first'}, evt.get_client_object)
     assert(evt.should_propagate)
+    GC.start
     evt.skip
     assert(evt.skipped)
     evt.string = 'CommandEvent Test'
     assert_equal('CommandEvent Test', evt.string)
     evt_dup = evt.clone
+    GC.start
     assert_not_equal(evt, evt_dup)
     assert_equal(evt.event_type, evt_dup.event_type)
     assert_equal(evt.id, evt_dup.id)
     assert_equal(evt.string, evt_dup.string)
+    assert_equal({one: 'first'}, evt.get_client_object)
+    assert_equal({one: 'first'}, evt_dup.get_client_object)
   end
 
   def test_event_clone

data/tests/test_item_data.rb

@@ -22,6 +22,9 @@ class TestItemData < Test::Unit::TestCase
   end
 
   def do_control_with_items_assertions(f)
+    f.control.set_client_object([:client, :object])
+    assert_equal([:client, :object], f.control.client_object)
+
     assert_retrievable_data(f.control, 0, { 'b' => 'B' })
     assert_retrievable_data(f.control, 1, 'string item data')
     assert_retrievable_data(f.control, 2, 42.3)
@@ -87,10 +90,31 @@ class TestItemData < Test::Unit::TestCase
 
     GC.start
 
+    klass = Class.new do
+      def initialize(list)
+        @list = list
+        @list << self
+      end
+      def client_data_unlinked
+        @list.delete(self)
+      end
+    end
+    data_list = []
+    10.times { |i| f.control.append("test #{i}", klass.new(data_list)) }
+
+    assert_equal(10, data_list.size)
+    assert_equal(28, f.control.count)
+    assert_kind_of(klass, f.control.get_item_data(27))
+
     # clear all
     f.control.clear
     assert_equal(0, f.control.count)
 
+    assert_equal(0, data_list.size)
+
+    # still there?
+    assert_equal([:client, :object], f.control.client_object)
+
     GC.start
   end
 

data/tests/test_sizer.rb

@@ -52,8 +52,51 @@ class SizerTests < WxRuby::Test::GUITests
     assert_true(children[1].spacer?)
     assert_true(children[2].sizer?)
     frame_win.sizer.each_child do |si|
-      assert_equal(children.shift, si)
+      assert_equal(children.shift.ptr_addr, si.ptr_addr)
     end
   end
 
+  def test_user_data
+    frame_win.get_sizer.add(Wx::HBoxSizer.new, 0, 0, 0, 'This is user data')
+    frame_win.get_sizer.add(5,5, 0,0,0, %w[This is user data])
+    frame_win.get_sizer.add(Wx::VBoxSizer.new, 0, 0, 0, {1 => 'This', 2 => 'is', 3 => 'user', 4 => 'data'})
+
+    GC.start
+
+    assert_equal(3, frame_win.sizer.item_count)
+    children = frame_win.sizer.get_children
+    assert_equal(3, children.size)
+    assert_kind_of(::String, children[0].user_data)
+    assert_equal('This is user data', children[0].user_data)
+    assert_kind_of(::Array, children[1].user_data)
+    assert_equal(%w[This is user data], children[1].user_data)
+    assert_kind_of(::Hash, children[2].user_data)
+    assert_equal({1 => 'This', 2 => 'is', 3 => 'user', 4 => 'data'}, children[2].user_data)
+
+    klass = Class.new do
+      def initialize
+        @unlinked = false
+      end
+      def client_data_unlinked
+        @unlinked = true
+      end
+      attr_reader :unlinked
+    end
+
+    frame_win.get_sizer.add(Wx::HBoxSizer.new, 0, 0, 0, klass.new)
+
+    GC.start
+
+    assert_equal(4, frame_win.sizer.item_count)
+    assert_kind_of(klass, frame_win.get_sizer.get_item(3).user_data)
+    user_data = frame_win.get_sizer.get_item(3).user_data
+    assert_false(user_data.unlinked)
+    frame_win.get_sizer.get_item(3).set_user_data(nil)
+
+    GC.start
+
+    assert_true(user_data.unlinked)
+    assert_nil(frame_win.get_sizer.get_item(3).user_data)
+  end
+
 end