glimmer-dsl-tk 0.0.62 → 0.0.63

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6a4152765e0997cd3d29beec05f16be105a09ae868e49335fb09e81d552e576
-  data.tar.gz: 31c3f1d4ee33b5ab9dec7ccd76d11a6c50cde145cf3a5517401859b0ae16a45a
+  metadata.gz: 68fb65641bc77c179c7600d37210817eadd271de99aeb0ed8ca6bd7c3c5716b3
+  data.tar.gz: 40be5cb8a31b5a8284a8c3a208e6ccee512df2d42d051db3fdb9c7fc0041554a
 SHA512:
-  metadata.gz: 7f4820bb0d35553b16fc9b37bfca7d2abdc463cbd2e958f462b5be5c53e79e7ae3abc918fa2bbc6775d642432b127fa3d26ff72d96195287fecd287e13a50a23
-  data.tar.gz: 6f5b093cd7f834e6d8126142d5f63e66dde7c164b463eee577cd8b177d27784335d3f2df88555ce103c68a29eaed72ab1ec1e608018e8b76655c9704e77c0826
+  metadata.gz: 002fe595bd7e763629bd42c63f1ac9b004388dab953e3bb3b764582b623befff82cc17009a9277f75f314621b7e8fb393efe9595dcda3ecf83389f0a0c95d204
+  data.tar.gz: 5f31f46283e9170bd5459514f4406b829cb718d3bb068a35f3983fcd9e6e29142a4d15bbffd9c60b59dbb135f40ce982f48b2d14561df7e8c5a8fb8f4d986693

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## 0.0.63
+
+- `modal = true` modifier for toplevels (the root becomes hidden till the toplevel is closed)
+- If no icon is set for a toplevel, take icon from the root
+- An experimental fix of `center_within_screen` for Linux multi-monitor environments
+- `center_within_root` method to center a toplevel within the boundaries of the root (useful for modal windows / dialogs)
+- A helper `window?` method to determine if the widget is a window (root, toplevel) or not
+- Support for single style name argument in the `style` setter to be able to use predefined Tk styles by name
+- Support for `columnuniform` / `rowuniform` grid arguments, aliased also as `column_uniform` / `row_uniform`
+- `event_generate` method for raising custom Tk events (wrapper around `tk.event_generate`)
+- Fix `unbind_all`, use `tk.bind_remove` instead of `tk.bind(..., '')` which was causing weird effects when reloading events
+- `closest_window` method to find the closest parent window-type widget
+- `enabled` / `disabled` pair of attributes
+- `visible` / `hidden` pair of attributes
+- Fixed the problem when variables bound to deselected radiobuttons weren't being updated to false
+
 ## 0.0.62
 
 - `icon_photo` as alias for `iconphoto` attribute on `root` and `toplevel`

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.62
+# [<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.63
 ## Ruby Tk 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)
@@ -51,19 +51,7 @@ Glimmer app:
 
 NOTE: Glimmer DSL for Tk is currently in early alpha mode (only about 44% complete). If you want it developed faster, then [open an issue report](https://github.com/AndyObtiva/glimmer-dsl-tk/issues/new). I have completed some features much faster before due to [issue reports](https://github.com/AndyObtiva/glimmer-dsl-tk/issues) and [pull requests](https://github.com/AndyObtiva/glimmer-dsl-tk/pulls). Please help make better by contributing, adopting for small or low risk projects, and providing feedback. It is still an early alpha, so the more feedback and issues you report the better.
 
-**[Glimmer](https://rubygems.org/gems/glimmer) DSL Comparison Table:**
-DSL | Platforms | Native? | Vector Graphics? | Pros | Cons | Prereqs
-----|-----------|---------|------------------|------|------|--------
-[Glimmer DSL for SWT (JRuby Desktop Development GUI Framework)](https://github.com/AndyObtiva/glimmer-dsl-swt) | Mac / Windows / Linux | Yes | Yes (Canvas Shape DSL) | Very Mature / Scaffolding / Native Executable Packaging / Custom Widgets | Slow JRuby Startup Time / Heavy Memory Footprint | Java / JRuby
-[Glimmer DSL for Opal (Pure Ruby Web GUI and Auto-Webifier of Desktop Apps)](https://github.com/AndyObtiva/glimmer-dsl-opal) | All Web Browsers | No | Yes (Canvas Shape DSL) | Simpler than All JavaScript Technologies / Auto-Webify Desktop Apps | Setup Process / Incomplete Alpha | Rails
-[Glimmer DSL for LibUI (Prerequisite-Free Ruby Desktop Development GUI Library)](https://github.com/AndyObtiva/glimmer-dsl-libui) | Mac / Windows / Linux | Yes | Yes (Area API) | Fast Startup Time / Light Memory Footprint | LibUI is an Incomplete Mid-Alpha Only | None Other Than MRI Ruby
-[Glimmer DSL for Tk (Ruby Tk Desktop Development GUI Library)](https://github.com/AndyObtiva/glimmer-dsl-tk) | Mac / Windows / Linux | Some Native-Themed Widgets (Not Truly Native) | Yes (Canvas) | Fast Startup Time / Light Memory Footprint | Complicated setup / Widgets Do Not Look Truly Native, Espcially on Linux | ActiveTcl / MRI Ruby
-[Glimmer DSL for GTK (Ruby-GNOME Desktop Development GUI Library)](https://github.com/AndyObtiva/glimmer-dsl-gtk) | Mac / Windows / Linux | Only on Linux | Yes (Cairo) | Complete Access to GNOME Features on Linux (Forte) | Not Native on Mac and Windows | None Other Than MRI Ruby on Linux / Brew Packages on Mac / MSYS & MING Toolchains on Windows / MRI Ruby
-[Glimmer DSL for FX (FOX Toolkit Ruby Desktop Development GUI Library)](https://github.com/AndyObtiva/glimmer-dsl-fx) | Mac (requires XQuartz) / Windows / Linux | No | Yes (Canvas) | No Prerequisites on Windows (Forte Since Binaries Are Included Out of The Box) | Widgets Do Not Look Native / Mac Usage Obtrusively Starts XQuartz | None Other Than MRI Ruby on Windows / XQuarts on Mac / MRI Ruby
-[Glimmer DSL for JFX (JRuby JavaFX Desktop Development GUI Library)](https://github.com/AndyObtiva/glimmer-dsl-jfx) | Mac / Windows / Linux | No | Yes (javafx.scene.shape and javafx.scene.canvas) | Rich in Custom Widgets | Slow JRuby Startup Time / Heavy Memory Footprint / Widgets Do Not Look Native | Java / JRuby / JavaFX SDK
-[Glimmer DSL for Swing (JRuby Swing Desktop Development GUI Library)](https://github.com/AndyObtiva/glimmer-dsl-swing) | Mac / Windows / Linux | No | Yes (Java2D) | Very Mature | Slow JRuby Startup Time / Heavy Memory Footprint / Widgets Do Not Look Native | Java / JRuby
-[Glimmer DSL for XML (& HTML)](https://github.com/AndyObtiva/glimmer-dsl-xml) | All Web Browsers | No | Yes (SVG) | Programmable / Lighter-weight Than Actual XML | XML Elements Are Sometimes Not Well-Named (Many Types of Input) | None
-[Glimmer DSL for CSS](https://github.com/AndyObtiva/glimmer-dsl-css) | All Web Browsers | No | Yes | Programmable | CSS Is Over-Engineered / Too Many Features To Learn | None
+Learn more about the differences between various [Glimmer](https://github.com/AndyObtiva/glimmer) DSLs by looking at the **[Glimmer DSL Comparison Table](https://github.com/AndyObtiva/glimmer#glimmer-dsl-comparison-table)**.
 
 ## Table of Contents
 
@@ -139,7 +127,6 @@ DSL | Platforms | Native? | Vector Graphics? | Pros | Cons | Prereqs
   - [Applications](#applications)
     - [Glimmer Tk Calculator](#glimmer-tk-calculator)
     - [Y3network Ruby UI](#y3network-ruby-ui)
-    - [CryptoPunks GUI](#cryptopunks-gui)
     - [Circule](#circule)
   - [Process](#process)
   - [Resources](#resources)
@@ -195,7 +182,7 @@ gem install glimmer-dsl-tk
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer-dsl-tk', '0.0.62'
+gem 'glimmer-dsl-tk', '0.0.63'
 ```
 
 And, then run:
@@ -4283,14 +4270,6 @@ https://github.com/ancorgs/glimmer-tk-calculator
 
 https://github.com/ancorgs/y3network-ruby-ui
 
-### CryptoPunks GUI
-
-This is a Graphical User Interface for the famous [cryptopunks Ruby gem](https://github.com/cryptopunksnotdead/cryptopunks/tree/master/cryptopunks).
-
-https://github.com/cryptopunksnotdead/cryptopunks/tree/master/cryptopunks-gui
-
-![CryptoPunks GUI Screenshot](https://raw.githubusercontent.com/cryptopunksnotdead/cryptopunks/master/cryptopunks-gui/screenshots/cryptopunks-gui-screenshot.png)
-
 ### Circule
 
 Generate an icon of overlapping circles derived from a hash.

data/VERSION

@@ -1 +1 @@
-0.0.62
+0.0.63

data/lib/glimmer/tk/toplevel_proxy.rb

@@ -32,19 +32,47 @@ module Glimmer
       DEFAULT_HEIGHT = 0
       
       attr_reader :tk
-      attr_accessor :escapable
+      attr_accessor :escapable, :modal, :centered
       alias escapable? escapable
-      
+      alias modal? modal
+      alias centered? centered
+
       def post_add_content
-        center_within_screen unless @x || @y
         if escapable?
            on('KeyPress') do |event|
-            if event.keysym == 'Escape'
-              grab_release
+            if event.state == 0 && event.keysym == 'Escape'
+              tk.grab_release
               destroy
             end
           end
         end
+
+        if modal?
+          unless is_a?(Glimmer::Tk::ToplevelProxy)
+            raise 'Modal windows must be top level windows. Root cannot be modal.'
+          end
+
+          center_within_root unless @x || @y
+          root_parent_proxy.withdraw
+          tk.grab_set
+          on('WM_DELETE_WINDOW') do
+            tk.grab_release
+            root_parent_proxy.deiconify
+            destroy
+            true
+          end
+          on('destroy') do
+            tk.grab_release
+            root_parent_proxy.deiconify
+            true
+          end
+        else
+          center_within_screen unless @x || @y
+        end
+
+        if is_a?(Glimmer::Tk::ToplevelProxy) && @tk.iconphoto.nil? && root_parent_proxy.iconphoto
+          @tk.iconphoto = root_parent_proxy.iconphoto
+        end
       end
       
       def has_attribute?(attribute, *args)
@@ -125,18 +153,68 @@ module Glimmer
           super
         end
       end
-      
+
       def center_within_screen
         monitor_width, monitor_height = wm_maxsize
         update :idletasks
         current_width = width
         current_height = height
-        self.x = (winfo_screenwidth - width) / 2
-        self.y = (winfo_screenheight - height) / 2
+
+        if RbConfig::CONFIG['host_os'] == 'linux'
+          begin
+            # example output: HDMI-A-0 connected primary 2560x1080+1024+100 (normal left inverted right x axis y axis) 798mm x 334mm
+            # TODO: is xrandr output same on all systems?
+            sizes = `xrandr`
+                      .split("\n")
+                      .find { |line| line.include?(' connected primary ') }
+                      &.match(/([0-9]+)x([0-9]+)\+([0-9]+)\+([0-9]+)/)
+            raise "`xrandr` returned unexpected results. Try to run `xrandr`, verify it's output and possibly update this code." unless sizes
+
+            self.x = (sizes[1].to_i - width) / 2 + sizes[3].to_i
+            self.y = (sizes[2].to_i - height) / 2 + sizes[4].to_i
+
+          rescue StandardError => e
+            Glimmer::Config.logger.debug {"Unable to detect primary screen on Linux with xrandr"}
+            Glimmer::Config.logger.debug {e.full_message}
+
+            self.x = (winfo_screenwidth - width) / 2
+            self.y = (winfo_screenheight - height) / 2
+          end
+
+        else
+          self.x = (winfo_screenwidth - width) / 2
+          self.y = (winfo_screenheight - height) / 2
+        end
+
         self.width = width
         self.height = height
       end
-      
+
+      def center_within_root(margin: 0)
+        self.x = root_parent_proxy.x + margin
+        self.y = root_parent_proxy.y + margin
+        self.width = root_parent_proxy.width - 2 * margin
+        self.height = root_parent_proxy.height - 2 * margin
+      end
+
+      def window?
+        true
+      end
+
+      [:visible,  :hidden,  :enabled,  :disabled,
+       :visible=, :hidden=, :enabled=, :disabled=,
+       :visible?, :hidden?, :enabled?, :disabled?].each \
+      do |restricted_method|
+        define_method(restricted_method) do
+          # TODO: or just do nothing?
+          raise 'Not applicable for a root / toplevel'
+        end
+      end
+
+      def closest_window
+        self
+      end
+
       private
       
       def sign_number(sign, number)

data/lib/glimmer/tk/widget_proxy.rb

@@ -19,6 +19,7 @@
 # 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 'yaml'
 require 'glimmer/data_binding/tk/one_time_observer'
 require 'glimmer/tk/widget'
 require 'glimmer/tk/draggable_and_droppable'
@@ -102,6 +103,7 @@ module Glimmer
       def toplevel_parent_proxy
         ancestor_proxies.find {|widget_proxy| widget_proxy.is_a?(ToplevelProxy)}
       end
+      alias closest_window toplevel_parent_proxy
       
       # returns list of ancestors ordered from direct parent to root parent
       def ancestor_proxies
@@ -254,13 +256,18 @@ module Glimmer
         "#{attribute}="
       end
       
-      def style=(styles)
-        styles.each do |attribute, value|
-          apply_style(attribute => value)
+      def style=(style_or_styles)
+        if style_or_styles.is_a? String
+          @tk.style(style_or_styles)
+        else
+          style_or_styles.each do |attribute, value|
+            apply_style(attribute => value)
+          end
         end
       end
-      
+
       def grid(options = {})
+        @_visible = true
         options = options.stringify_keys
         options['rowspan'] = options.delete('row_span') if options.keys.include?('row_span')
         options['columnspan'] = options.delete('column_span') if options.keys.include?('column_span')
@@ -273,13 +280,17 @@ module Glimmer
         options['columnminsize'] = options.delete('column_minsize') if options.keys.include?('column_minsize')
         options['columnminsize'] = options.delete('minwidth') if options.keys.include?('minwidth')
         options['columnminsize'] = options.delete('min_width') if options.keys.include?('min_width')
-        options['columnminsize'] = options['rowminsize'] = options.delete('minsize')  if options.keys.include?('minsize')
+        options['columnminsize'] = options['rowminsize'] = options.delete('minsize') if options.keys.include?('minsize')
+        options['rowuniform'] = options.delete('row_uniform') || options.delete('rowuniform')
+        options['columnuniform'] = options.delete('column_uniform') || options.delete('columnuniform')
         index_in_parent = griddable_parent_proxy&.children&.index(griddable_proxy)
         if index_in_parent
           TkGrid.rowconfigure(griddable_parent_proxy.tk, index_in_parent, 'weight'=> options.delete('rowweight')) if options.keys.include?('rowweight')
           TkGrid.rowconfigure(griddable_parent_proxy.tk, index_in_parent, 'minsize'=> options.delete('rowminsize')) if options.keys.include?('rowminsize')
+          TkGrid.rowconfigure(griddable_parent_proxy.tk, index_in_parent, 'uniform'=> options.delete('rowuniform')) if options.keys.include?('rowuniform')
           TkGrid.columnconfigure(griddable_parent_proxy.tk, index_in_parent, 'weight'=> options.delete('columnweight')) if options.keys.include?('columnweight')
           TkGrid.columnconfigure(griddable_parent_proxy.tk, index_in_parent, 'minsize'=> options.delete('columnminsize')) if options.keys.include?('columnminsize')
+          TkGrid.columnconfigure(griddable_parent_proxy.tk, index_in_parent, 'uniform'=> options.delete('columnuniform')) if options.keys.include?('columnuniform')
         end
         griddable_proxy&.tk&.grid(options)
       end
@@ -297,6 +308,7 @@ module Glimmer
       end
       
       def destroy
+        children.each(&:destroy)
         unbind_all
         @tk.destroy
         @on_destroy_procs&.each {|p| p.call(@tk)}
@@ -484,7 +496,15 @@ module Glimmer
           },
           ::Tk::Tile::TRadiobutton => {
             'variable' => lambda do |observer|
+              # tk.command is called only when the radiobutton is clicked/selected
+              # it isn't called when other radiobutton in the group is clicked/selected == this radiobutton is deselected
+              # so, we need to call the observers of the deselected radiobuttons in order for their variables to be reset to false
               @tk.command {
+                if @tk.variable.value == @tk.value
+                  sibling_radio_buttons.each do |sibling_radio_button|
+                    sibling_radio_button.tk.command.call
+                  end
+                end
                 observer.call(@tk.variable.value == @tk.value)
               }
             end,
@@ -551,21 +571,81 @@ module Glimmer
       def on(listener_name, &listener)
         handle_listener(listener_name, &listener)
       end
-      
+
+      def event_generate(event_name, data = nil)
+        data = YAML.dump(data) if data && !data.is_a?(String)
+        tk.event_generate("<#{event_name}>", data: data)
+      end
+
       def unbind_all
         @listeners&.keys&.each do |key|
           if key.to_s.downcase.include?('command')
             @tk.send(key, '')
           else
-            @tk.bind(key, '')
+            @tk.bind_remove(key)
           end
         end
+        @listeners = nil
       end
-      
+
+      def clear_children
+        children.each(&:destroy)
+        @children = []
+      end
+
       def content(&block)
         Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Tk::WidgetExpression.new, keyword, *args, &block)
       end
 
+      def window?
+        false
+      end
+
+      def visible
+        @visible = true if @visible.nil?
+        @visible
+      end
+      alias visible? visible
+
+      def visible=(value)
+        value = !!value
+        return if visible == value
+
+        if value
+          grid
+        else
+          tk.grid_remove
+        end
+        @visible = value
+      end
+
+      def hidden
+        !visible
+      end
+      alias hidden? hidden
+
+      def hidden=(value)
+        self.visible = !value
+      end
+
+      def enabled
+        tk.state == 'normal'
+      end
+      alias enabled? enabled
+
+      def enabled=(value)
+        tk.state = !!value ? 'normal' : 'disabled'
+      end
+
+      def disabled
+        !enabled
+      end
+      alias disabled? disabled
+
+      def disabled=(value)
+        self.enabled = !value
+      end
+
       def method_missing(method, *args, &block)
         method = method.to_s
         attribute_name = method.sub(/=$/, '')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-tk
 version: !ruby/object:Gem::Version
-  version: 0.0.62
+  version: 0.0.63
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-30 00:00:00.000000000 Z
+date: 2024-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -302,7 +302,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.1
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Glimmer DSL for Tk