glimmer-dsl-libui 0.7.5 → 0.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec43caceca7a5693e9a98278af76787a03cdfa7e259b4eafc221456f2388f1cf
-  data.tar.gz: 72e7b5b20c6d07ab1160d1e83c7564dea41181b538b71d73d54acb41e839f503
+  metadata.gz: cc2c8178ea922168b2df15740230c175155c96313d847dd117137ba18eba0991
+  data.tar.gz: 49cbaff89df8bb0d1099b6adf9f0dcdaefe05010c4ee7b295160b0f7fbe8bd66
 SHA512:
-  metadata.gz: b829f991b9fa34fb2ba186a022a950e45e65d13e81019ad53829b2c57b13aa7a16c10304207c6cc734015a4a5a3b44885070da15832f92f655603e925623396e
-  data.tar.gz: c00a6b5c543039dc64c68f5e2e3cccfad74f7b511ba6fb40aa3482e9468ea49de995dc0edb8cc924082c2cce456923a47e5d9bc406b2866be8999f6309b31925
+  metadata.gz: 30c0cbe41224d6c18e32c204a9f8fab80330ce27d8174f3293399ea9aeb73474f2083145d361d708f062d7035762a4417a135be886dacc09785034ed2b8f0887
+  data.tar.gz: 3f5adf2374b390a21f4e6e7c28003c0446d5fd2a1c810beaebedb820530f56f7415c4a44f91887056be8e7745bc6cc6cd9728c9833cbd7688886f1b3a293d355

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## 0.7.7
+
+- Support ability for `area` `on_key_event`/`on_key_down`/`on_key_up` listeners to return a boolean value indicating whether they handled a key event or not in case some key events need to be left to other operating system key handlers like COMMAND+Q for the Mac quit menu item
+- Update `examples/tetris.rb` to return `false` in its `on_key_down` listener for unhandled events
+- Update `examples/area_gallery.rb` to return `false` in its `on_key_event`/`on_key_down`/`on_key_up` listeners for unhandled events
+
+## 0.7.6
+
+- Fix issue with hearing "fonk" sound on every key press when handling `on_key_event`/`on_key_down`/`on_key_up` listeners (by returning expected `1` value if the listeners are handled properly or otherwise allowing the "fonk" sound to ring when the listeners are not handled)
+- Update examples/tetris.rb with COMMAND+Q shortcut for quitting on the Mac and ALT+F4 shortcut for quitting on Windows/Linux
+
 ## 0.7.5
 
 - Fix [issue 46](https://github.com/AndyObtiva/glimmer-dsl-libui/issues/46) (GTK Error rendering table with zero initial elements), which happens when explicitly data-binding table cell_rows to an empty array

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 LibUI 0.7.5
+# [<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 LibUI 0.7.7
 ## Prerequisite-Free Ruby Desktop Development GUI Library
 ### The Quickest Way From Zero To GUI
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-libui.svg)](http://badge.fury.io/rb/glimmer-dsl-libui)
@@ -544,7 +544,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.7.5'
+gem 'glimmer-dsl-libui', '~> 0.7.7'
 ```
 
 Test that installation worked by running the [Meta-Example](#examples):
@@ -763,7 +763,7 @@ Keyword(Args) | Properties | Listeners
 - `valign` [dsl-only] (`:fill`, `:start`, `:center`, or `:end`) [default=`:fill`]: available in [Glimmer GUI DSL](#glimmer-gui-dsl-concepts) when nested under `grid`
 
 ### Common Control Operations
-- `destroy`
+- `destroy` (note that for closing a `window`, in addition to calling `somewindow.destroy`, you also have to call `::LibUI.quit`)
 - `disable`
 - `enable`
 - `hide`
@@ -1947,7 +1947,7 @@ The [Observer Design Pattern](https://en.wikipedia.org/wiki/Observer_pattern) (a
 
 ![MVC - Model View Controller](https://developer.mozilla.org/en-US/docs/Glossary/MVC/model-view-controller-light-blue.png)
 
-[Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) supports the [Observer Design Pattern](https://en.wikipedia.org/wiki/Observer_pattern) via the `observe(model, attribute_or_key=nil)` keyword, which can observe `Object` models with attributes, `Hash`es with keys, and `Array`s. It automatically enhances objects as needed to support automatically notifying observers of changes via `observable#notify_observers(attribute_or_key = nil)` method:
+[Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) supports the [Observer Design Pattern](https://en.wikipedia.org/wiki/Observer_pattern) via control listeners in the View layer (e.g. `on_clicked` or `on_closing`) and via the `observe(model, attribute_or_key=nil)` keyword in the Model layer, which can observe `Object` models with attributes, `Hash`es with keys, and `Array`s. It automatically enhances objects as needed to support automatically notifying observers of changes via `observable#notify_observers(attribute_or_key = nil)` method:
 - `Object` becomes `Glimmer::DataBinding::ObservableModel`, which supports observing specified `Object` model attributes.
 - `Hash` becomes `Glimmer::DataBinding::ObservableHash`, which supports observing all `Hash` keys or a specific `Hash` key
 - `Array` becomes `Glimmer::DataBinding::ObservableArray`, which supports observing `Array` changes like those done with `push`, `<<`, `delete`, and `map!` methods (all mutation methods).

data/VERSION

@@ -1 +1 @@
-0.7.5
+0.7.7

data/examples/area_gallery.rb

@@ -92,14 +92,50 @@ window('Area Gallery', 400, 400) {
     
     on_key_event do |area_key_event|
       p area_key_event
+      # As a smart default, key events are assumed to be handled if you add a key event listener,
+      # but you can return false to indicate a key event is not handled to allow it
+      # to propagate to other operating system key handlers, like the Mac quit menu item,
+      # which expects a COMMAND+Q shortcut usually.
+      # Otherwise, if you return false in all key event handlers for a specific key combo,
+      # the Mac beeps (makes a "fonk" sound), which is normal behavior on the Mac.
+      case area_key_event
+      in modifiers: [:command], key: 'q'
+        false if OS.mac? # allow to propagate to Mac quit menu item
+      else
+        # true # no return value (nil) or any return value other than false or 0 means true (event handled)
+      end
     end
     
     on_key_up do |area_key_event|
       puts 'key up'
+      # As a smart default, key events are assumed to be handled if you add a key event listener,
+      # but you can return false to indicate a key event is not handled to allow it
+      # to propagate to other operating system key handlers, like the Mac quit menu item,
+      # which expects a COMMAND+Q shortcut usually.
+      # Otherwise, if you return false in all key event handlers for a specific key combo,
+      # the Mac beeps (makes a "fonk" sound), which is normal behavior on the Mac.
+      case area_key_event
+      in modifiers: [:command], key: 'q'
+        false if OS.mac? # allow to propagate to Mac quit menu item
+      else
+        # true # no return value (nil) or any return value other than false or 0 means true (event handled)
+      end
     end
     
     on_key_down do |area_key_event|
       puts 'key down'
+      # As a smart default, key events are assumed to be handled if you add a key event listener,
+      # but you can return false to indicate a key event is not handled to allow it
+      # to propagate to other operating system key handlers, like the Mac quit menu item,
+      # which expects a COMMAND+Q shortcut usually.
+      # Otherwise, if you return false in all key event handlers for a specific key combo,
+      # the Mac beeps (makes a "fonk" sound), which is normal behavior on the Mac.
+      case area_key_event
+      in modifiers: [:command], key: 'q'
+        false if OS.mac? # allow to propagate to Mac quit menu item
+      else
+        # true # no return value (nil) or any return value other than false or 0 means true (event handled)
+      end
     end
   }
 }.show

data/examples/tetris.rb

@@ -258,6 +258,7 @@ class Tetris
       }
       
       on_key_down do |key_event|
+        handled = true # assume it is handled for all cases except the else clause below
         case key_event
         in ext_key: :down
           if OS.windows?
@@ -293,8 +294,12 @@ class Tetris
         in modifier: :control
           @game.rotate!(:left)
         else
-          # Do Nothing
+          # returning false explicitly means the key event was not handled, which
+          # propagates the event to other handlers, like the quit menu item, which
+          # can handle COMMAND+Q on the Mac to quit an application
+          handled = false
         end
+        handled
       end
       
       extra_content&.call

data/lib/glimmer/libui/control_proxy/area_proxy.rb

@@ -179,14 +179,32 @@ module Glimmer
             @area_handler.DragBroken   = fiddle_closure_block_caller(0, [1, 1]) do |_, _|
               notify_custom_listeners('on_drag_broken')
             end
-            @area_handler.KeyEvent     = fiddle_closure_block_caller(0, [1, 1, 1]) do |_, _, area_key_event|
+            @area_handler.KeyEvent     = fiddle_closure_block_caller(1, [1, 1, 1]) do |_, _, area_key_event|
               area_key_event = ::LibUI::FFI::AreaKeyEvent.new(area_key_event)
               area_key_event = area_key_event_hash(area_key_event)
-              notify_custom_listeners('on_key_event', area_key_event)
+              on_key_up_results = on_key_down_results = []
+              on_key_event_results = notify_custom_listeners('on_key_event', area_key_event)
               if area_key_event[:up]
-                notify_custom_listeners('on_key_up', area_key_event)
+                on_key_up_results = notify_custom_listeners('on_key_up', area_key_event)
               else
-                notify_custom_listeners('on_key_down', area_key_event)
+                on_key_down_results = notify_custom_listeners('on_key_down', area_key_event)
+              end
+              if ((
+                    handle_custom_listener('on_key_event').empty? ||
+                    (handle_custom_listener('on_key_event').any? && on_key_event_results.all? {|result| LibUI.boolean_to_integer(result) == 0})
+                  ) &&
+                  (
+                    handle_custom_listener('on_key_up').empty? ||
+                    (handle_custom_listener('on_key_up').any? && on_key_up_results.all? {|result| LibUI.boolean_to_integer(result) == 0})
+                  ) &&
+                  (
+                    handle_custom_listener('on_key_down').empty? ||
+                    (handle_custom_listener('on_key_down').any? && on_key_down_results.all? {|result| LibUI.boolean_to_integer(result) == 0})
+                  )
+                 )
+                0
+              else
+                1
               end
             end
             @listeners_installed = true
@@ -221,13 +239,14 @@ module Glimmer
         
         def area_key_event_hash(area_key_event)
           modifiers = modifiers_to_symbols(area_key_event.Modifiers)
+          modifier = modifiers_to_symbols(area_key_event.Modifier).first
           {
             key: key_to_char(area_key_event.Key, modifiers),
             key_value: area_key_event.Key,
             key_code: area_key_event.Key,
             ext_key: ext_key_to_symbol(area_key_event.ExtKey),
             ext_key_value: area_key_event.ExtKey,
-            modifier: modifiers_to_symbols(area_key_event.Modifier).first,
+            modifier: modifier,
             modifiers: modifiers,
             up: Glimmer::LibUI.integer_to_boolean(area_key_event.Up),
           }

data/lib/glimmer/libui/control_proxy.rb

@@ -223,7 +223,7 @@ module Glimmer
       end
       
       def notify_custom_listeners(listener_name, *args)
-        handle_custom_listener(listener_name).each do |listener|
+        handle_custom_listener(listener_name).map do |listener|
           listener.call(*args)
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.7.7
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-30 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -567,7 +567,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.16
+rubygems_version: 3.3.1
 signing_key:
 specification_version: 4
 summary: Glimmer DSL for LibUI