glimmer-dsl-libui 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee3dcc2080c663175956845a975fb2bb0fb3a927f9b1b612f9d230d874fe8c86
-  data.tar.gz: 754ca74f6124c056209da9c8131cf1f3b527d67cf9a3c62a318d0c9d75f3c2ca
+  metadata.gz: 6159cc2323ab4b53114187df37e888c3f070102ce1b8a98dbaad724912b999b9
+  data.tar.gz: b0368395d3175a5528732c665f43902f84187a4f62ab23e4f47ebb8d729ac304
 SHA512:
-  metadata.gz: 5d8f0591d1647409c2c0f5f443addabb06d668e7b3fcdfbceabb8d6cf545fd23ec8d1f87c42302a72375da1db72a2268a1c6e27deffbdd2d38399f0d038f011e
-  data.tar.gz: 3494b576ed3d9945e7f4675739cb5a303dcaeb8360a78ea233ae1b11dd6a6d56fda6d90458be1422af3ce3e6a453643dd6e99ce872b7410bd2f07bacab832ca4
+  metadata.gz: ede14899e28cc5030f2d49653c51b931e1438934b26f7486843ed518d74fbe33107fa6db7c53a46991895835d9989e275a41474fbf4d2d692ae33d0c6cbf2bfd
+  data.tar.gz: e0964cfde750af8ebe2f14ab326eb477ebf0ed7cea56b7145828af909615a534acd67ec0169ceb41ed3d876bb229fb552dd62cc79ed4f9a552d7e72750d8a108

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 0.1.9
+
+- Support `area` listener: `on_key_event`
+- Support `area` listener: `on_key_down`
+- Support `area` listener: `on_key_up`
+
 ## 0.1.8
 
 - Support `area` listener: `on_mouse_event`

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.1.8
+# [<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.1.9
 ## Prerequisite-Free Ruby Desktop Development GUI Library
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-libui.svg)](http://badge.fury.io/rb/glimmer-dsl-libui)
 [![Maintainability](https://api.codeclimate.com/v1/badges/ce2853efdbecf6ebdc73/maintainability)](https://codeclimate.com/github/AndyObtiva/glimmer-dsl-libui/maintainability)
@@ -159,6 +159,18 @@ window('Area Gallery', 400, 400) {
     on_mouse_exited do
       puts 'exited'
     end
+    
+    on_key_event do |area_key_event|
+      p area_key_event
+    end
+    
+    on_key_up do |area_key_event|
+      puts 'key up'
+    end
+    
+    on_key_down do |area_key_event|
+      puts 'key down'
+    end
   }
 }.show
 ```
@@ -179,7 +191,7 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
 
 ## Table of Contents
 
-- [Glimmer DSL for LibUI 0.1.8](#-glimmer-dsl-for-libui-018)
+- [Glimmer DSL for LibUI 0.1.9](#-glimmer-dsl-for-libui-019)
   - [Glimmer GUI DSL Concepts](#glimmer-gui-dsl-concepts)
   - [Usage](#usage)
   - [Girb (Glimmer IRB)](#girb-glimmer-irb)
@@ -309,7 +321,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.1.8'
+gem 'glimmer-dsl-libui', '~> 0.1.9'
 ```
 
 Add `require 'glimmer-dsl-libui'` at the top, and then `include Glimmer` into the top-level main object for testing or into an actual class for serious usage.
@@ -383,7 +395,7 @@ w.libui # => #<Fiddle::Pointer:0x00007fde53997980 ptr=0x00007fde51352a60 size=0
 Control(Args) | Properties | Listeners
 ------------- | ---------- | ---------
 `about_menu_item` | None | `on_clicked`
-`area` | None | `on_draw(area_draw_params)`, `on_mouse_event(area_mouse_event)`, `on_mouse_down(area_mouse_event)`, `on_mouse_up(area_mouse_event)`, `on_mouse_drag_started(area_mouse_event)`, `on_mouse_dragged(area_mouse_event)`, `on_mouse_dropped(area_mouse_event)`, `on_mouse_entered`, `on_mouse_exited`
+`area` | None | `on_draw(area_draw_params)`, `on_mouse_event(area_mouse_event)`, `on_mouse_down(area_mouse_event)`, `on_mouse_up(area_mouse_event)`, `on_mouse_drag_started(area_mouse_event)`, `on_mouse_dragged(area_mouse_event)`, `on_mouse_dropped(area_mouse_event)`, `on_mouse_entered`, `on_mouse_exited`, `on_key_event(area_key_event)`, `on_key_down(area_key_event)`, `on_key_up(area_key_event)`
 `arc(x_center as Numeric, y_center as Numeric, radius as Numeric, start_angle as Numeric, sweep as Numeric, is_negative as Boolean)` | `x_center` (`Numeric`), `y_center` (`Numeric`), `radius` (`Numeric`), `start_angle` (`Numeric`), `sweep` (`Numeric`), `is_negative` (Boolean) | None
 `bezier(c1_x as Numeric, c1_y as Numeric, c2_x as Numeric, c2_y as Numeric, end_x as Numeric, end_y as Numeric)` | `c1_x` (`Numeric`), `c1_y` (`Numeric`), `c2_x` (`Numeric`), `c2_y` (`Numeric`), `end_x` (`Numeric`), `end_y` (`Numeric`) | None
 `button(text as String)` | `text` (`String`) | `on_clicked`
@@ -645,18 +657,21 @@ The `area_draw_params` argument for `on_draw` block is a hash consisting of the
 In general, it is recommended to use declarative stable paths whenever feasible since they require less code and simpler maintenance. But, in more advanced cases, semi-declarative dynamic paths could be used instead, especially if there are thousands of dynamic paths that need maximum performance and low memory footprint.
 
 `area` supported mouse listeners are:
-- `on_mouse_event {|area_mouse_event| ...}`: general catch-all mouse event (recommend use fine-grained event below instead)
-- `on_mouse_down {|area_mouse_event)`
-- `on_mouse_up {|area_mouse_event)`
-- `on_mouse_drag_started {|area_mouse_event)`
-- `on_mouse_dragged {|area_mouse_event)`
-- `on_mouse_dropped {|area_mouse_event)`
+- `on_key_event {|area_key_event| ...}`: general catch-all key event (recommend using fine-grained key events below instead)
+- `on_key_down {|area_key_event| ...}`
+- `on_key_up {|area_key_event| ...}`
+- `on_mouse_event {|area_mouse_event| ...}`: general catch-all mouse event (recommend using fine-grained mouse events below instead)
+- `on_mouse_down {|area_mouse_event| ...}`
+- `on_mouse_up {|area_mouse_event| ...}`
+- `on_mouse_drag_started {|area_mouse_event| ...}`
+- `on_mouse_dragged {|area_mouse_event| ...}`
+- `on_mouse_dropped {|area_mouse_event| ...}`
 - `on_mouse_entered {...}`
 - `on_mouse_exited {...}`
 - `on_mouse_crossed {|left| ...}` (NOT RECOMMENDED; it does what `on_mouse_entered` and `on_mouse_exited` do by returning a `left` argument indicating if mouse left `area`)
 - `on_drag_broken {...}` (NOT RECOMMENDED; varies per platforms; use `on_mouse_dropped` instead)
 
-The `area_mouse_event` argument for mouse events that receive it (e.g. `on_mouse_up`, `on_mouse_dragged`) consist of the following keys:
+The `area_mouse_event` `Hash` argument for mouse events that receive it (e.g. `on_mouse_up`, `on_mouse_dragged`) consist of the following hash keys:
 - `:x`: mouse x location in relation to area's top-left-corner
 - `:y`: mouse y location in relation to area's top-left-corner
 - `:area_width`: area current width
@@ -667,6 +682,13 @@ The `area_mouse_event` argument for mouse events that receive it (e.g. `on_mouse
 - `:modifers`: `Array` of `Symbol`s from one of the following: `[:command, :shift, :alt, :control]`
 - `:held`: mouse held button during dragging (e.g. `1` is left button, `4` is right button)
 
+The `area_key_event` `Hash` argument for keyboard events that receive it (e.g. `on_key_up`, `on_key_down`) consist of the following hash keys:
+- `:key`: key character (`String`)
+- `:ext_key`: non-character extra key (`Symbol`) such as `:left`, `:right`, `:escape`, `:insert`
+- `:modifier`: modifier key pressed alone (e.g. `:shift` or `:control`)
+- `:modifiers`: modifier keys pressed simultaneously with `:key`, `:ext_key`, or `:modifier`
+- `:up`: indicates if key has been released or not (Boolean)
+
 Note that when nesting an `area` directly underneath `window` (without a layout control like `vertical_box`), it is automatically reparented with `vertical_box` in between the `window` and `area` since it would not show up on Linux otherwise.
 
 To redraw an `area`, you may call the `#queue_redraw_all` method, or simply `#redraw`.
@@ -3474,6 +3496,18 @@ window('Area Gallery', 400, 400) {
     on_mouse_exited do
       puts 'exited'
     end
+    
+    on_key_event do |area_key_event|
+      p area_key_event
+    end
+    
+    on_key_up do |area_key_event|
+      puts 'key up'
+    end
+    
+    on_key_down do |area_key_event|
+      puts 'key down'
+    end
   }
 }.show
 ```
@@ -3626,6 +3660,18 @@ window('Area Gallery', 400, 400) {
     on_mouse_exited do
       puts 'exited'
     end
+    
+    on_key_event do |area_key_event|
+      p area_key_event
+    end
+    
+    on_key_up do |area_key_event|
+      puts 'key up'
+    end
+    
+    on_key_down do |area_key_event|
+      puts 'key down'
+    end
   }
 }.show
 ```
@@ -3719,6 +3765,18 @@ window('Area Gallery', 400, 400) {
     on_mouse_exited do
       puts 'exited'
     end
+    
+    on_key_event do |area_key_event|
+      p area_key_event
+    end
+    
+    on_key_up do |area_key_event|
+      puts 'key up'
+    end
+    
+    on_key_down do |area_key_event|
+      puts 'key down'
+    end
   }
 }.show
 ```
@@ -3873,6 +3931,18 @@ window('Area Gallery', 400, 400) {
     on_mouse_exited do
       puts 'exited'
     end
+    
+    on_key_event do |area_key_event|
+      p area_key_event
+    end
+    
+    on_key_up do |area_key_event|
+      puts 'key up'
+    end
+    
+    on_key_down do |area_key_event|
+      puts 'key down'
+    end
   }
 }.show
 ```

data/VERSION

@@ -1 +1 @@
-0.1.8
+0.1.9

data/examples/area_gallery.rb

@@ -82,5 +82,17 @@ window('Area Gallery', 400, 400) {
     on_mouse_exited do
       puts 'exited'
     end
+    
+    on_key_event do |area_key_event|
+      p area_key_event
+    end
+    
+    on_key_up do |area_key_event|
+      puts 'key up'
+    end
+    
+    on_key_down do |area_key_event|
+      puts 'key down'
+    end
   }
 }.show

data/examples/area_gallery2.rb

@@ -143,5 +143,17 @@ window('Area Gallery', 400, 400) {
     on_mouse_exited do
       puts 'exited'
     end
+    
+    on_key_event do |area_key_event|
+      p area_key_event
+    end
+    
+    on_key_up do |area_key_event|
+      puts 'key up'
+    end
+    
+    on_key_down do |area_key_event|
+      puts 'key down'
+    end
   }
 }.show

data/examples/area_gallery3.rb

@@ -84,5 +84,17 @@ window('Area Gallery', 400, 400) {
     on_mouse_exited do
       puts 'exited'
     end
+    
+    on_key_event do |area_key_event|
+      p area_key_event
+    end
+    
+    on_key_up do |area_key_event|
+      puts 'key up'
+    end
+    
+    on_key_down do |area_key_event|
+      puts 'key down'
+    end
   }
 }.show

data/examples/area_gallery4.rb

@@ -145,5 +145,17 @@ window('Area Gallery', 400, 400) {
     on_mouse_exited do
       puts 'exited'
     end
+    
+    on_key_event do |area_key_event|
+      p area_key_event
+    end
+    
+    on_key_up do |area_key_event|
+      puts 'key up'
+    end
+    
+    on_key_down do |area_key_event|
+      puts 'key down'
+    end
   }
 }.show

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

@@ -34,9 +34,13 @@ module Glimmer
         class << self
           # this attribute is only populated during on_draw call
           attr_accessor :current_area_draw_params
+          
+          def ext_key_symbols
+            @ext_key_symbols ||= ::LibUI.constants.select { |c| c.to_s.start_with?('ExtKey') }.map { |c| c.to_s.underscore.sub('ext_key_', '') }
+          end
         end
         
-        LISTENERS = ['on_draw', 'on_mouse_event', 'on_mouse_move', 'on_mouse_down', 'on_mouse_up', 'on_mouse_drag_start', 'on_mouse_drag', 'on_mouse_drop', 'on_mouse_crossed', 'on_mouse_enter', 'on_mouse_exit', 'on_drag_broken']
+        LISTENERS = ['on_draw', 'on_mouse_event', 'on_mouse_move', 'on_mouse_down', 'on_mouse_up', 'on_mouse_drag_start', 'on_mouse_drag', 'on_mouse_drop', 'on_mouse_crossed', 'on_mouse_enter', 'on_mouse_exit', 'on_drag_broken', 'on_key_event', 'on_key_down', 'on_key_up']
         LISTENER_ALIASES = {
           on_drawn: 'on_draw',
           on_mouse_moved: 'on_mouse_move',
@@ -110,7 +114,16 @@ module Glimmer
           @area_handler.DragBroken   = fiddle_closure_block_caller(0, [1, 1]) do |_, _|
             on_drag_broken.each { |listener| listener.call }
           end
-          @area_handler.KeyEvent     = fiddle_closure_block_caller(0, [0]) {}
+          @area_handler.KeyEvent     = fiddle_closure_block_caller(0, [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)
+            on_key_event.each { |listener| listener.call(area_key_event) }
+            if area_key_event[:up]
+              on_key_up.each { |listener| listener.call(area_key_event) }
+            else
+              on_key_down.each { |listener| listener.call(area_key_event) }
+            end
+          end
         end
         
         def area_draw_params_hash(area_draw_params)
@@ -139,6 +152,24 @@ module Glimmer
           }
         end
         
+        def area_key_event_hash(area_key_event)
+          {
+            key: key_to_char(area_key_event.Key),
+            ext_key: ext_key_to_symbol(area_key_event.ExtKey),
+            modifier: modifiers_to_symbols(area_key_event.Modifier).first,
+            modifiers: modifiers_to_symbols(area_key_event.Modifiers),
+            up: Glimmer::LibUI.integer_to_boolean(area_key_event.Up),
+          }
+        end
+        
+        def key_to_char(key)
+          key.chr if key > 0
+        end
+        
+        def ext_key_to_symbol(ext_key_value)
+          AreaProxy.ext_key_symbols[ext_key_value - 1].to_s.to_sym if ext_key_value > 0
+        end
+                
         def modifiers_to_symbols(modifiers_value)
           symbols = []
           modifiers_value = extract_symbol_from_modifiers_value(modifiers_value, symbols: symbols) while modifiers_value > 0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-02 00:00:00.000000000 Z
+date: 2021-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.10
+        version: 0.0.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.10
+        version: 0.0.11
 - !ruby/object:Gem::Dependency
   name: juwelier
   requirement: !ruby/object:Gem::Requirement