GtkSimpleLayout 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 63da04a080c9692caa7a4d73c64cd039cc925767c056668fdd44d1054ccec355
+  data.tar.gz: 4f784f8a7c76dee45b23c50e020f88d06a52a928a79903bb3351bf4a0d5fcc25
+SHA512:
+  metadata.gz: 820c45c85a73d4f0972ac2c5aa893edc001c1cccba316b1b39f6cb8d7bfd523b924b43bf4f78a734ee9ad839f4a47fe1b462ef14665f67ccad3d9390a9147a4b
+  data.tar.gz: efc1b63c51fcd7f2126bbfc64fd9e5e07f4329a8608aa5873fbfd2733787cd1a88f4871cecb277a6bfd364cc0922d14f794d009d4401372b4e6fdde89b954054

data/README

@@ -1,9 +1,9 @@
 == GtkSimpleLayout ==
 
-The GtkSimpleLayout is a helper module for RubyGnome2, it provides a builder
+The GtkSimpleLayout is a helper module for RubyGtk3, it provides a builder
 style layout producing much better readable UI codes.
 
-Copy Right 2009, Ricky Zheng <ricky_gz_zheng@yahoo.co.nz>
+Copyright 2009, Ricky Zheng <ricky_gz_zheng@yahoo.co.nz>
 
 Licence: GPLv2
 
@@ -22,7 +22,7 @@ About inspector:
 
 == Example ==
 
-require 'gtk2'
+require 'gtk3'
 require 'simple_layout'
 
 class MyWin < Gtk::Window
@@ -36,9 +36,9 @@ class MyWin < Gtk::Window
   end
 
   def my_layout
-    vbox do
-      label 'Hello'
-      button 'World !'
+    _box :vertical do
+      _label 'Hello'
+      _button 'World !'
     end
   end
 end

data/example/auto_event_map.rb

@@ -1,14 +1,14 @@
-require 'gtk2'
-require File.dirname(__FILE__) + '/../lib/simple_layout'
+require 'gtk3'
+require 'simple_layout'
 
 class MyWin < Gtk::Window
   include SimpleLayout::Base
 
   def my_layout
-    hbutton_box do
-      button 'Click me !', :id => :btn_test
-      button 'Hi !', :id => :btn_hi
-      button 'Quit', :id => :btn_quit
+    _button_box :horizontal do
+      _button 'Click me !', :id => :btn_test
+      _button 'Hi !', :id => :btn_hi
+      _button 'Quit', :id => :btn_quit
     end
   end
 

data/example/basic.rb

@@ -1,5 +1,5 @@
-require 'gtk2'
-require File.dirname(__FILE__) + '/../lib/simple_layout'
+require 'gtk3'
+require 'simple_layout'
 
 class MyWin < Gtk::Window
   include SimpleLayout::Base
@@ -12,20 +12,20 @@ class MyWin < Gtk::Window
   end
 
   def my_layout
-    vbox do
-      frame 'frame 1' do
-        hbox do
-          label 'Label 1'
-          button 'Button 1, fixed'
-          button "Button 2, I'm flexiable", :layout => [true, true]
+    _box :vertical do
+      _frame 'frame 1' do
+        _box :horizontal do
+          _label 'Label 1'
+          _button 'Button 1, fixed'
+          _button "Button 2, I'm flexiable", layout: [padding: 15]
+          _button 'Button 3, fixed, at the end', layout: [:end, false, false] 
         end
       end
-      frame 'frame 2' do
-        vbox do
-          label 'Label 2'
-          label 'Label 3'
-          button 'Button 3'
-          button 'Button 4'
+      _frame 'frame 2', layout: [expand: true, fill: true, padding: 20] do
+        _box :vertical do
+          _label 'Label 2'
+          _label 'Label 3'
+          _button 'Button 4, extend: true', layout: [:end, extend: true, fill: true]
         end
       end
     end

data/example/calculator.rb

@@ -1,5 +1,5 @@
-require 'gtk2'
-require File.dirname(__FILE__) + '/../lib/simple_layout'
+require 'gtk3'
+require 'simple_layout'
 
 class MyWin < Gtk::Window
   include SimpleLayout::Base
@@ -13,27 +13,27 @@ class MyWin < Gtk::Window
   end
 
   def my_layout
-    vbox do
+    _box :vertical do
       with_attr :border_width => 3 do
-        hbox do
-          entry :id => :ent_input, :layout => [true, true, 5]
+        _box :horizontal do
+          _entry :id => :ent_input, :layout => [true, true, 5]
         end
-        hbox do
-          frame do
-            label 'M', :set_size_request => [20, 20]
+        _box :horizontal do
+          _frame do
+            _label 'M', :set_size_request => [20, 20]
           end
-          hbutton_box do
-            button 'Backspace'
-            button 'CE'
-            button 'C'
+          _button_box :horizontal do
+            _button 'Backspace'
+            _button 'CE'
+            _button 'C'
           end
         end
-        hbox do
-          vbutton_box do
-            button 'MC'
-            button 'MR'
-            button 'MS'
-            button 'M+'
+        _box :horizontal do
+          _button_box :vertical do
+            _button 'MC'
+            _button 'MR'
+            _button 'MS'
+            _button 'M+'
           end
           with_attr :layout => [true, true] do
             number_and_operators_layout
@@ -44,14 +44,14 @@ class MyWin < Gtk::Window
   end
 
   def number_and_operators_layout
-    vbox do
+    _box :vertical do
       [ ['7', '8', '9', '/', 'sqt'],
         ['4', '5', '6', '*', '%'],
         ['1', '2', '3', '-', '1/x'],
         ['0', '+/-', '.', '+', '=']].each do |cols|
-        hbox :layout => [true, true] do
+        _box :horizontal, :layout => [true, true] do
           cols.each do |txt|
-            button txt, :id => txt.to_sym, :set_size_request => [30, 30], :layout => [true, true]
+            _button txt, :id => txt.to_sym, :set_size_request => [30, 30], :layout => [true, true]
           end
         end
       end

data/example/expose_components.rb

@@ -1,13 +1,13 @@
-require 'gtk2'
-require File.dirname(__FILE__) + '/../lib/simple_layout'
+require 'gtk3'
+require 'simple_layout'
 
 class MyWin < Gtk::Window
   include SimpleLayout::Base
 
   def my_layout
-    hbutton_box do
-      button 'A', :id => :btn_a
-      button 'B', :id => :btn_b
+    _button_box :horizontal do
+      _button 'A', :id => :btn_a
+      _button 'B', :id => :btn_b
     end
   end
 

data/example/group.rb

@@ -5,33 +5,33 @@ class MyWin < Gtk::Window
   include SimpleLayout::Base
 
   def my_layout
-    vbox do
-      hbox do
-        button 'Change group A', :id => :btn_change_a
-        button 'Change group B', :id => :btn_change_b
+    _box :vertical do
+      _box :horizontal do
+        _button 'Change group A', :id => :btn_change_a
+        _button 'Change group B', :id => :btn_change_b
       end
-      hbutton_box do
+      _button_box :horizontal do
         group :A do  # set group A
-          button 'A'
-          button 'A'
-          button 'A'
+          _button 'A'
+          _button 'A'
+          _button 'A'
         end
       end
-      hbutton_box do
+      button_box :horizontal do
         group :B do  # set group B
-          button 'B'
-          button 'B'
-          button 'B'
+          _button 'B'
+          _button 'B'
+          _button 'B'
         end
       end
-      hbutton_box do
+      _button_box :horizontal do
         group :A do  # you can set group A again !
-          button 'A'
-          button 'A'
+          _button 'A'
+          _button 'A'
         end
         group :B do  # you can set group B again !
-          button 'B'
-          button 'B'
+          _button 'B'
+          _button 'B'
         end
       end
     end

data/example/hello_world.rb

@@ -1,5 +1,5 @@
-require 'gtk2'
-require File.dirname(__FILE__) + '/../lib/simple_layout'
+require 'gtk3'
+require 'simple_layout'
 
 class MyWin < Gtk::Window
   include SimpleLayout::Base
@@ -12,12 +12,12 @@ class MyWin < Gtk::Window
   end
 
   def my_layout
-    hbox do
-      label 'Hello, '
-      button 'World !'
+    _box :horizontal do
+      _label 'Hello, '
+      _button 'World !'
     end
   end
 end
 
 MyWin.new.show_all
-Gtk.main
+Gtk.main

data/example/menu.rb

@@ -1,5 +1,5 @@
-require 'gtk2'
-require File.dirname(__FILE__) + '/../lib/simple_layout'
+require 'gtk3'
+require 'simple_layout'
 
 class MyWin < Gtk::Window
   include SimpleLayout::Base
@@ -12,40 +12,36 @@ class MyWin < Gtk::Window
   end
 
   def my_layout
-    vbox do
-      factory_menu_bar "main", :type => :menu do
-        factory_menu_item "<_File>" do
-          factory_menu_item "_Open"
-          factory_menu_item "_Close"
-          factory_menu_item "---"
-          factory_menu_item "_Quit", :id => :quit, :accel => "<control>Q"
-        end
-        factory_menu_item "<_Edit>" do
-          factory_menu_item "<--->"
-          factory_menu_item "Copy", :accel => "<control>C"
-          factory_menu_item "Cut", :accel => "<control>X"
-          factory_menu_item "Paste", :accel => "<control>V"
-          factory_menu_item "<Advanced>", :accel => "<control>S" do
-            factory_menu_item "<--->", :accel => "<control>A"
-            factory_menu_item "Zoom In", :image => Gtk::Stock::ZOOM_IN, :accel => "<control>plus"
-            factory_menu_item "Zoom Out", :image => Gtk::Stock::ZOOM_OUT, :accel => "<control>minus"
+    _box :vertical do
+
+      # menubar
+      _box :horizontal do
+        _menubar do
+          _menuitem 'File' do
+            _menu :id => :main, :accel_group => :main_accel_group do
+              _menuitem 'New', :id => :menu_new
+              _menuitem 'Open', :id => :menu_open
+              _menuitem 'Save', :id => :menu_save
+              _menuitem 'Save As', :id => :menu_save_as
+              _menuitem 'Quit', :id => :menu_quit, accel: "<cmd>Q"
+            end
           end
         end
-        factory_menu_item ">>Help>>" do
-          factory_menu_item "About"
-        end
       end
-      scrolled_window :layout => [true, true] do
-        text_view :set_size_request => [300, 200]
+
+      # edit area
+      _scrolled_window :set_size_request => [300, 200], layout: [expand: true, fill: true] do
+        _text_view :layout => [:automatic, :automatic]
       end
     end
+
+    add_accel_group(component(:main_accel_group)) # add the accel group to the window
+
+    register_auto_events()  # enable the auto event map
   end
 
-  def menu_main_on_active(id, path, w)
-    puts "menu: #{id}, path: #{path}"
-    if id == :quit
-      self.destroy
-    end
+  def menu_quit_on_activate(w)
+    self.destroy
   end
 
 end

data/example/serial_port_setup.rb

@@ -1,24 +1,24 @@
-require 'gtk2'
-require File.dirname(__FILE__) + '/../lib/simple_layout'
+require 'gtk3'
+require 'simple_layout'
 
 class MyWin < Gtk::Window
 	include SimpleLayout::Base
 
 	def my_layout
-		frame 'Serial Port Setup', :border_width => 5 do
-			vbox :border_width => 5 do
+		_frame 'Serial Port Setup', :border_width => 5 do
+			_box :vertical, :border_width => 5 do
         with_attr :border_width => 3, :layout => [true, true] do
-          hbox do
-            label 'Port name: '
-            combobox :id => :comb_port, :layout => [true, true]
+          _box :horizontal do
+            _label 'Port name: '
+            _combobox :id => :comb_port, :layout => [true, true]
           end
-          hbox do
-            label 'Baud rate: '
-            combobox :id => :comb_baudrate, :layout => [true, true]
+          _box :horizontal do
+            _label 'Baud rate: '
+            _combobox :id => :comb_baudrate, :layout => [true, true]
           end
-          hbutton_box do
-            button 'Open', :id => :btn_open, :sensitive => false
-            button 'Close', :id => :btn_close, :sensitive => false
+          _button_box :horizontal do
+            _button 'Open', :id => :btn_open, :sensitive => false
+            _button 'Close', :id => :btn_close, :sensitive => false
           end
         end
 			end
@@ -42,6 +42,10 @@ class MyWin < Gtk::Window
 			(1..10).each do |n|
 				comb_port.append_text "COM#{n}"
 			end
+		elsif RUBY_PLATFORM =~ /darwin/
+			Dir.glob("/dev/cu.*").each do |name|
+				comb_port.append_text name
+			end
 		else
 			Dir.glob("/dev/ttyS*").each do |name|
 				comb_port.append_text name

data/example/with_attr.rb

@@ -1,5 +1,5 @@
-require 'gtk2'
-require File.dirname(__FILE__) + '/../lib/simple_layout'
+require 'gtk3'
+require 'simple_layout'
 
 class MyWin < Gtk::Window
   include SimpleLayout::Base
@@ -12,27 +12,29 @@ class MyWin < Gtk::Window
   end
 
   def my_layout
-    vbox do
-      frame 'default' do
-        hbutton_box do
-          button 'A'
-          button 'B'
-          button 'C'
+    _box :vertical do
+      with_attr :border_width => 10 do
+        _frame 'default' do
+          _button_box :horizontal do
+            _button 'A'
+            _button 'B'
+            _button 'C'
+          end
         end
-      end
-      frame 'set :border_width => 10 for each button' do
-        hbutton_box do
-          button 'A', :border_width => 10
-          button 'B', :border_width => 10
-          button 'C', :border_width => 10
+        _frame 'set :border_width => 10 for each button' do
+          _button_box :horizontal do
+            _button 'A', :border_width => 10
+            _button 'B', :border_width => 10
+            _button 'C', :border_width => 10
+          end
         end
-      end
-      frame 'using with_attr :border_width => 10' do
-        hbutton_box do
-          with_attr :border_width => 10 do
-            button 'A'
-            button 'B'
-            button 'C'
+        _frame 'using with_attr :border_width => 10' do
+          _button_box :horizontal do
+            with_attr :border_width => 10 do
+              _button 'A'
+              _button 'B'
+              _button 'C'
+            end
           end
         end
       end

data/lib/simple_layout.rb

@@ -1,4 +1,4 @@
-require 'gtk2'
+require 'gtk3'
 
 module SimpleLayout
 
@@ -32,67 +32,70 @@ module SimpleLayout
 
     def layout_class_maps
       @layout_class_maps_hash ||= {
-        'image' => Gtk::Image,
-        'label' => Gtk::Label,
-        'progress_bar' => Gtk::ProgressBar,
-        'status_bar' => Gtk::Statusbar,
-        'button' => Gtk::Button,
-        'check_button' => Gtk::CheckButton,
-        'radio_button' => Gtk::RadioButton,
-        'toggle_button' => Gtk::ToggleButton,
-        'link_button' => Gtk::LinkButton,
-        'entry' => Gtk::Entry,
-        'hscale' => Gtk::HScale,
-        'vscale' => Gtk::VScale,
-        'spin_button' => Gtk::SpinButton,
-        'text_view' => Gtk::TextView,
-        'tree_view' => Gtk::TreeView,
-        'cell_view' => Gtk::CellView,
-        'icon_view' => Gtk::IconView,
-        'combobox' => Gtk::ComboBox,
-        'combobox_entry' => Gtk::ComboBoxEntry,
-        #'menu' => Gtk::Menu,
-        #'menubar' => Gtk::MenuBar,
-        'toolbar' => Gtk::Toolbar,
-        'toolitem' => Gtk::ToolItem,
-        'separator_toolitem' => Gtk::SeparatorToolItem,
-        'tool_button' => Gtk::ToolButton,
-        'toggle_tool_button' => Gtk::ToggleToolButton,
-        'radio_tool_button' => Gtk::RadioToolButton,
-        'color_button' => Gtk::ColorButton,
-        'color_selection' => Gtk::ColorSelection,
-        'file_chooser_button' => Gtk::FileChooserButton,
-        'file_chooser_widget' => Gtk::FileChooserWidget,
-        'font_button' => Gtk::FontButton,
-        'font_selection' => Gtk::FontSelection,
-        'alignment' => Gtk::Alignment,
-        'aspect_frame' => Gtk::AspectFrame,
-        'hbox' => Gtk::HBox,
-        'vbox' => Gtk::VBox,
-        'hbutton_box' => Gtk::HButtonBox,
-        'vbutton_box' => Gtk::VButtonBox,
-        'hpaned' => Gtk::HPaned,
-        'vpaned' => Gtk::VPaned,
-        'layout' => Gtk::Layout,
-        'notebook' => Gtk::Notebook,
-        'table' => Gtk::Table,
-        'expander' => Gtk::Expander,
-        'frame' => Gtk::Frame,
-        'hseparator' => Gtk::HSeparator,
-        'vseparator' => Gtk::VSeparator,
-        'hscrollbar' => Gtk::HScrollbar,
-        'vscrollbar' => Gtk::VScrollbar,
-        'scrolled_window' => Gtk::ScrolledWindow,
-        'arrow' => Gtk::Arrow,
-        'calendar' => Gtk::Calendar,
-        'drawing_area' => Gtk::DrawingArea,
-        'event_box' => Gtk::EventBox,
-        'handle_box' => Gtk::HandleBox,
-        'viewport' => Gtk::Viewport,
-        'curve' => Gtk::Curve,
-        'gamma_curve' => Gtk::GammaCurve,
-        'hruler' => Gtk::HRuler,
-        'vruler' => Gtk::VRuler,
+        '_image' => Gtk::Image,
+        '_label' => Gtk::Label,
+        '_progress_bar' => Gtk::ProgressBar,
+        '_status_bar' => Gtk::Statusbar,
+        '_button' => Gtk::Button,
+        '_check_button' => Gtk::CheckButton,
+        '_radio_button' => Gtk::RadioButton,
+        '_toggle_button' => Gtk::ToggleButton,
+        '_link_button' => Gtk::LinkButton,
+        '_entry' => Gtk::Entry,
+        '_hscale' => Gtk::HScale,
+        '_vscale' => Gtk::VScale,
+        '_spin_button' => Gtk::SpinButton,
+        '_text_view' => Gtk::TextView,
+        '_tree_view' => Gtk::TreeView,
+        '_cell_view' => Gtk::CellView,
+        '_icon_view' => Gtk::IconView,
+        '_combobox' => Gtk::ComboBoxText,
+        #'combobox_entry' => Gtk::ComboBoxEntry,
+        '_menu' => Gtk::Menu,
+        '_menubar' => Gtk::MenuBar,
+        '_menuitem' => Gtk::MenuItem,
+        '_menuitem_radio' => Gtk::RadioMenuItem,
+        '_menuitem_check' => Gtk::CheckMenuItem,
+        '_menuitem_separator' => Gtk::SeparatorMenuItem,
+        '_menuitem_teoroff' => Gtk::TearoffMenuItem,
+        '_toolbar' => Gtk::Toolbar,
+        '_toolitem' => Gtk::ToolItem,
+        '_separator_toolitem' => Gtk::SeparatorToolItem,
+        '_tool_button' => Gtk::ToolButton,
+        '_toggle_tool_button' => Gtk::ToggleToolButton,
+        '_radio_tool_button' => Gtk::RadioToolButton,
+        '_color_button' => Gtk::ColorButton,
+        '_color_chooser' => Gtk::ColorChooserWidget,
+        '_file_chooser_button' => Gtk::FileChooserButton,
+        '_file_chooser_widget' => Gtk::FileChooserWidget,
+        '_font_button' => Gtk::FontButton,
+        '_font_selection' => Gtk::FontSelection,
+        '_alignment' => Gtk::Alignment,
+        '_aspect_frame' => Gtk::AspectFrame,
+        '_box' => Gtk::Box,
+        '_button_box' => Gtk::ButtonBox,
+        '_hpaned' => Gtk::HPaned,
+        '_vpaned' => Gtk::VPaned,
+        '_layout' => Gtk::Layout,
+        '_notebook' => Gtk::Notebook,
+        '_table' => Gtk::Table,
+        '_expander' => Gtk::Expander,
+        '_frame' => Gtk::Frame,
+        '_hseparator' => Gtk::HSeparator,
+        '_vseparator' => Gtk::VSeparator,
+        '_hscrollbar' => Gtk::HScrollbar,
+        '_vscrollbar' => Gtk::VScrollbar,
+        '_scrolled_window' => Gtk::ScrolledWindow,
+        '_arrow' => Gtk::Arrow,
+        '_calendar' => Gtk::Calendar,
+        '_drawing_area' => Gtk::DrawingArea,
+        '_event_box' => Gtk::EventBox,
+        '_handle_box' => Gtk::HandleBox,
+        '_viewport' => Gtk::Viewport,
+        #'curve' => Gtk::Curve,
+        #'gamma_curve' => Gtk::GammaCurve,
+        #'hruler' => Gtk::HRuler,
+        #'vruler' => Gtk::VRuler,
       }
     end
 
@@ -134,33 +137,54 @@ module SimpleLayout
 
     # add a widget to container (and/or become a new container as well).
     # do not call this function directly unless knowing what you are doing
-    def add_component(w, container, layout_opt = nil)
+    def add_component(w, container, layout_opt)
       if @pass_on_stack.last.nil? || @pass_on_stack.last[0] == false
         if container.is_a?(Gtk::Box)
-          layout_opt ||= [false, false, 0]
+          layout_opt ||= [expand: false, fill: false, padding: 0]
           pack_method = 'pack_start'
-          if layout_opt.first.is_a?(Symbol)
-            pack_method = 'pack_end' if layout_opt.shift == :end
+          railse LayoutError, "layout_opt should be an Array" unless layout_opt.is_a?(Array)
+          if layout_opt.first.is_a?(Symbol) && layout_opt[0] == :end
+            layout_opt.shift  # remove the first ':end'
+            pack_method = 'pack_end'
+          end
+          if layout_opt.size == 1 && layout_opt.last.is_a?(Hash)
+            # if there is only one Hash in layout_opt, it's the keyword arguments for pack_start or pack_end
+            container.send(pack_method, w, **layout_opt.last)
+          else
+            # else it's the position arguments, old style, we need to conver to keyword arguments
+            opt = {expand: layout_opt[0], fill: layout_opt[1], padding: layout_opt[2]}
+            container.send(pack_method, w, **opt)
           end
-          container.send(pack_method, w, *layout_opt)
         elsif container.is_a?(Gtk::Fixed) || container.is_a?(Gtk::Layout)
           layout_opt ||= [0, 0]
           container.put w, *layout_opt
-        elsif container.is_a?(Gtk::MenuShell)
+        elsif container.is_a?(Gtk::MenuShell) || container.is_a?(Gtk::MenuBar) || container.is_a?(Gtk::Menu)
           container.append w
+        elsif container.is_a?(Gtk::MenuItem)
+          container.submenu = w
         elsif container.is_a?(Gtk::Toolbar)
           container.insert(container.n_items, w)
         elsif container.is_a?(Gtk::MenuToolButton)
           container.menu = w
+        elsif container.is_a?(Gtk::ScrolledWindow)
+          container.add_with_viewport(w)
+          if layout_opt && layout_opt.size > 0
+            if layout_opt.size == 1 && layout_opt.first.is_a?(Hash)
+              container.set_policy(**layout_opt.first)
+            else
+              container.set_policy(*layout_opt)
+            end
+          end
         elsif container.is_a?(Gtk::Table)
           # should use #grid or #grid_flx to add a child to Table
         elsif container.is_a?(Gtk::Notebook)
           # should use #page to add a child to Notebook
         elsif container.is_a?(Gtk::Paned)
           # should use #area_first or #area_second to add child to Paned
-        elsif container.is_a?(Gtk::Container)
-          layout_opt ||= []
-          container.add(w, *layout_opt)
+        elsif container.is_a?(Gtk::Container) || container.respond_to?(:add)
+          # lastly, if it's a general container or respond to 'add', use #add to add child
+          args = [w, *layout_opt].flatten
+          container.add(*args)
         end
       else
         fun_name, args = *(@pass_on_stack.last[1])
@@ -201,6 +225,7 @@ module SimpleLayout
             :insp => misc[:insp],
             :layout => misc[:layout],
             :options => misc[:options],
+            :accel_group => misc[:accel_group],
             :name => nil,
           }
       @containers.push [cnt, m]
@@ -252,7 +277,7 @@ module SimpleLayout
       items.each do |x|
         # TODO: ...
       end
-      layout_component(fact.get_widget("<#{name}>"), options)
+      layout_component(fact.get_widget("<#{name}>"), [], options)
     end
 
     def factory_menu_item(name, options = {}, &block)
@@ -301,7 +326,11 @@ module SimpleLayout
     end
 
     # layout the new UI component (container or widget)
-    def layout_component(w, options = {}, &block)
+    # w: the widget
+    # args: the arguments for creating the widget (just for inspection purpose)
+    # options: the options for layout the widget
+    # block: the block for creating the children
+    def layout_component(w, args, options = {}, &block)
       @containers ||= []
       @pass_on_stack ||= []
       @components ||= {}
@@ -310,53 +339,72 @@ module SimpleLayout
 
       add_singleton_event_map(w) # so that you can use: w.on_clicked{|*args| ... }
 
+      # there are some special options: :id, :gid, :layout, :keep_top_container
+      # :id is the name of the component, :gid is the group name of the component, if :gid is not given, use :id as group name
+      # :layout is the layout options for the component, :keep_top_container is to keep the top container
       name = options.delete(:id)
       group_name = options.delete(:gid) || name
       layout_opt = options.delete(:layout)
       keep_top_cnt = options.delete(:keep_top_container)
+      accel_group = options.delete(:accel_group)
+      accel = options.delete(:accel)
 
+      # the rest of the key-value pairs are turn into the function calls if the widget response to the key
       options.each do |k, v|
-        if v.is_a?(Array)
+        if v.is_a?(Array)   # e.g. :set_size_request => [100, 100] turn into w.set_size_request(100, 100)
           w.send(k.to_s, *v) if w.respond_to?(k.to_s)
-        else
+        else                # e.g. :size => 10 turn into w.size = 10
           w.send(k.to_s + '=', v) if w.respond_to?(k.to_s + '=')
         end
       end
 
-      @components[name] = w if name
+      @components[name] = w if name   # add the widget to the components hash, if 'name' is given
+
+      # if :gid is given, create the group if the group is not exist
       gs = (group_name ? [group_name].flatten : [])
       gs.each{|g| @component_children[g] ||= [] }
 
-      misc = nil
+      parent, param = nil, nil
       if @containers.size > 0
-        container, misc = @containers.last
-        misc[:groups].each{ |g| @component_children[g].push w }
-        misc[:sibling] += 1
+        parent, param = @containers.last
+        param[:groups].each{ |g| @component_children[g].push w }   # add the widget to the parent's children group
+        param[:sibling] += 1    # record the sibling count
+
+        # if the widget is a menuitem, add the accelerator to the menuitem
+        menuitem_add_accel_group(w, accel, param[:accel_group]) if accel && param[:accel_group]
+
       end
 
-      unless container and container.is_a? Gtk::ScrolledWindow
-        insp_evb = make_inspect_evb(misc, w, name, layout_opt, options)
+      # if parent is a ScrolledWindow, create the inspector eventbox around the widget
+      insp_evb = nil
+      unless parent and parent.is_a?(Gtk::ScrolledWindow)
+        insp_evb = make_inspect_evb(param, w, name, args, layout_opt, options)
       end
 
-      if block # if given block, it's a container as well
+      if block # if given block, it's a container
+
+        # if the widget options has :accel_group (a menu widget), create a new accelerator group to the container(menu)
+        @components[accel_group] = Gtk::AccelGroup.new if accel_group
         m = { :groups => gs,
               :sibling => 0,
               :insp => insp_evb,
               :name => name,
               :layout => layout_opt,
               :options => options,
+              :args => args,
+              :accel_group => accel_group,
             }
-        @containers.push [w, m]
+        @containers.push [w, m] # push the new container to the stack
         @pass_on_stack.push [false, nil]
         @common_attribute.push({})
-        block.call(w) if block
+        block.call(w) # create the children
         @common_attribute.pop
         @pass_on_stack.pop
         @containers.pop
       end
 
       if @containers.size > 0
-        add_component(insp_evb || w, container, layout_opt) # add myself to parent
+        add_component(insp_evb || w, parent, layout_opt) # add myself to parent
       else
         add_component(insp_evb || w, self, layout_opt) unless keep_top_cnt # add top container to host
         @components[:self] = self  # add host as ':self'
@@ -380,18 +428,79 @@ module SimpleLayout
       end
     end
 
+    # add accelerator to the munuitem
+    # w: the menuitem widget
+    # accel: the accelerator string
+    # accel_group: the accelerator group id
+    def menuitem_add_accel_group(w, accel, accel_group)
+      # if accel is given, the widget is a menuitem, parse the accel string and add the accelerator to the widget
+      if w && @components[accel_group] && accel && w.is_a?(Gtk::MenuItem) #w.respond_to?(:add_accelerator)
+        if accel.to_s =~ /^<(.+)>(.*)$/
+          ctl, key = $1, $2
+          mask, kc = nil, nil
+          case ctl.downcase
+          when 'ctrl', 'control'
+            mask = Gdk::ModifierType::CONTROL_MASK
+          when 'alt'
+            mask = Gdk::ModifierType::MOD1_MASK
+          when 'meta', 'cmd', 'command'
+            if RUBY_PLATFORM =~ /darwin/
+              mask = Gdk::ModifierType::META_MASK
+            else
+              mask = Gdk::ModifierType::MOD1_MASK # for non-Mac, use Alt
+            end
+          when 'shift'
+            mask = Gdk::ModifierType::SHIFT_MASK
+          else
+            mask = nil
+          end
+
+          case key.downcase
+          when 'f1'..'f12'
+            kc = Gdk::Keyval.const_get("GDK_KEY_#{key}")
+          when 'a'..'z'
+            kc = Gdk::Keyval.const_get("KEY_#{key.upcase}")
+          when 'plus'
+            kc = Gdk::Keyval::GDK_PLUS
+          when 'minus'
+            kc = Gdk::Keyval::GDK_MINUS
+          else
+            kc = nil
+          end
+    
+          if mask && kc
+            w.add_accelerator('activate', @components[accel_group], kc, mask, Gtk::AccelFlags::VISIBLE)
+          end
+        end
+      end
+
+    end
+
+    # create the inspector eventbox color
+    # level: the level of the container stack
+    # mode: :enter or :leave
+    def inspect_box_color(level:, mode:)
+      @evb_colors ||= {}  # color cache
+      rgb = 1 - (level+2) / 12.0
+      case mode
+      when :enter
+        @evb_colors["#{level}_#{mode}"] ||= Gdk::RGBA.new(rgb, rgb + 0.2, rgb + 0.2, 1)
+      when :leave
+        @evb_colors["#{level}_#{mode}"] ||= Gdk::RGBA.new(rgb, rgb, rgb, 0.6)
+      end
+    end
+
     # create the inspector eventbox for widget
-    def make_inspect_evb(cnt_misc, w, name, layout_opt, options)
+    def make_inspect_evb(cnt_misc, w, name, args, layout_opt, options)
       insp_evb = nil
       insp_opt = self.class.inspector_opt
       if insp_opt[:enable]
-        rgb = 0xffff - @containers.size * 0x1000
         insp_evb = evb = Gtk::EventBox.new
         sub_evb = Gtk::EventBox.new
         sub_evb.add w
         evb.add sub_evb
-        sub_evb.border_width = insp_opt[:border_width]
-        evb.modify_bg Gtk::STATE_NORMAL, Gdk::Color.new(rgb, rgb, rgb)
+        sub_evb.border_width = insp_opt[:border_width].to_i
+        evb.override_background_color :normal, inspect_box_color(level: @containers.size, mode: :leave)
         evbs = []
         tips = ""
         @containers.size.times do |i|
@@ -399,6 +508,7 @@ module SimpleLayout
           if m[:insp] && (not m[:virtual])
             evbs << m[:insp]
             tips << "<b>container[#{i}]: #{cnt.class}#{m[:name] ? " (#{m[:name]})" : ''}</b>\n"
+            tips << "  args: #{m[:args].inspect}\n" if m[:args] && m[:args].size > 0
             tips << "  layout: #{m[:layout].inspect}\n" if m[:layout]
             tips << "  options: #{m[:options].inspect}\n" if m[:options] && m[:options].size > 0
             tips << "  groups: #{m[:groups].inspect}\n" if m[:groups].size > 0
@@ -406,24 +516,25 @@ module SimpleLayout
         end
         evbs << evb
         tips << "<b>widget: #{w.class}#{name ? " (#{name})" : ''}</b>\n"
+        tips << "  args: #{args.inspect}\n" if args && args.size > 0
         tips << "  layout: #{layout_opt.inspect}\n" if layout_opt
         tips << "  options: #{options.inspect}\n" if options && options.size > 0
         tips << "  groups: #{cnt_misc[:groups].inspect}\n" if cnt_misc && cnt_misc[:groups].size > 0
 
-        evb.signal_connect('event') do |b, evt|
+        evb.signal_connect('enter-notify-event') do |b, _|
           b.tooltip_markup = tips
-          case evt.event_type
-          when Gdk::Event::ENTER_NOTIFY, Gdk::Event::LEAVE_NOTIFY            
-            evbs.size.times do |i|
-              rgb = 0xffff - i * 0x1000
-              if evt.event_type == Gdk::Event::ENTER_NOTIFY
-                evbs[i].modify_bg Gtk::STATE_NORMAL, Gdk::Color.new(rgb, rgb - 0x2000, rgb - 0x2000)
-              elsif evt.event_type == Gdk::Event::LEAVE_NOTIFY
-                evbs[i].modify_bg Gtk::STATE_NORMAL, Gdk::Color.new(rgb, rgb, rgb)
-              end
-            end
+          evbs.size.times do |i|
+            evbs[i].override_background_color :normal, inspect_box_color(level: i, mode: :enter)
           end
         end
+
+        evb.signal_connect('leave-notify-event') do |b, _|
+          b.tooltip_markup = nil
+          evbs.size.times do |i|
+            evbs[i].override_background_color :normal, inspect_box_color(level: i, mode: :leave)
+          end
+        end
+
       end
       insp_evb
     end
@@ -435,8 +546,19 @@ module SimpleLayout
       options = args.pop if args.last.is_a?(Hash)
       options.merge! @common_attribute.last if @common_attribute.last
 
-      w = component_class.new(*args)
-      layout_component(w, options, &block)
+      if args.size == 1 && args.first.is_a?(Array) && args.first.size == 1 && args.first.first.is_a?(Hash)
+        w = component_class.new(**args.first.first)
+      else
+        case component_class.to_s
+        when /(Button)$/
+          w = component_class.new(label: args[0])
+        when /(MenuItem)$/
+          w = component_class.new(label: args[0])
+        else
+          w = component_class.new(*args)
+        end
+      end
+      layout_component(w, args, options, &block)
     end
 
     def container_pass_on(container_class, fun_name, *args)
@@ -451,38 +573,34 @@ module SimpleLayout
       end
     end
 
-    alias_method :simple_layout_method_missing_alias, :method_missing
-
-    def method_missing(sym, *args, &block)
-      if sym.to_s =~ /^(.+)_in_(.+)$/
-        maps = self.class.layout_class_maps
-        inner, outter = $1, $2
-        if maps[inner] && maps[outter]
-          if args.last.is_a?(Hash)
-            options = {}
-            options = args.pop if args.last.is_a?(Hash)
-
-            # default args pass to inner component, execpt:
-            #  :layout pass to outter :layout
-            #  :inner_layout pass to inner :layout
-            #  :outter_args pass to outter args
-            outter_args, outter_layout_opt, options[:layout] =
-              options.delete(:outter_args), options.delete(:layout), options.delete(:inner_layout)
-
-            outter_args = (outter_args ? [outter_args] : []) unless outter_args.is_a?(Array)
-            outter_args << {} unless outter_args.last.is_a?(Hash)
-            outter_args.last[:layout] ||= outter_layout_opt
-            args.push options # push back inner options
-          end
-
-          inner_proc = Proc.new do
-            create_component(maps[inner], args, block)
-          end
-          return create_component(maps[outter], outter_args || [], inner_proc)
-        end
-      end
-      simple_layout_method_missing_alias(sym, *args, &block)
-    end
+    # alias_method :simple_layout_method_missing_alias, :method_missing
+    # def method_missing(sym, *args, &block)
+    #   if sym.to_s =~ /^(.+)_in_(.+)$/
+    #     maps = self.class.layout_class_maps
+    #     inner, outter = $1, $2
+    #     if maps[inner] && maps[outter]
+    #       if args.last.is_a?(Hash)
+    #         options = {}
+    #         options = args.pop if args.last.is_a?(Hash)
+    #         # default args pass to inner component, execpt:
+    #         #  :layout pass to outter :layout
+    #         #  :inner_layout pass to inner :layout
+    #         #  :outter_args pass to outter args
+    #         outter_args, outter_layout_opt, options[:layout] =
+    #           options.delete(:outter_args), options.delete(:layout), options.delete(:inner_layout)
+    #         outter_args = (outter_args ? [outter_args] : []) unless outter_args.is_a?(Array)
+    #         outter_args << {} unless outter_args.last.is_a?(Hash)
+    #         outter_args.last[:layout] ||= outter_layout_opt
+    #         args.push options # push back inner options
+    #       end
+    #       inner_proc = Proc.new do
+    #         create_component(maps[inner], args, block)
+    #       end
+    #       return create_component(maps[outter], outter_args || [], inner_proc)
+    #     end
+    #   end
+    #   simple_layout_method_missing_alias(sym, *args, &block)
+    # end
 
   end
 end

metadata

@@ -1,78 +1,59 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: GtkSimpleLayout
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 1
-  version: 0.2.1
+version: !ruby/object:Gem::Version
+  version: 0.3.0
 platform: ruby
-authors: 
+authors:
 - Ricky Zheng
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-
-date: 2010-12-19 00:00:00 +13:00
-default_executable: 
+date: 2024-09-08 00:00:00.000000000 Z
 dependencies: []
-
-description: A simple builder style layout helper for RubyGnome2
+description: A simple builder style layout helper for Ruby GTK3, it helps you to build
+  ruby GTK3 UI codes in a much more readable way. It also includes a UI inspector
+  to debug the UI.
 email: ricky_gz_zheng@yahoo.co.nz
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README
 - LICENSE
-files: 
+files:
 - LICENSE
 - README
 - Rakefile
 - example/auto_event_map.rb
+- example/basic.rb
+- example/calculator.rb
+- example/expose_components.rb
 - example/group.rb
-- example/composit_layout.rb
 - example/hello_world.rb
 - example/menu.rb
 - example/serial_port_setup.rb
-- example/expose_components.rb
 - example/with_attr.rb
-- example/basic.rb
-- example/calculator.rb
 - lib/simple_layout.rb
-has_rdoc: true
-homepage: 
-licenses: []
-
-post_install_message: 
+homepage: https://github.com/rickyzheng/GtkSimpleLayout
+licenses:
+- GPL-2.0-or-later
+metadata: {}
+post_install_message:
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.7
-signing_key: 
-specification_version: 3
-summary: A simple builder style layout helper for RubyGnome2
+rubygems_version: 3.5.17
+signing_key:
+specification_version: 4
+summary: A simple builder style layout helper for Ruby GTK3
 test_files: []
-

data/example/composit_layout.rb

@@ -1,26 +0,0 @@
-require 'gtk2'
-require File.dirname(__FILE__) + '/../lib/simple_layout'
-
-class MyWin < Gtk::Window
-  include SimpleLayout::Base
-  def initialize
-    super
-    my_layout
-    signal_connect('destroy') do
-      Gtk.main_quit
-    end
-  end
-
-  def my_layout
-    vbox do
-      with_attr :border_width => 10 do
-        label_in_hbox "I'm a label, in a hbox"
-        button_in_frame "I'm a button, in a frame", :border_width => 10
-        label_in_hbox "I'm a label, in a hbox, with inner_layout[:end, false, false]", :inner_layout => [:end, false, false]
-      end
-    end
-  end
-end
-
-MyWin.new.show_all
-Gtk.main