glimmer-dsl-tk 0.0.42 → 0.0.46

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbb49ce9e435d0313cdec33a81afec3ad4d7716ee6e8363004651417d3535704
-  data.tar.gz: 9ad46f88ace884c5d670d2449728369af8510b95e24c291a3bda7580cef65820
+  metadata.gz: 5313d90447c3c864cdbc16c6704c6bcb07fc2b8adcd51f136d92762be919327e
+  data.tar.gz: e4e48e9330f79b4a5c677651336560805485d6d0b036fc7c248f3b0a338e0f82
 SHA512:
-  metadata.gz: d58a0179466efe9991f53eefb23c6dd3749c386230d70722e0a6c3f24c85f2affc361e18c21d65b34b2cb37269dfb8c7ceff9953a1bc5059f1db971051b0c4c8
-  data.tar.gz: bad07c9519d483534306b04be7e4d110fe302c6dc3f03028d85aa5c85fcfe01437c0471d58b49e3db013abc99d6f55535d5aefacc4bdc651df50b30ecda467e0
+  metadata.gz: 41b3096f2f320ae2bd277b71f4f98ca8ba0f43e05d50eba9adc1a200106d698c17a67bee78082e2f62cb1179d2185df0765e1e9b4a83fc4de15d367a4701e83d
+  data.tar.gz: 74761ae2d6f037d7c237d47da581ff2be8bf5f2c2c6e96a9656b900b5bc19ea39442afc14b16b9d2f5ac5ff370887973262b0d2cc8223a2fa7080972a63c564d

data/CHANGELOG.md

@@ -1,10 +1,37 @@
 # Change Log
 
+## 0.0.46
+
+- Support `drag_source true` on `list` widget
+- Support `drop_target true` keyword alternative to `on_drop` for cases where it is implied what to drop (text in the case of label, entry, combo, list, and button)
+- Support `on('drag_start')` (instead of `on_drag_start`), `on('drag_motion')`, and `on('drop')` for consistency with Glimmer DSL for general Tk listener style (`on('event')`)
+
+## 0.0.45
+
+- Support `lbl` widget as the non-tile-themed version of `label` (i.e. `::TkLabel` not `::Tk::Tile::TLabel`)
+- Add `#proxy` method to all Tk widgets to return Glimmer widget proxy objects (e.g. `Tk::Tile::TButton#proxy` returns `Glimmer::Tk::WidgetProxy` object)
+- Provide question mark alias of `event.drop_accepted` (i.e. `drop_accepted?`)
+- Have `DragAndDropEvent` `source`/`target` be the enhanced Glimmer widget proxy instead of the unenhanced Tk widget
+- Look into improving code that uses `TkLabel` explicitly in Hello, Drag and Drop! (do `event.tooltip.content {label {...} }` with Glimmer DSL instead)
+- Add Glimmer Style Guide
+- Fix issue with dropping button and list unto checkbox in Hello, Drag and Drop!
+
+## 0.0.44
+
+- Fix issue with not being able to drop list into checkbox in Hello, Drag and Drop! by disabling functionality for list just like button
+
+## 0.0.43
+
+- Modified Hello, Drag and Drop! to include a list
+- Removed the need to require `'glimmer/tk/drag_and_drop_extension'` to do drag and drop; it is automatically included in `require 'glimmer-dsl-tk'` now.
+- Remove 'os' gem due to Tk having the capability to detect the OS it is on using `Tk.windowingsystem` (include Glimmer implementation of `OS` class having `OS.mac?`, `OS.windows?` and `OS.linux?`)
+- Default to 'clam' Tk theme on Linux ('alt' looks a bit too classic with certain widgets)
+
 ## 0.0.42
 
 - Add vertical/horizontal scrollbars to Meta-Sample
 - Keep only vertical scrollbar in Hello, Text!
-- Fix issue with including bwidgets and iwidgets in Windows
+- Fix issue with including bwidgets and iwidgets in Windows (by removing from default requires, leaving to users to require manually when needed only and only systems that support them)
 - Fix Hello, Menu Bar! sample in Windows (by disabling Windows-special System menu, which does not seem to be working in Tk)
 
 ## 0.0.41

data/README.md

@@ -1,4 +1,4 @@
-# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for Tk 0.0.42
+# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for Tk 0.0.46
 ## MRI Ruby Desktop Development GUI Library
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-tk.svg)](http://badge.fury.io/rb/glimmer-dsl-tk)
 [![Ruby](https://github.com/AndyObtiva/glimmer-dsl-tk/actions/workflows/ruby.yml/badge.svg)](https://github.com/AndyObtiva/glimmer-dsl-tk/actions/workflows/ruby.yml)
@@ -100,6 +100,7 @@ Other [Glimmer](https://github.com/AndyObtiva/glimmer) DSL gems:
     - [Radiobutton Data-Binding](#radiobutton-data-binding)
   - [Command Callback](#command-callback)
   - [Gotchas](#gotchas)
+  - [Glimmer Style Guide](#glimmer-style-guide)
   - [Samples](#samples)
     - [Hello, World!](#hello-world)
     - [Hello, Button!](#hello-button)
@@ -181,7 +182,7 @@ gem install glimmer-dsl-tk
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer-dsl-tk', '0.0.42'
+gem 'glimmer-dsl-tk', '0.0.46'
 ```
 
 And, then run:
@@ -225,6 +226,8 @@ The Glimmer GUI DSL follows these simple concepts in mapping from Tk syntax:
 - **Content/Options Block**: Any keyword may optionally be followed by a Ruby curly-brace block containing nested widgets (content) and attributes (options). Attributes are simply Tk option keywords followed by arguments and no block (e.g. `title 'Hello, World!'` under a `root`)
 - **Event Binding Block**: `on(event) {}` keyword receiving a Tk binding event name (e.g. `KeyPress` or `ComboboxSelected`). Surrounding event by `<>` is optional as [Glimmer DSL for Tk](https://rubygems.org/gems/glimmer-dsl-tk) can take care of that automatically.
 
+Note that Glimmer widgets are proxy objects (wrappers) for Tk widgets. To get wrapped Tk widget from a Glimmer widget, you simply invoke `#tk` method. To get the proxy of a wrapped Tk widget, you may invoke `#proxy` method.
+
 Example of an app written in [Tk](https://www.tcl.tk/) imperative syntax:
 
 ```ruby
@@ -303,6 +306,7 @@ keyword(args) | attributes | event bindings & callbacks
 `spinbox` | `text`, `from`, `to`, `increment`, `format`, [more attributes](https://tcl.tk/man/tcl8.6/TkCmd/text.htm#M116) | `command {}`, `'increment'`, `'decrement'`
 `frame(text: nil)` | `width`, `height`, `borderwidth`, `relief` (`'flat' (default), 'raised', 'sunken', 'solid', 'ridge', 'groove'`) | None
 `label` | `text`, `image` (optional keyword args: `subsample`, `zoom`, `from`, `to`, `shrink`, `compositingrule`), `compound` (`'center', 'top', 'bottom', 'left', 'right'`), `font` (`'default', 'text', 'fixed', 'menu', 'heading', 'caption', 'small_caption', 'icon', 'tooltip'`), `relief` (`'flat' (default), 'raised', 'sunken', 'solid', 'ridge', 'groove'`), `justify` (`'left', 'center', 'right'`), `foreground`, `background` | None
+`lbl` (non-theme version of `label`) | `text`, `image` (optional keyword args: `subsample`, `zoom`, `from`, `to`, `shrink`, `compositingrule`), `compound` (`'center', 'top', 'bottom', 'left', 'right'`), `font` (`'default', 'text', 'fixed', 'menu', 'heading', 'caption', 'small_caption', 'icon', 'tooltip'`), `relief` (`'flat' (default), 'raised', 'sunken', 'solid', 'ridge', 'groove'`), `justify` (`'left', 'center', 'right'`), `foreground`, `background`, `bg`, `bitmap`, [more here](https://tcl.tk/man/tcl8.6/TkCmd/label.htm) | None
 `list` | `selectmode`, `selection` | None
 `message_box(type: , message: , detail: , title: , icon: , default: , parent: )` | None | None
 `menu(label: nil) (label is nil if nested under root/toplevel for menu bar)` | None | None
@@ -476,14 +480,23 @@ Check out the [Hello, Scrollbar!](#hello-scrollbar) sample for a `text` demo wit
 
 #### Drag and Drop API
 
-Drag and drop works by simply designating a widget as a drag source with attribute `drag_source true`
+Drag and drop works by simply designating a widget as a drag source with attribute `drag_source true` and another widget as a drop target with attribute `drop_target true`.
+
+Alternatively, add listeners on the drag source:
+- `on('drag_start') {|event| ...}`: fires on drag start receiving an `event` arg to set `data` and configure `source`
+- `on('drag_motion') {|event| ...}`: fires on drag motion receiving an `event` arg to check `event#drop_accepted`, and configure `source` and `tooltip`
 
-Alternatively, add listeners:
-- `on_drag_start {|event| ...}`: fires on drag start receiving an `event` arg to set `data` and configure `source`
-- `on_drag_motion {|event| ...}`: fires on drag motion receiving an `event` arg to check `event#drop_accepted`, and configure `source` and `tooltip`
+And on the drop target, add listener:
+- `on('drop') { |event| ...}`: fires on drop, receiving an `event` arg with `event#target` and `event#data` (set during drag). You can even destroy the `event#source` if you want to get rid of the dragged widget.
 
-On the drop target, you simply define:
-- `on_drop { |event| ...}`: fires on drop, receiving an `event` arg with `event#target` and `event#data` (set during drag). You can even destroy the `event#source` if you want to get rid of the dragged widget.
+These are all the available attributes on event, which is of type `DragAndDropEvent`:
+- `source`: drag source widget proxy
+- `target`: drop target widget proxy
+- `tooltip`: tooltip widget proxy
+- `x_root`: x coordinate from top-left root corner
+- `y_root`: y coordinate from top-left root corner
+- `data`: data being transferred through drag and drop
+- `drop_accepted`: boolean indicating if drop was accepted
 
 Learn more at the [Hello, Drag and Drop!](#hello-drag-and-drop) sample.
 
@@ -824,6 +837,17 @@ More details can be found in the [Hello, Button!](#hello-button) sample below.
 
 - Setting `background` attribute on `frame` or `label` does not work in `'aqua'` theme on the Mac (only in `'classic'` theme)
 
+## Glimmer Style Guide
+
+- Widget arguments are always wrapped by parentheses.
+- Widget blocks are always declared with curly braces `{}` to clearly visualize hierarchical view code and separate from logic code.
+- Widget attribute declarations always have arguments that are never wrapped inside parentheses and never take a block.
+- Widget listeners are always declared with `on` keyword receiving listener event name as an argument. Their multi-line blocks have a `do; end` style to distinguish as logic from widget keywords and attributes.
+- In a widget's content block, group attributes on top first, with the `grid` geometry management attribute being first, and separate by an empty line from nested widgets and listeners following afterwards.
+- In a widget's content block, after attributes, you may either include nested widgets second and listeners third or vice versa.
+- Unlike attributes, nested widgets and listeners are all separated by an empty line to make readability easier except where it helps to group two widgets together (e.g. label and described entry)
+- Pure logic multi-line blocks that do not constitute GUI DSL view elements in general always have `do; end` style to clearly separate logic code from view code.
+
 ## Samples
 
 The easiest way to run samples is by launching the Glimmer Meta-Sample (the Sample of Samples).
@@ -1026,14 +1050,14 @@ class HelloButton
           text 'Text Button'
         }
         
-        button {
+        button { |b|
           text <= [self, :count, on_read: ->(value) { "Click To Increment: #{value}  " }]
           default 'active'
           focus true
           
-          command {
+          on('command') do
             self.count += 1
-          }
+          end
         }
       }
         
@@ -1048,9 +1072,9 @@ class HelloButton
         button {
           image File.expand_path('../../icons/glimmer.png', __dir__), subsample: 5
           
-          command {
+          on('command') do
             message_box(title: 'Image Button', message: 'Image Button Clicked!')
-          }
+          end
         }
       }
       
@@ -1065,12 +1089,12 @@ class HelloButton
         ['center', 'top', 'bottom', 'left', 'right'].each do |compound_option|
           button {
             image File.expand_path('../../icons/glimmer.png', __dir__), subsample: 5
-            text 'Text Image Button'
+            text "#{compound_option.capitalize} Image"
             compound compound_option
             
-            command {
+            on('command') do
               message_box(title: 'Text Image Button', message: 'Text Image Button Clicked!', detail: "(#{compound_option})")
-            }
+            end
           }
         end
       }
@@ -2683,140 +2707,184 @@ Glimmer app:
 Glimmer code (from [samples/hello/hello_drag_and_drop.rb](samples/hello/hello_drag_and_drop.rb)):
 
 ```ruby
-require "glimmer-dsl-tk"
-require "glimmer/tk/drag_and_drop_extension"
+require 'glimmer-dsl-tk'
 
 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
+        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 => 1, :column => 1, :pady => 5, :sticky => "e"
         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
+        
+        # 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
-        }
-        on_drag_motion { |event|
-          if event.drop_accepted
+          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?
             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
+        end
       }
+      
       label {
-        text "Combobox"
         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
-        grid :row => 2, :column => 1, :pady => 5, :sticky => "e"
-        on_drag_start { |event|
-          event.data = event.source.textvariable&.value
-        }
+        
+        drag_source true
+      }
+      
+      label {
+        grid :row => 3, :column => 0
+        text 'List'
+      }
+      list {
+        grid :row => 3, :column => 1, :pady => 5, :sticky => "e"
+        selectmode 'browse'
+        items %w[USA Canada Mexico]
+        selection 'Canada'
+        height 3
+        
+        # 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
       }
+      
       label {
+        grid :row => 4, :column => 0
         text "Button"
-        grid :row => 3, :column => 0
       }
       button {
+        grid :row => 4, :column => 1, :pady => 5, :sticky => "w"
         text "Drag it"
-        grid :row => 3, :column => 1, :pady => 5, :sticky => "w"
         drag_source true
       }
     }
 
     labelframe {
-      text "Drop targets"
       grid :sticky => "nsew", :pady => 15
+      text "Drop targets"
       padding 5
+      
       label {
-        text "Entry"
         grid :row => 0, :column => 0
+        text "Label"
       }
-      entry {
+      label {
+        grid :row => 0, :column => 1, :pady => 10, :sticky => "e"
         width 30
-        grid :row => 0, :column => 1, :pady => 5, :sticky => "e"
-        on_drop { |event|
-          event.target.textvariable.value = event.data
-        }
+        borderwidth 2
+        relief "solid"
+        
+        drop_target true
       }
+      
       label {
-        text "Label"
         grid :row => 1, :column => 0
+        text "Entry"
       }
-      label {
+      entry {
+        grid :row => 1, :column => 1, :pady => 5, :sticky => "e"
         width 30
-        grid :row => 1, :column => 1, :pady => 10, :sticky => "e"
-        borderwidth 2
-        relief "solid"
-        on_drop { |event|
-          event.target.textvariable.value = event.data
-        }
+        
+        drop_target true
       }
+      
       label {
-        text "Combobox"
         grid :row => 2, :column => 0
+        text "Combobox"
       }
       combobox {
-        width 27
         grid :row => 2, :column => 1, :pady => 5, :sticky => "e"
-        on_drop { |event|
-          event.target.textvariable.value = event.data
-        }
+        width 27
+        
+        drop_target true
       }
+      
       label {
-        text "Button"
         grid :row => 3, :column => 0
+        text 'List'
+      }
+      list {
+        grid :row => 3, :column => 1, :pady => 5, :sticky => "e"
+        selectmode 'browse'
+        height 3
+        
+        drop_target true
+      }
+      
+      label {
+        grid :row => 4, :column => 0
+        text "Button"
       }
       button {
+        grid :row => 4, :column => 1, :pady => 5, :sticky => "w"
         text "Drop here"
-        grid :row => 3, :column => 1, :pady => 5, :sticky => "w"
-        on_drop { |event|
-          event.target.text = event.data
-        }
+        
+        drop_target true
       }
+      
       label {
+        grid :row => 5, :column => 0
         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|
+        grid :row => 5, :column => 1, :pady => 5, :sticky => "w"
+        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
-        }
+          # execute asynchronously after 100ms to ensure all events have been processed before destruction
+          ::Tk.after(100) {event.source.destroy}
+        end
       }
     }
   }

data/VERSION

@@ -1 +1 @@
-0.0.42
+0.0.46

data/lib/glimmer/dsl/tk/list_selection_data_binding_expression.rb

@@ -50,7 +50,7 @@ module Glimmer
           #TODO check if nested data binding works for list widget and other widgets that need custom data binding
           list_selection_binding.observe(model, model_binding.property_name_expression)
   
-          parent.tk.bind('<TreeviewSelect>') do
+          parent.on('<TreeviewSelect>') do
             model_binding.call(list_selection_binding.evaluate_property)
           end
         end

data/lib/glimmer/tk/{drag_and_drop_extension.rb → draggable_and_droppable.rb}

@@ -1,9 +1,43 @@
+# 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 "json"
 
 module Glimmer
   module Tk
-    class WidgetProxy
+    module DraggableAndDroppable
       attr_accessor :on_drag_motion_block
+      
+      def handle_listener(listener_name, &listener)
+        case listener_name.to_s.downcase
+        when 'drag_start'
+          self.on_drag_start_block = listener
+        when 'drag_motion'
+          self.on_drag_motion_block = listener
+        when 'drop'
+          self.on_drop_block = listener
+        else
+          super
+        end
+      end
 
       def drag_source=(value)
         @drag_source = value
@@ -14,6 +48,15 @@ module Glimmer
         end
       end
 
+      def drop_target=(value)
+        @drop_target = value
+        if @drop_target
+          make_droppable
+        else
+          make_non_droppable
+        end
+      end
+
       def on_drag_start_block=(block)
         @on_drag_start_block = block
         make_draggable
@@ -23,7 +66,7 @@ module Glimmer
         @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
+          @on_drop_block.call(drop_event) if self == drop_event.target
         })
         self.tk.bind("<DropCheckEvent>", proc { |tk_event|
           drop_check_event = DragAndDropEvent.json_create(JSON.parse("{" + tk_event.detail + "}"))
@@ -40,23 +83,36 @@ module Glimmer
         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 = WidgetProxy.new('toplevel', root_parent_proxy, [])
+            tooltip.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)
+            drag_event = DragAndDropEvent.new(self, 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
+              drag_event.data = if textvariable_defined?
+                tk.textvariable.value
+              elsif has_attribute?('text')
+                tk.text
+              elsif has_attribute?('selection')
+                selection.first
+              end
+              tooltip_label = WidgetProxy.new('label', tooltip, [])
+              tooltip_label.text = drag_event.data
+              tooltip_label.pack # TODO look into using grid instead to be consistent with the modern Tk way
             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
+              if tooltip.winfo_children().length == 0
+                tooltip_label = WidgetProxy.new('label', tooltip, [])
+                tooltip_label.text = drag_event.data
+                tooltip_label.pack # TODO look into using grid instead to be consistent with the modern Tk way
+              end
             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
+            drag_event.target = move_over_widget.proxy
             move_over_widget.event_generate("<DropCheckEvent>", :data => drag_event.to_json)
             if @on_drag_motion_block.nil?
               # Default motion behavior:
@@ -75,7 +131,7 @@ module Glimmer
         })
         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.target = tk_event.widget.winfo_containing(tk_event.x_root, tk_event.y_root).proxy
             drag_event.source.configure(:cursor => "")
             drag_event.target.event_generate("<DropEvent>", :data => drag_event.to_json)
             drag_event.tooltip.destroy
@@ -90,7 +146,23 @@ module Glimmer
         @tk.bind_remove("<DropAcceptedEvent>")
       end
 
+      def make_droppable
+        self.on_drop_block = Proc.new do |event|
+          event.target.text = event.data if event.target.has_attribute?('text')
+          event.target.items += [event.data] if event.target.has_attribute?('items')
+          event.target.selection += [event.data] if event.target.has_attribute?('selection')
+        end
+      end
+
+      def make_non_droppable
+        @tk.bind_remove('<DropEvent>')
+        @tk.bind_remove('<DropCheckEvent>')
+        @on_drop_block = nil
+      end
+
       DragAndDropEvent = Struct.new(:source, :target, :tooltip, :x_root, :y_root, :data, :drop_accepted) do
+        alias drop_accepted? drop_accepted
+        
         def as_json(*)
           klass = self.class.name
           {
@@ -104,9 +176,9 @@ module Glimmer
         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))
+          new(*[ObjectSpace._id2ref(object["v"][0]), ObjectSpace._id2ref(object["v"][1]).proxy, ObjectSpace._id2ref(object["v"][2])].concat(object["v"].drop 3))
         end
       end
     end
   end
-end
+end

data/lib/glimmer/tk/lbl_proxy.rb

@@ -0,0 +1,33 @@
+# 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/tk/widget_proxy'
+
+module Glimmer
+  module Tk
+    # Non-Themable (non-Tile) Tk Label
+    class LblProxy < WidgetProxy
+      def build_widget
+        @tk = ::TkLabel.new(@parent_proxy.tk, *args).tap {|tk| tk.singleton_class.include(Glimmer::Tk::Widget); tk.proxy = self}
+      end
+    end
+  end
+end

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/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/glimmer/tk/widget.rb

@@ -0,0 +1,28 @@
+# 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.
+
+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
@@ -49,10 +51,10 @@ module Glimmer
           # TODO consider exposing this via Glimmer::Config
           potential_tk_widget_class_names = [
             "::Tk::Tile::#{tk_widget_class_basename}",
-            "::Tk::BWidget::#{tk_widget_class_basename}",
-            "::Tk::Iwidgets::#{tk_widget_class_basename}",
             "::Tk#{tk_widget_class_basename}",
             "::Tk::#{tk_widget_class_basename}",
+            "::Tk::BWidget::#{tk_widget_class_basename}",
+            "::Tk::Iwidgets::#{tk_widget_class_basename}",
             "::Glimmer::Tk::#{tk_widget_class_basename}Proxy",
           ]
           tk_widget_class = nil
@@ -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

@@ -48,7 +48,7 @@ Glimmer::Config.excluded_keyword_checkers << lambda do |method_symbol, *args|
   result ||= method == 'load_iseq'
 end
 
-Tk::Tile::Style.theme_use 'alt' if OS.linux?
+Tk::Tile::Style.theme_use 'clam' if OS.linux?
 
 ::TkOption.add '*tearOff', 0
 

data/lib/os.rb

@@ -0,0 +1,36 @@
+# 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.
+
+class OS
+  class << self
+    def mac?
+      Tk.windowingsystem == 'aqua'
+    end
+    
+    def windows?
+      Tk.windowingsystem == 'win32'
+    end
+    
+    def linux?
+      Tk.windowingsystem == 'x11'
+    end
+  end
+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

@@ -19,140 +19,184 @@
 # 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"
+require 'glimmer-dsl-tk'
 
 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
+        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 => 1, :column => 1, :pady => 5, :sticky => "e"
         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
+        
+        # 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
-        }
-        on_drag_motion { |event|
-          if event.drop_accepted
+          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?
             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
+        end
       }
+      
       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
+        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
-        grid :row => 2, :column => 1, :pady => 5, :sticky => "e"
-        on_drag_start { |event|
-          event.data = event.source.textvariable&.value
-        }
+        
+        drag_source true
       }
+      
       label {
-        text "Button"
         grid :row => 3, :column => 0
+        text 'List'
+      }
+      list {
+        grid :row => 3, :column => 1, :pady => 5, :sticky => "e"
+        selectmode 'browse'
+        items %w[USA Canada Mexico]
+        selection 'Canada'
+        height 3
+        
+        # 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
+      }
+      
+      label {
+        grid :row => 4, :column => 0
+        text "Button"
       }
       button {
+        grid :row => 4, :column => 1, :pady => 5, :sticky => "w"
         text "Drag it"
-        grid :row => 3, :column => 1, :pady => 5, :sticky => "w"
         drag_source true
       }
     }
 
     labelframe {
-      text "Drop targets"
       grid :sticky => "nsew", :pady => 15
+      text "Drop targets"
       padding 5
+      
       label {
-        text "Entry"
         grid :row => 0, :column => 0
+        text "Label"
       }
-      entry {
+      label {
+        grid :row => 0, :column => 1, :pady => 10, :sticky => "e"
         width 30
-        grid :row => 0, :column => 1, :pady => 5, :sticky => "e"
-        on_drop { |event|
-          event.target.textvariable.value = event.data
-        }
+        borderwidth 2
+        relief "solid"
+        
+        drop_target true
       }
+      
       label {
-        text "Label"
         grid :row => 1, :column => 0
+        text "Entry"
       }
-      label {
+      entry {
+        grid :row => 1, :column => 1, :pady => 5, :sticky => "e"
         width 30
-        grid :row => 1, :column => 1, :pady => 10, :sticky => "e"
-        borderwidth 2
-        relief "solid"
-        on_drop { |event|
-          event.target.textvariable.value = event.data
-        }
+        
+        drop_target true
       }
+      
       label {
-        text "Combobox"
         grid :row => 2, :column => 0
+        text "Combobox"
       }
       combobox {
-        width 27
         grid :row => 2, :column => 1, :pady => 5, :sticky => "e"
-        on_drop { |event|
-          event.target.textvariable.value = event.data
-        }
+        width 27
+        
+        drop_target true
       }
+      
       label {
-        text "Button"
         grid :row => 3, :column => 0
+        text 'List'
+      }
+      list {
+        grid :row => 3, :column => 1, :pady => 5, :sticky => "e"
+        selectmode 'browse'
+        height 3
+        
+        drop_target true
+      }
+      
+      label {
+        grid :row => 4, :column => 0
+        text "Button"
       }
       button {
+        grid :row => 4, :column => 1, :pady => 5, :sticky => "w"
         text "Drop here"
-        grid :row => 3, :column => 1, :pady => 5, :sticky => "w"
-        on_drop { |event|
-          event.target.text = event.data
-        }
+        
+        drop_target true
       }
+      
       label {
+        grid :row => 5, :column => 0
         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|
+        grid :row => 5, :column => 1, :pady => 5, :sticky => "w"
+        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
-        }
+          # execute asynchronously after 100ms to ensure all events have been processed before destruction
+          ::Tk.after(100) {event.source.destroy}
+        end
       }
     }
   }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-tk
 version: !ruby/object:Gem::Version
-  version: 0.0.42
+  version: 0.0.46
 platform: ruby
 authors:
 - AndyMaleh
@@ -38,26 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.1
-- !ruby/object:Gem::Dependency
-  name: os
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: tk
   requirement: !ruby/object:Gem::Requirement
@@ -228,10 +208,11 @@ 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/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
@@ -245,7 +226,9 @@ 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