glimmer-dsl-tk 0.0.20 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b35ad7e7ce829ab16c8ded93da64a71120483982e1799afddf538ff0726d686
-  data.tar.gz: 6a5eec2b8c52f7df03d1f324780cc3b209b2969fe04ab64dc33efc8a1b3d05e7
+  metadata.gz: 49a3f4e1f560a01173a20fa1a13fc62f107445c63cad77f353b3b7a9765433c3
+  data.tar.gz: 70decda6f2e3a73a24916b2e9d0685ff386fc4fe29b89fff3b4188fab830f21b
 SHA512:
-  metadata.gz: 3b462e07684dc68a0c15096ea80cd5a516ac9332a1ba21f2235e85b5343b174561446d62633aa2dfc280557ff01531872fd3a033aafc1bf0eec6386b8b4d9901
-  data.tar.gz: 79dba86d404165e841ad94d034799bf3ba10e52fc286bdaa2af3d85b80d0ada8a075396f229e2de498fcea61274722cb8dacd762e68fb7243a9754b57e6221fe
+  metadata.gz: 7f9b8ee1544898bcb7031eacaf4ebb532ab113ac5852b6606bf247a05e27937b5d22c87833b5947527e6b525d83e2eb5714a42f1cf8f754bf7513d59eaf19ff4
+  data.tar.gz: 479e321c66646a97bd5fee7e6844e4b7a862ec88b2ba25697a9f8e1ac231717297258576b4b88facab135094bff30b2a507bd6b1a624fb0288f163ca5dff54c9

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## 0.0.21
+
+- Support event bindings via `on(event) {}` syntax nestable under any widget
+- Support `root` event binding: `'WM_DELETE_WINDOW'` and alias `'DELETE_WINDOW'`
+- Support `root` event binding: `'OPEN_WINDOW'`
+- Support `root` attribute: `background` (any color including `systemTransparent`)
+- Support `root` boolean attribute: `alpha`
+- Support `root` boolean attributes: `fullscreen`, `topmost`, `transparent`
+- Support `root` attributes: `stackorder`, `winfo_screendepth`, `winfo_screenvisual`, `winfo_screenwidth`, `winfo_screenheight`, `winfo_pixels('li')`, `winfo_screen`, `wm_maxsize`
+- Support `root` attribute: `state` (`'normal', 'iconic', 'withdrawn', 'icon', 'zoomed'`)
+
 ## 0.0.20
 
 - Hello, Root! sample

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.20
+# [<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.21
 ## 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)
@@ -120,7 +120,7 @@ Other [Glimmer](https://github.com/AndyObtiva/glimmer) DSL gems:
 For example, on the Mac, you can:
 - Install the ActiveTcl Mac package from [ActiveState.com](https://activestate.com)
 - Install [RVM](https://rvm.io/) by running `\curl -sSL https://get.rvm.io | bash -s stable` (and run `curl -sSL https://rvm.io/pkuczynski.asc | gpg --import -` if needed for mentioned security reasons)
-- Run: `rvm install 2.7.1 --enable-shared --enable-pthread --with-tk --with-tcl`
+- Run: `rvm install 3.0.2 --enable-shared --enable-pthread --with-tk --with-tcl`
 - Run: `gem install tk -v0.4.0`
 
 Afterwards, if you open `irb`, you should be able to run `require 'tk'` successfully.
@@ -138,7 +138,7 @@ gem install glimmer-dsl-tk
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer-dsl-tk', '~> 0.0.20'
+gem 'glimmer-dsl-tk', '~> 0.0.21'
 ```
 
 And, then run:
@@ -180,6 +180,7 @@ The Glimmer GUI DSL follows these simple concepts in mapping from Tk syntax:
 - **Widget Keyword**: Any Tk widget (e.g. `Tk::Tile::Label`) or toplevel window (e.g. `TkRoot`) may be declared by its lower-case underscored name without the namespace (e.g. `label` or `root`). This is called a keyword and is represented in the Glimmer GUI DSL by a Ruby method behind the scenes.
 - **Args**: Any keyword method may optionally take arguments surrounded by parentheses (e.g. a `frame` nested under a `notebook` may receive tab options like `frame(text: 'Users')`, which gets used behind the scenes by Tk code such as `notebook.add tab, text: 'Users'`)
 - **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`). No need to surround event by `<>` as [Glimmer DSL for Tk](https://rubygems.org/gems/glimmer-dsl-tk) takes care of that automatically.
 
 Example of an app written in [Tk](https://www.tcl.tk/) imperative syntax:
 
@@ -199,6 +200,15 @@ notebook.add tab2, text: 'French'
 label2 = ::Tk::Tile::Label.new(tab2).grid
 label2.text = 'Bonjour, Univers!'
 
+root.bind('KeyPress') do |event|
+  case event.keysym
+  when 'e', 'E'
+    notebook.select(0)
+  when 'f', 'F'
+    notebook.select(1)
+  end
+end
+
 root.mainloop
 ```
 
@@ -208,7 +218,7 @@ Example of the same app written in [Glimmer](https://github.com/AndyObtiva/glimm
 root {
   title 'Hello, Notebook!'
    
-  notebook {
+  @notebook = notebook {
     frame(text: 'English') {
       label {
         text 'Hello, World!'
@@ -221,6 +231,15 @@ root {
       }
     }
   }
+  
+  on('KeyPress') do |event|
+    case event.keysym
+    when 'e', 'E'
+      @notebook.select(0)
+    when 'f', 'F'
+      @notebook.select(1)
+    end
+  end
 }.open
 ```
 
@@ -228,19 +247,51 @@ root {
 
 keyword(args) | attributes | event bindings & callbacks
 ------------- | ---------- | ---------
-`button` | `text`, `image` (optional keyword args: `subsample`, `zoom`, `from`, `to`, `shrink`, `compositingrule`), `compound` (`'center', 'top', 'bottom', 'left', 'right'`), `default` (`'active', 'normal'`) | `command`
+`button` | `text`, `image` (optional keyword args: `subsample`, `zoom`, `from`, `to`, `shrink`, `compositingrule`), `compound` (`'center', 'top', 'bottom', 'left', 'right'`), `default` (`'active', 'normal'`) | `command {}`
+`combobox` | `state`, `text` | `'ComboboxSelected'`
 `entry` | `width`, `text` | None
 `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
 `list` | `selectmode`, `selection` | None
 `message_box(type: , message: , detail: , title: , icon: , default: , parent: )` | None | None
 `notebook` | None | None
-`root` | `title`, `iconphoto` | None
+`root` | `title`, `iconphoto`, `background`, `alpha`, `fullscreen?`, `topmost?`, `transparent?`, `stackorder`, `winfo_screendepth`, `winfo_screenvisual`, `winfo_screenwidth`, `winfo_screenheight`, `winfo_pixels('li')`, `winfo_screen`, `wm_maxsize`, `state` (`'normal', 'iconic', 'withdrawn', 'icon', 'zoomed'`) | `'DELETE_WINDOW'`, `'OPEN_WINDOW'`
 
 #### Common Attributes
 
 - `grid`: `Hash` of `:row`, `:column`, `:padx`, `:pady`, `:sticky` (`'e', 'w', 'n', 's'` or any combination of direction letters)
 
+#### Common Event Bindings
+
+- `Activate`
+- `Deactivate`
+- `MouseWheel`
+- `KeyPress`
+- `KeyRelease`
+- `ButtonPress`
+- `ButtonRelease`
+- `Motion`
+- `Configure`
+- `Map`
+- `Unmap`
+- `Visibility`
+- `Expose`
+- `Destroy`
+- `FocusIn`
+- `FocusOut`
+- `Enter`
+- `Leave`
+- `Property`
+- `Colormap`
+- `MapRequest`
+- `CirculateRequest`
+- `ResizeRequest`
+- `ConfigureRequest`
+- `Create`
+- `Gravity`
+- `Reparent`
+- `Circulate`
+
 #### Common Themed Widget States
 
 - `active?`
@@ -256,6 +307,10 @@ keyword(args) | attributes | event bindings & callbacks
 
 ### Smart Defaults and Convensions
 
+#### Event Bindings
+
+Any events that normally can be accepted by the Tk `bind` or `protocol` methods can be accepted by the `on(event) {}` listener syntax. There is no need to surround event name by `<>` as [Glimmer DSL for Tk](https://rubygems.org/gems/glimmer-dsl-tk) automatically takes care of that when needed and leaves out when not needed.
+
 #### Grid Layout
 
 `grid` layout is the default on most widgets (which support it).
@@ -655,15 +710,28 @@ require 'glimmer-dsl-tk'
 
 include Glimmer
 
-root {
+root { |r|
   title 'Hello, Root!'
+  iconphoto File.expand_path('../../icons/glimmer.png', __dir__)
   width 400
   height 200
-  x 150
+  x -150
   y 300
   resizable true # same as `resizable true, true`, meaning cannot resize horizontally and vertically
   minsize 200, 100
   maxsize 600, 400
+  background 'lightgrey'
+  alpha 0.85 # on the mac, you can set `transparent true` as well
+  topmost true
+  
+  on('OPEN_WINDOW') do # custom event that runs right after Tk.mainloop
+    message_box(parent: r, title: 'Hi', message: 'Hi')
+  end
+  
+  on('DELETE_WINDOW') do |event| # alias for WM_DELETE_WINDOW protocol event
+    message_box(parent: r, title: 'Bye', message: 'Bye')
+    exit(0)
+  end
 }.open
 ```
 
@@ -679,6 +747,14 @@ Alternatively, run from cloned project without [glimmer-dsl-tk](https://rubygems
 ruby -r ./lib/glimmer-dsl-tk.rb ./samples/hello/hello_root.rb
 ```
 
+Glimmer app:
+
+![glimmer dsl tk screenshot sample hello root hi](images/glimmer-dsl-tk-screenshot-sample-hello-root-hi.png)
+
+![glimmer dsl tk screenshot sample hello root](images/glimmer-dsl-tk-screenshot-sample-hello-root.png)
+
+![glimmer dsl tk screenshot sample hello root bye](images/glimmer-dsl-tk-screenshot-sample-hello-root-bye.png)
+
 ### Hello, Notebook!
 
 Glimmer code (from [samples/hello/hello_notebook.rb](samples/hello/hello_notebook.rb)):

data/VERSION

@@ -1 +1 @@
-0.0.20
+0.0.21

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

@@ -0,0 +1,35 @@
+# Copyright (c) 2021 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'glimmer/dsl/static_expression'
+require 'glimmer/tk/widget_proxy'
+
+module Glimmer
+  module DSL
+    module Tk
+      class OnExpression < StaticExpression
+        def interpret(parent, keyword, *args, &block)
+          parent.handle_listener(args.first, &block)
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/tk/root_proxy.rb

@@ -126,8 +126,28 @@ module Glimmer
         set_attribute(:y, value)
       end
       
+      def handle_listener(listener_name, &listener)
+        case listener_name.to_s
+        when 'WM_DELETE_WINDOW', 'DELETE_WINDOW'
+          listener_name = 'WM_DELETE_WINDOW'
+          @tk.protocol(listener_name, &listener)
+        when 'WM_OPEN_WINDOW', 'OPEN_WINDOW'
+          @on_open_window_procs ||= []
+          @on_open_window_procs << listener
+        else
+          super
+        end
+      end
+      
       # Starts Tk mainloop
       def start_event_loop
+        if @on_open_window_procs.to_a.any?
+          ::Tk.after(100) do # ensure root window showed up first
+            @on_open_window_procs.to_a.each do |on_open_window|
+              ::Tk.after(0, on_open_window)
+            end
+          end
+        end
         ::Tk.mainloop
       end
       

data/lib/glimmer/tk/widget_proxy.rb

@@ -140,11 +140,17 @@ module Glimmer
         end
       end
       
+      def has_attributes_attribute?(attribute)
+        attribute = attribute.sub(/\?$/, '').sub(/=$/, '')
+        @tk.respond_to?(:attributes) && @tk.attributes.keys.include?(attribute.to_s)
+      end
+      
       def has_attribute?(attribute, *args)
         (widget_custom_attribute_mapping[tk.class] and widget_custom_attribute_mapping[tk.class][attribute.to_s]) or
           tk_widget_has_attribute_setter?(attribute) or
           tk_widget_has_attribute_getter_setter?(attribute) or
           has_state?(attribute) or
+          has_attributes_attribute?(attribute) or
           respond_to?(attribute_setter(attribute), args)
       end
 
@@ -169,6 +175,9 @@ module Glimmer
           else
             @tk.tile_state("!#{attribute}")
           end
+        elsif has_attributes_attribute?(attribute)
+          attribute = attribute.sub(/=$/, '')
+          @tk.attributes(attribute, args.first)
         else
           send(attribute_setter(attribute), args)
         end
@@ -182,6 +191,10 @@ module Glimmer
           @tk.send(attribute)
         elsif has_state?(attribute)
           @tk.tile_instate(attribute.sub(/\?$/, ''))
+        elsif has_attributes_attribute?(attribute)
+          result = @tk.attributes[attribute.sub(/\?$/, '')]
+          result = result == 1 if result.is_a?(Integer)
+          result
         else
           send(attribute)
         end
@@ -277,16 +290,28 @@ module Glimmer
         widget_listener_installers = attribute_listener_installers.map{|installer| installer[attribute.to_s]}.compact if !attribute_listener_installers.empty?
         widget_listener_installers.to_a.first&.call(observer)
       end
-
+      
+      def handle_listener(listener_name, &listener)
+        listener_name = listener_name.to_s
+        begin
+          @tk.bind(listener_name, &listener)
+        rescue => e
+          Glimmer::Config.logger.debug {e.full_message}
+          listener_name = "<#{listener_name}" if !listener_name.start_with?('<')
+          listener_name = "#{listener_name}>" if !listener_name.end_with?('>')
+          @tk.bind(listener_name, &listener)
+        end
+      end
+      
       def content(&block)
         Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Tk::WidgetExpression.new, keyword, *args, &block)
       end
 
       def method_missing(method, *args, &block)
         method = method.to_s
-        if args.empty? && block.nil? && ((widget_custom_attribute_mapping[tk.class] && widget_custom_attribute_mapping[tk.class][method]) || has_state?(method))
+        if args.empty? && block.nil? && ((widget_custom_attribute_mapping[tk.class] && widget_custom_attribute_mapping[tk.class][method]) || has_state?(method) || has_attributes_attribute?(method))
           get_attribute(method)
-        elsif method.end_with?('=') && block.nil? && ((widget_custom_attribute_mapping[tk.class] && widget_custom_attribute_mapping[tk.class][method.sub(/=$/, '')]) || has_state?(method))
+        elsif method.end_with?('=') && block.nil? && ((widget_custom_attribute_mapping[tk.class] && widget_custom_attribute_mapping[tk.class][method.sub(/=$/, '')]) || has_state?(method) || has_attributes_attribute?(method))
           set_attribute(method.sub(/=$/, ''), *args)
         else
           tk.send(method, *args, &block)

data/samples/hello/hello_notebook.rb

@@ -27,7 +27,7 @@ class HelloNotebook
   def launch
     root {
       title 'Hello, Notebook!'
-       
+      
       notebook {
         frame(text: 'English') {
           label {

data/samples/hello/hello_root.rb

@@ -23,13 +23,26 @@ require 'glimmer-dsl-tk'
 
 include Glimmer
 
-root {
+root { |r|
   title 'Hello, Root!'
+  iconphoto File.expand_path('../../icons/glimmer.png', __dir__)
   width 400
   height 200
-  x 150
+  x -150
   y 300
   resizable true # same as `resizable true, true`, meaning cannot resize horizontally and vertically
   minsize 200, 100
   maxsize 600, 400
+  background 'lightgrey'
+  alpha 0.85 # on the mac, you can set `transparent true` as well
+  topmost true
+  
+  on('OPEN_WINDOW') do # custom event that runs right after Tk.mainloop
+    message_box(parent: r, title: 'Hi', message: 'Hi')
+  end
+  
+  on('DELETE_WINDOW') do |event| # alias for WM_DELETE_WINDOW protocol event
+    message_box(parent: r, title: 'Bye', message: 'Bye')
+    exit(0)
+  end
 }.open

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-tk
 version: !ruby/object:Gem::Version
-  version: 0.0.20
+  version: 0.0.21
 platform: ruby
 authors:
 - AndyMaleh
@@ -198,6 +198,7 @@ files:
 - lib/glimmer/dsl/tk/dsl.rb
 - lib/glimmer/dsl/tk/list_selection_data_binding_expression.rb
 - lib/glimmer/dsl/tk/message_box_expression.rb
+- lib/glimmer/dsl/tk/on_expression.rb
 - lib/glimmer/dsl/tk/root_expression.rb
 - lib/glimmer/dsl/tk/shine_data_binding_expression.rb
 - lib/glimmer/dsl/tk/widget_expression.rb