glimmer-dsl-tk 0.0.45 → 0.0.46

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a9655c46ab2b4638e96077e0795a6b7201456baf020ade27838d139797d3a44
-  data.tar.gz: dc2b2924a180df216a16161aa938b4429f814a59f18e0fba945b73eb40513bd6
+  metadata.gz: 5313d90447c3c864cdbc16c6704c6bcb07fc2b8adcd51f136d92762be919327e
+  data.tar.gz: e4e48e9330f79b4a5c677651336560805485d6d0b036fc7c248f3b0a338e0f82
 SHA512:
-  metadata.gz: cab872767a730b059ebdaee18a124f0ded5e9fa0d5f980592b2c9fc9a20d756894846a4662b1f20043108987424daf6b79f895df639d1e273b66cad90f8437ae
-  data.tar.gz: 5a92bbe321b0ca538fbebc84d5e076047b2a761294f47be236f041853873c60787ce593dd142e7a5ba9671b9cdc7faaf1ca6d9f41c9a45fed1dde8cc55b5f184
+  metadata.gz: 41b3096f2f320ae2bd277b71f4f98ca8ba0f43e05d50eba9adc1a200106d698c17a67bee78082e2f62cb1179d2185df0765e1e9b4a83fc4de15d367a4701e83d
+  data.tar.gz: 74761ae2d6f037d7c237d47da581ff2be8bf5f2c2c6e96a9656b900b5bc19ea39442afc14b16b9d2f5ac5ff370887973262b0d2cc8223a2fa7080972a63c564d

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # 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`)

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.45
+# [<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)
@@ -182,7 +182,7 @@ gem install glimmer-dsl-tk
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer-dsl-tk', '0.0.45'
+gem 'glimmer-dsl-tk', '0.0.46'
 ```
 
 And, then run:
@@ -480,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_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 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`
 
-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.
+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.
+
+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.
 
@@ -834,6 +843,9 @@ More details can be found in the [Hello, Button!](#hello-button) sample below.
 - 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
@@ -1038,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
         }
       }
         
@@ -1060,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
         }
       }
       
@@ -1077,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
       }
@@ -2729,11 +2741,12 @@ root {
         text "Drag entry text"
         width 30
         
+        # 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")
-          event.tooltip.content {
+          event.tooltip.content { # re-open tooltip content and add a label
             lbl { # non-tile-theme version of label
               text event.data + " "
               bg "yellow"
@@ -2762,9 +2775,7 @@ root {
         values %w[USA Canada Mexico Columbia UK Australia Germany Italy Spain]
         width 27
         
-        on_drag_start do |event|
-          event.data = event.source.text
-        end
+        drag_source true
       }
       
       label {
@@ -2778,6 +2789,8 @@ root {
         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
@@ -2809,9 +2822,7 @@ root {
         borderwidth 2
         relief "solid"
         
-        on_drop do |event|
-          event.target.text = event.data
-        end
+        drop_target true
       }
       
       label {
@@ -2822,9 +2833,7 @@ root {
         grid :row => 1, :column => 1, :pady => 5, :sticky => "e"
         width 30
         
-        on_drop { |event|
-          event.target.text = event.data
-        }
+        drop_target true
       }
       
       label {
@@ -2835,9 +2844,7 @@ root {
         grid :row => 2, :column => 1, :pady => 5, :sticky => "e"
         width 27
         
-        on_drop do |event|
-          event.target.text = event.data
-        end
+        drop_target true
       }
       
       label {
@@ -2849,9 +2856,7 @@ root {
         selectmode 'browse'
         height 3
         
-        on_drop do |event|
-          event.target.items += [event.data]
-        end
+        drop_target true
       }
       
       label {
@@ -2862,9 +2867,7 @@ root {
         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 {
@@ -2874,7 +2877,9 @@ root {
       checkbutton {
         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
           # execute asynchronously after 100ms to ensure all events have been processed before destruction

data/VERSION

@@ -1 +1 @@
-0.0.45
+0.0.46

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

@@ -23,8 +23,21 @@ 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
@@ -35,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
@@ -68,7 +90,13 @@ module Glimmer
             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
+              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
@@ -118,6 +146,20 @@ 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
         

data/lib/glimmer/tk/widget_proxy.rb

@@ -21,6 +21,7 @@
 
 require 'glimmer/data_binding/tk/one_time_observer'
 require 'glimmer/tk/widget'
+require 'glimmer/tk/draggable_and_droppable'
 
 module Glimmer
   module Tk
@@ -69,6 +70,8 @@ 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, :bind_ids, :destroyed
@@ -155,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
@@ -170,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

data/lib/glimmer-dsl-tk.rb

@@ -39,7 +39,6 @@ require 'delegate'
 # require 'ext/glimmer/config'
 # require 'ext/glimmer'
 require 'glimmer/dsl/tk/dsl'
-require 'glimmer/tk/drag_and_drop_extension'
 
 Glimmer::Config.loop_max_count = -1
 

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

@@ -53,11 +53,12 @@ root {
         text "Drag entry text"
         width 30
         
+        # drag_source true
         # This is how to do `drag_source true` the manual way for use in exceptional cases
-        on_drag_start do |event|
+        on('drag_start') do |event|
           event.data = event.source.text
           event.source.configure(:cursor => "hand2")
-          event.tooltip.content {
+          event.tooltip.content { # re-open tooltip content and add a label
             lbl { # non-tile-theme version of label
               text event.data + " "
               bg "yellow"
@@ -66,7 +67,7 @@ root {
             }
           }
         end
-        on_drag_motion do |event|
+        on('drag_motion') do |event|
           if event.drop_accepted?
             event.source.configure(:cursor => "hand1")
           else
@@ -86,9 +87,7 @@ root {
         values %w[USA Canada Mexico Columbia UK Australia Germany Italy Spain]
         width 27
         
-        on_drag_start do |event|
-          event.data = event.source.text
-        end
+        drag_source true
       }
       
       label {
@@ -102,7 +101,9 @@ root {
         selection 'Canada'
         height 3
         
-        on_drag_start do |event|
+        # 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
       }
@@ -133,9 +134,7 @@ root {
         borderwidth 2
         relief "solid"
         
-        on_drop do |event|
-          event.target.text = event.data
-        end
+        drop_target true
       }
       
       label {
@@ -146,9 +145,7 @@ root {
         grid :row => 1, :column => 1, :pady => 5, :sticky => "e"
         width 30
         
-        on_drop { |event|
-          event.target.text = event.data
-        }
+        drop_target true
       }
       
       label {
@@ -159,9 +156,7 @@ root {
         grid :row => 2, :column => 1, :pady => 5, :sticky => "e"
         width 27
         
-        on_drop do |event|
-          event.target.text = event.data
-        end
+        drop_target true
       }
       
       label {
@@ -173,9 +168,7 @@ root {
         selectmode 'browse'
         height 3
         
-        on_drop do |event|
-          event.target.items += [event.data]
-        end
+        drop_target true
       }
       
       label {
@@ -186,9 +179,7 @@ root {
         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 {
@@ -198,8 +189,10 @@ root {
       checkbutton {
         grid :row => 5, :column => 1, :pady => 5, :sticky => "w"
         text "Drop here to destroy a widget"
-        
-        on_drop do |event|
+
+        # 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
           # execute asynchronously after 100ms to ensure all events have been processed before destruction
           ::Tk.after(100) {event.source.destroy}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-tk
 version: !ruby/object:Gem::Version
-  version: 0.0.45
+  version: 0.0.46
 platform: ruby
 authors:
 - AndyMaleh
@@ -208,7 +208,7 @@ 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