glimmer-dsl-tk 0.0.35 → 0.0.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daadce6a22be7ae817b7e0a3f5679a8c3d04d7ed6a0205fa30b03da206dc156a
-  data.tar.gz: f0324e91b54ac7e3179ffe122de59f714731d336d982937a92e76c6d0fd95079
+  metadata.gz: 808f3c088481b9a8feedbccfcab17a2b37046493141bcce5677871f90e28046e
+  data.tar.gz: 1f433efd48c50a6b95f61cf8bae8617c44d8bbdfe9ee8b68e4c7d0bc868e5028
 SHA512:
-  metadata.gz: 461c26dee79b7a387eddc3107f342dffe14b39d49f307ab469a49afda8112af2ad75a350f88ab64fad616e458a217570c0f3414570c195aeef884c170bff9656
-  data.tar.gz: b7b2cd0c333de05d2c923ed461147fd245d58f55a622e57f7631c049b32344b7730801e3c49e271e5a0d7e884dcb1f64981f0feb5a57300952e05f191b1537eb
+  metadata.gz: 9e0e8067624c6493dbd33bd151b885da42e04a443ef702a65abd10578c47ae22fc12f19d114ce2c345aa9bfc57c3332fa90a6ec758b7606ad62a354363b8fa27
+  data.tar.gz: c29b2b44399613bd15df154ee9986807ae121fcef57ff37448014ef36cc825fe6aa80e7ae28cee02d77cbdf15893ff82ea06390ca8e46394ccd6abffdeafb21a

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 0.0.36
+
+- Hello, Toplevel! (Custom Window and Custom Dialog)
+- Support `mac_style` attribute under `toplevel`
+- Support registering multiple general event listeners on widgets (previously, later event listener registrations replaced former ones)
+- Support `escapable true` property under `root` and `toplevel` to close on hitting ESCAPE button
+
 ## 0.0.35
 
 - Improved Meta-Sample by utilizing Ruby from `RbConfig.ruby`

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.35
+# [<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.36
 ## 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)
@@ -84,6 +84,7 @@ Other [Glimmer](https://github.com/AndyObtiva/glimmer) DSL gems:
       - [Notebook Frame](#notebook-frame)
       - [Icon Photo](#icon-photo)
       - [Root Background](#root-background)
+      - [Toplevel Mac Style](#toplevel-mac-style)
       - [Text Defaults](#text-defaults)
   - [The Grid Geometry Manager](#the-grid-geometry-manager)
   - [Data-Binding](#data-binding)
@@ -105,6 +106,7 @@ Other [Glimmer](https://github.com/AndyObtiva/glimmer) DSL gems:
     - [Hello, Radiobutton!](#hello-radiobutton)
     - [Hello, Frame!](#hello-frame)
     - [Hello, Root!](#hello-root)
+    - [Hello, Toplevel!](#hello-toplevel)
     - [Hello, Notebook!](#hello-notebook)
     - [Hello, Label!](#hello-label)
     - [Hello, Message Box!](#hello-message-box)
@@ -159,7 +161,7 @@ gem install glimmer-dsl-tk
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer-dsl-tk', '~> 0.0.35'
+gem 'glimmer-dsl-tk', '~> 0.0.36'
 ```
 
 And, then run:
@@ -479,6 +481,20 @@ root {
 
 `root` `background` color attribute is automatically set to `'#ececec'` on the Mac to avoid having a non-native-looking light-colored background.
 
+#### Toplevel Mac Style
+
+Mac has special support for mac styles in Tk `toplevel` via the `mac_style` attribute, which can receive 1 to 2 arguments. `mac_style`'s first argument (`mac_class`) and second argument (`mac_attribute_list`) can be chosen from this page:
+
+https://wiki.tcl-lang.org/page/MacWindowStyle
+
+Behind the scenes, `mac_style` automatically calls out to:
+
+```ruby
+Tk.tk_call("::tk::unsupported::MacWindowStyle", "style", tk_toplevel_widget, mac_class, mac_attribute_list)
+```
+
+More details can be found at the [Hello, Toplevel!](#hello-toplevel) sample.
+
 #### Text Defaults
 
 `text` widget has these defaults:
@@ -1333,7 +1349,7 @@ Glimmer app:
 
 ### Hello, Root!
 
-Glimmer code (from [samples/hello/hello_frame.rb](samples/hello/hello_frame.rb)):
+Glimmer code (from [samples/hello/hello_root.rb](samples/hello/hello_root.rb)):
 
 ```ruby
 require 'glimmer-dsl-tk'
@@ -1385,6 +1401,208 @@ Glimmer app:
 
 ![glimmer dsl tk screenshot sample hello root bye](images/glimmer-dsl-tk-screenshot-sample-hello-root-bye.png)
 
+### Hello, Toplevel!
+
+`toplevel` widgets represent windows nested under `root`, which can be modeless (custom windows) or modal (dialogs that take the focus away from the owning window behind them until closed).
+
+Mac has special support for mac styles in Tk `toplevel` via the `mac_style` attribute, which can receive 1 to 2 arguments. `mac_style`'s first argument (`mac_class`) and second argument (`mac_attribute_list`) can be chosen from this page:
+
+https://wiki.tcl-lang.org/page/MacWindowStyle
+
+Glimmer code (from [samples/hello/hello_toplevel.rb](samples/hello/hello_toplevel.rb)):
+
+```ruby
+require 'glimmer-dsl-tk'
+
+include Glimmer
+
+def toplevel_content
+  frame {
+    label {
+      text "This is a fully custom toplevel, meaning you can add any widgets here!\nYou can press the ESCAPE button on the keyboard to close."
+    }
+    separator
+    checkbutton {
+      text 'This is a checkbutton'
+    }
+    radiobutton {
+      text 'This is a radiobutton'
+    }
+  }
+end
+
+root { |root_window|
+  title 'Hello, Toplevel!'
+  
+  button {
+    text 'Nested Window'
+    
+    on('command') do
+      toplevel(root_window) {
+        title 'Custom Window'
+        escapable true
+        x 150
+        y 180
+        width 500
+        height 200
+        minsize 500, 100
+        maxsize 1000, 300
+          
+        toplevel_content
+      }
+    end
+  }
+  
+  button {
+    text 'Transparent Window'
+    
+    on('command') do
+      toplevel(root_window) {
+        title 'Transparent Window'
+        escapable true
+        alpha 0.85
+        width 250
+        height 100
+        resizable false, false # not resizable horizontally or vertically
+          
+        frame {
+          label {
+            text "This is a transparent window\nYou can hit ESCAPE to close."
+            anchor 'center'
+          }
+        }
+      }
+    end
+  }
+  
+  button {
+    text 'Fullscreen Window'
+    
+    on('command') do
+      toplevel(root_window) {
+        title 'Fullscreen Window'
+        escapable true
+        fullscreen true
+          
+        frame {
+          label {
+            text "This is a fullscreen window\nYou can hit ESCAPE to close."
+            anchor 'center'
+          }
+        }
+      }
+    end
+  }
+  
+  if OS.mac?
+    # Mac has special support for mac styles in Tk `toplevel`
+    # `mac_style` first argument (`mac_class`) and second argument (`mac_attribute_list`) can be chosen from this page: https://wiki.tcl-lang.org/page/MacWindowStyle
+    
+    button {
+      text 'Mac Plain (No-Button-Modeless) Window'
+      
+      on('command') do
+        toplevel(root_window) { |t|
+          title 'Mac Plain (No-Button-Modeless) Window'
+          escapable true
+          mac_style 'plain'
+          
+          toplevel_content
+        }
+      end
+    }
+    
+    button {
+      text 'Mac Floating (Close-Button-Modeless) Window'
+      
+      on('command') do
+        toplevel(root_window) { |t|
+          title 'Mac Floating (Close-Button-Modeless) Window'
+          escapable true
+          mac_style 'floating'
+          
+          toplevel_content
+        }
+      end
+    }
+    
+    button {
+      text 'Mac Document (All-Button-Modeless) Window'
+      
+      on('command') do
+        toplevel(root_window) { |t|
+          title 'Mac Document (All-Button-Modeless) Window'
+          escapable true
+          mac_style 'document'
+          
+          toplevel_content
+        }
+      end
+    }
+    
+    button {
+      text 'Mac Utility (Close-Button-Modal) Dialog'
+      
+      on('command') do
+        toplevel(root_window) { |t|
+          title 'Mac Utility (Close-Button-Modal) Dialog'
+          escapable true
+          mac_style 'utility'
+          
+          toplevel_content
+        }
+      end
+    }
+    
+    button {
+      text 'Mac Utility with Attribute List (All-Button-Modal) Dialog'
+      
+      on('command') do
+        toplevel(root_window) { |t|
+          title 'Mac Utility with Attribute List (All-Button-Modal) Dialog'
+          escapable true
+          mac_style 'utility', 'closeBox collapseBox resizable horizontalZoom verticalZoom sideTitlebar'
+          
+          toplevel_content
+        }
+      end
+    }
+  end
+}.open
+```
+
+Run with [glimmer-dsl-tk](https://rubygems.org/gems/glimmer-dsl-tk) gem installed:
+
+```
+ruby -r glimmer-dsl-tk -e "require 'samples/hello/hello_toplevel'"
+```
+
+Alternatively, run from cloned project without [glimmer-dsl-tk](https://rubygems.org/gems/glimmer-dsl-tk) gem installed:
+
+```
+ruby -r ./lib/glimmer-dsl-tk.rb samples/hello/hello_toplevel.rb
+```
+
+Glimmer app:
+
+![glimmer dsl tk screenshot sample hello toplevel 1](images/glimmer-dsl-tk-screenshot-sample-hello-toplevel.png)
+
+![glimmer dsl tk screenshot sample hello toplevel 2](images/glimmer-dsl-tk-screenshot-sample-hello-toplevel-custom-window.png)
+
+![glimmer dsl tk screenshot sample hello toplevel 3](images/glimmer-dsl-tk-screenshot-sample-hello-toplevel-transparent-window.png)
+
+![glimmer dsl tk screenshot sample hello toplevel 4](images/glimmer-dsl-tk-screenshot-sample-hello-toplevel-fullscreen-window.png)
+
+![glimmer dsl tk screenshot sample hello toplevel 5](images/glimmer-dsl-tk-screenshot-sample-hello-toplevel-mac-plain-window.png)
+
+![glimmer dsl tk screenshot sample hello toplevel 6](images/glimmer-dsl-tk-screenshot-sample-hello-toplevel-mac-floating-window.png)
+
+![glimmer dsl tk screenshot sample hello toplevel 7](images/glimmer-dsl-tk-screenshot-sample-hello-toplevel-mac-document-window.png)
+
+![glimmer dsl tk screenshot sample hello toplevel 8](images/glimmer-dsl-tk-screenshot-sample-hello-toplevel-mac-utility-window.png)
+
+![glimmer dsl tk screenshot sample hello toplevel 9](images/glimmer-dsl-tk-screenshot-sample-hello-toplevel-mac-utility-with-attribute-list-window.png)
+
 ### Hello, Notebook!
 
 Glimmer code (from [samples/hello/hello_notebook.rb](samples/hello/hello_notebook.rb)):

data/VERSION

@@ -1 +1 @@
-0.0.35
+0.0.36

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

@@ -33,7 +33,7 @@ module Glimmer
   
         def can_interpret?(parent, keyword, *args, &block)
           !EXCLUDED_KEYWORDS.include?(keyword) and
-            Glimmer::Tk::WidgetProxy.widget_exists?(keyword)
+            Glimmer::Tk::WidgetProxy.widget_exists?(keyword) and
             (parent.respond_to?(:tk) or args.first.respond_to?(:tk))
         end
   

data/lib/glimmer/tk/root_proxy.rb

@@ -36,6 +36,7 @@ module Glimmer
 
       def post_add_content
         set_attribute('iconphoto', File.expand_path('../../../icons/glimmer.png', __dir__)) if @tk.iconphoto.nil?
+        super
       end
       
       def open

data/lib/glimmer/tk/text_proxy.rb

@@ -432,16 +432,11 @@ module Glimmer
         self.wrap = 'none'
         self.padx = 5
         self.pady = 5
-#         on('Modified') { apply_all_tag }
       end
       
       def clone_font(font)
         ::TkFont.new(Hash[font.actual])
       end
-      
-#       def apply_all_tag
-#         @tk.tag_add(ALL_TAG, '1.0', 'end')
-#       end
     end
   end
 end

data/lib/glimmer/tk/toplevel_proxy.rb

@@ -32,6 +32,19 @@ module Glimmer
       DEFAULT_HEIGHT = 95
       
       attr_reader :tk
+      attr_accessor :escapable
+      alias escapable? escapable
+      
+      def post_add_content
+        if escapable?
+           on('KeyPress') do |event|
+            if event.keysym == 'Escape'
+              grab_release
+              destroy
+            end
+          end
+        end
+      end
       
       def has_attribute?(attribute, *args)
         %w[width height x y].include?(attribute.to_s) || super
@@ -114,6 +127,17 @@ module Glimmer
           destroy
         end
       end
+      
+      def mac_style=(mac_class, mac_attribute_list = nil)
+        if OS.mac?
+          @mac_style = [mac_class, mac_attribute_list]
+          ::Tk.tk_call("::tk::unsupported::MacWindowStyle", "style", @tk, *@mac_style.compact)
+        end
+      end
+      
+      def mac_style
+        @mac_style
+      end
     end
   end
 end

data/lib/glimmer/tk/widget_proxy.rb

@@ -460,14 +460,20 @@ module Glimmer
           parent_proxy.handle_listener(listener_name, &listener) if parent_proxy
           # TODO return a listener registration object that has a deregister method
         else
+          @listeners ||= {}
           begin
-            @tk.bind(listener_name, &listener)
+            @listeners[listener_name] ||= []
+            @tk.bind(listener_name) { |event| @listeners[listener_name].each {|l| l.call(event)} } if @listeners[listener_name].empty?
+            @listeners[listener_name] << listener
           rescue => e
+            @listeners.delete(listener_name)
             Glimmer::Config.logger.debug {"Unable to bind to #{listener_name} .. attempting to surround with <>"}
             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)
+            @listeners[listener_name] ||= []
+            @tk.bind(listener_name) { |event| @listeners[listener_name].each {|l| l.call(event)} } if @listeners[listener_name].empty?
+            @listeners[listener_name] << listener
           end
         end
       end

data/samples/hello/hello_checkbutton.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020-2021 Andy Maleh
+`# 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

data/samples/hello/hello_toplevel.rb

@@ -0,0 +1,178 @@
+# 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-dsl-tk'
+
+include Glimmer
+
+def toplevel_content
+  frame {
+    label {
+      text "This is a fully custom toplevel, meaning you can add any widgets here!\nYou can press the ESCAPE button on the keyboard to close."
+    }
+    separator
+    checkbutton {
+      text 'This is a checkbutton'
+    }
+    radiobutton {
+      text 'This is a radiobutton'
+    }
+  }
+end
+
+root { |root_window|
+  title 'Hello, Toplevel!'
+  
+  button {
+    text 'Nested Window'
+    
+    on('command') do
+      toplevel(root_window) {
+        title 'Custom Window'
+        escapable true
+        x 150
+        y 180
+        width 500
+        height 200
+        minsize 500, 100
+        maxsize 1000, 300
+          
+        toplevel_content
+      }
+    end
+  }
+  
+  button {
+    text 'Transparent Window'
+    
+    on('command') do
+      toplevel(root_window) {
+        title 'Transparent Window'
+        escapable true
+        alpha 0.85
+        width 250
+        height 100
+        resizable false, false # not resizable horizontally or vertically
+          
+        frame {
+          label {
+            text "This is a transparent window\nYou can hit ESCAPE to close."
+            anchor 'center'
+          }
+        }
+      }
+    end
+  }
+  
+  button {
+    text 'Fullscreen Window'
+    
+    on('command') do
+      toplevel(root_window) {
+        title 'Fullscreen Window'
+        escapable true
+        fullscreen true
+          
+        frame {
+          label {
+            text "This is a fullscreen window\nYou can hit ESCAPE to close."
+            anchor 'center'
+          }
+        }
+      }
+    end
+  }
+  
+  if OS.mac?
+    # Mac has special support for mac styles in Tk `toplevel`
+    # `mac_style` first argument (`mac_class`) and second argument (`mac_attribute_list`) can be chosen from this page: https://wiki.tcl-lang.org/page/MacWindowStyle
+    
+    button {
+      text 'Mac Plain (No-Button-Modeless) Window'
+      
+      on('command') do
+        toplevel(root_window) { |t|
+          title 'Mac Plain (No-Button-Modeless) Window'
+          escapable true
+          mac_style 'plain'
+          
+          toplevel_content
+        }
+      end
+    }
+    
+    button {
+      text 'Mac Floating (Close-Button-Modeless) Window'
+      
+      on('command') do
+        toplevel(root_window) { |t|
+          title 'Mac Floating (Close-Button-Modeless) Window'
+          escapable true
+          mac_style 'floating'
+          
+          toplevel_content
+        }
+      end
+    }
+    
+    button {
+      text 'Mac Document (All-Button-Modeless) Window'
+      
+      on('command') do
+        toplevel(root_window) { |t|
+          title 'Mac Document (All-Button-Modeless) Window'
+          escapable true
+          mac_style 'document'
+          
+          toplevel_content
+        }
+      end
+    }
+    
+    button {
+      text 'Mac Utility (Close-Button-Modal) Dialog'
+      
+      on('command') do
+        toplevel(root_window) { |t|
+          title 'Mac Utility (Close-Button-Modal) Dialog'
+          escapable true
+          mac_style 'utility'
+          
+          toplevel_content
+        }
+      end
+    }
+    
+    button {
+      text 'Mac Utility with Attribute List (All-Button-Modal) Dialog'
+      
+      on('command') do
+        toplevel(root_window) { |t|
+          title 'Mac Utility with Attribute List (All-Button-Modal) Dialog'
+          escapable true
+          mac_style 'utility', 'closeBox collapseBox resizable horizontalZoom verticalZoom sideTitlebar'
+          
+          toplevel_content
+        }
+      end
+    }
+  end
+}.open

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-tk
 version: !ruby/object:Gem::Version
-  version: 0.0.35
+  version: 0.0.36
 platform: ruby
 authors:
 - AndyMaleh
@@ -265,6 +265,7 @@ files:
 - samples/hello/hello_separator.rb
 - samples/hello/hello_spinbox.rb
 - samples/hello/hello_text.rb
+- samples/hello/hello_toplevel.rb
 - samples/hello/hello_world.rb
 - samples/hello/images/align-center.png
 - samples/hello/images/align-left.png