wxruby3 1.5.4 → 1.6.0

data/samples/scrolling/varscroll.rb

@@ -0,0 +1,416 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+#
+# Adapted for wxRuby from wxWidgets vscroll sample
+# Copyright (c) 2001 Vadim Zeitlin
+
+require 'wx'
+
+# Example demonstrating the use of Wx::VScrolledWindow, Wx::HScrolledWindow and
+# Wx::HVScrolledWindow
+
+module VarScroll
+
+  MAX_LINES = 10000
+
+  # Define a new frame type: this is going to be our main frame
+  class VarScrollFrame < Wx::Frame
+
+    module ID
+      include Wx::IDHelper
+
+      # menu items
+      VScroll_Quit = Wx::ID_EXIT
+
+      # it is important for the id corresponding to the "About" command to have
+      # this standard value as otherwise it won't be handled properly under Mac
+      # (where it is special and put into the "Apple" menu)
+      VScroll_About = Wx::ID_ABOUT
+
+      VScroll_VScrollMode = self.next_id
+      VScroll_HScrollMode = self.next_id
+      VScroll_HVScrollMode = self.next_id
+    end
+
+    def initialize
+      super(nil, Wx::ID_ANY, 'VarScroll wxWidgets Sample', size:  [400, 350])
+
+      set_icon(Wx.Icon(:sample, art_path: File.dirname(__dir__)))
+
+      # either a Wx::VScrolledWindow, Wx::HScrolledWindow or a Wx::HVScrolledWindow, depending on current mode
+      @scrollWindow = nil
+
+      if Wx.has_feature?(:USE_MENUS)
+        # create a menu bar
+        menuFile = Wx::Menu.new
+
+        menuMode = Wx::Menu.new
+
+        # the "About" item should be in the help menu
+        menuHelp = Wx::Menu.new
+        menuHelp.append(ID::VScroll_About, "&About\tF1", 'Show about dialog')
+
+        menuMode.append_radio_item(ID::VScroll_VScrollMode, "&Vertical\tAlt-V",
+                                  'Vertical scrolling only')
+        menuMode.append_radio_item(ID::VScroll_HScrollMode, "&Horizontal\tAlt-H",
+                                  'Horizontal scrolling only')
+        menuMode.append_radio_item(ID::VScroll_HVScrollMode,
+                                  "Hori&zontal/Vertical\tAlt-Z",
+                                  'Horizontal and vertical scrolling')
+        menuMode.check(ID::VScroll_VScrollMode, true)
+
+        menuFile.append(ID::VScroll_Quit, "E&xit\tAlt-X", 'Quit this program')
+
+        # now append the freshly created menu to the menu bar...
+        menuBar = Wx::MenuBar.new
+        menuBar.append(menuFile, '&File')
+        menuBar.append(menuMode, '&Mode')
+        menuBar.append(menuHelp, '&Help')
+
+        # ... and attach this menu bar to the frame
+        set_menu_bar(menuBar)
+      end # USE_MENUS
+
+      if Wx.has_feature?(:USE_STATUSBAR)
+        # create a status bar just for fun (by default with 1 pane only)
+        create_status_bar(2)
+        set_status_text("Welcome to wxWidgets!")
+        set_status_widths([-1, 100])
+      end # USE_STATUSBAR
+
+      # create our one and only child -- it will take our entire client area
+      if menuMode.is_checked(ID::VScroll_VScrollMode)
+        @scrollWindow = VScrollWindow.new(self)
+      elsif menuMode.is_checked(ID::VScroll_HScrollMode)
+        @scrollWindow = HScrollWindow.new(self)
+      else
+        @scrollWindow = HVScrollWindow.new(self)
+      end
+
+      evt_menu(ID::VScroll_Quit,  :on_quit)
+      evt_menu(ID::VScroll_VScrollMode, :on_mode_v_scroll)
+      evt_menu(ID::VScroll_HScrollMode, :on_mode_h_scroll)
+      evt_menu(ID::VScroll_HVScrollMode, :on_mode_hv_scroll)
+      evt_menu(ID::VScroll_About, :on_about)
+      evt_size :on_size
+    end
+
+    # event handlers
+    def on_quit(_event)
+      close(true)
+    end
+
+    def on_mode_v_scroll(_event)
+      @scrollWindow.destroy if @scrollWindow
+
+      @scrollWindow = VScrollWindow.new(self)
+      send_size_event
+    end
+
+    def on_mode_h_scroll(_event)
+      @scrollWindow.destroy if @scrollWindow
+
+      @scrollWindow = HScrollWindow.new(self)
+      send_size_event
+    end
+
+    def on_mode_hv_scroll(_event)
+      @scrollWindow.destroy if @scrollWindow
+
+      @scrollWindow = HVScrollWindow.new(self)
+      send_size_event
+    end
+
+    def on_about(_event)
+      Wx.message_box("VarScroll shows how to implement scrolling with\n" +
+                     "variable line widths and heights.\n" +
+                     "(c) 2025 Martin Corino\n" +
+                     "Adapted for wxRuby from wxWidgets vscroll sample, \n" +
+                     "(c) 2003 Vadim Zeitlin",
+              "About VarScroll",
+                     Wx::OK | Wx::ICON_INFORMATION,
+                     self)
+    end
+
+    def on_size(event)
+      # show current size in the status bar
+      if Wx.has_feature?(:USE_STATUSBAR)
+        sz = get_client_size
+        set_status_text('%dx%d' % [sz.x, sz.y], 1)
+      end # USE_STATUSBAR
+
+      event.skip
+    end
+  end
+
+  class VScrollWindow < Wx::VScrolledWindow
+    def initialize(frame)
+      super(frame, Wx::ID_ANY)
+      @frame = frame
+
+      @heights = ::Array.new(MAX_LINES) { |i| rand(16..40) } # low: 16; high: 40
+
+      @changed = true
+
+      set_row_count(MAX_LINES)
+
+      evt_idle :on_idle
+      evt_paint :on_paint
+      evt_scrollwin :on_scroll
+      evt_mouse_events :on_mouse
+    end
+
+    def on_idle(_)
+      if Wx.has_feature?(:USE_STATUSBAR)
+        @frame.set_status_text('Page size = %d, pos = %d, max = %d' % [
+          get_scroll_thumb(Wx::VERTICAL),
+          get_scroll_pos(Wx::VERTICAL),
+          get_scroll_range(Wx::VERTICAL) ])
+      end # USE_STATUSBAR
+      @changed = false
+    end
+
+    def on_paint(_)
+      paint do |dc|
+
+        dc.with_pen(Wx::BLACK_PEN) do
+          lineFirst = get_visible_begin
+          lineLast = get_visible_end
+
+          hText = dc.get_char_height
+
+          clientSize = get_client_size
+
+          y = 0
+          (lineFirst...lineLast).each do |line|
+            dc.draw_line(0, y, clientSize.width, y)
+
+            hLine = on_get_row_height(line)
+            dc.draw_text('Line %d' % line, 2, y + (hLine - hText) / 2)
+
+            y += hLine
+            dc.draw_line(0, y, 1000, y)
+          end
+        end
+      end
+    end
+
+    def on_scroll(event)
+      @changed = true
+
+      event.skip
+    end
+
+    def on_mouse(event)
+      if event.left_down
+        capture_mouse
+      elsif event.left_up
+        release_mouse
+      end
+      event.skip
+    end
+
+    def on_get_row_height(n)
+      raise ArgumentError, 'row index too high' unless n < get_row_count
+
+      @heights[n]
+    end
+
+  end
+
+  class HScrollWindow < Wx::HScrolledWindow
+    def initialize(frame)
+      super(frame, Wx::ID_ANY)
+      @frame = frame
+
+      @widths = ::Array.new(MAX_LINES) { |i| rand(16..40) } # low: 16; high: 40
+
+      @changed = true
+
+      set_column_count(MAX_LINES)
+
+      evt_idle :on_idle
+      evt_paint :on_paint
+      evt_scrollwin :on_scroll
+      evt_mouse_events :on_mouse
+    end
+
+    def on_idle(_)
+      if Wx.has_feature?(:USE_STATUSBAR)
+        @frame.set_status_text('Page size = %d, pos = %d, max = %d' % [
+          get_scroll_thumb(Wx::HORIZONTAL),
+          get_scroll_pos(Wx::HORIZONTAL),
+          get_scroll_range(Wx::HORIZONTAL) ])
+      end # USE_STATUSBAR
+      @changed = false
+    end
+
+    def on_paint(_)
+      paint do |dc|
+
+        dc.with_pen(Wx::BLACK_PEN) do
+          lineFirst = get_visible_begin
+          lineLast = get_visible_end
+
+          hText = dc.get_char_height
+
+          clientSize = get_client_size
+
+          x = 0
+          (lineFirst...lineLast).each do |col|
+            dc.draw_line(x, 0, x, clientSize.height)
+
+            wCol = on_get_column_width(col)
+            dc.draw_rotated_text('Column %d' % col, x + (wCol - hText) / 2, clientSize.height - 5, 90)
+
+            x += wCol
+            dc.draw_line(x, 0, x, 1000)
+          end
+        end
+      end
+    end
+
+    def on_scroll(event)
+      @changed = true
+
+      event.skip
+    end
+
+    def on_mouse(event)
+      if event.left_down
+        capture_mouse
+      elsif event.left_up
+        release_mouse
+      end
+      event.skip
+    end
+
+    def on_get_column_width(n)
+      raise ArgumentError, 'column index too high' unless n < get_column_count
+
+      @widths[n]
+    end
+
+  end
+
+  class HVScrollWindow < Wx::HVScrolledWindow
+    def initialize(frame)
+      super(frame, Wx::ID_ANY)
+      @frame = frame
+
+      @widths = ::Array.new(MAX_LINES) { |i| rand(60..90) } # low: 60; high: 90
+      @heights = ::Array.new(MAX_LINES) { |i| rand(30..60) } # low: 30; high: 60
+
+      @changed = true
+
+      set_row_column_count(MAX_LINES, MAX_LINES)
+
+      evt_idle :on_idle
+      evt_paint :on_paint
+      evt_scrollwin :on_scroll
+      evt_mouse_events :on_mouse
+    end
+
+    def on_idle(_)
+      if Wx.has_feature?(:USE_STATUSBAR)
+        @frame.set_status_text('Page size = %d rows %d columns; pos = row: %d, column: %d; max = %d rows, %d columns' % [
+          get_scroll_thumb(Wx::VERTICAL),
+          get_scroll_thumb(Wx::HORIZONTAL),
+          get_scroll_pos(Wx::VERTICAL),
+          get_scroll_pos(Wx::HORIZONTAL),
+          get_scroll_range(Wx::VERTICAL),
+          get_scroll_range(Wx::HORIZONTAL) ])
+      end # USE_STATUSBAR
+      @changed = false
+    end
+
+    def on_paint(_)
+      paint do |dc|
+
+        dc.with_pen(Wx::BLACK_PEN) do
+          rowFirst = get_visible_rows_begin
+          rowLast = get_visible_rows_end
+          columnFirst = get_visible_columns_begin
+          columnLast = get_visible_columns_end
+
+          hText = dc.get_char_height
+
+          clientSize = get_client_size
+
+          y =0
+          (rowFirst...rowLast).each do |row|
+            rowHeight = on_get_row_height(row)
+            dc.draw_line(0, y, clientSize.width, y)
+            x = 0
+            (columnFirst...columnLast).each do |col|
+              colWidth = on_get_column_width(col)
+
+              dc.draw_line(x, 0, x, clientSize.height) if row == rowFirst
+
+              dc.draw_text('Row %d' % row, x + 2, y + rowHeight / 2 - hText)
+              dc.draw_text('Col %d' % col, x + 2, y + rowHeight / 2)
+
+
+              x += colWidth;
+              dc.draw_line(x, 0, x, clientSize.height) if row == rowFirst
+            end
+
+            y += rowHeight
+            dc.draw_line(0, y, clientSize.width, y)
+          end
+        end
+      end
+    end
+
+    def on_scroll(event)
+      @changed = true
+
+      event.skip
+    end
+
+    def on_mouse(event)
+      if event.left_down
+        capture_mouse
+      elsif event.left_up
+        release_mouse
+      end
+      event.skip
+    end
+
+    def on_get_row_height(n)
+      raise ArgumentError, 'row index too high' unless n < get_row_count
+
+      @heights[n]
+    end
+
+    def on_get_column_width(n)
+      raise ArgumentError, 'column index too high' unless n < get_column_count
+
+      @widths[n]
+    end
+
+  end
+end
+
+module VarScrollSample
+
+  include WxRuby::Sample if defined? WxRuby::Sample
+
+  def self.describe
+    { file: __FILE__,
+      summary: 'wxRuby VarScroll example.',
+      description: 'wxRuby example demonstrating the use of Wx::VScrolledWindow, Wx::HScrolledWindow and Wx::HVScrolledWindow.' }
+  end
+
+  def self.activate
+    frame = VarScroll::VarScrollFrame.new
+    frame.show(true)
+    frame
+  end
+
+  if $0 == __FILE__
+    Wx::App.run { VarScrollSample.activate }
+  end
+
+end

data/samples/widgets/hyperlink.rb

@@ -34,8 +34,14 @@ module Widgets
       def get_widget
         @hyperlink
       end
+
+      def get_widgets
+        [get_widget, @hyperlinkLong]
+      end
+
       def recreate_widget
         create_hyperlink
+        create_hyperlink_long
       end
   
       # lazy creation of the content
@@ -45,32 +51,42 @@ module Widgets
         # left pane
         sizerLeft = Wx::StaticBoxSizer.new(Wx::VERTICAL, self, 'Hyperlink details')
         sizerLeftBox = sizerLeft.get_static_box
-    
+
+        choices = Wx::PLATFORM == 'WXOSX' ? %w[default generic] : %w[native generic]
+        @radioImplementation = Wx::RadioBox.new(sizerLeftBox, Wx::ID_ANY, 'Implementation',
+                                  choices: choices)
+        sizerLeft.add(@radioImplementation, 0, Wx::ALL|Wx::GROW, 5)
+
         szr, @label = create_sizer_with_text_and_button(ID::SetLabel,'Set &Label', Wx::ID_ANY, sizerLeftBox)
         sizerLeft.add(szr, 0, Wx::ALL | Wx::ALIGN_RIGHT, 5)
-    
+
         szr, @url = create_sizer_with_text_and_button(ID::SetURL,'Set &URL', Wx::ID_ANY, sizerLeftBox)
         sizerLeft.add(szr, 0, Wx::ALL | Wx::ALIGN_RIGHT, 5)
-    
+
         alignments = %w{&left &centre &right}
     
         @radioAlignMode = Wx::RadioBox.new(sizerLeftBox, Wx::ID_ANY, 'alignment',
                                            choices: alignments)
-        @radioAlignMode.set_selection(1)  # start with "centre" selected since
-                                          # wxHL_DEFAULT_STYLE contains wxHL_ALIGN_CENTRE
         sizerLeft.add(@radioAlignMode, 0, Wx::ALL|Wx::GROW, 5)
-    
+
+        b0 = Wx::Button.new(sizerLeftBox, Wx::ID_ANY, '&Reset')
+        b0.evt_button(Wx::ID_ANY, self.method(:on_button_reset))
+        sizerLeft.add(b0, 0, Wx::ALIGN_CENTRE_HORIZONTAL | Wx::ALL, 15)
+
+        @hyperlink = nil
+        @hyperlinkLong = nil
+
+        # initializations
+        reset
+
+        recreate_widget # create hyperlink controls
+
         # right pane
         szHyperlinkLong = Wx::VBoxSizer.new
         szHyperlink = Wx::HBoxSizer.new
     
         @visit = Wx::StaticText.new(self, Wx::ID_ANY, 'Visit ')
     
-        @hyperlink = Wx::HyperlinkCtrl.new(self,
-                                           ID::Ctrl,
-                                           'wxRuby website',
-                                           'www.github.com/mcorino/wxRuby3')
-    
         @fun = Wx::StaticText.new(self, Wx::ID_ANY, " for fun!")
     
         szHyperlink.add(0, 0, 1, Wx::CENTRE)
@@ -80,11 +96,6 @@ module Widgets
         szHyperlink.add(0, 0, 1, Wx::CENTRE)
         szHyperlink.set_min_size(150, 0)
     
-        @hyperlinkLong = Wx::HyperlinkCtrl.new(self,
-                                               Wx::ID_ANY,
-                                               'This is a long hyperlink',
-                                               'www.github.com/mcorino/wxRuby3')
-
         szHyperlinkLong.add(0, 0, 1, Wx::CENTRE)
         szHyperlinkLong.add(szHyperlink, 0, Wx::CENTRE|Wx::GROW)
         szHyperlinkLong.add(0, 0, 1, Wx::CENTRE)
@@ -95,10 +106,7 @@ module Widgets
         # the 3 panes panes compose the window
         sizerTop.add(sizerLeft, 0, (Wx::ALL & ~Wx::LEFT), 10)
         sizerTop.add(szHyperlinkLong, 1, Wx::GROW | (Wx::ALL & ~Wx::RIGHT), 10)
-    
-        # final initializations
-        reset
-    
+
         set_sizer(sizerTop)
 
         # connect event handlers
@@ -114,86 +122,103 @@ module Widgets
       # event handlers
       def on_button_set_label(_event)
         @hyperlink.set_label(@label.value)
-        create_hyperlink
+        recreate_widget
       end
 
       def on_button_set_url(_event)
         @hyperlink.set_url(@url.value)
-        create_hyperlink
+        recreate_widget
       end
   
       def on_button_reset(_event)
         reset
 
-        create_hyperlink
+        recreate_widget
       end
 
       def on_alignment(_event)
-        case @radioAlignMode.selection
-        when ID::Align_Left
-          addstyle = Wx::HL_ALIGN_LEFT
-        when ID::Align_Centre
-          addstyle = Wx::HL_ALIGN_CENTRE
-        when ID::Align_Right
-          addstyle = Wx::HL_ALIGN_RIGHT
-        else
-          ::Kernel.raise RuntimeError, 'unknown alignment'
-        end
-    
-        create_hyperlink_long(addstyle)
+        @alignment = case @radioAlignMode.selection
+                     when ID::Align_Left
+                       addstyle = Wx::HL_ALIGN_LEFT
+                     when ID::Align_Centre
+                       addstyle = Wx::HL_ALIGN_CENTRE
+                     when ID::Align_Right
+                       addstyle = Wx::HL_ALIGN_RIGHT
+                     else
+                       ::Kernel.raise RuntimeError, 'unknown alignment'
+                     end
+
+        recreate_widget
       end
 
       # reset the control parameters
       def reset
-        @label.set_value(@hyperlink.label)
-        @url.set_value(@hyperlink.url)
+        @radioImplementation.set_selection(0)  # start with "native" or "default" selected
+        @label.value = 'wxRuby website'
+        @url.value = 'www.github.com/mcorino/wxRuby3'
+        @radioAlignMode.set_selection(1)  # start with "centre" selected
+        @alignment = Wx::HL_ALIGN_CENTRE
       end
   
       # (re)create the hyperlinkctrl
       def create_hyperlink
-        label = @hyperlink.label
-        url = @hyperlink.url
         style = get_attrs.default_flags
-    
+
         style |= Wx::HL_DEFAULT_STYLE & ~Wx::BORDER_MASK
-    
-        hyp = Wx::HyperlinkCtrl.new(self,
-                                    ID::Ctrl,
-                                    label,
-                                    url,
-                                    style: style)
+
+        hyp = if @radioImplementation.selection == 0
+                Wx::HyperlinkCtrl.new(self,
+                                      Wx::ID_ANY,
+                                      @label.value,
+                                      @url.value,
+                                      style: style)
+              else
+                Wx::GenericHyperlinkCtrl.new(self,
+                                             Wx::ID_ANY,
+                                             @label.value,
+                                             @url.value,
+                                             style: style)
+              end
 
         # update sizer's child window
-        get_sizer.replace(@hyperlink, hyp, true)
+        get_sizer.replace(@hyperlink, hyp, true) if get_sizer
     
         # update our pointer
-        @hyperlink.destroy
+        @hyperlink.destroy if @hyperlink
         @hyperlink = hyp
     
         # re-layout the sizer
-        get_sizer.layout
+        get_sizer.layout if get_sizer
       end
 
-      def create_hyperlink_long(align)
+      def create_hyperlink_long
         style = get_attrs.default_flags
-        style |= align
+        style |= @alignment
         style |= Wx::HL_DEFAULT_STYLE & ~(Wx::HL_ALIGN_CENTRE | Wx::BORDER_MASK)
-    
-        hyp = Wx::HyperlinkCtrl.new(self,
-                                    Wx::ID_ANY,
-                                    'This is a long hyperlink',
-                                    'www.github.com/mcorino/wxRuby3',
-                                    style: style)
+
+        hyp = if @radioImplementation.selection == 0
+                Wx::HyperlinkCtrl.new(self,
+                                      Wx::ID_ANY,
+                                      'This is a long hyperlink',
+                                      @url.value,
+                                      style: style)
+              else
+                Wx::GenericHyperlinkCtrl.new(self,
+                                             Wx::ID_ANY,
+                                             'This is a long hyperlink',
+                                             @url.value,
+                                             style: style)
+              end
 
         # update sizer's child window
-        get_sizer.replace(@hyperlinkLong, hyp, true)
+        get_sizer.replace(@hyperlinkLong, hyp, true) if get_sizer
     
         # update our pointer
-        @hyperlinkLong.destroy
+        @hyperlinkLong.destroy if @hyperlinkLong
         @hyperlinkLong = hyp
     
         # re-layout the sizer
-        get_sizer.layout
+        get_sizer.layout if get_sizer
       end
       
     end