wxruby3 0.9.0.pre.rc.1 → 0.9.0.pre.rc.2

data/rakelib/lib/director/searchctrl.rb

@@ -14,7 +14,8 @@ module WXRuby3
       def setup
         super
         # mixin TextEntry
-        spec.include_mixin 'wxSearchCtrl', 'Wx::TextEntry'
+        spec.include_mixin 'wxSearchCtrl', { 'Wx::TextEntry' => 'wxTextEntryBase' }
+        spec.suppress_warning(473, 'wxSearchCtrl::GetMenu')
         spec.override_inheritance_chain('wxSearchCtrl', %w[wxControl wxWindow wxEvtHandler wxObject])
       end
     end # class SearchCtrl

data/rakelib/lib/director/static_box.rb

@@ -13,7 +13,7 @@ module WXRuby3
 
       def setup
         super
-        if Config.instance.wx_port == :wxQT
+        if Config.instance.wx_port == :wxQT || Config.platform == :macosx
           # missing from implementation currently
           spec.ignore 'wxStaticBox::wxStaticBox(wxWindow *, wxWindowID, wxWindow *, const wxPoint &, const wxSize &, long, const wxString &)',
                       'wxStaticBox::Create(wxWindow *, wxWindowID, wxWindow *, const wxPoint &, const wxSize &, long, const wxString &)'

data/rakelib/lib/director/styled_text_ctrl.rb

@@ -15,7 +15,7 @@ module WXRuby3
         super
         spec.override_inheritance_chain('wxStyledTextCtrl', %w[wxControl wxWindow wxEvtHandler wxObject])
         # mixin TextEntry
-        spec.include_mixin 'wxStyledTextCtrl', 'Wx::TextEntry'
+        spec.include_mixin 'wxStyledTextCtrl', { 'Wx::TextEntry' => 'wxTextEntryBase' }
         spec.map 'int *', 'long *', as: 'Integer' do
           map_in ignore: true, temp: '$*1_ltype a', code: '$1 = &a;'
           map_argout code: <<~__CODE

data/rakelib/lib/director/text_entry.rb

@@ -16,6 +16,11 @@ module WXRuby3
         spec.gc_as_untracked 'wxTextEntry' # actually no GC control necessary as this is a mixin only
         # turn wxTextEntry into a mixin module
         spec.make_mixin 'wxTextEntry'
+        # !!NOTE!!
+        # This is not very nice but it is the easiest way to work around the problem that
+        # what we actually want as native type is wxTextEntryBase (because of some bad implementation decisions in wxw)
+        # and what is documented is wxTextEntry.
+        spec.add_header_code '#define wxTextEntry wxTextEntryBase'
         spec.disown 'wxTextCompleter *completer' # managed by wxWidgets after passing in
         spec.map_apply 'long * OUTPUT' => 'long *' # for GetSelection
       end

data/rakelib/lib/director/textctrl.rb

@@ -14,7 +14,7 @@ module WXRuby3
       def setup
         super
         # mixin TextEntry
-        spec.include_mixin 'wxTextCtrl', 'Wx::TextEntry'
+        spec.include_mixin 'wxTextCtrl', { 'Wx::TextEntry' => 'wxTextEntryBase' }
         spec.override_inheritance_chain('wxTextCtrl', %w[wxControl wxWindow wxEvtHandler wxObject])
         spec.ignore 'wxTextCtrl::HitTest(const wxPoint &,long *)'
         if Config.instance.wx_port == :wxQT

data/rakelib/lib/director/window.rb

@@ -132,8 +132,28 @@ module WXRuby3
             'wxWindow::GetTextExtent(const wxString &,int *,int *,int *,int *,const wxFont *)',
             'wxWindow::SendIdleEvents',
             'wxWindow::ClientToScreen(int*,int*)', # no need; prefer the wxPoint version
-            'wxWindow::ScreenToClient(int*,int*)' # no need; prefer the wxPoint version
+            'wxWindow::ScreenToClient(int*,int*)', # no need; prefer the wxPoint version
           ]
+          # redefine these so a nil parent is accepted
+          spec.ignore %w[wxWindow::FindWindowById wxWindow::FindWindowByLabel wxWindow::FindWindowByName], ignore_doc: false
+          # overrule common typemap to allow default NULL
+          spec.map 'wxWindow* find_from_parent' do
+            map_check code: ''
+          end
+          spec.add_extend_code 'wxWindow', <<~__HEREDOC
+            static wxWindow* find_window_by_id(long id, const wxWindow *find_from_parent=0)
+            {
+              return wxWindow::FindWindowById(id, find_from_parent);
+            }
+            static wxWindow* find_window_by_label(const wxString &label, const wxWindow *find_from_parent=0)
+            {
+              return wxWindow::FindWindowByLabel(label, find_from_parent);
+            }
+            static wxWindow* find_window_by_name(const wxString &name, const wxWindow *find_from_parent=0)
+            {
+              return wxWindow::FindWindowByName(name, find_from_parent);
+            }
+            __HEREDOC
           if Config.instance.wx_port == :wxQT
             # protected for wxQT; ignore for now
             spec.ignore 'wxWindow::EnableTouchEvents'
@@ -257,6 +277,22 @@ module WXRuby3
         # update generated code for all windows
         spec.post_processors << :update_window
       end
+
+      def process(gendoc: false)
+        defmod = super
+        if spec.module_name == 'wxWindow'
+          # special processing to ignore the non-static versions of methods FromDIP,ToDIP,FromPhys,ToPhys
+          # as SWIG cannot handle identically named static & non-static methods
+          # will handle that in pure Ruby
+          %w[FromDIP ToDIP FromPhys ToPhys].each do |mtd|
+            if (item = defmod.find("wxWindow::#{mtd}"))
+              item.all.each { |ovl| ovl.ignore(true, ignore_doc: false) unless ovl.is_static }
+            end
+          end
+        end
+        defmod
+      end
+
     end # class Window
 
   end # class Director

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

@@ -0,0 +1,16 @@
+---
+:wxContextHelp:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+            
+            ```ruby
+              # puts the application into a 'context-sensitive help mode' for my_window
+              context_help = Wx::ContextHelp.new(my_window)
+              ...
+              ...
+              # ends the 'context-sensitive help mode' for my_window
+              context_help.end_context_help            
+            ```

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

@@ -0,0 +1,27 @@
+---
+:wxEventBlocker:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+            
+            ```ruby
+              class MyWindow
+
+                ...
+            
+                def do_something
+                  # block all events directed to this window
+                  Wx::EventBlocker.blocked_for(self) do
+                    # while we do 1000 function_that_sends_events calls 
+                    1000.times { |i| function_that_sends_events(i) }
+                  end
+                  # old event handler restored; generated event(s) from next call will be processed
+                  function_that_sends_events(0)
+                end
+
+                ... 
+            
+              end
+            ```

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

@@ -0,0 +1,47 @@
+---
+:wxEventFilter:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+            
+            ```ruby
+            # This class allows determining the last time the user has worked with
+            # this application:
+            class LastActivityTimeDetector < Wx::EventFilter
+              def initialize
+                Wx::EvtHandler.add_filter(self)
+        
+                @last = Time.now
+              end
+        
+              def clear
+                Wx::EvtHandler.remove_filter(self)
+              end
+        
+              def filter_event(event)
+                # Update the last user activity
+                t = event.get_event_type
+                case t
+                when Wx::EVT_KEY_DOWN, 
+                     Wx::EVT_MOTION, 
+                     Wx::EVT_LEFT_DOWN,
+                     Wx::EVT_RIGHT_DOWN,
+                     Wx::EVT_MIDDLE_DOWN
+                  @last = Time.now
+                end
+    
+                # Continue processing the event normally as well.
+                Event_Skip
+              end
+        
+              # This function could be called periodically from some timer to
+              # do something (e.g. hide sensitive data or log out from remote
+              # server) if the user has been inactive for some time period.
+              def is_inactive_for?(diff)
+                (Time.now - diff) > @last
+              end
+            
+            end
+            ```

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

@@ -0,0 +1,68 @@
+---
+:wxFileDialog:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /MyFrame::OnOpen/
+          :replace: |
+            
+            ```ruby
+            class MyFrame
+              ...
+              def on_open(event)
+                if (...current content has not been saved...)
+                  if Wx.message_box('Current content has not been saved! Proceed?', 'Please confirm',
+                                    Wx::ICON_QUESTION | Wx::YES_NO, self) == Wx::NO
+                    return 
+                  #else: proceed asking to the user the new file to open
+                  end
+                end
+              
+                Wx::FileDialog(self, "Open XYZ file", "", "",
+                                    "XYZ files (*.xyz)|*.xyz", Wx::FD_OPEN|Wx::FD_FILE_MUST_EXIST) do |dlg|
+                  return if dlg.show_modal == Wx::ID_CANCEL # the user changed idea...?
+            
+                  # proceed loading the file chosen by the user
+                  file = File.open(dlg.path, 'r') rescue nil
+                  unless file
+                     Wx.log_error("Cannot open file '#{dlg.path}'.")
+                     return
+                  end
+                  ...
+                end
+              end
+            
+            end
+            ```
+        - :pattern: !ruby/regexp /MyFrame::OnSaveAs/
+          :replace: |
+            
+            ```ruby
+            class MyFrame
+              ...
+              def on_save_as(event)
+                Wx::FileDialog(self, "Save XYZ file", "", "",
+                                    "XYZ files (*.xyz)|*.xyz", Wx::FD_SAVE|Wx::FD_OVERWRITE_PROMPT) do |dlg|
+                  return if dlg.show_modal == Wx::ID_CANCEL # the user changed idea...?
+              
+                  # save the current contents in the file
+                  begin
+                    File.open(dlg.path, 'w+') do |f|
+                      # save to file
+                    end
+                  rescue 
+                    Wx.log_error("Cannot save current contents in file '#{dlg.path}'.")
+                    return
+                  end
+                end
+                ...
+              end
+            
+            end
+            ```
+        - :pattern: !ruby/regexp /wxSystemOptions::SetOption/
+          :replace: |
+            
+            ```ruby
+              Wx::SystemOptions.set_option(Wx::OSX_FILEDIALOG_ALWAYS_SHOW_TYPES, 1)
+            ```

data/rakelib/lib/generate/doc.rb

@@ -860,7 +860,7 @@ module WXRuby3
 
             # mixin includes
             if included_mixins.has_key?(item.name)
-              included_mixins[item.name].each { |mod| fdoc.iputs "include #{mod}" }
+              included_mixins[item.name].keys.each { |mod| fdoc.iputs "include #{mod}" }
               fdoc.puts
             end
 

data/rakelib/lib/generate/interface.rb

@@ -99,18 +99,19 @@ module WXRuby3
       __HEREDOC
     end
 
-    def gen_mixin_convert_code(fout, cls, mod)
+    def gen_mixin_convert_code(fout, cls, mod, ctype)
       rb_mod_name = mod.split('::').last
+      ctype ||= "wx#{rb_mod_name}"
       decl_flag = (mod.start_with?(package.fullname) ? 'WXRB_EXPORT_FLAG' : 'WXRB_IMPORT_FLAG') # same package (dll) or import?
       fout.puts
       fout << <<~__HEREDOC
-          // Mixin converter for wx#{rb_mod_name} included in #{cls} 
-          typedef wx#{rb_mod_name}* (*wx_#{underscore(rb_mod_name)}_convert_fn)(void*); 
+          // Mixin converter for #{ctype} (#{mod}) included in #{cls} 
+          typedef #{ctype}* (*wx_#{underscore(rb_mod_name)}_convert_fn)(void*); 
           #{decl_flag} void wxRuby_Register_#{rb_mod_name}_Include(swig_class* cls_info, 
                                                                               wx_#{underscore(rb_mod_name)}_convert_fn converter);
-          static wx#{rb_mod_name}* wxRuby_ConvertTo_#{rb_mod_name}(void* ptr)
+          static #{ctype}* wxRuby_ConvertTo_#{rb_mod_name}(void* ptr)
           {
-            return ((wx#{rb_mod_name}*) static_cast<#{cls}*> (ptr));
+            return ((#{ctype}*) static_cast<#{cls}*> (ptr));
           }
       __HEREDOC
     end
@@ -147,7 +148,7 @@ module WXRuby3
           mixins.each { |name| gen_mixin_code(fout, name) }
         end
         unless included_mixins.empty?
-          included_mixins.each_pair {|cls, mods| mods.each { |mod| gen_mixin_convert_code(fout, cls, mod) } }
+          included_mixins.each_pair {|cls, mods| mods.each_pair { |mod, ctype| gen_mixin_convert_code(fout, cls, mod, ctype) } }
         end
         fout.puts "%}"
       end
@@ -215,8 +216,8 @@ module WXRuby3
       end
       unless included_mixins.empty?
         fout.puts
-        included_mixins.each_pair do |cls, module_names|
-          module_names.each { |m| fout.puts %Q{%mixin #{cls} "#{m}";} }
+        included_mixins.each_pair do |cls, modules|
+          modules.keys.each { |m| fout.puts %Q{%mixin #{cls} "#{m}";} }
         end
       end
     end
@@ -240,8 +241,8 @@ module WXRuby3
         end
         unless included_mixins.empty?
           fout.puts
-          included_mixins.each_pair do |cls, module_names|
-            module_names.each do |modname|
+          included_mixins.each_pair do |cls, modules|
+            modules.keys.each do |modname|
               m = modname.split('::').last
               fout.puts %Q{wxRuby_Register_#{m}_Include(&SwigClassWx#{rb_wx_name(cls)}, wxRuby_ConvertTo_#{m});}
             end

data/rakelib/lib/specs/interfaces.rb

@@ -177,7 +177,7 @@ module WXRuby3
     Director.Spec(pkg, 'wxDataObjectSimpleBase', requirements: %w[wxUSE_CLIPBOARD])
     Director.Spec(pkg, 'wxClipboard', requirements: %w[wxUSE_CLIPBOARD])
     Director.Spec(pkg, 'wxDragDrop', requirements: %w[wxUSE_DRAG_AND_DROP])
-    Director.Spec(pkg, 'wxContextHelpButton', director: Director::Button, requirements: %w[wxUSE_HELP])
+    Director.Spec(pkg, 'wxContextHelpButton', requirements: %w[wxUSE_HELP])
     Director.Spec(pkg, 'wxHelpProvider', requirements: %w[wxUSE_HELP])
     Director.Spec(pkg, 'wxHelpController', requirements: %w[wxUSE_HELP])
     Director.Spec(pkg, 'wxExtHelpController', director: Director::HelpController, requirements: %w[wxUSE_HELP])
@@ -200,6 +200,9 @@ module WXRuby3
     Director.Spec(pkg, 'wxPlatformInfo')
     Director.Spec(pkg, 'wxSplashScreen', requirements: %w[wxUSE_SPLASH])
     Director.Spec(pkg, 'wxUIActionSimulator', requirements: %w[wxUSE_UIACTIONSIMULATOR])
+    Director.Spec(pkg, 'wxActivityIndicator', director: Director::Window, requirements: %w[wxUSE_ACTIVITYINDICATOR])
+    Director.Spec(pkg, 'wxHyperlinkCtrl', director: Director::Window, requirements: %w[wxUSE_HYPERLINKCTRL])
+    Director.Spec(pkg, 'wxHyperlinkEvent', requirements: %w[wxUSE_HYPERLINKCTRL])
   }
 
   Director.Package('Wx::PRT', 'wxUSE_PRINTING_ARCHITECTURE') do |pkg|