glimmer-dsl-libui 0.0.16 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ab738eba1965fffc98860a23a44f2e1ed15c0c426ba4d21bcbb3fc4812ecde5
-  data.tar.gz: 2d5c195882767b63d941d9b8bad8338bc5d5ce160e97f34a9f57f5631c833fac
+  metadata.gz: d4f4c60e8967700c477acdd623d75af1b119ab243f90e22b4f9861d9fbde3705
+  data.tar.gz: f92952b04a511a54107114cad3b7b336b4731720b4a6844097353c97fd16f4a5
 SHA512:
-  metadata.gz: 23e1de3b8f30f90abb605a351e6cd9302dd778da2e711f7c72c4ad39b267090bab324bd056ca3855c343781c53757af320ca67c0d4aacac4c6351f7cf4a646e8
-  data.tar.gz: 18f3d9b8d48bc15a342efeb38f6979e1b2516b5144a790876d931c28a2803da840f980d0d9b9cd4c96484817d4cf241d19b7b64c751229fa1ae6a236029545ac
+  metadata.gz: 7fb3cd049cadd55cfb9750c6167804a8af54d793498bc3a67ac1efe913ec4497e2dec7ed19c176d644ecf8f49e721ad33e5b4d49fc32cafb073ccf5b0b08cc9c
+  data.tar.gz: bf246270c2651c86fa311ac72e02dd75c1ba03074286e254edfb6a99ae2dc59a1084e4317649d04cea31abf1c6b68908bf962d5b091a5a205d56830b138eb0ee

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Change Log
 
+## 0.0.20
+
+- New examples/editable_column_table.rb
+- Support `editable` property for `text_column`
+
+## 0.0.19
+
+- New examples/editable_table.rb
+- Support editable `table` control
+- Fix issue with table `text_column` repeating the first column as the second
+
+## 0.0.18
+
+- Support examples/basic_table_image.rb
+- Support table `image_column`
+- Support `image` and `image_part` for building images from rgba byte arrays
+- Rename `Glimmer::LibUI::ControlProxy.all_control_proxies` to `Glimmer::LibUI::ControlProxy.control_proxies`
+- Add `Glimmer::LibUI::ControlProxy.image_proxies`
+
+## 0.0.17
+
+- Support examples/basic_table.rb
+- Support non-editable `table` control
+- Support table `text_column`
+- Support table `cell_rows` property as an `Array` (rows) of `Array`s (row columns) of cell values
+
 ## 0.0.16
 
 - Support ability to instantiate without args and set args as properties afterwards inside block (e.g. `window { title 'Greeter'; content_size 300, 400; button {text 'Greet'; on_clicked {puts 'Hi'}} }`)

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.0.16
+# [<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.0.20
 ## 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)
@@ -43,7 +43,7 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
 
 ## Table of Contents
 
-- [Glimmer DSL for LibUI 0.0.16](#-glimmer-dsl-for-libui-0016)
+- [Glimmer DSL for LibUI 0.0.20](#-glimmer-dsl-for-libui-0020)
   - [Glimmer GUI DSL Concepts](#glimmer-gui-dsl-concepts)
   - [Usage](#usage)
   - [API](#api)
@@ -69,6 +69,10 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
     - [Date Time Picker](#date-time-picker)
     - [Grid](#grid)
     - [Form](#form)
+    - [Basic Table](#basic-table)
+    - [Editable Table](#editable-table)
+    - [Editable Column Table](#editable-column-table)
+    - [Basic Table Image](#basic-table-image)
   - [Contributing to glimmer-dsl-libui](#contributing-to-glimmer-dsl-libui)
   - [Help](#help)
     - [Issues](#issues)
@@ -156,7 +160,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.0.16'
+gem 'glimmer-dsl-libui', '~> 0.0.20'
 ```
 
 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.
@@ -226,6 +230,9 @@ Control(Args) | Properties | Listeners
 `group(text as String)` | `margined` (Boolean), `title` (`String`) | None
 `horizontal_box` | `padded` (Boolean) | None
 `horizontal_separator` | None | None
+`image(width as Numeric, height as Numeric)` | None | None
+`image_part(pixels as String [encoded image rgba byte array], width as Numeric, height as Numeric, byte_stride as Numeric [usually width*4])` | None | None
+`image_column(name as String)` | None | None
 `label(text as String)` | `text` (`String`) | None
 `menu(text as String)` | None | None
 `menu_item(text as String)` | `checked` (Boolean) | `on_clicked`
@@ -241,9 +248,11 @@ Control(Args) | Properties | Listeners
 `spinbox(min as Numeric, max as Numeric)` | `value` (`Numeric`) | `on_changed`
 `tab` | `margined` (Boolean), `num_pages` (`Integer`) | None
 `tab_item(name as String)` | `index` [read-only] (`Integer`), `margined` (Boolean), `name` [read-only] (`String`) | None
+`table` | `cell_rows` (`Array` (rows) of `Arrays` (row columns) of cell values (e.g. `String` values)), `editable` as Boolean | None
+`text_column(name as String)` | `editable` as Boolean | None
 `time_picker` | `time` (`Hash` of keys: `sec` as `Integer`, `min` as `Integer`, `hour` as `Integer`, `mday` as `Integer`, `mon` as `Integer`, `year` as `Integer`, `wday` as `Integer`, `yday` as `Integer`, `dst` as Boolean) | `on_changed`
 `vertical_box` | `padded` (Boolean) | None
-`window(title as String, width as Integer, height as Integer, has_menubar as Boolean)` | `borderless` (Boolean), `content_size` (width `Numeric`, height `Numeric`), `fullscreen` (Boolean), `margined` (Boolean), `title` (`String`) | `on_closing`, `on_content_size_changed`
+`window(title as String, width as Integer, height as Integer, has_menubar as Boolean)` | `borderless` (Boolean), `content_size` (width `Numeric`, height `Numeric`), `fullscreen` (Boolean), `margined` (Boolean), `title` (`String`) | `on_closing`, `on_content_size_changed`, `on_destroy`
 
 ### Common Control Properties
 - `enabled` (Boolean)
@@ -276,7 +285,9 @@ Control(Args) | Properties | Listeners
 
 ### Extra Operations
 
-- `ControlProxy::all_control_proxies`: returns all instantiated control proxies in the application
+- `ControlProxy::control_proxies`: returns all instantiated control proxies in the application
+- `ControlProxy::menu_proxies`: returns all instantiated `menu` proxies in the application
+- `ControlProxy::image_proxies`: returns all instantiated `image` proxies in the application
 - `ControlProxy::main_window_proxy`: returns the first window proxy instantiated in the application
 - `ControlProxy#window_proxy`: returns the window proxy parent for a control
 
@@ -303,6 +314,9 @@ Control(Args) | Properties | Listeners
 - 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`)
+- 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.
+- `image` instances are automatically freed from memory after `window` is destroyed.
 
 ### API Gotchas
 
@@ -496,6 +510,23 @@ window('hello world', 300, 200, true) {
 }.show
 ```
 
+[Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version 2:
+
+```ruby
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+window { # first 3 args can be set via properties with 4th arg has_menubar=true by default
+  title 'hello world'
+  content_size 300, 200
+  
+  on_closing do
+    puts 'Bye Bye'
+  end
+}.show
+```
+
 ### Basic Button
 
 [examples/basic_button.rb](examples/basic_button.rb)
@@ -560,7 +591,7 @@ require 'glimmer-dsl-libui'
 
 include Glimmer
 
-window('hello world', 300, 200, true) { |w|
+window('hello world', 300, 200) { |w|
   button('Button') {
     on_clicked do
       msg_box(w, 'Information', 'You clicked the button')
@@ -573,23 +604,6 @@ window('hello world', 300, 200, true) { |w|
 }.show
 ```
 
-[Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version 2:
-
-```ruby
-require 'glimmer-dsl-libui'
-
-include Glimmer
-
-window { # first 3 args can be set via properties with 4th arg has_menubar=true by default
-  title 'hello world'
-  content_size 300, 200
-  
-  on_closing do
-    puts 'Bye Bye'
-  end
-}.show
-```
-
 ### Basic Entry
 
 [examples/basic_entry.rb](examples/basic_entry.rb)
@@ -1629,8 +1643,8 @@ window('Grid') {
   tab {
     tab_item('Spanning') {
       grid {
-        4.times { |left_value|
-          4.times { |top_value|
+        4.times { |top_value|
+          4.times { |left_value|
             label("(#{left_value}, #{top_value}) xspan1\nyspan1") {
               left left_value
               top top_value
@@ -1749,6 +1763,404 @@ window('Form') { |w|
 }.show
 ```
 
+### Basic Table
+
+[examples/basic_table.rb](examples/basic_table.rb)
+
+Run with this command from the root of the project if you cloned the project:
+
+```
+ruby -r './lib/glimmer-dsl-libui' examples/basic_table.rb
+```
+
+Run with this command if you installed the [Ruby gem](https://rubygems.org/gems/glimmer-dsl-libui):
+
+```
+ruby -r glimmer-dsl-libui -e "require 'examples/basic_table'"
+```
+
+Mac
+
+![glimmer-dsl-libui-mac-basic-table.png](images/glimmer-dsl-libui-mac-basic-table.png)
+
+Linux
+
+![glimmer-dsl-libui-linux-basic-table.png](images/glimmer-dsl-libui-linux-basic-table.png)
+
+[LibUI](https://github.com/kojix2/LibUI) Original Version:
+
+```ruby
+require 'libui'
+
+UI = LibUI
+
+UI.init
+
+main_window = UI.new_window('Animal sounds', 300, 200, 1)
+
+hbox = UI.new_horizontal_box
+UI.window_set_child(main_window, hbox)
+
+data = [
+  %w[cat meow],
+  %w[dog woof],
+  %w[checken cock-a-doodle-doo],
+  %w[hourse neigh],
+  %w[cow moo]
+]
+
+# Protects BlockCaller objects from garbage collection.
+@blockcaller = []
+def rbcallback(*args, &block)
+  args << [0] if args.size == 1 # Argument types are ommited
+  blockcaller = Fiddle::Closure::BlockCaller.new(*args, &block)
+  @blockcaller << blockcaller
+  blockcaller
+end
+
+model_handler = UI::FFI::TableModelHandler.malloc
+model_handler.NumColumns   = rbcallback(4) { 2 }
+model_handler.ColumnType   = rbcallback(4) { 0 }
+model_handler.NumRows      = rbcallback(4) { 5 }
+model_handler.CellValue    = rbcallback(1, [1, 1, 4, 4]) do |_, _, row, column|
+  UI.new_table_value_string(data[row][column])
+end
+model_handler.SetCellValue = rbcallback(0, [0]) {}
+
+model = UI.new_table_model(model_handler)
+
+table_params = UI::FFI::TableParams.malloc
+table_params.Model = model
+table_params.RowBackgroundColorModelColumn = -1
+
+table = UI.new_table(table_params)
+UI.table_append_text_column(table, 'Animal', 0, -1)
+UI.table_append_text_column(table, 'Description', 1, -1)
+
+UI.box_append(hbox, table, 1)
+UI.control_show(main_window)
+
+UI.window_on_closing(main_window) do
+  puts 'Bye Bye'
+  UI.control_destroy(main_window)
+  UI.free_table_model(model)
+  UI.quit
+  0
+end
+
+UI.main
+UI.quit
+```
+
+[Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version:
+
+```ruby
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+data = [
+  %w[cat meow],
+  %w[dog woof],
+  %w[chicken cock-a-doodle-doo],
+  %w[hourse neigh],
+  %w[cow moo]
+]
+
+window('Animal sounds', 300, 200) {
+  horizontal_box {
+    table {
+      text_column('Animal')
+      text_column('Description')
+
+      cell_rows data
+    }
+  }
+  
+  on_closing do
+    puts 'Bye Bye'
+  end
+}.show
+```
+
+### Editable Table
+
+[examples/editable_table.rb](examples/editable_table.rb)
+
+Run with this command from the root of the project if you cloned the project:
+
+```
+ruby -r './lib/glimmer-dsl-libui' examples/editable_table.rb
+```
+
+Run with this command if you installed the [Ruby gem](https://rubygems.org/gems/glimmer-dsl-libui):
+
+```
+ruby -r glimmer-dsl-libui -e "require 'examples/editable_table'"
+```
+
+Mac
+
+![glimmer-dsl-libui-mac-editable-table.png](images/glimmer-dsl-libui-mac-editable-table.png)
+![glimmer-dsl-libui-mac-editable-table-editing.png](images/glimmer-dsl-libui-mac-editable-table-editing.png)
+![glimmer-dsl-libui-mac-editable-table-edited.png](images/glimmer-dsl-libui-mac-editable-table-edited.png)
+
+Linux
+
+![glimmer-dsl-libui-linux-editable-table.png](images/glimmer-dsl-libui-linux-editable-table.png)
+![glimmer-dsl-libui-linux-editable-table-editing.png](images/glimmer-dsl-libui-linux-editable-table-editing.png)
+![glimmer-dsl-libui-linux-editable-table-edited.png](images/glimmer-dsl-libui-linux-editable-table-edited.png)
+
+New [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version:
+
+```ruby
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+data = [
+  %w[cat meow],
+  %w[dog woof],
+  %w[chicken cock-a-doodle-doo],
+  %w[hourse neigh],
+  %w[cow moo]
+]
+
+window('Editable animal sounds', 300, 200) {
+  horizontal_box {
+    table {
+      text_column('Animal')
+      text_column('Description')
+
+      cell_rows data
+      editable true
+    }
+  }
+  
+  on_closing do
+    puts 'Bye Bye'
+  end
+}.show
+```
+
+### Editable Column Table
+
+[examples/editable_column_table.rb](examples/editable_column_table.rb)
+
+Run with this command from the root of the project if you cloned the project:
+
+```
+ruby -r './lib/glimmer-dsl-libui' examples/editable_column_table.rb
+```
+
+Run with this command if you installed the [Ruby gem](https://rubygems.org/gems/glimmer-dsl-libui):
+
+```
+ruby -r glimmer-dsl-libui -e "require 'examples/editable_column_table'"
+```
+
+Mac
+
+![glimmer-dsl-libui-mac-editable-column-table-editing.png](images/glimmer-dsl-libui-mac-editable-column-table-editing.png)
+![glimmer-dsl-libui-mac-editable-column-table-edited.png](images/glimmer-dsl-libui-mac-editable-column-table-edited.png)
+
+Linux
+
+![glimmer-dsl-libui-linux-editable-column-table-editing.png](images/glimmer-dsl-libui-linux-editable-column-table-editing.png)
+![glimmer-dsl-libui-linux-editable-column-table-edited.png](images/glimmer-dsl-libui-linux-editable-column-table-edited.png)
+
+New [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version:
+
+```ruby
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+data = [
+  %w[cat calm meow],
+  %w[dog loyal woof],
+  %w[chicken bird cock-a-doodle-doo],
+  %w[hourse fast neigh],
+  %w[cow slow moo]
+]
+
+window('Editable column animal sounds', 400, 200) {
+  horizontal_box {
+    table {
+      text_column('Animal')
+      text_column('Description')
+      text_column('Sound (Editable)') {
+        editable true
+      }
+
+      cell_rows data
+    }
+  }
+  
+  on_closing do
+    puts 'Bye Bye'
+  end
+}.show
+```
+
+### Basic Table Image
+
+This example has a prerequisite of installing `chunky_png` Ruby gem:
+
+```
+gem install chunky_png -v1.4.0
+```
+
+Also, note that behavior varies per platform (i.e. how `table` chooses to size images by default).
+
+[examples/basic_table_image.rb](examples/basic_table_image.rb)
+
+Run with this command from the root of the project if you cloned the project:
+
+```
+ruby -r './lib/glimmer-dsl-libui' examples/basic_table_image.rb
+```
+
+Run with this command if you installed the [Ruby gem](https://rubygems.org/gems/glimmer-dsl-libui):
+
+```
+ruby -r glimmer-dsl-libui -e "require 'examples/basic_table_image'"
+```
+
+Mac
+
+![glimmer-dsl-libui-mac-basic-table-image.png](images/glimmer-dsl-libui-mac-basic-table-image.png)
+
+Linux
+
+![glimmer-dsl-libui-linux-basic-table-image.png](images/glimmer-dsl-libui-linux-basic-table-image.png)
+
+[LibUI](https://github.com/kojix2/LibUI) Original Version:
+
+```ruby
+# NOTE:
+# This example displays images that can be freely downloaded from the Studio Ghibli website.
+
+require 'libui'
+require 'chunky_png'
+require 'open-uri'
+
+UI = LibUI
+
+UI.init
+
+main_window = UI.new_window('The Red Turtle', 310, 350, 0)
+
+hbox = UI.new_horizontal_box
+UI.window_set_child(main_window, hbox)
+
+IMAGES = []
+
+50.times do |i|
+  url = format('https://www.ghibli.jp/gallery/thumb-redturtle%03d.png', (i + 1))
+  puts "Processing Image: #{url}"
+  f = URI.open(url)
+  canvas = ChunkyPNG::Canvas.from_io(f)
+  f.close
+  data = canvas.to_rgba_stream
+  width = canvas.width
+  height = canvas.height
+  image = UI.new_image(width, height)
+  UI.image_append(image, data, width, height, width * 4)
+  IMAGES << image
+rescue StandardError => e
+  warn url, e.message
+end
+
+# Protects BlockCaller objects from garbage collection.
+@blockcaller = []
+def rbcallback(*args, &block)
+  args << [0] if args.size == 1 # Argument types are ommited
+  blockcaller = Fiddle::Closure::BlockCaller.new(*args, &block)
+  @blockcaller << blockcaller
+  blockcaller
+end
+
+model_handler = UI::FFI::TableModelHandler.malloc
+model_handler.NumColumns   = rbcallback(4) { 1 }
+model_handler.ColumnType   = rbcallback(4) { 1 } # Image
+model_handler.NumRows      = rbcallback(4) { IMAGES.size }
+model_handler.CellValue    = rbcallback(1, [1, 1, 4, 4]) do |_, _, row, _column|
+  UI.new_table_value_image(IMAGES[row])
+end
+model_handler.SetCellValue = rbcallback(0, [0]) {}
+
+model = UI.new_table_model(model_handler)
+
+table_params = UI::FFI::TableParams.malloc
+table_params.Model = model
+table_params.RowBackgroundColorModelColumn = -1
+
+table = UI.new_table(table_params)
+UI.table_append_image_column(table, 'www.ghibli.jp/works/red-turtle', 0)
+
+UI.box_append(hbox, table, 1)
+UI.control_show(main_window)
+
+UI.window_on_closing(main_window) do
+  puts 'Bye Bye'
+  UI.control_destroy(main_window)
+  UI.free_table_model(model)
+  IMAGES.each { |i| UI.free_image(i) }
+  UI.quit
+  0
+end
+
+UI.main
+UI.quit
+```
+
+[Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version:
+
+```ruby
+# NOTE:
+# This example displays images that can be freely downloaded from the Studio Ghibli website.
+
+require 'glimmer-dsl-libui'
+require 'chunky_png'
+require 'open-uri'
+
+include Glimmer
+
+IMAGE_ROWS = []
+
+50.times do |i|
+  url = format('https://www.ghibli.jp/gallery/thumb-redturtle%03d.png', (i + 1))
+  puts "Processing Image: #{url}"
+  f = URI.open(url)
+  canvas = ChunkyPNG::Canvas.from_io(f)
+  f.close
+  data = canvas.to_rgba_stream
+  width = canvas.width
+  height = canvas.height
+  img = image(width, height) {
+    image_part(data, width, height, width * 4)
+  }
+  IMAGE_ROWS << [img] # array of one column cell
+rescue StandardError => e
+  warn url, e.message
+end
+
+window('The Red Turtle', 310, 350, false) {
+  horizontal_box {
+    table {
+      image_column('www.ghibli.jp/works/red-turtle', 0)
+      
+      cell_rows IMAGE_ROWS
+    }
+  }
+    
+  on_closing do
+    puts 'Bye Bye'
+  end
+}.show
+```
+
 ## Contributing to glimmer-dsl-libui
 
 -   Check out the latest master to make sure the feature hasn't been

data/VERSION

@@ -1 +1 @@
-0.0.16
+0.0.20

data/examples/basic_table.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+data = [
+  %w[cat meow],
+  %w[dog woof],
+  %w[chicken cock-a-doodle-doo],
+  %w[hourse neigh],
+  %w[cow moo]
+]
+
+window('Animal sounds', 300, 200) {
+  horizontal_box {
+    table {
+      text_column('Animal')
+      text_column('Description')
+
+      cell_rows data
+    }
+  }
+  
+  on_closing do
+    puts 'Bye Bye'
+  end
+}.show

data/examples/basic_table_image.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# NOTE:
+# This example displays images that can be freely downloaded from the Studio Ghibli website.
+
+require 'glimmer-dsl-libui'
+require 'chunky_png'
+require 'open-uri'
+
+include Glimmer
+
+IMAGE_ROWS = []
+
+50.times do |i|
+  url = format('https://www.ghibli.jp/gallery/thumb-redturtle%03d.png', (i + 1))
+  puts "Processing Image: #{url}"
+  f = URI.open(url)
+  canvas = ChunkyPNG::Canvas.from_io(f)
+  f.close
+  data = canvas.to_rgba_stream
+  width = canvas.width
+  height = canvas.height
+  img = image(width, height) {
+    image_part(data, width, height, width * 4)
+  }
+  IMAGE_ROWS << [img] # array of one column cell
+rescue StandardError => e
+  warn url, e.message
+end
+
+window('The Red Turtle', 310, 350, false) {
+  horizontal_box {
+    table {
+      image_column('www.ghibli.jp/works/red-turtle')
+      
+      cell_rows IMAGE_ROWS
+    }
+  }
+  
+  on_closing do
+    puts 'Bye Bye'
+  end
+}.show

data/examples/editable_column_table.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+data = [
+  %w[cat calm meow],
+  %w[dog loyal woof],
+  %w[chicken bird cock-a-doodle-doo],
+  %w[hourse fast neigh],
+  %w[cow slow moo]
+]
+
+window('Editable column animal sounds', 400, 200) {
+  horizontal_box {
+    table {
+      text_column('Animal')
+      text_column('Description')
+      text_column('Sound (Editable)') {
+        editable true
+      }
+
+      cell_rows data
+    }
+  }
+  
+  on_closing do
+    puts 'Bye Bye'
+  end
+}.show

data/examples/editable_table.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+data = [
+  %w[cat meow],
+  %w[dog woof],
+  %w[chicken cock-a-doodle-doo],
+  %w[hourse neigh],
+  %w[cow moo]
+]
+
+window('Editable animal sounds', 300, 200) {
+  horizontal_box {
+    table {
+      text_column('Animal')
+      text_column('Description')
+
+      cell_rows data
+      editable true
+    }
+  }
+  
+  on_closing do
+    puts 'Bye Bye'
+  end
+}.show

data/examples/grid.rb

@@ -8,8 +8,8 @@ window('Grid') {
   tab {
     tab_item('Spanning') {
       grid {
-        4.times { |left_value|
-          4.times { |top_value|
+        4.times { |top_value|
+          4.times { |left_value|
             label("(#{left_value}, #{top_value}) xspan1\nyspan1") {
               left left_value
               top top_value

data/lib/glimmer/libui/box.rb

@@ -42,7 +42,7 @@ module Glimmer
       
       def destroy_child(child)
         ::LibUI.send("box_delete", @libui, children.index(child))
-        ControlProxy.all_control_proxies.delete(child)
+        ControlProxy.control_proxies.delete(child)
       end
       
       private

data/lib/glimmer/libui/column.rb

@@ -0,0 +1,55 @@
+# Copyright (c) 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/libui/control_proxy'
+
+module Glimmer
+  module LibUI
+    # Common logic for all column proxy objects
+    module Column
+      attr_reader :appended
+      alias appended? appended
+    
+      def initialize(keyword, parent, args, &block)
+        @keyword = keyword
+        @parent_proxy = parent
+        @args = args
+        @block = block
+        @enabled = true
+        post_add_content if @block.nil?
+      end
+      
+      def name
+        @args.first
+      end
+      
+      private
+      
+      def build_control
+        @appended = true
+      end
+      
+      def next_column_index
+        @parent_proxy.columns.map(&:appended?).compact.count
+      end
+    end
+  end
+end

data/lib/glimmer/libui/control_proxy.rb

@@ -33,7 +33,7 @@ module Glimmer
         end
         
         def create(keyword, parent, args, &block)
-          widget_proxy_class(keyword).new(keyword, parent, args, &block).tap {|c| all_control_proxies << c}
+          widget_proxy_class(keyword).new(keyword, parent, args, &block).tap {|c| control_proxies << c}
         end
         
         def widget_proxy_class(keyword)
@@ -46,13 +46,13 @@ module Glimmer
         end
         
         # autosave all controls in this array to avoid garbage collection
-        def all_control_proxies
-          @@all_control_proxies = [] unless defined?(@@all_control_proxies)
-          @@all_control_proxies
+        def control_proxies
+          @@control_proxies = [] unless defined?(@@control_proxies)
+          @@control_proxies
         end
         
         def main_window_proxy
-          all_control_proxies.find {|c| c.is_a?(Glimmer::LibUI::WindowProxy)}
+          control_proxies.find {|c| c.is_a?(Glimmer::LibUI::WindowProxy)}
         end
         
         def integer_to_boolean(int)
@@ -64,7 +64,11 @@ module Glimmer
         end
         
         def menu_proxies
-          all_control_proxies.select {|c| c.keyword == 'menu' }
+          control_proxies.select {|c| c.keyword == 'menu' }
+        end
+        
+        def image_proxies
+          control_proxies.select {|c| c.keyword == 'image' }
         end
         
         def new_control(keyword, args)
@@ -220,7 +224,7 @@ module Glimmer
       
       def default_destroy
         send_to_libui('destroy')
-        ControlProxy.all_control_proxies.delete(self)
+        ControlProxy.control_proxies.delete(self)
       end
             
       def enabled(value = nil)

data/lib/glimmer/libui/form_proxy.rb

@@ -39,7 +39,7 @@ module Glimmer
       
       def destroy_child(child)
         ::LibUI.send("form_delete", @libui, children.index(child))
-        ControlProxy.all_control_proxies.delete(child)
+        ControlProxy.control_proxies.delete(child)
       end
       
       private

data/lib/glimmer/libui/image_column_proxy.rb

@@ -0,0 +1,41 @@
+# Copyright (c) 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/libui/control_proxy'
+require 'glimmer/libui/column'
+
+module Glimmer
+  module LibUI
+    # Proxy for LibUI image column objects
+    #
+    # Follows the Proxy Design Pattern
+    class ImageColumnProxy < ControlProxy
+      include Column
+    
+      private
+      
+      def build_control
+        @parent_proxy.append_image_column(name, next_column_index)
+        super
+      end
+    end
+  end
+end

data/lib/glimmer/libui/image_part_proxy.rb

@@ -0,0 +1,37 @@
+# Copyright (c) 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/libui/control_proxy'
+
+module Glimmer
+  module LibUI
+    # Proxy for LibUI image part objects
+    #
+    # Follows the Proxy Design Pattern
+    class ImagePartProxy < ControlProxy
+      private
+      
+      def build_control
+        @libui = @parent_proxy.append(*@args)
+      end
+    end
+  end
+end

data/lib/glimmer/libui/table_proxy.rb

@@ -0,0 +1,138 @@
+# Copyright (c) 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/libui/control_proxy'
+
+module Glimmer
+  module LibUI
+    # Proxy for LibUI table objects
+    #
+    # Follows the Proxy Design Pattern
+    class TableProxy < ControlProxy
+      attr_reader :model_handler, :model, :table_params, :columns
+    
+      def initialize(keyword, parent, args, &block)
+        @keyword = keyword
+        @parent_proxy = parent
+        @args = args
+        @block = block
+        @enabled = true
+        @columns = []
+        @cell_rows = []
+        window_proxy.on_destroy do
+          # the following unless condition is an exceptional condition stumbled upon that fails freeing the table model
+          ::LibUI.free_table_model(@model) unless @destroyed && parent_proxy.is_a?(Glimmer::LibUI::Box)
+        end
+      end
+      
+      def post_add_content
+        build_control
+        super
+      end
+      
+      def post_initialize_child(child)
+        @columns << child
+      end
+      
+      def destroy
+        super
+        @destroyed = true
+      end
+      
+      def cell_rows(rows = nil)
+        if rows.nil?
+          @cell_rows
+        else
+          rows = rows.map {|row| row.map {|cell| cell.respond_to?(:libui) ? cell.libui : cell }}
+          @cell_rows = rows
+        end
+      end
+      alias cell_rows= cell_rows
+      alias set_cell_rows cell_rows
+      
+      def editable(value = nil)
+        if value.nil?
+          @editable
+        else
+          @editable = !!value
+        end
+      end
+      alias editable= editable
+      alias set_editable editable
+      alias editable? editable
+      
+      private
+      
+      def build_control
+        @model_handler = ::LibUI::FFI::TableModelHandler.malloc
+        @model_handler.NumColumns   = rbcallback(4) { @columns.count }
+        @model_handler.ColumnType   = rbcallback(4) do
+          # Note: this assumes all columns are the same type
+          # TODO support different values per different columns
+          case @columns.first
+          when TextColumnProxy
+            0
+          when ImageColumnProxy
+            1
+          end
+        end
+        @model_handler.NumRows      = rbcallback(4) { cell_rows.count }
+        @model_handler.CellValue    = rbcallback(1, [1, 1, 4, 4]) do |_, _, row, column|
+          case @columns[column]
+          when TextColumnProxy
+            ::LibUI.new_table_value_string((@cell_rows[row] && @cell_rows[row][column]).to_s)
+          when ImageColumnProxy
+            ::LibUI.new_table_value_image((@cell_rows[row] && @cell_rows[row][column]))
+          end
+        end
+        @model_handler.SetCellValue = rbcallback(0, [1, 1, 4, 4, 1]) do |_, _, row, column, val|
+          case @columns[column]
+          when TextColumnProxy
+            @cell_rows[row] ||= []
+            @cell_rows[row][column] = ::LibUI.table_value_string(val).to_s
+          end
+        end
+        
+        @model = ::LibUI.new_table_model(@model_handler)
+        
+        @table_params = ::LibUI::FFI::TableParams.malloc
+        @table_params.Model = @model
+        @table_params.RowBackgroundColorModelColumn = -1
+        
+        @libui = ControlProxy.new_control(@keyword, [@table_params])
+        @libui.tap do
+          @columns.each {|column| column.send(:build_control) }
+        end
+      end
+      
+      def rbcallback(*args, &block)
+        # TODO consider moving to a more general reusable location in the future (e.g. when used with `AreaProxy`)
+        # Protects BlockCaller objects from garbage collection.
+        @blockcaller ||= []
+        args << [0] if args.size == 1 # Argument types are ommited
+        blockcaller = Fiddle::Closure::BlockCaller.new(*args, &block)
+        @blockcaller << blockcaller
+        blockcaller
+      end
+      
+    end
+  end
+end

data/lib/glimmer/libui/text_column_proxy.rb

@@ -0,0 +1,52 @@
+# Copyright (c) 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/libui/control_proxy'
+require 'glimmer/libui/column'
+
+module Glimmer
+  module LibUI
+    # Proxy for LibUI text column objects
+    #
+    # Follows the Proxy Design Pattern
+    class TextColumnProxy < ControlProxy
+      include Column
+          
+      def editable(value = nil)
+        if value.nil?
+          @editable
+        else
+          @editable = !!value
+        end
+      end
+      alias editable= editable
+      alias set_editable editable
+      alias editable? editable
+          
+      private
+      
+      def build_control
+        @parent_proxy.append_text_column(name, next_column_index, @parent_proxy.editable? || editable? ? -2 : -1)
+        super
+      end
+    end
+  end
+end

data/lib/glimmer/libui/window_proxy.rb

@@ -40,6 +40,17 @@ module Glimmer
         ::LibUI.send("window_set_child", @libui, nil)
         super
       end
+      
+      def destroy
+        super
+        ControlProxy.image_proxies.each { |image_proxy| ::LibUI.free_image(image_proxy.libui) }
+        @on_destroy_procs&.each { |on_destroy_proc| on_destroy_proc.call(self)}
+      end
+      
+      def on_destroy(&block)
+        @on_destroy_procs ||= []
+        @on_destroy_procs << block
+      end
     
       def show
         super

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.20
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-23 00:00:00.000000000 Z
+date: 2021-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -162,8 +162,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
 description: Glimmer DSL for LibUI - Prerequisite-Free Ruby Desktop Development GUI
-  Library (no need to pre-install any prerequisites. Just install the gem and have
+  Library (No need to pre-install any prerequisites. Just install the gem and have
   platform-independent native GUI that just works!)
 email: andy.am@gmail.com
 executables:
@@ -182,11 +196,15 @@ files:
 - bin/girb_runner.rb
 - examples/basic_button.rb
 - examples/basic_entry.rb
+- examples/basic_table.rb
+- examples/basic_table_image.rb
 - examples/basic_window.rb
 - examples/basic_window2.rb
 - examples/color_button.rb
 - examples/control_gallery.rb
 - examples/date_time_picker.rb
+- examples/editable_column_table.rb
+- examples/editable_table.rb
 - examples/font_button.rb
 - examples/form.rb
 - examples/grid.rb
@@ -209,6 +227,7 @@ files:
 - lib/glimmer/libui/check_menu_item_proxy.rb
 - lib/glimmer/libui/checkbox_proxy.rb
 - lib/glimmer/libui/color_button_proxy.rb
+- lib/glimmer/libui/column.rb
 - lib/glimmer/libui/combobox_proxy.rb
 - lib/glimmer/libui/control_proxy.rb
 - lib/glimmer/libui/date_picker_proxy.rb
@@ -219,6 +238,8 @@ files:
 - lib/glimmer/libui/grid_proxy.rb
 - lib/glimmer/libui/group_proxy.rb
 - lib/glimmer/libui/horizontal_box_proxy.rb
+- lib/glimmer/libui/image_column_proxy.rb
+- lib/glimmer/libui/image_part_proxy.rb
 - lib/glimmer/libui/label_proxy.rb
 - lib/glimmer/libui/menu_item_proxy.rb
 - lib/glimmer/libui/menu_proxy.rb
@@ -229,6 +250,8 @@ files:
 - lib/glimmer/libui/radio_buttons_proxy.rb
 - lib/glimmer/libui/separator_menu_item_proxy.rb
 - lib/glimmer/libui/tab_item_proxy.rb
+- lib/glimmer/libui/table_proxy.rb
+- lib/glimmer/libui/text_column_proxy.rb
 - lib/glimmer/libui/time_picker_proxy.rb
 - lib/glimmer/libui/vertical_box_proxy.rb
 - lib/glimmer/libui/window_proxy.rb