glimmer-dsl-tk 0.0.44 → 0.0.45

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cb173f133301f49a6f4ddfc86578e450b563ff842b96274b6003b784b2e8acb
-  data.tar.gz: 810087c40f044768c6394a968b945fdc2e3c4c0d1eb8caac2b3421259c431d61
+  metadata.gz: 0a9655c46ab2b4638e96077e0795a6b7201456baf020ade27838d139797d3a44
+  data.tar.gz: dc2b2924a180df216a16161aa938b4429f814a59f18e0fba945b73eb40513bd6
 SHA512:
-  metadata.gz: 8842b20e509fd9c0f918953942665ac5a0609cbc91b0faf020c808e736890e1d2617abb579b384696711ecb0d40bf7ab82a5a0e669a1ff878bede9ed061c6abb
-  data.tar.gz: 983740e737d7e066f56411ddea5ab7ab607bf196579d519e41aea07bd4c5e8d24b2dcd178086a3d8f35aa8e6ae7b0b8995cb27e3846516887ad4908e07758847
+  metadata.gz: cab872767a730b059ebdaee18a124f0ded5e9fa0d5f980592b2c9fc9a20d756894846a4662b1f20043108987424daf6b79f895df639d1e273b66cad90f8437ae
+  data.tar.gz: 5a92bbe321b0ca538fbebc84d5e076047b2a761294f47be236f041853873c60787ce593dd142e7a5ba9671b9cdc7faaf1ca6d9f41c9a45fed1dde8cc55b5f184

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change Log
 
+## 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

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.44
+# [<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.45
 ## 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.44'
+gem 'glimmer-dsl-tk', '0.0.45'
 ```
 
 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
@@ -824,6 +828,14 @@ 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.
+- 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).
@@ -2699,27 +2711,39 @@ 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
         
+        # 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.textvariable&.value
+          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 {
+            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
+          if event.drop_accepted?
             event.source.configure(:cursor => "hand1")
           else
             event.source.configure(:cursor => "hand2")
@@ -2728,23 +2752,10 @@ 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"
@@ -2752,7 +2763,7 @@ root {
         width 27
         
         on_drag_start do |event|
-          event.data = event.source.textvariable&.value
+          event.data = event.source.text
         end
       }
       
@@ -2760,8 +2771,7 @@ root {
         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]
@@ -2769,7 +2779,7 @@ root {
         height 3
         
         on_drag_start do |event|
-          event.data = event.source.selection.to_a.first.text
+          event.data = event.source.selection.first
         end
       }
       
@@ -2777,7 +2787,6 @@ root {
         grid :row => 4, :column => 0
         text "Button"
       }
-      
       button {
         grid :row => 4, :column => 1, :pady => 5, :sticky => "w"
         text "Drag it"
@@ -2792,45 +2801,42 @@ 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
-        }
+        on_drop do |event|
+          event.target.text = event.data
+        end
       }
       
       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
+        on_drop { |event|
+          event.target.text = event.data
+        }
       }
       
       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
+          event.target.text = event.data
         end
       }
       
@@ -2838,14 +2844,13 @@ root {
         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)
+          event.target.items += [event.data]
         end
       }
       
@@ -2853,7 +2858,6 @@ root {
         grid :row => 4, :column => 0
         text "Button"
       }
-      
       button {
         grid :row => 4, :column => 1, :pady => 5, :sticky => "w"
         text "Drop here"
@@ -2867,14 +2871,14 @@ root {
         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)"
+        text "Drop here to destroy a widget"
         
         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.44
+0.0.45

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

@@ -1,3 +1,24 @@
+# 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
@@ -23,7 +44,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 +61,30 @@ 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
+              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 +103,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
@@ -91,6 +119,8 @@ module Glimmer
       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 +134,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,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 require 'glimmer/data_binding/tk/one_time_observer'
+require 'glimmer/tk/widget'
 
 module Glimmer
   module Tk
@@ -70,7 +71,8 @@ module Glimmer
       
       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
       #
@@ -288,8 +290,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 +495,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 +528,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 +547,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/samples/hello/hello_drag_and_drop.rb

@@ -35,27 +35,39 @@ 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
         
+        # 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.textvariable&.value
+          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 {
+            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
+          if event.drop_accepted?
             event.source.configure(:cursor => "hand1")
           else
             event.source.configure(:cursor => "hand2")
@@ -64,23 +76,10 @@ 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"
@@ -88,7 +87,7 @@ root {
         width 27
         
         on_drag_start do |event|
-          event.data = event.source.textvariable&.value
+          event.data = event.source.text
         end
       }
       
@@ -96,8 +95,7 @@ root {
         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]
@@ -105,7 +103,7 @@ root {
         height 3
         
         on_drag_start do |event|
-          event.data = event.source.selection.to_a.first.text
+          event.data = event.source.selection.first
         end
       }
       
@@ -113,7 +111,6 @@ root {
         grid :row => 4, :column => 0
         text "Button"
       }
-      
       button {
         grid :row => 4, :column => 1, :pady => 5, :sticky => "w"
         text "Drag it"
@@ -128,45 +125,42 @@ 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
-        }
+        on_drop do |event|
+          event.target.text = event.data
+        end
       }
       
       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
+        on_drop { |event|
+          event.target.text = event.data
+        }
       }
       
       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
+          event.target.text = event.data
         end
       }
       
@@ -174,14 +168,13 @@ root {
         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)
+          event.target.items += [event.data]
         end
       }
       
@@ -189,7 +182,6 @@ root {
         grid :row => 4, :column => 0
         text "Button"
       }
-      
       button {
         grid :row => 4, :column => 1, :pady => 5, :sticky => "w"
         text "Drop here"
@@ -203,14 +195,14 @@ root {
         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)"
+        text "Drop here to destroy a widget"
         
         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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-tk
 version: !ruby/object:Gem::Version
-  version: 0.0.44
+  version: 0.0.45
 platform: ruby
 authors:
 - AndyMaleh
@@ -212,6 +212,7 @@ files:
 - 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
@@ -225,6 +226,7 @@ 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