glimmer-dsl-tk 0.0.44 → 0.0.48

data/lib/glimmer/tk/menu_proxy.rb

@@ -63,20 +63,20 @@ module Glimmer
       def build_widget
         if application?
           if OS.mac?
-            @tk = ::TkSysMenu_Apple.new(@parent_proxy.tk)
+            @tk = ::TkSysMenu_Apple.new(@parent_proxy.tk).tap {|tk| tk.singleton_class.include(Glimmer::Tk::Widget); tk.proxy = self}
             @parent_proxy.tk.add :cascade, :menu => @tk
           end
         else
           if @parent_proxy.parent_proxy.is_a?(ToplevelProxy) && (OS.mac? || OS.linux?) && help?
-            @tk = ::TkSysMenu_Help.new(@parent_proxy.tk)
+            @tk = ::TkSysMenu_Help.new(@parent_proxy.tk).tap {|tk| tk.singleton_class.include(Glimmer::Tk::Widget); tk.proxy = self}
           elsif @parent_proxy.parent_proxy.is_a?(ToplevelProxy) && OS.mac? && window?
-            @tk = ::Tk::TkSysMenu_Window.new(@parent_proxy.tk)
+            @tk = ::Tk::TkSysMenu_Window.new(@parent_proxy.tk).tap {|tk| tk.singleton_class.include(Glimmer::Tk::Widget); tk.proxy = self}
           # Windows system menu does not seem to work
 #           elsif @parent_proxy.parent_proxy.is_a?(ToplevelProxy) && OS.windows? && system?
-#             @tk = ::TkSysMenu_System.new(@parent_proxy.tk)
+#             @tk = ::TkSysMenu_System.new(@parent_proxy.tk).tap {|tk| tk.singleton_class.include(Glimmer::Tk::Widget); tk.proxy = self}
           else
             tk_widget_class = self.class.tk_widget_class_for(@keyword)
-            @tk = tk_widget_class.new(@parent_proxy.tk)
+            @tk = tk_widget_class.new(@parent_proxy.tk).tap {|tk| tk.singleton_class.include(Glimmer::Tk::Widget); tk.proxy = self}
           end
           case @parent_proxy
           when MenuProxy

data/lib/glimmer/tk/os.rb

@@ -0,0 +1,48 @@
+# 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 'tk'
+
+module Glimmer
+  module Tk
+    class OS
+      class << self
+        def mac?
+          ::Tk.windowingsystem == 'aqua'
+        end
+        
+        def windows?
+          ::Tk.windowingsystem == 'win32'
+        end
+        
+        def linux?
+          ::Tk.windowingsystem == 'x11'
+        end
+      end
+    end
+  end
+end
+
+begin
+  OS
+rescue
+  ::OS = Glimmer::Tk::OS
+end

data/lib/glimmer/tk/root_proxy.rb

@@ -28,7 +28,7 @@ module Glimmer
     # Follows the Proxy Design Pattern
     class RootProxy < ToplevelProxy
       def initialize(*args, &block)
-        @tk = ::TkRoot.new
+        @tk = ::TkRoot.new.tap {|tk| tk.singleton_class.include(Glimmer::Tk::Widget); tk.proxy = self}
         @tk.minsize = DEFAULT_WIDTH, DEFAULT_HEIGHT
         initialize_defaults
         post_add_content if block.nil?

data/lib/glimmer/tk/scrollbar_frame_proxy.rb

@@ -103,7 +103,7 @@ module Glimmer
         build_yscrollbar
         build_xscrollbar
         tk_widget_class = self.class.tk_widget_class_for('frame')
-        @tk = tk_widget_class.new(@canvas_proxy.tk, *args)
+        @tk = tk_widget_class.new(@canvas_proxy.tk, *args).tap {|tk| tk.singleton_class.include(Glimmer::Tk::Widget); tk.proxy = self}
         TkcWindow.new(@canvas_proxy.tk, 0, 0, :anchor => "nw", :window => @tk)
       end
       

data/lib/{os.rb → glimmer/tk/widget.rb}

@@ -19,18 +19,10 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-class OS
-  class << self
-    def mac?
-      Tk.windowingsystem == 'aqua'
-    end
-    
-    def windows?
-      Tk.windowingsystem == 'win32'
-    end
-    
-    def linux?
-      Tk.windowingsystem == 'x11'
+module Glimmer
+  module Tk
+    module Widget
+      attr_accessor :proxy
     end
   end
 end

data/lib/glimmer/tk/widget_proxy.rb

@@ -20,6 +20,8 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 require 'glimmer/data_binding/tk/one_time_observer'
+require 'glimmer/tk/widget'
+require 'glimmer/tk/draggable_and_droppable'
 
 module Glimmer
   module Tk
@@ -68,9 +70,12 @@ module Glimmer
         end
       end
       
+      prepend DraggableAndDroppable
+      
       FONTS_PREDEFINED = %w[default text fixed menu heading caption small_caption icon tooltip]
       
-      attr_reader :parent_proxy, :tk, :args, :keyword, :children
+      attr_reader :parent_proxy, :tk, :args, :keyword, :children, :bind_ids, :destroyed
+      alias destroyed? destroyed
 
       # Initializes a new Tk Widget
       #
@@ -153,6 +158,7 @@ module Glimmer
       end
       
       def has_state?(attribute)
+        attribute = attribute.to_s
         attribute = attribute.sub(/\?$/, '').sub(/=$/, '')
         if @tk.respond_to?(:tile_state)
           begin
@@ -168,6 +174,7 @@ module Glimmer
       end
       
       def has_attributes_attribute?(attribute)
+        attribute = attribute.to_s
         attribute = attribute.sub(/\?$/, '').sub(/=$/, '')
         @tk.respond_to?(:attributes) && @tk.attributes.keys.include?(attribute.to_s)
       end
@@ -288,8 +295,10 @@ module Glimmer
       end
       
       def destroy
+        unbind_all
         @tk.destroy
         @on_destroy_procs&.each {|p| p.call(@tk)}
+        @destroyed = true
       end
       
       def apply_style(options)
@@ -491,6 +500,16 @@ module Glimmer
         handle_listener(listener_name, &listener)
       end
       
+      def unbind_all
+        @listeners&.keys&.each do |key|
+          if key.to_s.downcase.include?('command')
+            @tk.send(key, '')
+          else
+            @tk.bind(key, '')
+          end
+        end
+      end
+      
       def content(&block)
         Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Tk::WidgetExpression.new, keyword, *args, &block)
       end
@@ -514,6 +533,11 @@ module Glimmer
           !super_only && tk.respond_to?(method, *args, &block)
       end
       
+      # inspect is overridden to prevent printing very long stack traces
+      def inspect
+        "#{super[0, 150]}... >"
+      end
+      
       private
       
       # The griddable parent widget proxy to apply grid to (is different from @tk in composite widgets like notebook or scrolledframe)
@@ -528,7 +552,7 @@ module Glimmer
       
       def build_widget
         tk_widget_class = self.class.tk_widget_class_for(@keyword)
-        @tk = tk_widget_class.new(@parent_proxy.tk, *args)
+        @tk = tk_widget_class.new(@parent_proxy.tk, *args).tap {|tk| tk.singleton_class.include(Glimmer::Tk::Widget); tk.proxy = self}
       end
       
       def initialize_defaults

data/lib/glimmer-dsl-tk.rb

@@ -29,7 +29,6 @@ require 'puts_debuggerer' if ENV['pd'].to_s.downcase == 'true'
 require 'tk'
 #require 'tkextlib/bwidget' # does not work on Windows
 #require 'tkextlib/iwidgets' # does not work on Windows
-require 'os'
 require 'facets/hash/symbolize_keys'
 require 'facets/string/underscore'
 require 'facets/string/camelcase'
@@ -38,8 +37,8 @@ require 'delegate'
 # Internal requires
 # require 'ext/glimmer/config'
 # require 'ext/glimmer'
+require 'glimmer/tk/os'
 require 'glimmer/dsl/tk/dsl'
-require 'glimmer/tk/drag_and_drop_extension'
 
 Glimmer::Config.loop_max_count = -1
 
@@ -49,11 +48,11 @@ Glimmer::Config.excluded_keyword_checkers << lambda do |method_symbol, *args|
   result ||= method == 'load_iseq'
 end
 
-Tk::Tile::Style.theme_use 'clam' if OS.linux?
+::Tk::Tile::Style.theme_use 'clam' if OS.linux?
 
 ::TkOption.add '*tearOff', 0
 
-class ::Tk::TkSysMenu_Window < Tk::Menu
-  include Tk::SystemMenu
+class ::Tk::TkSysMenu_Window < ::Tk::Menu
+  include ::Tk::SystemMenu
   SYSMENU_NAME = 'window'
 end

data/samples/hello/hello_button.rb

@@ -47,9 +47,9 @@ class HelloButton
           default 'active'
           focus true
           
-          on('command') {
+          on('command') do
             self.count += 1
-          }
+          end
         }
       }
         
@@ -64,9 +64,9 @@ class HelloButton
         button {
           image File.expand_path('../../icons/glimmer.png', __dir__), subsample: 5
           
-          on('command') {
+          on('command') do
             message_box(title: 'Image Button', message: 'Image Button Clicked!')
-          }
+          end
         }
       }
       
@@ -84,9 +84,9 @@ class HelloButton
             text "#{compound_option.capitalize} Image"
             compound compound_option
             
-            on('command') {
+            on('command') do
               message_box(title: 'Text Image Button', message: 'Text Image Button Clicked!', detail: "(#{compound_option})")
-            }
+            end
           }
         end
       }

data/samples/hello/hello_drag_and_drop.rb

@@ -35,27 +35,40 @@ root {
       
       label {
         grid :row => 0, :column => 0
-        text "Entry"
+        text "Label"
+      }
+      label {
+        grid :row => 0, :column => 1, :pady => 10, :sticky => "e"
+        text "Drag label text"
+        width 30
+        drag_source true
       }
       
+      label {
+        grid :row => 1, :column => 0
+        text "Entry"
+      }
       entry {
-        grid :row => 0, :column => 1, :pady => 5, :sticky => "e"
+        grid :row => 1, :column => 1, :pady => 5, :sticky => "e"
         text "Drag entry text"
         width 30
         
-        on_drag_start do |event|
-          event.data = event.source.textvariable&.value
+        # drag_source true
+        # This is how to do `drag_source true` the manual way for use in exceptional cases
+        on('drag_start') do |event|
+          event.data = event.source.text
           event.source.configure(:cursor => "hand2")
-          TkLabel.new(event.tooltip) {
-            text event.data + " "
-            bg "yellow"
-            bitmap "warning"
-            compound "right"
-          }.pack
+          event.tooltip.content { # re-open tooltip content and add a label
+            lbl { # non-tile-theme version of label
+              text event.data + " "
+              bg "yellow"
+              bitmap "warning"
+              compound "right"
+            }
+          }
         end
-        
-        on_drag_motion do |event|
-          if event.drop_accepted
+        on('drag_motion') do |event|
+          if event.drop_accepted?
             event.source.configure(:cursor => "hand1")
           else
             event.source.configure(:cursor => "hand2")
@@ -64,48 +77,34 @@ root {
         end
       }
       
-      label {
-        grid :row => 1, :column => 0
-        text "Label"
-      }
-      
-      label {
-        grid :row => 1, :column => 1, :pady => 10, :sticky => "e"
-        text "Drag label text"
-        width 30
-        drag_source true
-      }
-      
       label {
         grid :row => 2, :column => 0
         text "Combobox"
       }
-      
       combobox {
         grid :row => 2, :column => 1, :pady => 5, :sticky => "e"
         text "Spain"
         values %w[USA Canada Mexico Columbia UK Australia Germany Italy Spain]
         width 27
         
-        on_drag_start do |event|
-          event.data = event.source.textvariable&.value
-        end
+        drag_source true
       }
       
       label {
         grid :row => 3, :column => 0
         text 'List'
       }
-      
-      country_list = list {
+      list {
         grid :row => 3, :column => 1, :pady => 5, :sticky => "e"
         selectmode 'browse'
         items %w[USA Canada Mexico]
         selection 'Canada'
         height 3
         
-        on_drag_start do |event|
-          event.data = event.source.selection.to_a.first.text
+        # drag_source true
+        # This is another alternative to `drag_source true` with manual specification of transferred data only
+        on('drag_start') do |event|
+          event.data = event.source.selection.first
         end
       }
       
@@ -113,7 +112,6 @@ root {
         grid :row => 4, :column => 0
         text "Button"
       }
-      
       button {
         grid :row => 4, :column => 1, :pady => 5, :sticky => "w"
         text "Drag it"
@@ -128,89 +126,76 @@ root {
       
       label {
         grid :row => 0, :column => 0
-        text "Entry"
+        text "Label"
       }
-      
-      entry {
-        grid :row => 0, :column => 1, :pady => 5, :sticky => "e"
+      label {
+        grid :row => 0, :column => 1, :pady => 10, :sticky => "e"
         width 30
+        borderwidth 2
+        relief "solid"
         
-        on_drop { |event|
-          event.target.textvariable.value = event.data
-        }
+        drop_target true
       }
       
       label {
         grid :row => 1, :column => 0
-        text "Label"
+        text "Entry"
       }
-      
-      label {
-        grid :row => 1, :column => 1, :pady => 10, :sticky => "e"
+      entry {
+        grid :row => 1, :column => 1, :pady => 5, :sticky => "e"
         width 30
-        borderwidth 2
-        relief "solid"
         
-        on_drop do |event|
-          event.target.textvariable.value = event.data
-        end
+        drop_target true
       }
       
       label {
         grid :row => 2, :column => 0
         text "Combobox"
       }
-      
       combobox {
         grid :row => 2, :column => 1, :pady => 5, :sticky => "e"
         width 27
         
-        on_drop do |event|
-          event.target.textvariable.value = event.data
-        end
+        drop_target true
       }
       
       label {
         grid :row => 3, :column => 0
         text 'List'
       }
-      
       list {
         grid :row => 3, :column => 1, :pady => 5, :sticky => "e"
         selectmode 'browse'
         height 3
         
-        on_drop do |event|
-          event.target.insert('', 'end', :text => event.data)
-        end
+        drop_target true
       }
       
       label {
         grid :row => 4, :column => 0
         text "Button"
       }
-      
       button {
         grid :row => 4, :column => 1, :pady => 5, :sticky => "w"
         text "Drop here"
         
-        on_drop do |event|
-          event.target.text = event.data
-        end
+        drop_target true
       }
       
       label {
         grid :row => 5, :column => 0
         text "Checkbutton"
       }
-      
       checkbutton {
         grid :row => 5, :column => 1, :pady => 5, :sticky => "w"
-        text "Drop here to destroy a widget\n(except button and list)"
-        
-        on_drop do |event|
+        text "Drop here to destroy a widget"
+
+        # drop_target true
+        # This is an alternative to `drop_target true` with manual consumption of transferred data
+        on('drop') do |event|
           event.target.text = event.data
-          event.source.destroy unless event.source.is_a?(Tk::Button) || event.source.is_a?(Tk::Tile::Treeview)
+          # execute asynchronously after 100ms to ensure all events have been processed before destruction
+          ::Tk.after(100) {event.source.destroy}
         end
       }
     }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-tk
 version: !ruby/object:Gem::Version
-  version: 0.0.44
+  version: 0.0.48
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2021-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.5.1
 - !ruby/object:Gem::Dependency
   name: puts_debuggerer
   requirement: !ruby/object:Gem::Requirement
@@ -208,14 +208,17 @@ files:
 - lib/glimmer/dsl/tk/widget_expression.rb
 - lib/glimmer/tk/checkbutton_proxy.rb
 - lib/glimmer/tk/combobox_proxy.rb
-- lib/glimmer/tk/drag_and_drop_extension.rb
+- lib/glimmer/tk/drag_and_drop_event.rb
+- lib/glimmer/tk/draggable_and_droppable.rb
 - lib/glimmer/tk/entry_proxy.rb
 - lib/glimmer/tk/frame_proxy.rb
 - lib/glimmer/tk/label_proxy.rb
+- lib/glimmer/tk/lbl_proxy.rb
 - lib/glimmer/tk/list_proxy.rb
 - lib/glimmer/tk/menu_item_proxy.rb
 - lib/glimmer/tk/menu_proxy.rb
 - lib/glimmer/tk/notebook_proxy.rb
+- lib/glimmer/tk/os.rb
 - lib/glimmer/tk/radiobutton_proxy.rb
 - lib/glimmer/tk/root_proxy.rb
 - lib/glimmer/tk/scrollbar_frame_proxy.rb
@@ -225,8 +228,8 @@ files:
 - lib/glimmer/tk/toplevel_proxy.rb
 - lib/glimmer/tk/treeview_proxy.rb
 - lib/glimmer/tk/variable_owner.rb
+- lib/glimmer/tk/widget.rb
 - lib/glimmer/tk/widget_proxy.rb
-- lib/os.rb
 - samples/elaborate/meta_sample.rb
 - samples/hello/hello_built_in_dialog.rb
 - samples/hello/hello_button.rb
@@ -291,7 +294,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.31
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Glimmer DSL for Tk

data/lib/glimmer/tk/drag_and_drop_extension.rb

@@ -1,112 +0,0 @@
-require "json"
-
-module Glimmer
-  module Tk
-    class WidgetProxy
-      attr_accessor :on_drag_motion_block
-
-      def drag_source=(value)
-        @drag_source = value
-        if @drag_source
-          make_draggable
-        else
-          make_non_draggable
-        end
-      end
-
-      def on_drag_start_block=(block)
-        @on_drag_start_block = block
-        make_draggable
-      end
-
-      def on_drop_block=(value)
-        @on_drop_block = value
-        self.tk.bind("<DropEvent>", proc { |tk_event|
-          drop_event = DragAndDropEvent.json_create(JSON.parse("{" + tk_event.detail + "}"))
-          @on_drop_block.call(drop_event) if self.tk == drop_event.target
-        })
-        self.tk.bind("<DropCheckEvent>", proc { |tk_event|
-          drop_check_event = DragAndDropEvent.json_create(JSON.parse("{" + tk_event.detail + "}"))
-          drop_check_event.source.event_generate("<DropAcceptedEvent>")
-        })
-      end
-
-      def textvariable_defined?
-        tk_widget_has_attribute_setter?(:textvariable) && !tk.textvariable.nil?
-      end
-
-      def make_draggable
-        drag_event = nil
-        bind("<DropAcceptedEvent>", proc { |event| drag_event.drop_accepted = true })
-        bind("B1-Motion", proc { |tk_event|
-          if drag_event.nil?
-            tooltip = TkToplevel.new(root).overrideredirect(1) #create tooltip window to display dragged data
-            tooltip.geometry("+#{tk_event.x_root + 10}+#{tk_event.y_root - 2}")
-            drag_event = DragAndDropEvent.new(self.tk, nil, tooltip, tk_event.x_root, tk_event.y_root, nil, false)
-            if @drag_source
-              tk_event.widget.configure(:cursor => "hand2")
-              # Default data to drag is text
-              drag_event.data = if textvariable_defined? then tk.textvariable.value elsif has_attribute?(:text) then tk.text end
-              TkLabel.new(tooltip) { text drag_event.data }.pack
-            elsif !@on_drag_start_block.nil?
-              @on_drag_start_block.call(drag_event)
-              TkLabel.new(tooltip) { text drag_event.data }.pack if tooltip.winfo_children().length == 0
-            end
-          else
-            drag_event.x_root, drag_event.y_root = tk_event.x_root, tk_event.y_root
-            drag_event.drop_accepted = false
-            move_over_widget = tk_event.widget.winfo_containing(tk_event.x_root, tk_event.y_root)
-            drag_event.target = move_over_widget
-            move_over_widget.event_generate("<DropCheckEvent>", :data => drag_event.to_json)
-            if @on_drag_motion_block.nil?
-              # Default motion behavior:
-              # 1.Change cursor to show whether text can be dropped.
-              # 2.Move tooltip with dragged data.
-              if drag_event.drop_accepted
-                tk_event.widget.configure(:cursor => "hand1")
-              else
-                tk_event.widget.configure(:cursor => "hand2")
-              end
-              drag_event.tooltip.geometry("+#{tk_event.x_root + 10}+#{tk_event.y_root - 2}")
-            else
-              @on_drag_motion_block.call(drag_event)
-            end
-          end
-        })
-        bind("ButtonRelease-1", proc { |tk_event|
-          if drag_event
-            drag_event.target = tk_event.widget.winfo_containing(tk_event.x_root, tk_event.y_root)
-            drag_event.source.configure(:cursor => "")
-            drag_event.target.event_generate("<DropEvent>", :data => drag_event.to_json)
-            drag_event.tooltip.destroy
-            drag_event = nil
-          end
-        })
-      end
-
-      def make_non_draggable
-        @tk.bind_remove("B1-Motion")
-        @tk.bind_remove("ButtonRelease-1")
-        @tk.bind_remove("<DropAcceptedEvent>")
-      end
-
-      DragAndDropEvent = Struct.new(:source, :target, :tooltip, :x_root, :y_root, :data, :drop_accepted) do
-        def as_json(*)
-          klass = self.class.name
-          {
-            JSON.create_id => klass,
-            "v" => [values[0].object_id, values[1].object_id, values[2].object_id].concat(values.drop 3),
-          }
-        end
-
-        def to_json(*args)
-          as_json.to_json(*args)
-        end
-
-        def self.json_create(object)
-          new(*[ObjectSpace._id2ref(object["v"][0]), ObjectSpace._id2ref(object["v"][1]), ObjectSpace._id2ref(object["v"][2])].concat(object["v"].drop 3))
-        end
-      end
-    end
-  end
-end