wxruby3 0.9.7 → 1.0.0

data/rakelib/lib/director/secret_store.rb

@@ -0,0 +1,117 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+###
+# wxRuby3 wxWidgets interface director
+###
+
+module WXRuby3
+
+  class Director
+
+    class SecretStore < Director
+
+      def setup
+        super
+        spec.items << 'wxSecretValue'
+        spec.gc_as_untracked # don't even track SecretStore and SecretValue objects
+        # there is no possibility of SecretStore derivatives
+        # not least because wxRuby only ever allows a single global SecretStore
+        spec.disable_proxies
+        spec.make_abstract 'wxSecretStore'
+
+        spec.include 'ruby/encoding.h'
+
+        spec.ignore 'wxSecretValue::GetAsString',
+                    'wxSecretValue::GetSize',
+                    'wxSecretValue::GetData',
+                    'wxSecretValue::Wipe',
+                    'wxSecretValue::WipeString',
+                    'wxSecretValue::wxSecretValue(const wxString&)',
+                    'wxSecretValue::wxSecretValue(size_t, const void *)'
+        spec.regard 'wxSecretValue::wxSecretValue()',
+                    'wxSecretValue::wxSecretValue(const wxSecretValue&)',
+                    regard_doc: false
+        # customize string arg ctor
+        spec.add_extend_code 'wxSecretValue', <<~__HEREDOC
+          wxSecretValue(VALUE secret_string)
+          {
+            if (RTEST(secret_string) && TYPE(secret_string) == T_STRING)
+            {
+              if (ENCODING_GET(secret_string) == rb_utf8_encindex())
+              {
+                return new wxSecretValue(RSTR_TO_WXSTR(secret_string));
+              }
+              else
+              {
+                return new wxSecretValue(RSTRING_LEN(secret_string), (void*)StringValuePtr(secret_string));
+              }
+            }
+            else
+            {
+              rb_raise(rb_eArgError, "Expected String or Wx::SecretValue for #0");
+            }
+          } 
+          __HEREDOC
+
+        # customize GetData
+        spec.map 'const void*' => 'String', swig: false do
+          map_out code: ''
+        end
+        spec.add_extend_code 'wxSecretValue', <<~__HEREDOC
+          VALUE get_data() 
+          {
+            size_t sz = $self->GetSize();
+            const void* data = $self->GetData();
+            return rb_enc_str_new(static_cast<const char*>(data), sz, rb_ascii8bit_encoding());
+          }
+
+          VALUE get_as_string() 
+          {
+            size_t sz = $self->GetSize();
+            const void* data = $self->GetData();
+            return rb_utf8_str_new(static_cast<const char*>(data), sz);
+          }
+          __HEREDOC
+
+        # customize GetDefault
+        spec.ignore 'wxSecretStore::GetDefault', ignore_doc: false
+        spec.add_extend_code 'wxSecretStore', <<~__HEREDOC
+          static VALUE get_default() 
+          {
+            wxSecretStore* result = new wxSecretStore(wxSecretStore::GetDefault());
+            return SWIG_NewPointerObj(result, SWIGTYPE_p_wxSecretStore, SWIG_POINTER_OWN);
+          }
+          __HEREDOC
+        spec.map 'wxString *errmsg' => 'String' do
+          map_in ignore: true, temp: 'wxString tmp', code: '$1 = &tmp;'
+          map_argout code: <<~__CODE
+            if ($result == Qfalse)
+            {
+              $result = SWIG_Ruby_AppendOutput($result, WXSTR_TO_RSTR(tmp$argnum));
+            }
+            __CODE
+        end
+        spec.map 'wxString& username' => 'String' do
+          map_in ignore: true, temp: 'wxString tmp', code: '$1 = &tmp;'
+          map_argout code: <<~__CODE
+            if ($result == Qtrue)
+            {
+              $result = SWIG_Ruby_AppendOutput($result, WXSTR_TO_RSTR(tmp$argnum));
+            }
+            __CODE
+        end
+        # the type matching of the username argument is tricky here since there only is the const difference
+        # have to explicitly overrule here for Save() incl. explicitly negating the argout mapping
+        spec.map 'const wxString& username' => 'String' do
+          map_in temp: 'wxString tmp', code: 'tmp = RSTR_TO_WXSTR($input); $1 = &tmp;'
+          map_argout by_ref: true
+        end
+      end
+
+    end # class SecretStore
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/system_settings.rb

@@ -22,7 +22,7 @@ module WXRuby3
                          'wxSystemSettings::HasFeature',
                          'wxSystemSettings::GetScreenType'
         spec.ignore 'wxSystemSettings::GetAppearance'
-        spec.add_extend_code <<~__HEREDOC
+        spec.add_extend_code 'wxSystemSettings', <<~__HEREDOC
           static wxString GetAppearanceName()
           {
             return wxSystemSettings::GetAppearance().GetName();

data/rakelib/lib/director/tree_event.rb

@@ -55,9 +55,9 @@ module WXRuby3
           static const rb_data_type_t __wxTreeItemId_type = {
             "TreeItemId",
           #if RUBY_API_VERSION_MAJOR >= 3
-            { NULL, NULL, __wxTreeItemId_size, 0, 0},
+            { NULL, NULL, __wxTreeItemId_size, 0, {}},
           #else
-            { NULL, NULL, __wxTreeItemId_size, 0},
+            { NULL, NULL, __wxTreeItemId_size, {}},
           #endif 
             NULL, NULL, RUBY_TYPED_FREE_IMMEDIATELY
           };

data/rakelib/lib/director/window.rb

@@ -150,13 +150,14 @@ module WXRuby3
             static VALUE do_paint_buffered(wxWindow* ptr)
             {
               VALUE rc = Qnil;
-              wxAutoBufferedPaintDC dc(ptr);
             #if wxALWAYS_NATIVE_DOUBLE_BUFFER
+              wxPaintDC dc(ptr);
               wxPaintDC* ptr_dc = &dc;
               VALUE r_class = rb_const_get(mWxCore, rb_intern("PaintDC"));
             #else
-              wxMemoryDC* ptr_dc = &dc;
-              VALUE r_class = rb_const_get(mWxCore, rb_intern("MemoryDC"));
+              wxBufferedPaintDC dc(ptr);
+              wxBufferedPaintDC* ptr_dc = &dc;
+              VALUE r_class = rb_const_get(mWxCore, rb_intern("BufferedPaintDC"));
             #endif
               swig_type_info* swig_type = wxRuby_GetSwigTypeForClass(r_class);
               VALUE rb_dc = SWIG_NewPointerObj(SWIG_as_voidptr(ptr_dc), swig_type, 0);

data/rakelib/lib/extractor/function.rb

@@ -293,7 +293,7 @@ module WXRuby3
         @is_static = element['static'] == 'yes'
         @is_virtual = %w[virtual pure-virtual].include?(element['virt'])
         @is_pure_virtual = (element['virt'] == 'pure-virtual')
-        @args_string.sub!(/\s*=0/, '') if @is_pure_virtual
+        @args_string.sub!(/\)(\s*const)?\s*=0/, ')\1') if @is_pure_virtual
         @is_override = !!element.at_xpath('reimplements')
         @is_const = (element['const'] == 'yes')
         @is_ctor = (@name == @class_name)

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

@@ -13,3 +13,13 @@
               animations.add("throbber_2x.gif")
               animationCtrl.play if animationCtrl.set_animation(animations)
             ```
+:wxAnimationCtrl.SetAnimation:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+            
+            ```ruby
+              animationCtrl.set_animation(Wx::AnimationBundle.new('progress.gif'))
+            ```

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

@@ -0,0 +1,35 @@
+---
+:wxBannerWindow:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+            
+            ```ruby
+              class MyFrame < Wx::Frame
+            
+                def initialize(...)
+            
+                  # ... create the frame itself ...
+            
+                  # Create and initialize the banner.
+                  banner = Wx::BannerWindow.new(self, Wx::TOP)
+                  banner.set_text("Welcome to my wonderful program",
+                                  "  Before doing anything else, you need to connect to the online server.\n" +
+                                  "  Please enter your credentials in the controls below.")
+             
+                  # And position it along the top edge of the window.
+                  sizer = Wx::VBoxSizer.new
+                  sizer.add(banner, Wx::SizerFlags.new.expand)
+             
+                  # ... add the rest of the window contents to the same sizer ...
+             
+                  set_sizer_and_fit(sizer)
+            
+                end
+            
+                # ...
+            
+              end
+            ```

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

@@ -32,3 +32,15 @@
                 end
               end
             ```
+:wxGraphicsPenInfo:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+
+            ```ruby
+              ctx = Wx::GraphicsContext.create(dc)
+            
+              ctx.set_pen(Wx::GraphicsPenInfo.new(Wx::BLUE).width(1.25).style(Wx::PENSTYLE_DOT))
+            ```

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

@@ -0,0 +1,12 @@
+---
+:wxGraphicsRenderer:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+
+            ```ruby
+              # path = Wx::GraphicsPath from somewhere
+              brush = path.get_renderer.create_brush(Wx::BLACK_BRUSH)
+            ```

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

@@ -23,3 +23,28 @@
             
               end
             ```
+:wxGrid.GetSelectedBlocks:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+            
+            ```ruby
+              grid.get_selected_blocks.each do |gbc|
+                break if gbc.intersects(my_block)
+              end
+            ```
+    :post:
+      - :pattern: !ruby/regexp /,\s+e\.g\.\s+with\s+range-for\s+loop:/
+        :subst: ':'
+:wxGridFitMode:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+            
+            ```ruby
+              grid.set_default_cell_fit_mode(Wx::GRID::GridFitMode.clip)
+            ```

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

@@ -0,0 +1,91 @@
+---
+:wxHeaderCtrl.Create:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+
+            ```ruby
+              Wx::HD_DEFAULT_STYLE & ~Wx::HD_ALLOW_REORDER
+            ```
+:wxHeaderCtrl.AddColumnsItems:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+
+            ```ruby
+              menu = Wx::Menu.new
+              menu.append(100, 'Some custom command')
+              menu.append_separator
+              add_columns_items(menu, 200)
+              rc = get_popup_menu_selection_from_user(menu, pt)
+              if rc >= 200
+                # ... toggle visibility of the column rc-200 ...
+              end
+            ```
+:wxHeaderCtrl.UpdateColumnWidthToFit:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+
+            ```ruby
+              class MyHeaderColumn < Wx::HeaderColumn
+                # ...
+            
+                def set_width(width) 
+                  @width = width
+                end
+          
+                def get_width 
+                  @width
+                end
+            
+              end
+              
+              class MyHeaderCtrl < Wx::HeaderCtrl
+                # ...
+            
+                protected
+            
+                def get_column(idx)
+                  # @cols = Array<MyHeaderColumn>
+                  @cols[idx]
+                end
+              
+                def update_column_width_to_fit(idx, widthTitle)
+                  widthContents = # ... compute minimal width for column idx ...
+                  @cols[idx].set_width([widthContents, widthTitle].max)
+                  true
+                end
+            
+              end
+            ```
+:wxHeaderCtrlSimple.HideColumn:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+
+            ```ruby
+              show_column(idx, false)
+            ```
+:wxHeaderColumnSimple:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+
+            ```ruby
+              header = Wx::HeaderCtrlSimple.new(...)
+              col = Wx::HeaderColumnSimple.new('Title')
+              col.set_width(100)
+              col.set_sortable(100)
+              header.append_column(col)
+            ```

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

@@ -9,3 +9,13 @@
             ```ruby
               get_icon(Wx::Size.new(size,size))
             ```
+:wxIconBundle.GetIcon:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+
+            ```ruby
+              get_icon(Wx::Size.new(size,size))
+            ```

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

@@ -0,0 +1,27 @@
+---
+:wxInfoBar:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+
+            ```ruby
+              class MyFrame < Wx::Frame
+              
+                def initialize()
+                  # ...
+                  @infoBar = Wx::InfoBar.new(self)
+              
+                  sizer = Wx::VBoxSizer.new
+                  sizer.add(@infoBar, Wx::SizerFlags.new.expand)
+                  # ... add other frame controls to the sizer ...
+                  set_sizer(sizer)
+                end
+                
+                def some_method
+                    @infoBar.show_message('Something happened', Wx::ICON_INFORMATION)
+                end
+            
+              end
+            ```

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

@@ -7,7 +7,7 @@
           :replace: |
             
             ```ruby
-              wxLog.set_component_level("wx/net", Wx::LOG_Error)
+              Wx::Log.set_component_level('wx/net', Wx::LOG_Error)
             ```
 :wxLog.LogRecord:
   :detail:

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

@@ -0,0 +1,27 @@
+---
+:wxMediaCtrl:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+
+            ```ruby
+              class MyFrame < Wx::Frame
+            
+                def initialize()
+                  # ... setup frame controls ...
+                  # bind events
+                  # ...
+                  evt_media_stop MY_ID, :on_media_stop
+                end
+            
+                def on_media_stop(evt)
+                  if @userWantsToSeek
+                    @mediactrl.seek(@mediactrl.length - 1)
+                    evt.veto
+                  end
+                end
+            
+              end
+            ```

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

@@ -0,0 +1,22 @@
+---
+:wxPersistentComboBox:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+
+            ```ruby
+              # Suppose you need to ask the user to select their favourite Linux
+              # distribution, for some reason:
+              combo = Wx::ComboBox.new(self, Wx::ID_ANY)
+              unless Wx.persistent_register_and_restore(combo, 'distribution')
+                # Seed it with some default contents.
+                combo.append("Debian")
+                combo.append("Fedora")
+                combo.append("Ubuntu")
+              end
+              
+              # Optionally, you might want to restore the last used entry:
+              combo.set_selection(0)
+            ```

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

@@ -6,6 +6,6 @@
         - :pattern: !ruby/regexp /.*/
           :replace: |
             
-            ```
+            ```ruby
               editor = Wx::PG::PropertyGrid.register_editor_class(MyEditorClass.new)
             ```

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

@@ -138,7 +138,7 @@
         - :pattern: !ruby/regexp /class.*MyProperty.*:.*public.*wxPGProperty/
           :replace: | 
             
-            ``` ruby
+            ```ruby
               class MyProperty < Wx::PG::PGProperty
               
                   # All arguments of this ctor must have a default value -
@@ -171,10 +171,10 @@
               end
             ```
     :post:
-      - :pattern: !ruby/regexp /==\swxIntProperty.*==\swxUIntProperty/m
+      - :pattern: !ruby/regexp /\#\#\swxIntProperty.*\#\#\swxUIntProperty/m
         :subst: |
           
-          == wxIntProperty
+          ## Wx::PG::IntProperty
           
           It derives from {Wx::PG::NumericProperty} and displays value as a signed long integer.
           Supported special attributes:
@@ -182,7 +182,7 @@
           - {Wx::PG::PG_ATTR_MIN}, {Wx::PG::PG_ATTR_MAX} to specify acceptable value range.
           - {Wx::PG::PG_ATTR_SPINCTRL_STEP}, {Wx::PG::PG_ATTR_SPINCTRL_WRAP}, {Wx::PG::PG_ATTR_SPINCTRL_MOTION}: Sets SpinCtrl editor parameters. 
           
-          == wxUIntProperty
+          ## Wx::PG::UIntProperty
 
       - :pattern: !ruby/regexp /Since\s\{Wx::PG::PGProperty\}\sderives.*For\sinstance:/m
         :subst: ''

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

@@ -0,0 +1,14 @@
+---
+:wxRearrangeList:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+
+            ```ruby
+              order = [
+                  0,  # checked item #0
+                  ~1  # unchecked item #1
+                ]
+            ```

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

@@ -0,0 +1,15 @@
+---
+:wxRibbonPanel:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+            
+            ```ruby
+              panel = @ribbon.get_page(0).get_panel_by_id(ID_EDITOR_PANEL)
+              panel.show(!panel.is_shown) if panel
+              # Update the UI
+              @ribbon.realise
+              @ribbon.layout
+            ```

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

@@ -0,0 +1,26 @@
+---
+:wxRichTextFormattingDialog:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+            
+            ```ruby
+              range = if @richTextCtrl.has_selection
+                        @richTextCtrl.get_selection_range
+                      else
+                        (0..@richTextCtrl.get_last_position+1)
+                      end
+              
+              pages = Wx::RTC::RICHTEXT_FORMAT_FONT|Wx::RTC::RICHTEXT_FORMAT_INDENTS_SPACING|
+                          Wx::RTC::RICHTEXT_FORMAT_TABS|Wx::RTC::RICHTEXT_FORMAT_BULLETS
+              
+              Wx::RTC.RichTextFormattingDialog(pages, self) do |formatDlg|
+                formatDlg.GetStyle(m_richTextCtrl, range);
+              
+                if formatDlg.show_modal == Wx::ID_OK
+                  formatDlg.apply_style(@richTextCtrl, range)
+                end
+              end
+            ```

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

@@ -0,0 +1,55 @@
+---
+:wxSecretStore:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /\!store\..*Save.*username.*password\)/
+          :replace: |
+            
+            ```ruby
+              store = Wx::SecretStore.get_default
+              rc, err = store.ok?
+              if rc
+                unless store.save('MyApp/MyService', username, password)
+                  Wx.log_warning('Failed to save credentials to the system secret store.')
+                end
+              else
+                Wx.log_warning("This system doesn't support storing passwords securely (#{err}).")
+              end
+            ```
+        - :pattern: !ruby/regexp /store\..*Load.*username.*password\)/
+          :replace: |
+            
+            ```ruby
+              store = Wx::SecretStore.get_default
+              rc, _ = store.ok?
+              if rc
+                password = Wx::SecretValue.new
+                rc, username = store.load('MyApp/MyService', password)
+                if rc
+                  # ... use the password ... 
+                end
+              end
+            ```
+:wxSecretStore.IsOk:
+  :brief:
+    :replace:
+      :text: |
+        Check if this object can actually be used.
+        Returns true if the object can be used.
+        Returns false and an error message describing the reason if not.
+
+:wxSecretStore.Load:
+  :detail:
+    :post:
+      - :pattern: !ruby/regexp /Otherwise\s+the\s+function.*arguments\./
+        :subst: |
+          Otherwise the function returns true and the username and updates the provided password argument.
+
+:wxSecretValue:
+  :detail:
+    :post:
+      - :pattern: !ruby/regexp /\s+\Z/
+        :subst: |
+          
+          @note Due to a bug using binary secrets will not work for WXGTK wxWidgets<=3.2.4 (WXOSX and WXMSW work fine). This has been fixed for later versions.

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

@@ -15,5 +15,5 @@
               text.append_text("Blue on grey text\n")
             ```
     :post:
-      - :pattern: !ruby/regexp /==\s+wxTextCtrl\s+and\s+C\+\+\s+Streams.*See\s+\{Wx::StreamToTextRedirector\}\s+for\s+more\s+details\./m
+      - :pattern: !ruby/regexp /\#\#\s+wxTextCtrl\s+and\s+C\+\+\s+Streams.*See\s+\{Wx::StreamToTextRedirector\}\s+for\s+more\s+details\./m
         :subst: ''

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

@@ -0,0 +1,27 @@
+---
+:wxWizard:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+            
+            ```ruby
+              class MyFrame < Wx::Frame
+            
+                # ...
+            
+                def on_run_wizard(_event)
+                  Wx.Wizard(self) do |wizard|
+              
+                    wizard.run_wizard(get_initial_page_from_some_where)
+              
+                    # The wizard is destroyed when the block ends.
+                  end
+                end
+            
+              end
+            ```
+    :post:
+      - :pattern: !ruby/regexp /Note\s+that\s+\{Wx::Wizard\}\s+inherits\s+from\s+\{Wx::Dialog\}.*typically\s+you\s+would\s+use\s+like\s+this:/
+        :subst: 'Note that {Wx::Wizard} inherits from {Wx::Dialog} so that typically you would use it like this:'