glimmer-dsl-libui 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26461689045ba139f45bc8b50392f77a261c4f3ade65ed9f64da188086d0f2e5
-  data.tar.gz: a8745528d47f04cff8c6d65d03e7d732dc06ab3b35dbea6d754253a5eddcd543
+  metadata.gz: 7aedcfa3ba9a8d44ce0df9ee4f684535d3492c858ca0171f4181a80ed4772899
+  data.tar.gz: 21f8b0577f27116216821c2bcbe3fd458261a5f8c957c5c0a2aa4683d370310d
 SHA512:
-  metadata.gz: 286be15f2b3df417ee6c7e904508d186353118a74547a87d0eef1d79670d7d4b405a803b3ba7c86c96d0665fbf7e8673f846aad55b2ce71f45b478ce05a904f7
-  data.tar.gz: 93e2451a94d4ec59c04a20dd6cd6cd34c3b8efb00d19d40cba7cbe6ef5c57efb0e0c689ea122d884fb0873dc7fcd50b3d68c032b0c712b9581e66303b8148257
+  metadata.gz: fc1404d69d320e772a50506bfde13942cc7f981fb932c1c0999340c1c048ce64935eeac799d6af3b258a1a18ccb3472b9915814da72a96f5fb4d5f0b9af13fb6
+  data.tar.gz: eac5a371a0d685fab5cd397a43f7b25c333d855b5972c898dd0794c4001f61c08440d5da4f80911017155f0c051cea79391eefa5e603e13fb5292db12f4d2689

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 0.7.2
+
+- `table` `on_selection_changed` listener arguments now provide extra arguments of `selection`, `added_selection`, `removed_selection` after first argument (`table`)
+- Update `examples/basic_table_selection.rb` to use new `on_selection_changed` arguments of `selection`, `added_selection`, and `removed_selection`
+
 ## 0.7.1
 
 - `table` column `on_clicked` listener (can be nested under `text_column`, `text_color_column`, `button_column`, `checkbox_column`, `checkbox_text_color_column`, `image_column`, `image_text_color_column`, `image_text_column`, and `progress_bar_column`)

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.1
+# [<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.2
 ## 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.1'
+gem 'glimmer-dsl-libui', '~> 0.7.2'
 ```
 
 Test that installation worked by running the [Meta-Example](#examples):
@@ -736,7 +736,7 @@ Keyword(Args) | Properties | Listeners
 `string(string = '')` | `font`, `color` (`Hash` of `:r` as `0`-`255`, `:g` as `0`-`255`, `:b` as `0`-`255`, `:a` as `0.0`-`1.0`, hex, or [X11](https://en.wikipedia.org/wiki/X11_color_names) color), `background` (`Hash` of `:r` as `0`-`255`, `:g` as `0`-`255`, `:b` as `0`-`255`, `:a` as `0.0`-`1.0`, hex, or [X11](https://en.wikipedia.org/wiki/X11_color_names) color), `underline`, `underline_color` (`Hash` of `:r` as `0`-`255`, `:g` as `0`-`255`, `:b` as `0`-`255`, `:a` as `0.0`-`1.0`, hex, or [X11](https://en.wikipedia.org/wiki/X11_color_names) color), `open_type_features`, `string` (`String`) | None
 `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 for `text_column` cells or `Array` of `image`/`String` for `image_text_column`)), `editable` as Boolean, `selection_mode` (`:zero_or_many` , `:none` , `:zero_or_one` , or `:one`), `selection` (`Integer` for row index or `Array` of multiple row indexes), `header_visible` (Boolean) | `on_changed {|row, type, row_data| ...}`, `on_edited {|row, row_data| ...}`, `on_row_clicked {|table, row| }`, `on_row_double_clicked {|table, row| }`, and `on_selection_changed {|table| }`
+`table` | `cell_rows` (`Array` (rows) of `Arrays` (row columns) of cell values (e.g. `String` values for `text_column` cells or `Array` of `image`/`String` for `image_text_column`)), `editable` as Boolean, `selection_mode` (`:zero_or_many` , `:none` , `:zero_or_one` , or `:one`), `selection` (`Integer` for row index or `Array` of multiple row indexes), `header_visible` (Boolean) | `on_changed {|row, type, row_data| ...}`, `on_edited {|row, row_data| ...}`, `on_row_clicked {|table, row| }`, `on_row_double_clicked {|table, row| }`, and `on_selection_changed {|table, selection, added_selection, removed_selection| }`
 `text(x = 0 as Numeric, y = 0 as Numeric, width = area_width as Numeric)` | `align`, `default_font` | None
 `text_column(name as String)` | `editable` (Boolean), `sort_indicator` (`:ascending` [alias: `:asc`, `:a`], `:descending` [alias: `:desc`, `:d`], or `nil`) | `on_clicked {|tc, column_index| }`
 `text_color_column(name as String)` | `editable` (Boolean) | None

data/VERSION

@@ -1 +1 @@
-0.7.1
+0.7.2

data/docs/examples/GLIMMER-DSL-LIBUI-BASIC-EXAMPLES.md

@@ -1521,6 +1521,10 @@ ruby -r glimmer-dsl-libui -e "require 'examples/basic_table_selection'"
 ```
 
 ![glimmer-dsl-libui-mac-basic-table-selection-one.png](/images/glimmer-dsl-libui-mac-basic-table-selection-one.png)
+![glimmer-dsl-libui-mac-basic-table-selection-zero-or-one.png](/images/glimmer-dsl-libui-mac-basic-table-selection-zero-or-one.png)
+![glimmer-dsl-libui-mac-basic-table-selection-zero-or-many.png](/images/glimmer-dsl-libui-mac-basic-table-selection-zero-or-many.png)
+![glimmer-dsl-libui-mac-basic-table-selection-none.png](/images/glimmer-dsl-libui-mac-basic-table-selection-none.png)
+![glimmer-dsl-libui-mac-basic-table-selection-header-not-visible.png](/images/glimmer-dsl-libui-mac-basic-table-selection-header-not-visible.png)
 
 ## Basic Area
 

data/examples/basic_table_selection.rb

@@ -4,16 +4,17 @@ class BasicTableSelection
   include Glimmer::LibUI::Application
   
   before_body do
-    @one_data = [
+    data = [
       %w[cat meow],
       %w[dog woof],
       %w[chicken cock-a-doodle-doo],
       %w[horse neigh],
       %w[cow moo]
     ]
-    @zero_or_one_data = @one_data.dup
-    @zero_or_many_data = @one_data.dup
-    @none_data = @one_data.dup
+    @one_table_data = data.dup
+    @zero_or_one_table_data = data.dup
+    @zero_or_many_table_data = data.dup
+    @none_table_data = data.dup
   end
   
   body {
@@ -24,8 +25,8 @@ class BasicTableSelection
             vertical_box {
               stretchy false
               
-              @one_radio_buttons = radio_buttons {
-                items @one_data.size.times.map { |row| "Row #{row} Selection" }
+              @one_table_selection_radio_buttons = radio_buttons {
+                items @one_table_data.size.times.map { |row| "Row #{row} Selection" }
                 
                 on_selected do |rb|
                   @one_table.selection = [rb.selected]
@@ -43,31 +44,21 @@ class BasicTableSelection
             
             @one_table = table {
               text_column('Animal') {
-                # sort_indicator :descending # can be :ascending, :descending, or nil (default)
+                # sort_indicator :descending # (optional) can be :ascending, :descending, or nil (default)
                 
                 on_clicked do |tc, column|
-                  puts "Clicked column #{column}: #{tc.name}"
-                  selected_row = @one_table.selection && @one_data[@one_table.selection]
-                  tc.toggle_sort_indicator
-                  @one_data.sort_by! { |row_data| row_data[column] }
-                  @one_data.reverse! if tc.sort_indicator == :descending
-                  @one_table.selection = @one_data.index(selected_row)
+                  sort_one_table_column(tc, column)
                 end
               }
               text_column('Description') {
-                # sort_indicator :descending # can be :ascending, :descending, or nil (default)
+                # sort_indicator :descending # (optional) can be :ascending, :descending, or nil (default)
                 
                 on_clicked do |tc, column|
-                  puts "Clicked column #{column}: #{tc.name}"
-                  selected_row = @one_table.selection && @one_data[@one_table.selection]
-                  tc.toggle_sort_indicator
-                  @one_data.sort_by! { |row_data| row_data[column] }
-                  @one_data.reverse! if tc.sort_indicator == :descending
-                  @one_table.selection = @one_data.index(selected_row)
+                  sort_one_table_column(tc, column)
                 end
               }
         
-              cell_rows @one_data
+              cell_rows @one_table_data
               selection_mode :one # other values are :zero_or_many , :zero_or_one, :none (default is :zero_or_one if not specified)
               selection 2 # initial selection row index (could be nil too or just left off, defaulting to 0)
               # header_visible true # default
@@ -80,11 +71,13 @@ class BasicTableSelection
                 puts "Row Double Clicked: #{row}"
               end
         
-              on_selection_changed do |t|
+              on_selection_changed do |t, selection, added_selection, removed_selection|
                 # selection is an array or nil if selection mode is zero_or_many
                 # otherwise, selection is a single index integer or nil when not selected
-                puts "Selection Changed: #{t.selection.inspect}"
-                @one_radio_buttons.selected = t.selection
+                puts "Selection Changed: #{selection.inspect}"
+                puts "Added Selection: #{added_selection.inspect}"
+                puts "Removed Selection: #{removed_selection.inspect}"
+                @one_table_selection_radio_buttons.selected = selection
               end
             }
           }
@@ -95,8 +88,8 @@ class BasicTableSelection
             vertical_box {
               stretchy false
               
-              @zero_or_one_radio_buttons = radio_buttons {
-                items @zero_or_one_data.size.times.map { |row| "Row #{row} Selection" }
+              @zero_or_one_table_selection_radio_buttons = radio_buttons {
+                items @zero_or_one_table_data.size.times.map { |row| "Row #{row} Selection" }
                 
                 on_selected do |rb|
                   @zero_or_one_table.selection = [rb.selected]
@@ -114,31 +107,21 @@ class BasicTableSelection
             
             @zero_or_one_table = table {
               text_column('Animal') {
-                # sort_indicator :descending # can be :ascending, :descending, or nil (default)
+                # sort_indicator :descending # (optional) can be :ascending, :descending, or nil (default)
                 
                 on_clicked do |tc, column|
-                  puts "Clicked column #{column}: #{tc.name}"
-                  selected_row = @zero_or_one_table.selection && @zero_or_one_data[@zero_or_one_table.selection]
-                  tc.toggle_sort_indicator
-                  @zero_or_one_data.sort_by! { |row_data| row_data[column] }
-                  @zero_or_one_data.reverse! if tc.sort_indicator == :descending
-                  @zero_or_one_table.selection = @zero_or_one_data.index(selected_row)
+                  sort_zero_or_one_table_column(tc, column)
                 end
               }
               text_column('Description') {
-                # sort_indicator :descending # can be :ascending, :descending, or nil (default)
+                # sort_indicator :descending # (optional) can be :ascending, :descending, or nil (default)
                 
                 on_clicked do |tc, column|
-                  puts "Clicked column #{column}: #{tc.name}"
-                  selected_row = @zero_or_one_table.selection && @zero_or_one_data[@zero_or_one_table.selection]
-                  tc.toggle_sort_indicator
-                  @zero_or_one_data.sort_by! { |row_data| row_data[column] }
-                  @zero_or_one_data.reverse! if tc.sort_indicator == :descending
-                  @zero_or_one_table.selection = @zero_or_one_data.index(selected_row)
+                  sort_zero_or_one_table_column(tc, column)
                 end
               }
         
-              cell_rows @zero_or_one_data
+              cell_rows @zero_or_one_table_data
               selection_mode :zero_or_one # other values are :zero_or_many , :one, :none (default is :zero_or_one if not specified)
               # selection 0 # initial selection row index (could be nil too or just left off)
               # header_visible true # default
@@ -151,11 +134,13 @@ class BasicTableSelection
                 puts "Row Double Clicked: #{row}"
               end
         
-              on_selection_changed do |t|
+              on_selection_changed do |t, selection, added_selection, removed_selection|
                 # selection is an array or nil if selection mode is zero_or_many
                 # otherwise, selection is a single index integer or nil when not selected
-                puts "Selection Changed: #{t.selection.inspect}"
-                @zero_or_one_radio_buttons.selected = t.selection
+                puts "Selection Changed: #{selection.inspect}"
+                puts "Added Selection: #{added_selection.inspect}"
+                puts "Removed Selection: #{removed_selection.inspect}"
+                @zero_or_one_table_selection_radio_buttons.selected = selection
               end
             }
           }
@@ -166,7 +151,7 @@ class BasicTableSelection
             vertical_box {
               stretchy false
               
-              @zero_or_many_checkboxes = @zero_or_many_data.size.times.map do |row|
+              @zero_or_many_table_selection_checkboxes = @zero_or_many_table_data.size.times.map do |row|
                 checkbox("Row #{row} Selection") {
                   on_toggled do |c|
                     table_selection = @zero_or_many_table.selection.to_a
@@ -191,31 +176,21 @@ class BasicTableSelection
             
             @zero_or_many_table = table {
               text_column('Animal') {
-                # sort_indicator :descending # can be :ascending, :descending, or nil (default)
+                # sort_indicator :descending # (optional) can be :ascending, :descending, or nil (default)
                 
                 on_clicked do |tc, column|
-                  puts "Clicked column #{column}: #{tc.name}"
-                  selected_rows = @zero_or_many_table.selection&.map { |row| @zero_or_many_data[row] }
-                  tc.toggle_sort_indicator
-                  @zero_or_many_data.sort_by! { |row_data| row_data[column] }
-                  @zero_or_many_data.reverse! if tc.sort_indicator == :descending
-                  @zero_or_many_table.selection = selected_rows&.map {|row_data| @zero_or_many_data.index(row_data) }
+                  sort_zero_or_many_table_column(tc, column)
                 end
               }
               text_column('Description') {
-                # sort_indicator :descending # can be :ascending, :descending, or nil (default)
+                # sort_indicator :descending # (optional) can be :ascending, :descending, or nil (default)
                 
                 on_clicked do |tc, column|
-                  puts "Clicked column #{column}: #{tc.name}"
-                  selected_rows = @zero_or_many_table.selection&.map { |row| @zero_or_many_data[row] }
-                  tc.toggle_sort_indicator
-                  @zero_or_many_data.sort_by! { |row_data| row_data[column] }
-                  @zero_or_many_data.reverse! if tc.sort_indicator == :descending
-                  @zero_or_many_table.selection = selected_rows&.map {|row_data| @zero_or_many_data.index(row_data) }
+                  sort_zero_or_many_table_column(tc, column)
                 end
               }
         
-              cell_rows @zero_or_many_data
+              cell_rows @zero_or_many_table_data
               selection_mode :zero_or_many # other values are :none , :zero_or_one , and :one (default is :zero_or_one if not specified)
               selection 0, 2, 4 # initial selection row indexes (could be empty array too or just left off)
               # header_visible true # default
@@ -228,13 +203,17 @@ class BasicTableSelection
                 puts "Row Double Clicked: #{row}"
               end
         
-              on_selection_changed do |t|
+              on_selection_changed do |t, selection, added_selection, removed_selection|
                 # selection is an array or nil if selection mode is zero_or_many
                 # otherwise, selection is a single index integer or nil when not selected
-                puts "Selection Changed: #{t.selection.inspect}"
-                @zero_or_many_checkboxes.each { |cb| cb.checked = false }
-                t.selection&.each do |selected_row|
-                  @zero_or_many_checkboxes[selected_row].checked = true
+                puts "Selection Changed: #{selection.inspect}"
+                puts "Added Selection: #{added_selection.inspect}"
+                puts "Removed Selection: #{removed_selection.inspect}"
+                removed_selection&.each do |selected_row|
+                  @zero_or_many_table_selection_checkboxes[selected_row].checked = false
+                end
+                added_selection&.each do |selected_row|
+                  @zero_or_many_table_selection_checkboxes[selected_row].checked = true
                 end
               end
             }
@@ -253,31 +232,21 @@ class BasicTableSelection
             
             @none_table = table {
               text_column('Animal') {
-                # sort_indicator :descending # can be :ascending, :descending, or nil (default)
+                # sort_indicator :descending # (optional) can be :ascending, :descending, or nil (default)
                 
                 on_clicked do |tc, column|
-                  puts "Clicked column #{column}: #{tc.name}"
-                  selected_row = @none_table.selection && @none_data[@none_table.selection]
-                  tc.toggle_sort_indicator
-                  @none_data.sort_by! { |row_data| row_data[column] }
-                  @none_data.reverse! if tc.sort_indicator == :descending
-                  @none_table.selection = @none_data.index(selected_row)
+                  sort_none_table_column(tc, column)
                 end
               }
               text_column('Description') {
-                # sort_indicator :descending # can be :ascending, :descending, or nil (default)
+                # sort_indicator :descending # (optional) can be :ascending, :descending, or nil (default)
                 
                 on_clicked do |tc, column|
-                  puts "Clicked column #{column}: #{tc.name}"
-                  selected_row = @none_table.selection && @none_data[@none_table.selection]
-                  tc.toggle_sort_indicator
-                  @none_data.sort_by! { |row_data| row_data[column] }
-                  @none_data.reverse! if tc.sort_indicator == :descending
-                  @none_table.selection = @none_data.index(selected_row)
+                  sort_none_table_column(tc, column)
                 end
               }
         
-              cell_rows @none_data
+              cell_rows @none_table_data
               selection_mode :none # other values are :zero_or_many , :zero_or_one, :one (default is :zero_or_one if not specified)
               # header_visible true # default
         
@@ -288,12 +257,6 @@ class BasicTableSelection
               on_row_double_clicked do |t, row|
                 puts "Row Double Clicked: #{row}"
               end
-        
-              on_selection_changed do |t|
-                # selection is an array or nil if selection mode is zero_or_many
-                # otherwise, selection is a single index integer or nil when not selected
-                puts "Selection Changed: #{t.selection.inspect}"
-              end
             }
           }
         }
@@ -301,6 +264,40 @@ class BasicTableSelection
       }
     }
   }
+  
+  def sort_one_table_column(tc, column)
+    puts "Clicked column #{column}: #{tc.name}"
+    selected_row = @one_table.selection && @one_table_data[@one_table.selection]
+    tc.toggle_sort_indicator
+    @one_table_data.sort_by! { |row_data| row_data[column] }
+    @one_table_data.reverse! if tc.sort_indicator == :descending
+    @one_table.selection = @one_table_data.index(selected_row)
+  end
+  
+  def sort_zero_or_one_table_column(tc, column)
+    puts "Clicked column #{column}: #{tc.name}"
+    selected_row = @zero_or_one_table.selection && @zero_or_one_table_data[@zero_or_one_table.selection]
+    tc.toggle_sort_indicator
+    @zero_or_one_table_data.sort_by! { |row_data| row_data[column] }
+    @zero_or_one_table_data.reverse! if tc.sort_indicator == :descending
+    @zero_or_one_table.selection = @zero_or_one_table_data.index(selected_row)
+  end
+  
+  def sort_zero_or_many_table_column(tc, column)
+    puts "Clicked column #{column}: #{tc.name}"
+    selected_rows = @zero_or_many_table.selection&.map { |row| @zero_or_many_table_data[row] }
+    tc.toggle_sort_indicator
+    @zero_or_many_table_data.sort_by! { |row_data| row_data[column] }
+    @zero_or_many_table_data.reverse! if tc.sort_indicator == :descending
+    @zero_or_many_table.selection = selected_rows&.map {|row_data| @zero_or_many_table_data.index(row_data) }
+  end
+  
+  def sort_none_table_column(tc, column)
+    puts "Clicked column #{column}: #{tc.name}"
+    tc.toggle_sort_indicator
+    @none_table_data.sort_by! { |row_data| row_data[column] }
+    @none_table_data.reverse! if tc.sort_indicator == :descending
+  end
 end
 
 BasicTableSelection.launch

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

@@ -164,11 +164,11 @@ module Glimmer
           value = value.first if value.size == 1
           @selection = value
           return @selection if !@content_added
-          return if value.nil?
+          return if @selection.nil?
         
           ts = ::LibUI::FFI::TableSelection.malloc
-          ts.NumRows = value.is_a?(Array) ? value.size : 1
-          ts.Rows = [value].flatten.pack('i*')
+          ts.NumRows = @selection.is_a?(Array) ? @selection.size : 1
+          ts.Rows = [@selection].flatten.pack('i*')
           super(ts)
           # TODO figure out why ensure block is not working (perhaps libui auto-frees that resource upon setting selection)
           # Delete following code if not needed.
@@ -248,9 +248,18 @@ module Glimmer
         end
         
         def handle_listener(listener_name, &listener)
-          # if content has been added, then you can register listeners immediately (without accumulation
-          if CUSTOM_LISTENER_NAMES.include?(listener_name.to_s) || @content_added
-            super
+          # if content has been added, then you can register listeners immediately (without accumulation)
+          if CUSTOM_LISTENER_NAMES.include?(listener_name) || @content_added
+            actual_listener = listener
+            case listener_name
+            when 'on_selection_changed'
+              actual_listener = Proc.new do |myself, *args|
+                added_selection = selection.is_a?(Array) ? (selection - @old_selection.to_a) : selection
+                removed_selection = selection.is_a?(Array) ? (@old_selection.to_a - selection) : @old_selection
+                listener.call(myself, selection, added_selection, removed_selection)
+              end
+            end
+            super(listener_name, &actual_listener)
           else
             # if content is not added yet, then accumulate listeners to register later when table content is closed
             @table_listeners ||= []
@@ -603,6 +612,9 @@ module Glimmer
           @table_listeners&.each do |listener_name, listener|
             handle_listener(listener_name, &listener)
           end
+          handle_listener('on_selection_changed') do |myself, selection, added_selection, removed_selection|
+            @old_selection = selection
+          end
         end
         
         def register_column_listeners

data/lib/glimmer/libui/control_proxy.rb

@@ -167,6 +167,7 @@ module Glimmer
       end
       
       def handle_listener(listener_name, &listener)
+        # replace first listener argument (control libui pointer) with actual Ruby libui object
         safe_listener = Proc.new { |*args| listener.call(self, *args[1..-1]) }
         if ::LibUI.respond_to?("#{libui_api_keyword}_#{listener_name}")
           if listeners[listener_name].nil?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-12 00:00:00.000000000 Z
+date: 2023-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer