glimmer-dsl-tk 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21a6a1f1d2d85928c9bac3b9fd14ce7d8ca39f1ddec7ad82b8bafa733a0e4caa
-  data.tar.gz: 3d3acdb3c53c63d45a54188e956fedc8fa010dadaa3b3edb697f4b5f23a85126
+  metadata.gz: fa03163d6b0577d65e67d245b810079da4ddd6aca50cde649963e9448defe1ee
+  data.tar.gz: 3d2cadbe0dff5e003ada1938a461785b11d5899d671d12f998b0c783983fa4dc
 SHA512:
-  metadata.gz: 2c118bbcd96a99bbd4037e8df41595e7e514e16a0077d895e3b1808d62f7a62062f784b450fbdb299f2e48d59f60dce1e5de6ab08267a55123d4cffd100d494b
-  data.tar.gz: fe21b7c7cc00eb47c9313ea953b4fdce36b8a2bc2aa86de010fd8f68fde9c0487bb86b629263d0fc47ac2b64ce6fcdf2003879fd124607f4ea9c666800093660
+  metadata.gz: 6160cea03e0e6ed6e1511271cd780db176ba569b2774e9a304749e612ec242ad65d611dce0c475f29dfe3f9dce869bee8c660825a90fff0b3a0f5315cf7fbb47
+  data.tar.gz: abc75b8c436416257770b9af8e38470bbf4ab53f448a281c6626fa56ef7617ffee4d551038fa9618b00d33cd63f9c8cf19f51b311406497e1ce99a54ba22d2f0

data/CHANGELOG.md

@@ -1,7 +1,18 @@
 # Change Log
 
+## 0.0.18
+
+- Hello, Frame! sample
+- Avoid setting grid geometry manager on `toplevel` widget
+- Support `frame` `width` and `height` attributes
+- Support `frame` `borderwidth` attribute
+- Support `frame` `relief` attribute
+- Support `frame` `padding` attribute
+- Rename Hello, Tab! to Hello, Notebook!
+
 ## 0.0.17
 
+- Hello, Label! sample
 - Support `label` `anchor` attribute (`'e'`, `'se'`, `'s'`, `'sw'`, `'w'`, `'nw'` or `'center'`)
 - Support `label` `width` attributes
 - Support `label` `image` attribute

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.17
+# [<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.18
 ## 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)
@@ -10,7 +10,7 @@
 
 [Glimmer](https://github.com/AndyObtiva/glimmer) DSL for [Tk](https://www.tcl.tk/) enables desktop development with [Glimmer](https://github.com/AndyObtiva/glimmer) in [Ruby](https://github.com/ruby/ruby).
 
-[Tcl/Tk](https://www.tcl.tk/) has evolved into a practical desktop GUI toolkit due to gaining native looking themed widgets on Mac, Windows, and Linux in [Tk version 8.5](https://www.tcl.tk/software/tcltk/8.5.html#:~:text=Highlights%20of%20Tk%208.5&text=Font%20rendering%3A%20Now%20uses%20anti,and%20window%20layout%2C%20and%20more.).
+[Tcl/Tk](https://www.tcl.tk/) has recently improved by gaining native looking themed widgets on Mac, Windows, and Linux in [Tk version 8.5](https://www.tcl.tk/software/tcltk/8.5.html#:~:text=Highlights%20of%20Tk%208.5&text=Font%20rendering%3A%20Now%20uses%20anti,and%20window%20layout%2C%20and%20more.).
 
 Additionally, [Ruby](https://www.ruby-lang.org/en/) 3.0 Ractor (formerly known as [Guilds](https://olivierlacan.com/posts/concurrency-in-ruby-3-with-guilds/)) supports truly parallel multi-threading, making both [MRI](https://github.com/ruby/ruby) and [Tk](https://www.tcl.tk/) finally viable for support in [Glimmer](https://github.com/AndyObtiva/glimmer) (Ruby Desktop Development GUI Library) as an alternative to [JRuby on SWT](https://github.com/AndyObtiva/glimmer-dsl-swt).
 
@@ -79,6 +79,7 @@ Other [Glimmer](https://github.com/AndyObtiva/glimmer) DSL gems:
     - [Smart Defaults and Convensions](#smart-defaults-and-convensions)
       - [Grid Layout](#grid-layout)
       - [Label/Button Image](#labelbutton-image)
+      - [Notebook Frame](#notebook-frame)
       - [Icon Photo](#icon-photo)
   - [The Grid Geometry Manager](#the-grid-geometry-manager)
   - [Bidirectional Data-Binding](#bidirectional-data-binding)
@@ -88,10 +89,12 @@ Other [Glimmer](https://github.com/AndyObtiva/glimmer) DSL gems:
     - [List Multi Selection Data-Binding](#list-multi-selection-data-binding)
     - [Entry Data-Binding](#entry-data-binding)
   - [Command Observer](#command-observer)
+  - [Gotchas](#gotchas)
   - [Samples](#samples)
     - [Hello, World!](#hello-world)
     - [Hello, Button!](#hello-button)
-    - [Hello, Tab!](#hello-tab)
+    - [Hello, Frame!](#hello-frame)
+    - [Hello, Notebook!](#hello-notebook)
     - [Hello, Label!](#hello-label)
     - [Hello, Message Box!](#hello-message-box)
     - [Hello, Combobox!](#hello-combobox)
@@ -134,7 +137,7 @@ gem install glimmer-dsl-tk
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer-dsl-tk', '~> 0.0.17'
+gem 'glimmer-dsl-tk', '~> 0.0.18'
 ```
 
 And, then run:
@@ -181,7 +184,7 @@ Example of an app written in [Tk](https://www.tcl.tk/) imperative syntax:
 
 ```ruby
 root = TkRoot.new
-root.title = 'Hello, Tab!'
+root.title = 'Hello, Notebook!'
 
 notebook = ::Tk::Tile::Notebook.new(root).grid
 
@@ -202,7 +205,7 @@ Example of the same app written in [Glimmer](https://github.com/AndyObtiva/glimm
 
 ```ruby
 root {
-  title 'Hello, Tab!'
+  title 'Hello, Notebook!'
    
   notebook {
     frame(text: 'English') {
@@ -226,7 +229,7 @@ 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`
 `entry` | `width`, `text` | None
-`frame(text: nil)` | None | 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
@@ -260,6 +263,10 @@ keyword(args) | attributes | event bindings & callbacks
 
 Label and Button `image` attribute can accept image path directly as an alternative to `TkPhotoImage` object in addition to key values for automatic processing of image (`subsample`, `zoom`, `from`, `to`, `shrink`, `compositingrule`)
 
+#### Notebook Frame
+
+When nesting `frame` under `notebook`, you can pass a `:text` keyword argument to indicate the tab title.
+
 #### Icon Photo
 
 The `iconphoto` attribute on `root` is set to the Glimmer icon by default if no icon photo is supplied.
@@ -426,6 +433,10 @@ This resets the person country.
 
 More details can be found in the [Hello, Combobox!](#hello-combobox) sample below.
 
+## Gotchas
+
+- Setting `background` attribute on `frame` or `label` does not work in `'aqua'` theme on the Mac (only in `'classic'` theme)
+
 ## Samples
 
 ### Hello, World!
@@ -561,48 +572,129 @@ Glimmer app:
 
 ![glimmer dsl tk screenshot sample hello button](images/glimmer-dsl-tk-screenshot-sample-hello-button.png)
 
-### Hello, Tab!
+### Hello, Frame!
 
-Glimmer code (from [samples/hello/hello_tab.rb](samples/hello/hello_tab.rb)):
+Glimmer code (from [samples/hello/hello_frame.rb](samples/hello/hello_frame.rb)):
 
 ```ruby
-include Glimmer
+require 'glimmer-dsl-tk'
 
-root {
-  title 'Hello, Tab!'
-   
-  notebook {
-    frame(text: 'English') {
-      label {
-        text 'Hello, World!'
+class HelloFrame
+  include Glimmer
+  
+  def launch
+    root {
+      title 'Hello, Frame!'
+      
+      frame { # frame simply contains widgets for visual organization via a layout
+        relief 'sunken'
+        
+        label {
+          grid row: 0, column: 0, columnspan: 4, padx: 5, pady: 5
+          text 'Enter Your Full Name'
+          font 'caption'
+          anchor 'center'
+        }
+
+        label {
+          grid row: 1, column: 0, padx: 5
+          text "First Name:"
+        }
+        
+        entry {
+          grid row: 1, column: 1, padx: 5
+        }
+        
+        label {
+          grid row: 2, column: 0, padx: 5
+          text "Last Name:"
+        }
+        
+        entry {
+          grid row: 2, column: 1, padx: 5
+        }
       }
-    }
-     
-    frame(text: 'French') {
-      label {
-        text 'Bonjour, Univers!'
+      
+      frame { # an empty frame can specify width and height
+        grid padx: 7, pady: 7
+        width 200
+        height 100
+        borderwidth 3
+        relief 'sunken'
       }
-    }
-  }
-}.open
+    }.open
+  end
+end
+
+HelloFrame.new.launch
+```
+
+Run with [glimmer-dsl-tk](https://rubygems.org/gems/glimmer-dsl-tk) gem installed:
+
+```
+ruby -r glimmer-dsl-tk -e "require 'samples/hello/hello_frame'"
+```
+
+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_frame.rb
+```
+
+Glimmer app:
+
+![glimmer dsl tk screenshot sample hello frame](images/glimmer-dsl-tk-screenshot-sample-hello-frame.png)
+
+### Hello, Notebook!
+
+Glimmer code (from [samples/hello/hello_notebook.rb](samples/hello/hello_notebook.rb)):
+
+```ruby
+require 'glimmer-dsl-tk'
+
+class HelloNotebook
+  include Glimmer
+  
+  def launch
+    root {
+      title 'Hello, Notebook!'
+       
+      notebook {
+        frame(text: 'English') {
+          label {
+            text 'Hello, World!'
+          }
+        }
+         
+        frame(text: 'French') {
+          label {
+            text 'Bonjour, Univers!'
+          }
+        }
+      }
+    }.open
+  end
+end
+
+HelloNotebook.new.launch
 ```
 
 Run with [glimmer-dsl-tk](https://rubygems.org/gems/glimmer-dsl-tk) gem installed:
 
 ```
-ruby -r glimmer-dsl-tk -e "require 'samples/hello/hello_tab'"
+ruby -r glimmer-dsl-tk -e "require 'samples/hello/hello_notebook'"
 ```
 
 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_tab.rb
+ruby -r ./lib/glimmer-dsl-tk.rb ./samples/hello/hello_notebook.rb
 ```
 
 Glimmer app:
 
-![glimmer dsl tk screenshot sample hello tab English](images/glimmer-dsl-tk-screenshot-sample-hello-tab-english.png)
-![glimmer dsl tk screenshot sample hello tab French](images/glimmer-dsl-tk-screenshot-sample-hello-tab-french.png)
+![glimmer dsl tk screenshot sample hello notebook English](images/glimmer-dsl-tk-screenshot-sample-hello-notebook-english.png)
+![glimmer dsl tk screenshot sample hello notebook French](images/glimmer-dsl-tk-screenshot-sample-hello-notebook-french.png)
 
 ### Hello, Label!
 

data/VERSION

@@ -1 +1 @@
-0.0.17
+0.0.18

data/lib/glimmer/tk/widget_proxy.rb

@@ -85,7 +85,7 @@ module Glimmer
         tk_widget_class = self.class.tk_widget_class_for(underscored_widget_name)
         @tk = tk_widget_class.new(@parent_proxy.tk, *args)
         # a common widget initializer
-        @tk.grid
+        @tk.grid unless @tk.is_a?(::Tk::Toplevel)
         DEFAULT_INITIALIZERS[underscored_widget_name]&.call(@tk)
         @parent_proxy.post_initialize_child(self)
       end

data/samples/hello/hello_frame.rb

@@ -0,0 +1,71 @@
+# 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'
+
+class HelloFrame
+  include Glimmer
+  
+  def launch
+    root {
+      title 'Hello, Frame!'
+      
+      frame { # frame simply contains widgets for visual organization via a layout
+        relief 'sunken'
+        
+        label {
+          grid row: 0, column: 0, columnspan: 4, padx: 5, pady: 5
+          text 'Enter Your Full Name'
+          font 'caption'
+          anchor 'center'
+        }
+
+        label {
+          grid row: 1, column: 0, padx: 5
+          text "First Name:"
+        }
+        
+        entry {
+          grid row: 1, column: 1, padx: 5
+        }
+        
+        label {
+          grid row: 2, column: 0, padx: 5
+          text "Last Name:"
+        }
+        
+        entry {
+          grid row: 2, column: 1, padx: 5
+        }
+      }
+      
+      frame { # an empty frame can specify width and height
+        grid padx: 7, pady: 7
+        width 200
+        height 100
+        borderwidth 3
+        relief 'sunken'
+      }
+    }.open
+  end
+end
+
+HelloFrame.new.launch

data/samples/hello/{hello_tab.rb → hello_notebook.rb}

@@ -21,12 +21,12 @@
 
 require 'glimmer-dsl-tk'
 
-class HelloTab
+class HelloNotebook
   include Glimmer
   
   def launch
     root {
-      title 'Hello, Tab!'
+      title 'Hello, Notebook!'
        
       notebook {
         frame(text: 'English') {
@@ -45,4 +45,4 @@ class HelloTab
   end
 end
 
-HelloTab.new.launch
+HelloNotebook.new.launch

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-tk
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - AndyMaleh
@@ -170,7 +170,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
-description: Glimmer DSL for Tk (Ruby Desktop Development GUI Library)
+description: Glimmer DSL for Tk (MRI Ruby Desktop Development GUI Library)
 email: andy.am@gmail.com
 executables:
 - girb
@@ -214,11 +214,12 @@ files:
 - samples/hello/hello_combobox.rb
 - samples/hello/hello_computed.rb
 - samples/hello/hello_computed/contact.rb
+- samples/hello/hello_frame.rb
 - samples/hello/hello_label.rb
 - samples/hello/hello_list_multi_selection.rb
 - samples/hello/hello_list_single_selection.rb
 - samples/hello/hello_message_box.rb
-- samples/hello/hello_tab.rb
+- samples/hello/hello_notebook.rb
 - samples/hello/hello_world.rb
 - samples/hello/images/denmark.png
 - samples/hello/images/finland.png