wxruby3 0.9.4 → 0.9.5

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

@@ -0,0 +1,135 @@
+---
+:wxComboCtrl:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /wxDECLARE_EVENT_TABLE/
+          :replace: |
+            
+            ```ruby
+            class ListViewComboPopup < Wx::ListView
+            
+              include Wx::ComboPopup
+              
+              # Allow only default ctor
+              def initialize
+                # call default control ctor; need to call Wx::ListView#create later
+                super
+              end
+              
+              # Initialize member variables
+              def init
+                @value = -1
+              end
+              
+              # Create popup control
+              def create(parent)
+                # 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
+                wx_lv_create = (Wx::ListView.instance_method :create).bind(self)
+                wx_lv_create.call(parent, 1, [0,0], Wx::DEFAULT_SIZE)
+                evt_motion :on_mouse_move
+                evt_left_up :on_mouse_click
+                end
+              
+              # Return pointer to the created control
+              def get_control
+                self
+              end
+              
+              def lv_find_item(*args)
+                unless @wx_lv_find_item
+                @wx_lv_find_item = (Wx::ListView.instance_method :find_item).bind(self)
+                end
+                @wx_lv_find_item.call(*args)
+              end
+              protected :lv_find_item
+              
+              # Translate string into a list selection
+              def set_string_value(s)
+                n = lv_find_item(-1, s)
+                if n >= 0 && n < get_item_count
+                  select(n)
+                  @value = n
+                end
+              end
+              
+              # Get list selection as a string
+              def get_string_value
+                return get_item_text(@value) if @value >= 0
+                ''
+              end
+              
+              # Do mouse hot-tracking (which is typical in list popups)
+              def on_mouse_move(event)
+                # Move selection to cursor ...
+              end
+              
+              # On mouse left up, set the value and close the popup
+              def on_mouse_click(_event)
+                @value = get_first_selected
+                
+                # Send event as well ...
+                
+                dismiss
+              end
+            
+            end
+            ```
+        - :pattern: !ruby/regexp /wxComboCtrl/
+          :replace: |
+            
+            ```ruby
+              comboCtrl = Wx::ComboCtrl.new(self, Wx::ID_ANY, '')
+              
+              popupCtrl = ListViewComboPopup.new
+              
+              # It is important to call #set_popup_control as soon as possible
+              comboCtrl.set_popup_control(popupCtrl)
+              
+              # Populate using Wx::ListView methods
+              popupCtrl.insert_item((popupCtrl.item_count, 'First Item')
+              popupCtrl.insert_item((popupCtrl.item_count, 'Second Item')
+              popupCtrl.insert_item((popupCtrl.item_count, 'Third Item')
+            ```
+:wxComboCtrl.SetMainControl:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+            
+            ```ruby
+              # Create the combo control using its default ctor.
+              combo = Wx::ComboCtrl.new
+              
+              # Create the custom main control using its default ctor too.
+              main = SomeWindow.new
+              
+              # Set the custom main control before creating the combo.
+              combo.set_main_control(main)
+              
+              # And only create it now: Wx::TextCtrl won't be unnecessarily
+              # created because the combo already has a main window.
+              combo.create(panel, Wx::ID_ANY, '')
+              
+              # Finally create the main window itself, now that its parent was
+              # created.
+              main.create(combo, ...)
+            ```
+:wxComboCtrl.SetTextCtrlStyle:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+            
+            ```ruby
+              comboCtrl = Wx::ComboCtrl.new
+              
+              # Let's make the text right-aligned
+              comboCtrl.set_text_ctrl_style(Wx::TE_RIGHT)
+              
+              comboCtrl.create(parent, Wx::ID_ANY, '')
+            ```

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

@@ -0,0 +1,62 @@
+---
+:wxFileDialogCustomizeHook:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+            
+            ```ruby
+            class EncryptHook < Wx::FileDialogCustomizeHook
+            
+              attr_reader :encrypt
+            
+              # Override to add custom controls using the provided customizer object.
+              def add_custom_controls(customizer)
+                # Suppose we can encrypt files when saving them.
+                @checkbox = customizer.add_check_box('Encrypt')
+       
+                # While @checkbox is not a Wx::CheckBox, it looks almost like one
+                # and, in particular, we can bind to custom control events as usual.
+                @checkbox.evt_checkbox(Wx::ID_ANY) do |event| 
+                   # We can also call Wx::Window-like functions on them.
+                   @button.enable(event.checked?)
+                end
+       
+                # The encryption parameters can be edited in a dedicated dialog.
+                @button = customizer.add_button('Parameters...')
+                @button.evt_button(Wx::ID_ANY) do |event|
+                   # ... show the encryption parameters dialog here ...
+                end
+              end
+          
+              # Override to save the values of the custom controls.
+              def transfer_data_from_custom_controls 
+                # Save the checkbox value, as we won't be able to use it any more
+                # once this function returns.
+                @encrypt = @checkbox.get_value
+              end
+          
+            end
+            
+            # ...
+            
+            def some_method
+              Wx.FileDialog(nil, 'Save document', '', 'file.my',
+                                 'My files (*.my)|*.my',
+                                 Wx::FD_SAVE | Wx::FD_OVERWRITE_PROMPT) do |dialog|
+           
+                # This object may be destroyed before the dialog, but must remain
+                # alive until #show_modal returns.
+                customize_hook = EncryptHook.new
+                dialog.set_customize_hook(custom_hook)
+           
+                if dialog.show_modal == Wx::ID_OK 
+                  if customize_hook.encrypt 
+                    # ... save with encryption ...
+                  else
+                    # ... save without encryption ...
+                  end
+                end
+            end
+            ```

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

@@ -0,0 +1,28 @@
+---
+:wxFileSystemHandler.CanOpen:
+  :detail:
+    :pre:
+      :para:
+        - :pattern: !ruby/regexp /Example:/
+          :subst: ''
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: ''
+:wxFileSystemHandler.GetMimeTypeFromExt:
+  :detail:
+    :pre:
+      :para:
+        - :pattern: !ruby/regexp /Example:/
+          :subst: ''
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: ''
+:wxMemoryFSHandler:
+  :detail:
+    :pre:
+      :para:
+        - :pattern: !ruby/regexp /Example:/
+          :subst: ''
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: ''

data/rakelib/lib/generate/interface.rb

@@ -547,10 +547,18 @@ module WXRuby3
         if Extractor::EnumDef === item && !item.ignored && !item.items.all? {|e| e.ignored }
           fout.puts
           fout.puts "// from enum #{item.is_anonymous ? '' : item.name}"
-          fout.puts "enum #{item.name};" unless item.is_anonymous
-          item.items.each do |e|
-            unless e.ignored
-              fout.puts "%constant int #{e.name} = #{e.fqn};"
+          if item.is_anonymous
+            item.items.each do |e|
+              unless e.ignored
+                fout.puts "%constant int #{e.name} = #{e.fqn};"
+              end
+            end
+          else
+            fout.puts "enum #{item.name};"
+            item.items.each do |e|
+              unless e.ignored
+                fout.puts "%constant int #{item.name}_#{e.name} = #{e.fqn};"
+              end
             end
           end
         end

data/rakelib/lib/swig_runner.rb

@@ -262,7 +262,7 @@ module WXRuby3
           def_items.each do |item|
             case item
             when Extractor::EnumDef
-              item.items.each { |e| enumerators[rb_wx_name(e.name)] = item } if item.is_type
+              item.items.each { |e| enumerators["#{rb_wx_name(item.name)}_#{e.name}"] = item } if item.is_type
             when Extractor::ClassDef
               item.items.select { |itm| Extractor::EnumDef === itm }.each do |enum|
                 enum.items.each { |e| enumerators[rb_wx_name(e.name)] = enum } if enum.is_type
@@ -334,6 +334,7 @@ module WXRuby3
                     fix_enum = true
                     enum_item = enum_table[md[2]]
                     enum_name = rb_wx_name(enum_item.name)
+                    enumerator_name = rb_wx_name(md[2].sub(/\A#{enum_name}_/, ''))
                     enum_id = enum_item.scope.empty? ? enum_name : "#{rb_wx_name(enum_item.scope)}::#{enum_name}"
                     enum_var = enum_id.gsub('::', '_')
                     line = [
@@ -343,7 +344,7 @@ module WXRuby3
                       # add enum class constant to current module (use unscoped name)
                       "  rb_define_const(#{md[1]}, \"#{enum_name}\", cWx#{enum_var}); // Inserted by fixmodule.rb",
                       # create enumerator value const under new enum class
-                      "  wxRuby_AddEnumValue(cWx#{enum_var}, \"#{md[2]}\"#{md[3]} // Updated by fixmodule.rb"
+                      "  wxRuby_AddEnumValue(cWx#{enum_var}, \"#{enumerator_name}\"#{md[3]} // Updated by fixmodule.rb"
                     ].join("\n")
                   end
                 else
@@ -352,13 +353,15 @@ module WXRuby3
                     # of the same enum?
                     if enum_item && enum_table[md[2]] == enum_item
                       enum_name = rb_wx_name(enum_item.name)
+                      enumerator_name = rb_wx_name(md[2].sub(/\A#{enum_name}_/, ''))
                       enum_id = enum_item.scope.empty? ? enum_name : "#{rb_wx_name(enum_item.scope)}::#{enum_name}"
                       enum_var = enum_id.gsub('::', '_')
                       # create enumerator value const under new enum class
-                      line = "  wxRuby_AddEnumValue(cWx#{enum_var}, \"#{md[2]}\"#{md[3]} // Updated by fixmodule.rb"
+                      line = "  wxRuby_AddEnumValue(cWx#{enum_var}, \"#{enumerator_name}\"#{md[3]} // Updated by fixmodule.rb"
                     else # we found the start of another enum
                       enum_item = enum_table[md[2]]
                       enum_name = rb_wx_name(enum_item.name)
+                      enumerator_name = rb_wx_name(md[2].sub(/\A#{enum_name}_/, ''))
                       enum_id = enum_item.scope.empty? ? enum_name : "#{rb_wx_name(enum_item.scope)}::#{enum_name}"
                       enum_var = enum_id.gsub('::', '_')
                       line = [
@@ -368,7 +371,7 @@ module WXRuby3
                         # add enum class constant to current module (use unscoped name)
                         "  rb_define_const(#{md[1]}, \"#{enum_name}\", cWx#{enum_var}); // Inserted by fixmodule.rb",
                         # create enumerator value const under new enum class
-                        "  wxRuby_AddEnumValue(cWx#{enum_var}, \"#{md[2]}\"#{md[3]} // Updated by fixmodule.rb"
+                        "  wxRuby_AddEnumValue(cWx#{enum_var}, \"#{enumerator_name}\"#{md[3]} // Updated by fixmodule.rb"
                       ].join("\n")
                     end
                   else # end of enum def

data/rakelib/lib/typemap/combo_popup.rb

@@ -0,0 +1,42 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+###
+# wxRuby3 wxComboPopup typemap definition
+###
+
+require_relative '../core/mapping'
+
+module WXRuby3
+
+  module Typemap
+
+    module ComboPopup
+
+      include Typemap::Module
+
+      define do
+
+        # for DoSetPopupControl
+        map 'wxComboPopup* popup' => 'Wx::ComboPopup,nil' do
+
+          add_header_code <<~__CODE
+            #include <wx/combo.h>
+            
+            WXRUBY_EXPORT wxComboPopup* wxRuby_ComboPopupFromRuby(VALUE popup);
+            WXRUBY_EXPORT VALUE wxRuby_ComboPopupToRuby(wxComboPopup* popup);
+            __CODE
+
+          map_in code: '$1 = wxRuby_ComboPopupFromRuby($input);'
+
+          map_directorin code: '$input = wxRuby_ComboPopupToRuby($1);'
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/tests/test_combo_ctrl.rb

@@ -0,0 +1,196 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+require_relative './lib/wxframe_runner'
+require_relative './lib/text_entry_tests'
+
+class ComboCtrlCtrlTests < WxRuby::Test::GUITests
+
+  include TextEntryTests
+
+  class LVComboPopup < Wx::ListView
+
+    include Wx::ComboPopup
+
+    def initialize
+      # call default control ctor; need to call Wx::ListView#create later
+      super
+    end
+
+    def init
+      @value = -1
+    end
+
+    def create(parent)
+      # 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
+      wx_lv_create = (Wx::ListView.instance_method :create).bind(self)
+      wx_lv_create.call(parent, 1, [0,0], Wx::DEFAULT_SIZE)
+      evt_motion :on_mouse_move
+      evt_left_up :on_mouse_click
+    end
+    
+    # Return pointer to the created control
+    def get_control
+      self
+    end
+
+    def lv_find_item(*args)
+      unless @wx_lv_find_item
+        @wx_lv_find_item = (Wx::ListView.instance_method :find_item).bind(self)
+      end
+      @wx_lv_find_item.call(*args)
+    end
+    protected :lv_find_item
+
+    # Translate string into a list selection
+    def set_string_value(s)
+      n = lv_find_item(-1, s)
+      if n >= 0 && n < get_item_count
+        select(n)
+        @value = n
+      end
+    end
+ 
+    # Get list selection as a string
+    def get_string_value
+      return get_item_text(@value) if @value >= 0
+      ''
+    end
+ 
+    # Do mouse hot-tracking (which is typical in list popups)
+    def on_mouse_move(event)
+      # Move selection to cursor ...
+    end
+ 
+    # On mouse left up, set the value and close the popup
+    def on_mouse_click(_event)
+      @value = get_first_selected
+ 
+      # Send event as well ...
+ 
+      dismiss
+    end
+
+  end
+
+  def setup
+    super
+    @combo = Wx::ComboCtrl.new(frame_win, name: 'ComboCtrl')
+    @combo.set_popup_control(LVComboPopup.new)
+  end
+
+  def cleanup
+    @combo.destroy
+    super
+  end
+
+  attr_reader :combo
+  alias :text_entry :combo
+
+  def fill_list(list)
+    list.insert_item(0, 'This is the first item')
+    list.insert_item(1, 'This is the second item')
+    list.insert_item(2, 'This is the third item')
+    list.insert_item(3, 'This is the fourth item')
+  end
+
+  def test_popup
+    assert_equal('', combo.get_value)
+
+    assert_kind_of(Wx::ComboPopup, combo.get_popup_control)
+    assert_kind_of(Wx::ListView, combo.get_popup_control)
+    assert_kind_of(Wx::ListView, combo.get_popup_control.get_control)
+
+    assert_nothing_raised { fill_list(combo.get_popup_control) }
+    combo.popup
+
+    combo.set_value_by_user('This is the second item')
+
+    assert_equal('This is the second item', combo.get_popup_control.get_string_value)
+
+    combo.dismiss
+  end
+
+end
+
+class OwnerDrawnCBTests < WxRuby::Test::GUITests
+
+  include TextEntryTests
+
+  class TestODComboBox < Wx::OwnerDrawnComboBox
+
+    def on_draw_item(dc, rect, item, _flags)
+      return if item == Wx::NOT_FOUND
+
+      dc.set_text_foreground(Wx::BLACK)
+      dc.draw_text(get_string(item),
+                   rect.x + 3,
+                   rect.y + ((rect.height - dc.char_height)/2))
+    end
+
+    def on_draw_background(dc, rect, item,  flags)
+      # If item is selected or even, or we are painting the
+      # combo control itself, use the default rendering.
+      if flags.anybits?(Wx::ODCB_PAINTING_CONTROL|Wx::ODCB_PAINTING_SELECTED) || (item & 1) == 0
+        super(dc,rect,item,flags)
+        return
+      end
+
+      # Otherwise, draw every other background with different colour.
+      bgCol = Wx::Colour.new(240,240,250)
+      dc.set_brush(Wx::Brush.new(bgCol))
+      dc.set_pen(Wx::Pen.new(bgCol))
+      dc.draw_rectangle(rect)
+    end
+
+    def on_measure_item(_item)
+      48
+    end
+
+    def on_measure_item_width(_item)
+      -1 # default - will be measured from text width
+    end
+
+  end
+
+  def setup
+    super
+    @combo = TestODComboBox.new(frame_win, name: 'ODComboBox')
+  end
+
+  def cleanup
+    @combo.destroy
+    super
+  end
+
+  attr_reader :combo
+  alias :text_entry :combo
+
+  def fill_list(list)
+    list.append('This is the first item')
+    list.append('This is the second item')
+    list.append('This is the third item')
+    list.append('This is the fourth item')
+  end
+
+  def test_popup
+    assert_equal('', combo.get_value)
+
+    assert_kind_of(Wx::ComboPopup, combo.get_popup_control)
+    assert_kind_of(Wx::ComboPopupWx, combo.get_popup_control)
+    assert_kind_of(Wx::VListBox, combo.get_popup_control.get_control)
+
+    assert_nothing_raised { fill_list(combo) }
+    combo.popup
+
+    combo.set_value_by_user('This is the third item')
+
+    assert_equal('This is the third item', combo.get_popup_control.get_string_value)
+
+    combo.dismiss
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wxruby3
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - Martin Corino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-07 00:00:00.000000000 Z
+date: 2024-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -99,6 +99,7 @@ files:
 - ext/mkrf_conf_srcgem.rb
 - ext/wxruby3/include/wxRubyApp.h
 - ext/wxruby3/include/wxruby-ClientData.h
+- ext/wxruby3/include/wxruby-ComboPopup.h
 - ext/wxruby3/include/wxruby-Config.h
 - ext/wxruby3/include/wxruby-Persistence.h
 - ext/wxruby3/include/wxruby-ScaledDC.h
@@ -147,6 +148,7 @@ files:
 - lib/wx/core/clipboard.rb
 - lib/wx/core/collapsible_pane.rb
 - lib/wx/core/colour.rb
+- lib/wx/core/combo_ctrl.rb
 - lib/wx/core/combobox.rb
 - lib/wx/core/config.rb
 - lib/wx/core/const.rb
@@ -683,6 +685,7 @@ files:
 - rakelib/lib/generate/doc/clipboard.yaml
 - rakelib/lib/generate/doc/collapsible_pane.yaml
 - rakelib/lib/generate/doc/colour_dialog.yaml
+- rakelib/lib/generate/doc/combo_ctrl.yaml
 - rakelib/lib/generate/doc/context_help_button.yaml
 - rakelib/lib/generate/doc/control.yaml
 - rakelib/lib/generate/doc/cursor.yaml
@@ -695,6 +698,8 @@ files:
 - rakelib/lib/generate/doc/events.yaml
 - rakelib/lib/generate/doc/evt_handler.yaml
 - rakelib/lib/generate/doc/file_dialog.yaml
+- rakelib/lib/generate/doc/file_dialog_customize_hook.yaml
+- rakelib/lib/generate/doc/file_system.yaml
 - rakelib/lib/generate/doc/font.yaml
 - rakelib/lib/generate/doc/frame.yaml
 - rakelib/lib/generate/doc/fs_file.yaml
@@ -764,6 +769,7 @@ files:
 - rakelib/lib/swig_runner.rb
 - rakelib/lib/typemap/array_int_selections.rb
 - rakelib/lib/typemap/client_data.rb
+- rakelib/lib/typemap/combo_popup.rb
 - rakelib/lib/typemap/common.rb
 - rakelib/lib/typemap/config.rb
 - rakelib/lib/typemap/data_format.rb
@@ -1088,6 +1094,7 @@ files:
 - tests/test_book_controls.rb
 - tests/test_box_sizer.rb
 - tests/test_clipboard.rb
+- tests/test_combo_ctrl.rb
 - tests/test_config.rb
 - tests/test_dc.rb
 - tests/test_dialog.rb