glimmer-dsl-tk 0.0.27 → 0.0.31

data/lib/glimmer/tk/widget_proxy.rb

@@ -19,6 +19,8 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+require 'glimmer/data_binding/tk/one_time_observer'
+
 module Glimmer
   module Tk
     # Proxy for Tk Widget objects
@@ -63,6 +65,8 @@ module Glimmer
         end
       end
       
+      FONTS_PREDEFINED = %w[default text fixed menu heading caption small_caption icon tooltip]
+      
       attr_reader :parent_proxy, :tk, :args, :keyword, :children
 
       # Initializes a new Tk Widget
@@ -81,6 +85,27 @@ module Glimmer
         post_add_content if @block.nil?
       end
       
+      def root_parent_proxy
+        current = self
+        current = current.parent_proxy while current.parent_proxy
+        current
+      end
+      
+      def toplevel_parent_proxy
+        ancestor_proxies.find {|widget_proxy| widget_proxy.is_a?(ToplevelProxy)}
+      end
+      
+      # returns list of ancestors ordered from direct parent to root parent
+      def ancestor_proxies
+        ancestors = []
+        current = self
+        while current.parent_proxy
+          ancestors << current.parent_proxy
+          current = current.parent_proxy
+        end
+        ancestors
+      end
+      
       def children
         @children ||= []
       end
@@ -225,7 +250,9 @@ module Glimmer
       
       def grid(options = {})
         options = options.stringify_keys
-        index_in_parent = @parent_proxy.children.index(self)
+        index_in_parent = @parent_proxy&.children&.index(self)
+        options['rowspan'] = options.delete('row_span') if options.keys.include?('row_span')
+        options['columnspan'] = options.delete('column_span') if options.keys.include?('column_span')
         options['rowweight'] = options.delete('row_weight') if options.keys.include?('row_weight')
         options['columnweight'] = options.delete('column_weight') if options.keys.include?('column_weight')
         options['columnweight'] = options['rowweight'] = options.delete('weight')  if options.keys.include?('weight')
@@ -236,21 +263,32 @@ module Glimmer
         options['columnminsize'] = options.delete('minwidth') if options.keys.include?('minwidth')
         options['columnminsize'] = options.delete('min_width') if options.keys.include?('min_width')
         options['columnminsize'] = options['rowminsize'] = options.delete('minsize')  if options.keys.include?('minsize')
-        TkGrid.rowconfigure(@parent_proxy.tk, index_in_parent, 'weight'=> options.delete('rowweight')) if options.keys.include?('rowweight')
-        TkGrid.rowconfigure(@parent_proxy.tk, index_in_parent, 'minsize'=> options.delete('rowminsize')) if options.keys.include?('rowminsize')
-        TkGrid.columnconfigure(@parent_proxy.tk, index_in_parent, 'weight'=> options.delete('columnweight')) if options.keys.include?('columnweight')
-        TkGrid.columnconfigure(@parent_proxy.tk, index_in_parent, 'minsize'=> options.delete('columnminsize')) if options.keys.include?('columnminsize')
+        if index_in_parent
+          TkGrid.rowconfigure(@parent_proxy.tk, index_in_parent, 'weight'=> options.delete('rowweight')) if options.keys.include?('rowweight')
+          TkGrid.rowconfigure(@parent_proxy.tk, index_in_parent, 'minsize'=> options.delete('rowminsize')) if options.keys.include?('rowminsize')
+          TkGrid.columnconfigure(@parent_proxy.tk, index_in_parent, 'weight'=> options.delete('columnweight')) if options.keys.include?('columnweight')
+          TkGrid.columnconfigure(@parent_proxy.tk, index_in_parent, 'minsize'=> options.delete('columnminsize')) if options.keys.include?('columnminsize')
+        end
         @tk.grid(options)
       end
       
       def font=(value)
-        @tk.font = value.is_a?(TkFont) ? value : TkFont.new(value)
+        if (value.is_a?(Symbol) || value.is_a?(String)) && FONTS_PREDEFINED.include?(value.to_s.downcase)
+          @tk.font = "tk_#{value}_font".camelcase(:upper)
+        else
+          @tk.font = value.is_a?(TkFont) ? value : TkFont.new(value)
+        end
       rescue => e
         Glimmer::Config.logger.debug {"Failed to set attribute #{attribute} with args #{args.inspect}. Attempting to set through style instead..."}
         Glimmer::Config.logger.debug {e.full_message}
         apply_style({"font" => value})
       end
       
+      def destroy
+        @tk.destroy
+        @on_destroy_procs&.each {|p| p.call(@tk)}
+      end
+      
       def apply_style(options)
         @@style_number = 0 unless defined?(@@style_number)
         style = "style#{@@style_number += 1}.#{@tk.class.name.split('::').last}"
@@ -373,9 +411,9 @@ module Glimmer
             end,
           },
           ::Tk::Text => {
-            'text' => lambda do |observer|
+            'value' => lambda do |observer|
               handle_listener('modified') do
-                observer.call(text)
+                observer.call(value)
               end
             end,
           },
@@ -413,16 +451,31 @@ module Glimmer
       
       def handle_listener(listener_name, &listener)
         listener_name = listener_name.to_s
-        begin
-          @tk.bind(listener_name, &listener)
-        rescue => e
-          Glimmer::Config.logger.debug {e.full_message}
-          listener_name = "<#{listener_name}" if !listener_name.start_with?('<')
-          listener_name = "#{listener_name}>" if !listener_name.end_with?('>')
-          @tk.bind(listener_name, &listener)
+        if listener_name == 'destroy'
+          # 'destroy' is a more reliable alternative listener binding to '<Destroy>'
+          @on_destroy_procs ||= []
+          listener.singleton_class.include(Glimmer::DataBinding::Tk::OneTimeObserver) unless listener.is_a?(Glimmer::DataBinding::Tk::OneTimeObserver)
+          @on_destroy_procs << listener
+          @tk.bind('<Destroy>', listener)
+          parent_proxy.handle_listener(listener_name, &listener) if parent_proxy
+          # TODO return a listener registration object that has a deregister method
+        else
+          begin
+            @tk.bind(listener_name, &listener)
+          rescue => e
+            Glimmer::Config.logger.debug {"Unable to bind to #{listener_name} .. attempting to surround with <>"}
+            Glimmer::Config.logger.debug {e.full_message}
+            listener_name = "<#{listener_name}" if !listener_name.start_with?('<')
+            listener_name = "#{listener_name}>" if !listener_name.end_with?('>')
+            @tk.bind(listener_name, &listener)
+          end
         end
       end
       
+      def on(listener_name, &listener)
+        handle_listener(listener_name, &listener)
+      end
+      
       def content(&block)
         Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Tk::WidgetExpression.new, keyword, *args, &block)
       end

data/samples/elaborate/meta_sample.rb

@@ -74,8 +74,8 @@ class MetaSample
   def launch
     @root = root {
       title 'Glimmer Meta-Sample'
-      width 700
-      height 500
+      width 1280
+      height 720
       
       frame {
         grid row: 0, column: 0, column_weight: 0, row_weight: 1
@@ -87,7 +87,7 @@ class MetaSample
             
             on('command') do
               @selected_sample_index = index
-              @code_text.text = File.read(file_path_for(selected_sample))
+              @code_text.value = File.read(file_path_for(selected_sample))
             end
           }
         end
@@ -102,7 +102,7 @@ class MetaSample
                 parent_dir = File.join(Dir.home, '.glimmer-dsl-tk', 'samples', 'hello')
                 FileUtils.mkdir_p(parent_dir)
                 sample_file = File.join(parent_dir, "#{selected_sample.underscore}.rb")
-                File.write(sample_file, @code_text.text)
+                File.write(sample_file, @code_text.value)
                 FileUtils.cp_r(File.expand_path('../../icons', __dir__), File.dirname(File.dirname(parent_dir)))
                 FileUtils.cp_r(File.expand_path('../hello/images', __dir__), parent_dir)
                 sample_namespace_directory = File.expand_path("../hello/#{selected_sample.underscore}", __dir__)
@@ -120,7 +120,7 @@ class MetaSample
             text 'Reset'
             
             on('command') do
-              @code_text.text = File.read(file_path_for(selected_sample))
+              @code_text.value = File.read(file_path_for(selected_sample))
             end
           }
         }
@@ -128,7 +128,7 @@ class MetaSample
       
       @code_text = text {
         grid row: 0, column: 1, column_weight: 1
-        text File.read(file_path_for(selected_sample))
+        value File.read(file_path_for(selected_sample))
       }
     }
     @root.open

data/samples/hello/hello_built_in_dialog.rb

@@ -0,0 +1,68 @@
+# Copyright (c) 2020-2021 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'glimmer-dsl-tk'
+
+include Glimmer
+
+root { |w|
+  title 'Hello, Built-in Dialog!'
+  width 400
+  height 400
+  x 150
+  y 150
+  
+  frame {
+    %w[get_open_file get_multiple_open_file get_save_file choose_directory choose_color].each do |dialog|
+      button {
+        text dialog.split('_').map(&:capitalize).join(' ')
+        
+        on('command') do
+          result = send(dialog, parent: w)
+          @result_label.text = [result].flatten.join("\n")
+        end
+      }
+    end
+    
+    button {
+      text 'Choose Font'
+      
+      on('command') do
+        choose_font(family: 'Courier New', size: '30', weight: 'bold') do |chosen_font|
+          @result_label.text = chosen_font
+        end
+      end
+    }
+  }
+  
+  frame {
+    grid sticky: 'nsew', padx: 15, pady: 15
+    
+    label {
+      grid row: 0, column: 0
+      text 'Result:'
+    }
+    
+    @result_label = label {
+      grid row: 0, column: 1
+    }
+  }
+}.open

data/samples/hello/hello_drag_and_drop.rb

@@ -0,0 +1,159 @@
+# Copyright (c) 2020-2021 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require "glimmer-dsl-tk"
+require "glimmer/tk/drag_and_drop_extension"
+
+include Glimmer
+
+root {
+  title "Hello, Drag and Drop!"
+  frame {
+    padding 5
+    labelframe {
+      text "Drag sources"
+      padding 5
+      label {
+        text "Entry"
+        grid :row => 0, :column => 0
+      }
+      entry {
+        text "Drag entry text"
+        width 30
+        grid :row => 0, :column => 1, :pady => 5, :sticky => "e"
+        on_drag_start { |event|
+          event.data = event.source.textvariable&.value
+          event.source.configure(:cursor => "hand2")
+          TkLabel.new(event.tooltip) {
+            text event.data + " "
+            bg "yellow"
+            bitmap "warning"
+            compound "right"
+          }.pack
+        }
+        on_drag_motion { |event|
+          if event.drop_accepted
+            event.source.configure(:cursor => "hand1")
+          else
+            event.source.configure(:cursor => "hand2")
+          end
+          event.tooltip.geometry("+#{event.x_root + 10}+#{event.y_root - 4}")
+        }
+      }
+      label {
+        text "Label"
+        grid :row => 1, :column => 0
+      }
+      label {
+        text "Drag label text"
+        width 30
+        grid :row => 1, :column => 1, :pady => 10, :sticky => "e"
+        drag_source true
+      }
+      label {
+        text "Combobox"
+        grid :row => 2, :column => 0
+      }
+      combobox {
+        text "Spain"
+        values %w[USA Canada Mexico Columbia UK Australia Germany Italy Spain]
+        width 27
+        grid :row => 2, :column => 1, :pady => 5, :sticky => "e"
+        on_drag_start { |event|
+          event.data = event.source.textvariable&.value
+        }
+      }
+      label {
+        text "Button"
+        grid :row => 3, :column => 0
+      }
+      button {
+        text "Drag it"
+        grid :row => 3, :column => 1, :pady => 5, :sticky => "w"
+        drag_source true
+      }
+    }
+
+    labelframe {
+      text "Drop targets"
+      grid :sticky => "nsew", :pady => 15
+      padding 5
+      label {
+        text "Entry"
+        grid :row => 0, :column => 0
+      }
+      entry {
+        width 30
+        grid :row => 0, :column => 1, :pady => 5, :sticky => "e"
+        on_drop { |event|
+          event.target.textvariable.value = event.data
+        }
+      }
+      label {
+        text "Label"
+        grid :row => 1, :column => 0
+      }
+      label {
+        width 30
+        grid :row => 1, :column => 1, :pady => 10, :sticky => "e"
+        borderwidth 2
+        relief "solid"
+        on_drop { |event|
+          event.target.textvariable.value = event.data
+        }
+      }
+      label {
+        text "Combobox"
+        grid :row => 2, :column => 0
+      }
+      combobox {
+        width 27
+        grid :row => 2, :column => 1, :pady => 5, :sticky => "e"
+        on_drop { |event|
+          event.target.textvariable.value = event.data
+        }
+      }
+      label {
+        text "Button"
+        grid :row => 3, :column => 0
+      }
+      button {
+        text "Drop here"
+        grid :row => 3, :column => 1, :pady => 5, :sticky => "w"
+        on_drop { |event|
+          event.target.text = event.data
+        }
+      }
+      label {
+        text "Checkbutton"
+        grid :row => 4, :column => 0
+      }
+      checkbutton {
+        text "Drop here to destroy a widget\n(except button)"
+        grid :row => 4, :column => 1, :pady => 5, :sticky => "w"
+        on_drop { |event|
+          event.target.text = event.data
+          event.source.destroy unless event.source.is_a? Tk::Button
+        }
+      }
+    }
+  }
+}.open

data/samples/hello/hello_message_box.rb

@@ -27,8 +27,6 @@ root { |r|
   title 'Hello, Message Box!'
   
   frame {
-    grid sticky: 'nsew', padx: 15, pady: 15
-    
     button {
       text 'Please Click To Win a Surprise'
       
@@ -80,8 +78,6 @@ root { |r|
   }
   
   frame {
-    grid sticky: 'nsew', padx: 15, pady: 15
-    
     label {
       grid row: 0, column: 0
       text 'Result:'

data/samples/hello/hello_separator.rb

@@ -0,0 +1,69 @@
+# Copyright (c) 2020-2021 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'glimmer-dsl-tk'
+
+include Glimmer
+
+root {
+  title 'Hello, Separator!'
+  width 200
+  height 200
+  
+  label {
+    grid row: 0, column: 0, min_width: 100, min_height: 100, column_weight: 0, sticky: 'nsew'
+    text 'Label 1'
+    anchor 'center'
+  }
+  
+  separator {
+    grid row: 0, column: 1
+    orient 'vertical'
+  }
+  
+  label {
+    grid row: 0, column: 2, min_width: 100, min_height: 100, sticky: 'nsew'
+    text 'Label 2'
+    anchor 'center'
+  }
+  
+  separator {
+    grid row: 1, column: 0, column_span: 3
+    # orient 'horizontal' # default
+  }
+  
+  label {
+    grid row: 2, column: 0, min_width: 100, min_height: 100, sticky: 'nsew'
+    text 'Label 3'
+    anchor 'center'
+  }
+  
+  separator {
+    grid row: 2, column: 1
+    orient 'vertical'
+  }
+  
+  label {
+    grid row: 2, column: 2, min_width: 100, min_height: 100, sticky: 'nsew'
+    text 'Label 4'
+    anchor 'center'
+  }
+}.open