glimmer-dsl-libui 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a247176e108fe8ba8dd7016b69bb0c6413e3b6c00c78aa068c28e70c11ec5330
-  data.tar.gz: 94aa3f51dd0576748ea09a9899d0f26f230457a315dce3a55ef5c4aa22ce4434
+  metadata.gz: 26461689045ba139f45bc8b50392f77a261c4f3ade65ed9f64da188086d0f2e5
+  data.tar.gz: a8745528d47f04cff8c6d65d03e7d732dc06ab3b35dbea6d754253a5eddcd543
 SHA512:
-  metadata.gz: 7a2e9ef07ac5b946e871577be49c34e0b8e38dbc506d0787178d1f5c01d1fe3294c1656bcb0ede0e6b16323760d1f47688ee023251079b95bdfa55a4e805f936
-  data.tar.gz: 1d335aaa18baad73376426d7c8cdd4669a14e961b91f9c7cdf58f9427afde8cb1ab100b436fae24f72e9249e41f23aae8accb55679cfa23692b7ab62725d6a4a
+  metadata.gz: 286be15f2b3df417ee6c7e904508d186353118a74547a87d0eef1d79670d7d4b405a803b3ba7c86c96d0665fbf7e8673f846aad55b2ce71f45b478ce05a904f7
+  data.tar.gz: 93e2451a94d4ec59c04a20dd6cd6cd34c3b8efb00d19d40cba7cbe6ef5c57efb0e0c689ea122d884fb0873dc7fcd50b3d68c032b0c712b9581e66303b8148257

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## 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`)
+- `table` column `sort_indicator` property (can be `nil`, `:ascending` [aliases: `:asc`, `:a`], `:descending` [aliases: `:desc`, `:d`])
+- `table` column `set_sort_indicator` alias for `sort_indicator=` can accept an option of `reset_columns: false` to avoid resetting sort indicator of other columns when setting sort indicator on a specific column
+- `table` `header_visible` property (Boolean)
+- Fix issue with `table` `selection_mode` getting set to `nil` if not specified
+
 ## 0.7.0
 
 - Upgrade to libui v0.1.2.pre (including newer libui-ng with table selection API)

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.0
+# [<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
 ## 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.0'
+gem 'glimmer-dsl-libui', '~> 0.7.1'
 ```
 
 Test that installation worked by running the [Meta-Example](#examples):
@@ -736,9 +736,9 @@ 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) | `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| }`
 `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) | 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
 `time_picker` | `time` (`Hash` of keys: `sec` as `Integer`, `min` as `Integer`, `hour` as `Integer`) | `on_changed`
 `vertical_box` | `padded` (Boolean) | None

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.7.1

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

@@ -1520,6 +1520,8 @@ Run with this command if you installed the [Ruby gem](https://rubygems.org/gems/
 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)
+
 ## Basic Area
 
 [examples/basic_area.rb](/examples/basic_area.rb)

data/examples/basic_table_selection.rb

@@ -4,13 +4,16 @@ class BasicTableSelection
   include Glimmer::LibUI::Application
   
   before_body do
-    @data = [
+    @one_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
   end
   
   body {
@@ -22,7 +25,7 @@ class BasicTableSelection
               stretchy false
               
               @one_radio_buttons = radio_buttons {
-                items @data.size.times.map { |row| "Row #{row} Selection" }
+                items @one_data.size.times.map { |row| "Row #{row} Selection" }
                 
                 on_selected do |rb|
                   @one_table.selection = [rb.selected]
@@ -30,13 +33,44 @@ class BasicTableSelection
               }
             }
             
+            button('Toggle Table Header Visibility') {
+              stretchy false
+              
+              on_clicked do
+                @one_table.header_visible = !@one_table.header_visible
+              end
+            }
+            
             @one_table = table {
-              text_column('Animal')
-              text_column('Description')
+              text_column('Animal') {
+                # sort_indicator :descending # 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)
+                end
+              }
+              text_column('Description') {
+                # sort_indicator :descending # 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)
+                end
+              }
         
-              cell_rows @data
-              selection_mode :one # other values are :zero_or_many , :zero_or_one, :none
+              cell_rows @one_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
         
               on_row_clicked do |t, row|
                 puts "Row Clicked: #{row}"
@@ -62,7 +96,7 @@ class BasicTableSelection
               stretchy false
               
               @zero_or_one_radio_buttons = radio_buttons {
-                items @data.size.times.map { |row| "Row #{row} Selection" }
+                items @zero_or_one_data.size.times.map { |row| "Row #{row} Selection" }
                 
                 on_selected do |rb|
                   @zero_or_one_table.selection = [rb.selected]
@@ -70,13 +104,44 @@ class BasicTableSelection
               }
             }
             
+            button('Toggle Table Header Visibility') {
+              stretchy false
+              
+              on_clicked do
+                @zero_or_one_table.header_visible = !@zero_or_one_table.header_visible
+              end
+            }
+            
             @zero_or_one_table = table {
-              text_column('Animal')
-              text_column('Description')
+              text_column('Animal') {
+                # sort_indicator :descending # 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)
+                end
+              }
+              text_column('Description') {
+                # sort_indicator :descending # 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)
+                end
+              }
         
-              cell_rows @data
-              selection_mode :zero_or_one # other values are :zero_or_many , :one, :none
+              cell_rows @zero_or_one_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
         
               on_row_clicked do |t, row|
                 puts "Row Clicked: #{row}"
@@ -101,7 +166,7 @@ class BasicTableSelection
             vertical_box {
               stretchy false
               
-              @zero_or_many_checkboxes = @data.size.times.map do |row|
+              @zero_or_many_checkboxes = @zero_or_many_data.size.times.map do |row|
                 checkbox("Row #{row} Selection") {
                   on_toggled do |c|
                     table_selection = @zero_or_many_table.selection.to_a
@@ -116,13 +181,44 @@ class BasicTableSelection
               end
             }
             
+            button('Toggle Table Header Visibility') {
+              stretchy false
+              
+              on_clicked do
+                @zero_or_many_table.header_visible = !@zero_or_many_table.header_visible
+              end
+            }
+            
             @zero_or_many_table = table {
-              text_column('Animal')
-              text_column('Description')
+              text_column('Animal') {
+                # sort_indicator :descending # 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) }
+                end
+              }
+              text_column('Description') {
+                # sort_indicator :descending # 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) }
+                end
+              }
         
-              cell_rows @data
-              selection_mode :zero_or_many # other values are :none , :zero_or_one , and :one
+              cell_rows @zero_or_many_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
         
               on_row_clicked do |t, row|
                 puts "Row Clicked: #{row}"
@@ -147,12 +243,43 @@ class BasicTableSelection
                 
         tab_item('None') {
           vertical_box {
+            button('Toggle Table Header Visibility') {
+              stretchy false
+              
+              on_clicked do
+                @none_table.header_visible = !@none_table.header_visible
+              end
+            }
+            
             @none_table = table {
-              text_column('Animal')
-              text_column('Description')
+              text_column('Animal') {
+                # sort_indicator :descending # 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)
+                end
+              }
+              text_column('Description') {
+                # sort_indicator :descending # 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)
+                end
+              }
         
-              cell_rows @data
-              selection_mode :none # other values are :zero_or_many , :zero_or_one, :one
+              cell_rows @none_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
         
               on_row_clicked do |t, row|
                 puts "Row Clicked: #{row}"

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

@@ -52,7 +52,58 @@ module Glimmer
         
         # actual index within table columns (disregarding extra fillings that account for DualColumn instances)
         def index
-          @parent_proxy.columns.select {|c| c.is_a?(Column)}.index(self)
+          @parent_proxy.column_proxies.index(self)
+        end
+        
+        def other_columns
+          @parent_proxy.column_proxies.reject {|c| c == self}
+        end
+        
+        def sort_indicator
+          return @sort_indicator if !@content_added
+          
+          result = ::LibUI.table_header_sort_indicator(@parent_proxy.libui, index)
+          LibUI.integer_to_column_sort_indicator(result)
+        end
+        
+        def sort_indicator=(*args)
+          options = args.last.is_a?(Hash) ? args.pop : {reset_columns: true}
+          value = args.first
+          @sort_indicator = value
+          return @sort_indicator if !@content_added
+          
+          other_columns.each { |c| c.set_sort_indicator(nil, reset_columns: false) } if options[:reset_columns]
+          value = LibUI.column_sort_indicator_to_integer(value)
+          ::LibUI.table_header_set_sort_indicator(@parent_proxy.libui, index, value)
+        end
+        alias set_sort_indicator sort_indicator=
+        
+        def toggle_sort_indicator(value = nil)
+          if value.nil?
+            self.sort_indicator = self.sort_indicator != :ascending ? :ascending : :descending
+          else
+            self.sort_indicator = value
+          end
+        end
+          
+        def can_handle_listener?(listener_name)
+          listener_name == 'on_clicked'
+        end
+        
+        def handle_listener(listener_name, &listener)
+          column_listeners_for(listener_name) << listener
+        end
+      
+        def column_listeners
+          @column_listeners ||= {}
+        end
+        
+        def column_listeners_for(listener_name)
+          column_listeners[listener_name] ||= []
+        end
+        
+        def configure_sort_indicator
+          set_sort_indicator(@sort_indicator, reset_columns: false)
         end
       end
     end

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

@@ -61,8 +61,11 @@ module Glimmer
           super
           # TODO consider automatically detecting what properties/listeners accumulated dynamically to avoid hardcoding code below
           register_listeners
+          register_column_listeners
           configure_selection_mode
           configure_selection
+          configure_header_visible
+          configure_column_sort_indicators
         end
         
         def post_initialize_child(child)
@@ -142,6 +145,7 @@ module Glimmer
           end
         end
         alias selection_mode= selection_mode
+        alias set_selection_mode selection_mode
         
         def selection
           return @selection if !@content_added
@@ -171,6 +175,24 @@ module Glimmer
 #         ensure
 #           ::LibUI.free_table_selection(ts)
         end
+        alias set_selection selection=
+        
+        def header_visible
+          return @header_visible if !@content_added
+          
+          result = ::LibUI.table_header_visible(@libui)
+          LibUI.integer_to_boolean(result)
+        end
+        
+        def header_visible=(value)
+          @header_visible = value
+          return @header_visible if !@content_added
+          return if value.nil?
+          
+          value = LibUI.boolean_to_integer(value)
+          ::LibUI.table_header_set_visible(@libui, value)
+        end
+        alias set_header_visible header_visible=
         
         def column_attributes
           @column_attributes ||= columns.select {|column| column.is_a?(Column)}.map(&:name).map(&:underscore)
@@ -221,6 +243,10 @@ module Glimmer
           compound_columns.index(compound_column)
         end
         
+        def column_proxies
+          @columns&.select {|c| c.is_a?(Column)}
+        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
@@ -579,13 +605,40 @@ module Glimmer
           end
         end
         
+        def register_column_listeners
+          # register accumulated column listeners after table content is closed
+          return if @columns.nil? || @columns.empty?
+          if @columns.any? {|column| column.is_a?(Column) && !column.column_listeners_for('on_clicked').empty? }
+            ::LibUI.table_header_on_clicked(@libui) do |_, column_index|
+              actual_columns = @columns.select {|column| column.is_a?(Column)}
+              column = actual_columns[column_index]
+              if column.is_a?(Column)
+                column_listeners = column.column_listeners_for('on_clicked')
+                if !column_listeners.empty?
+                  column_listeners.each do |column_listener|
+                    column_listener.call(column, column_index)
+                  end
+                end
+              end
+            end
+          end
+        end
+        
         def configure_selection_mode
-          send_to_libui('selection_mode=', @selection_mode)
+          send_to_libui('selection_mode=', @selection_mode) if @selection_mode
         end
         
         def configure_selection
           self.selection = @selection
         end
+        
+        def configure_header_visible
+          self.header_visible = @header_visible
+        end
+        
+        def configure_column_sort_indicators
+          column_proxies.each {|c| c.configure_sort_indicator }
+        end
       end
     end
   end

data/lib/glimmer/libui.rb

@@ -35,6 +35,33 @@ module Glimmer
         bool.nil? ? (allow_nil ? nil : 0) : (allow_integer && bool.is_a?(Integer) ? bool : (bool.is_a?(TrueClass) || bool.is_a?(FalseClass) ? (bool == true ? 1 : 0) : (allow_nil ? nil : 0)))
       end
       
+      def column_sort_indicator_to_integer(value)
+        return value if value.is_a?(Integer)
+        
+        if value.nil?
+          0
+        elsif 'ascending'.start_with?(value.to_s)
+          1
+        elsif 'descending'.start_with?(value.to_s)
+          2
+        else
+          0
+        end
+      end
+      
+      def integer_to_column_sort_indicator(value)
+        return value if value.is_a?(String) || value.is_a?(Symbol)
+        
+        case value
+        when 1
+          :ascending
+        when 2
+          :descending
+        else
+          nil
+        end
+      end
+      
       def degrees_to_radians(degrees)
         ((Math::PI * 2.0) / 360.00) * degrees.to_f
       end

metadata

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