glimmer-dsl-libui 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6159cc2323ab4b53114187df37e888c3f070102ce1b8a98dbaad724912b999b9
-  data.tar.gz: b0368395d3175a5528732c665f43902f84187a4f62ab23e4f47ebb8d729ac304
+  metadata.gz: 748bd2b706f088ec5e69da3567dac4b59085b374507f9e3dd5e4a2b0432895a0
+  data.tar.gz: 8ff551d013d3d7524698c3ceaf7c5176e190e5ff6ca3bb8189de56a90fc2b3a1
 SHA512:
-  metadata.gz: ede14899e28cc5030f2d49653c51b931e1438934b26f7486843ed518d74fbe33107fa6db7c53a46991895835d9989e275a41474fbf4d2d692ae33d0c6cbf2bfd
-  data.tar.gz: e0964cfde750af8ebe2f14ab326eb477ebf0ed7cea56b7145828af909615a534acd67ec0169ceb41ed3d876bb229fb552dd62cc79ed4f9a552d7e72750d8a108
+  metadata.gz: d2cff96b2dfe600c675feb491e9f396fb436b67430fa72dafd2ae88b69f06027a5cef250d18aa9872ed4329782e6ce7da14d78506e9786b8fc62426c9f985455
+  data.tar.gz: c6b565cf1aba0f603c1233a8411a4ad25f78821f832f0576cf97cad7ebf9b06a0b8f1b3d83200a79da5d998fa5849d10e47b2e9257069dc0fdfe6a1cfdb6b57f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## 0.1.10
+
+- Upgrade to glimmer 2.2.1
+- Add a 3rd tab to examples/grid.rb showcasing the halign and valign properties
+- Support `grid` `halign`/`valign` symbol values of `:fill` (default), `:start`, `:center`, `:end`
+- Add `key_value` to `area_key_event` `Hash`
+- Add `ext_key_value` to `area_key_event` `Hash`
+
 ## 0.1.9
 
 - Support `area` listener: `on_key_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.9
+# [<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.10
 ## 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)
@@ -191,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.9](#-glimmer-dsl-for-libui-019)
+- [Glimmer DSL for LibUI 0.1.10](#-glimmer-dsl-for-libui-0110)
   - [Glimmer GUI DSL Concepts](#glimmer-gui-dsl-concepts)
   - [Usage](#usage)
   - [Girb (Glimmer IRB)](#girb-glimmer-irb)
@@ -321,7 +321,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.1.9'
+gem 'glimmer-dsl-libui', '~> 0.1.10'
 ```
 
 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.
@@ -460,9 +460,9 @@ Control(Args) | Properties | Listeners
 - `xspan` [dsl-only] (`Integer`) [default=`1`]: available in [Glimmer GUI DSL](#glimmer-gui-dsl-concepts) when nested under `grid`
 - `yspan` [dsl-only] (`Integer`) [default=`1`]: available in [Glimmer GUI DSL](#glimmer-gui-dsl-concepts) when nested under `grid`
 - `hexpand` [dsl-only] (Boolean) [default=`false`]: available in [Glimmer GUI DSL](#glimmer-gui-dsl-concepts) when nested under `grid`
-- `halign` [dsl-only] (`Integer`) [default=`0`]: available in [Glimmer GUI DSL](#glimmer-gui-dsl-concepts) when nested under `grid`
+- `halign` [dsl-only] (`:fill`, `:start`, `:center`, or `:end`) [default=`:fill`]: available in [Glimmer GUI DSL](#glimmer-gui-dsl-concepts) when nested under `grid`
 - `vexpand` [dsl-only] (Boolean) [default=`false`]: available in [Glimmer GUI DSL](#glimmer-gui-dsl-concepts) when nested under `grid`
-- `valign` [dsl-only] (`Integer`) [default=`0`]: available in [Glimmer GUI DSL](#glimmer-gui-dsl-concepts) when nested under `grid`
+- `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`
@@ -684,7 +684,9 @@ The `area_mouse_event` `Hash` argument for mouse events that receive it (e.g. `o
 
 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`
+- `:key_value`: key value (`Integer`). Useful in rare cases for numeric processing of keys instead of dealing with as `:key` character `String`
+- `:ext_key`: non-character extra key (`Symbol`) from `Glimmer::LibUI.enum_symbols(:ext_key)` such as `:left`, `:right`, `:escape`, `:insert`
+- `:ext_key_value`: non-character extra key value (`Integer`). Useful in rare cases for numeric processing of extra keys instead of dealing with as `:ext_key` `Symbol`
 - `: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)
@@ -786,7 +788,7 @@ Check [Histogram](#histogram) example for use of hex colors.
 - When destroying a control nested under a `form`, it is automatically deleted from the form's children
 - When destroying a control nested under a `window` or `group`, it is automatically unset as their child to allow successful destruction
 - For `date_time_picker`, `date_picker`, and `time_picker`, make sure `time` hash values for `mon`, `wday`, and `yday` are 1-based instead of [libui](https://github.com/andlabs/libui) original 0-based values, and return `dst` as Boolean instead of `isdst` as `1`/`0`
-- Smart defaults for `grid` child attributes are `left` (`0`), `top` (`0`), `xspan` (`1`), `yspan` (`1`), `hexpand` (`false`), `halign` (`0`), `vexpand` (`false`), and `valign` (`0`)
+- Smart defaults for `grid` child attributes are `left` (`0`), `top` (`0`), `xspan` (`1`), `yspan` (`1`), `hexpand` (`false`), `halign` (`:fill`), `vexpand` (`false`), and `valign` (`:fill`)
 - The `table` control automatically constructs required `TableModelHandler`, `TableModel`, and `TableParams`, calculating all their arguments from `cell_rows` and `editable` properties (e.g. `NumRows`) as well as nested columns (e.g. `text_column`)
 - Table model instances are automatically freed from memory after `window` is destroyed.
 - Table `cell_rows` data has implicit data-binding to table cell values for deletion, insertion, and change (done by diffing `cell_rows` value before and after change and auto-informing `table` of deletions [`LibUI.table_model_row_deleted`], insertions [`LibUI.table_model_row_deleted`], and changes [`LibUI.table_model_row_changed`]). When deleting data rows from `cell_rows` array, then actual rows from the `table` are automatically deleted. When inserting data rows into `cell_rows` array, then actual `table` rows are automatically inserted. When updating data rows in `cell_rows` array, then actual `table` rows are automatically updated.
@@ -2097,13 +2099,15 @@ ruby -r glimmer-dsl-libui -e "require 'examples/grid'"
 
 Mac
 
-![glimmer-dsl-libui-mac-grid-spanning.png](images/glimmer-dsl-libui-mac-grid-spanning.png)
-![glimmer-dsl-libui-mac-grid-expanding.png](images/glimmer-dsl-libui-mac-grid-expanding.png)
+![glimmer-dsl-libui-mac-grid-span.png](images/glimmer-dsl-libui-mac-grid-span.png)
+![glimmer-dsl-libui-mac-grid-expand.png](images/glimmer-dsl-libui-mac-grid-expand.png)
+![glimmer-dsl-libui-mac-grid-align.png](images/glimmer-dsl-libui-mac-grid-align.png)
 
 Linux
 
-![glimmer-dsl-libui-linux-grid-spanning.png](images/glimmer-dsl-libui-linux-grid-spanning.png)
-![glimmer-dsl-libui-linux-grid-expanding.png](images/glimmer-dsl-libui-linux-grid-expanding.png)
+![glimmer-dsl-libui-linux-grid-span.png](images/glimmer-dsl-libui-linux-grid-span.png)
+![glimmer-dsl-libui-linux-grid-expand.png](images/glimmer-dsl-libui-linux-grid-expand.png)
+![glimmer-dsl-libui-linux-grid-align.png](images/glimmer-dsl-libui-linux-grid-align.png)
 
 New [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version:
 
@@ -2114,7 +2118,7 @@ include Glimmer
 
 window('Grid') {
   tab {
-    tab_item('Spanning') {
+    tab_item('Span') {
       grid {
         4.times { |top_value|
           4.times { |left_value|
@@ -2154,7 +2158,7 @@ window('Grid') {
         }
       }
     }
-    tab_item('Expanding') {
+    tab_item('Expand') {
       grid {
         label("(0, 0) hexpand/vexpand\nall available horizontal space is taken\nand\nall\navailable\nvertical\nspace\nis\ntaken") {
           left 0
@@ -2176,6 +2180,42 @@ window('Grid') {
         }
       }
     }
+    tab_item('Align') {
+      grid {
+        label("(0, 0) halign/valign fill\nall available horizontal space is taken\nand\nall\navailable\nvertical\nspace\nis\ntaken") {
+          left 0
+          top 0
+          hexpand true unless OS.mac? # on Mac, only the first label is given all space, so avoid expanding
+          vexpand true unless OS.mac? # on Mac, only the first label is given all space, so avoid expanding
+          halign :fill
+          valign :fill
+        }
+        label("(1, 0) halign/valign start") {
+          left 1
+          top 0
+          hexpand true unless OS.mac? # on Mac, only the first label is given all space, so avoid expanding
+          vexpand true unless OS.mac? # on Mac, only the first label is given all space, so avoid expanding
+          halign :start
+          valign :start
+        }
+        label("(0, 1) halign/valign center") {
+          left 0
+          top 1
+          hexpand true unless OS.mac? # on Mac, only the first label is given all space, so avoid expanding
+          vexpand true unless OS.mac? # on Mac, only the first label is given all space, so avoid expanding
+          halign :center
+          valign :center
+        }
+        label("(1, 1) halign/valign end") {
+          left 1
+          top 1
+          hexpand true unless OS.mac? # on Mac, only the first label is given all space, so avoid expanding
+          vexpand true unless OS.mac? # on Mac, only the first label is given all space, so avoid expanding
+          halign :end
+          valign :end
+        }
+      }
+    }
   }
 }.show
 ```

data/VERSION

@@ -1 +1 @@
-0.1.9
+0.1.10

data/examples/grid.rb

@@ -6,7 +6,7 @@ include Glimmer
 
 window('Grid') {
   tab {
-    tab_item('Spanning') {
+    tab_item('Span') {
       grid {
         4.times { |top_value|
           4.times { |left_value|
@@ -46,7 +46,7 @@ window('Grid') {
         }
       }
     }
-    tab_item('Expanding') {
+    tab_item('Expand') {
       grid {
         label("(0, 0) hexpand/vexpand\nall available horizontal space is taken\nand\nall\navailable\nvertical\nspace\nis\ntaken") {
           left 0
@@ -68,5 +68,41 @@ window('Grid') {
         }
       }
     }
+    tab_item('Align') {
+      grid {
+        label("(0, 0) halign/valign fill\nall available horizontal space is taken\nand\nall\navailable\nvertical\nspace\nis\ntaken") {
+          left 0
+          top 0
+          hexpand true unless OS.mac? # on Mac, only the first label is given all space, so avoid expanding
+          vexpand true unless OS.mac? # on Mac, only the first label is given all space, so avoid expanding
+          halign :fill
+          valign :fill
+        }
+        label("(1, 0) halign/valign start") {
+          left 1
+          top 0
+          hexpand true unless OS.mac? # on Mac, only the first label is given all space, so avoid expanding
+          vexpand true unless OS.mac? # on Mac, only the first label is given all space, so avoid expanding
+          halign :start
+          valign :start
+        }
+        label("(0, 1) halign/valign center") {
+          left 0
+          top 1
+          hexpand true unless OS.mac? # on Mac, only the first label is given all space, so avoid expanding
+          vexpand true unless OS.mac? # on Mac, only the first label is given all space, so avoid expanding
+          halign :center
+          valign :center
+        }
+        label("(1, 1) halign/valign end") {
+          left 1
+          top 1
+          hexpand true unless OS.mac? # on Mac, only the first label is given all space, so avoid expanding
+          vexpand true unless OS.mac? # on Mac, only the first label is given all space, so avoid expanding
+          halign :end
+          valign :end
+        }
+      }
+    }
   }
 }.show

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

@@ -34,10 +34,6 @@ 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', 'on_key_event', 'on_key_down', 'on_key_up']
@@ -155,7 +151,9 @@ module Glimmer
         def area_key_event_hash(area_key_event)
           {
             key: key_to_char(area_key_event.Key),
+            key_value: 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,
             modifiers: modifiers_to_symbols(area_key_event.Modifiers),
             up: Glimmer::LibUI.integer_to_boolean(area_key_event.Up),
@@ -167,7 +165,7 @@ module Glimmer
         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
+          Glimmer::LibUI.enum_symbols(:ext_key)[ext_key_value - 1].to_s.to_sym if ext_key_value > 0
         end
                 
         def modifiers_to_symbols(modifiers_value)

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

@@ -36,7 +36,18 @@ module Glimmer
           child.halign = 0 if child.halign.nil?
           child.vexpand = false if child.vexpand.nil?
           child.valign = 0 if child.valign.nil?
-          ::LibUI.grid_append(@libui, child.libui, child.left, child.top, child.xspan, child.yspan, Glimmer::LibUI.boolean_to_integer(child.hexpand), child.halign, Glimmer::LibUI.boolean_to_integer(child.vexpand), child.valign)
+          ::LibUI.grid_append(
+            @libui,
+            child.libui,
+            child.left,
+            child.top,
+            child.xspan,
+            child.yspan,
+            Glimmer::LibUI.boolean_to_integer(child.hexpand),
+            Glimmer::LibUI.enum_symbol_to_value(:align, child.halign),
+            Glimmer::LibUI.boolean_to_integer(child.vexpand),
+            Glimmer::LibUI.enum_symbol_to_value(:align, child.valign)
+          )
           children << child
         end
         

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

@@ -128,25 +128,11 @@ module Glimmer
         end
         
         def draw_line_cap
-          case @stroke && @stroke[:cap].to_s
-          when 'round'
-            1
-          when 'square'
-            2
-          else # 'flat'
-            0
-          end
+          Glimmer::LibUI.enum_symbol_to_value(:draw_line_cap, @stroke && @stroke[:cap])
         end
         
         def draw_line_join
-          case @stroke && @stroke[:join].to_s
-          when 'round'
-            1
-          when 'bevel'
-            2
-          else # 'miter'
-            0
-          end
+          Glimmer::LibUI.enum_symbol_to_value(:draw_line_join, @stroke && @stroke[:join])
         end
         
         def destroy
@@ -165,20 +151,7 @@ module Glimmer
         end
         
         def init_draw_brush(draw_brush, draw_brush_args)
-          case draw_brush_args[:type]
-          when Integer
-            draw_brush.Type = draw_brush_args[:type]
-          when :solid, 'solid'
-            draw_brush.Type = 0
-          when :linear_gradient, 'linear_gradient'
-            draw_brush.Type = 1
-          when :radial_gradient, 'radial_gradient'
-            draw_brush.Type = 2
-          when :image, 'image'
-            draw_brush.Type = 3
-          else
-            draw_brush.Type = 0
-          end
+          draw_brush.Type = Glimmer::LibUI.enum_symbol_to_value(:draw_brush_type, draw_brush_args[:type])
           draw_brush.R = (draw_brush_args[:r] || draw_brush_args[:red]).to_f / 255.0
           draw_brush.G = (draw_brush_args[:g] || draw_brush_args[:green]).to_f / 255.0
           draw_brush.B = (draw_brush_args[:b] || draw_brush_args[:blue]).to_f / 255.0

data/lib/glimmer/libui.rb

@@ -87,6 +87,23 @@ module Glimmer
         end
         value
       end
+      
+      # Returns ruby underscored symbols for enum values starting with enum name (camelcase, e.g. 'ext_key')
+      def enum_symbols(enum_name)
+        enum_name = enum_name.to_s.underscore.to_sym
+        @enum_symbols ||= {}
+        @enum_symbols[enum_name] ||= ::LibUI.constants.select { |c| c.to_s.start_with?(enum_name.to_s.camelcase(:upper)) }.map { |c| c.to_s.underscore.sub("#{enum_name}_", '').to_sym }
+      end
+      
+      def enum_symbol_to_value(enum_name, enum_symbol, default_index: 0)
+        if enum_symbol.is_a?(Integer)
+          enum_symbol
+        elsif enum_symbols(enum_name).include?(enum_symbol.to_s.to_sym)
+          ::LibUI.const_get("#{enum_name}_#{enum_symbol}".camelcase(:upper))
+        else
+          enum_symbol_to_value(enum_name, enum_symbols(enum_name)[default_index])
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Andy Maleh
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.2.1
 - !ruby/object:Gem::Dependency
   name: os
   requirement: !ruby/object:Gem::Requirement