libui_paradise 0.2.49 → 0.4.13

data/lib/libui_paradise/colours/colours.rb

@@ -2,13 +2,25 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-# require 'libui_paradise/colours/colours.rb
+# require 'libui_paradise/colours/colours.rb'
 # =========================================================================== #
 module LibuiParadise
 
   # ========================================================================= #
-  # === COLOR_BLUE
+  # === LibuiParadise::COLOR_BLUE
+  #
+  # This is actually dodgerblue.
   # ========================================================================= #
   COLOR_BLUE = 0x1E90FF
 
+  # ========================================================================= #
+  # === LibuiParadise::COLOR_MIDNIGHTBLUE
+  # ========================================================================= #
+  COLOR_MIDNIGHTBLUE = 0x191970
+
+  # ========================================================================= #
+  # === LibuiParadise::COLOR_LIGHTSEAGREEN
+  # ========================================================================= #
+  COLOR_LIGHTSEAGREEN = 0x20b2aa
+
 end

data/lib/libui_paradise/domain_specific_language/README.md

@@ -3,3 +3,9 @@ libui_paradise even more.
 
 For instance, the user should be able to parse widgets that
 are described in pure yaml.
+
+As of December 2023 this is probably no longer as important,
+as the gem called universal_widgets uses a simplified YAML
+format that is more terse. But, in the event that we may
+wish to revisit this idea, the directory here will be
+retained.

data/lib/libui_paradise/examples/complex/002_tabs_example.rb

@@ -5,9 +5,8 @@
 # require '002_tabs_example.rb'
 # =========================================================================== #
 require 'libui_paradise/autoinclude'
-#require 'libui_paradise/requires/require_the_libui_paradise_project.rb'
 
-window = ui_main_window('A notebook with tabs example', 1200, 200, 15)
+window = main_window('A notebook with tabs example', 1200, 200, 15)
 
 tab = ui_tabs
 tab.add('Page 1', hbox(text('One! 😎️')))

data/lib/libui_paradise/examples/complex/003_open_file_button_example.rb

@@ -8,14 +8,14 @@
 # =========================================================================== #
 require 'libui_paradise/autoinclude'
 
-window = ui_padded_main_window('An open-file button-example', 1200, 200, 15)
+window = padded_main_window('An open-file button-example', 1200, 200, 15)
 
 outer_vbox = ui_padded_vbox
 button_open_file = ui_button('Open file')
 button_open_file.on_clicked {
   begin
-    #filename = ui_open_file(window).to_s
-    filename = ::LibUI.open_file(main_window).to_s
+    # filename = ui_open_file(window).to_s
+    filename = LibUI.open_file(main_window).to_s
     e "The filename was: #{filename}"
   rescue ArgumentError => error # Rescue from "NULL pointer given"
     pp error
@@ -26,7 +26,6 @@ outer_vbox << button_open_file
 window.child = outer_vbox
 window.intelligent_quit
 
-
 if false
 LibUI.button_on_clicked(button) {
   result = ::LibUI.open_file(main_window).to_s
@@ -34,5 +33,4 @@ LibUI.button_on_clicked(button) {
     e 'The file exists. \o/'
   end
 }
-
 end

data/lib/libui_paradise/examples/complex/006_coloured_boxes_example.rb

@@ -8,9 +8,9 @@ require 'libui_paradise/autoinclude'
 
 require 'colours' # Needs the colours gem.
 
-window = ui_main_window('Coloured boxes example', 320, 200, 1)
+window = padded_main_window('Coloured boxes example', :default, 200, 1)
 
-outer_hbox = ui_hbox
+outer_hbox = create_hbox
 outer_hbox.maximal LibuiParadise.draw_rectangle(:default, :default, Colours.random_html_colour)
 outer_hbox.maximal LibuiParadise.draw_rectangle(:default, :default, :seagreen)
 outer_hbox.maximal LibuiParadise.draw_rectangle(:default, :default, :springgreen)

data/lib/libui_paradise/examples/complex/007_slider_example.rb

@@ -6,16 +6,21 @@
 # =========================================================================== #
 require 'libui_paradise/autoinclude'
 
-window = ui_main_window('Slider Example', 250, 70, 1)
+# =========================================================================== #
+# === UPPER_RANGE
+# =========================================================================== #
+UPPER_RANGE = 20
 
-slider = ui_slider(0, 100)
+window = padded_main_window('Slider Example', :default, 70, 1)
+
+slider = create_slider(0, UPPER_RANGE)
 
 # =========================================================================== #
 # === callback_for_the_slider
 # =========================================================================== #
 def callback_for_the_slider
   proc { |pointer|
-    puts "New Slider value: #{UI.slider_value(pointer)}"
+    puts "New Slider value: #{LibUI.slider_value(pointer)}"
   }
 end
 slider.on_changed { callback_for_the_slider }
@@ -27,5 +32,6 @@ slider.on_changed { callback_for_the_slider }
 #
 # =========================================================================== #
 outer_vbox = ui_padded_vbox(slider)
-window.add(outer_vbox)
+
+window << outer_vbox
 window.intelligent_quit

data/lib/libui_paradise/examples/complex/008_radio_button_example.rb

@@ -6,7 +6,7 @@
 # =========================================================================== #
 require 'libui_paradise/autoinclude'
 
-window = margined_window(:filename, 320, 200, 0)
+window = margined_window(:filename, :default, 200, 0)
 
 outer_vbox = padded_vbox
 array_to_use = ['Radio Button 1', 'Radio Button 2', 'Radio Button 3']
@@ -19,5 +19,5 @@ rb = ui_radio_buttons(array_to_use)
 outer_vbox.minimal(rb)
 outer_vbox.minimal(hsep, 0)
 
-window.child = outer_vbox
+window << outer_vbox
 window.intelligent_quit

data/lib/libui_paradise/examples/complex/009_separator_example.rb

@@ -6,7 +6,7 @@
 # =========================================================================== #
 require 'libui_paradise/autoinclude'
 
-window = margined_window(:filename, 250, 150, 0)
+window = margined_window(:filename, :default, 150, 0)
 
 outer_vbox = padded_vbox
 
@@ -21,5 +21,5 @@ outer_vbox.minimal(button_hello_world, 1)
 outer_vbox.minimal(hsep, 0)
 outer_vbox.minimal(hsep, 1)
 
-window.child = outer_vbox
+window << outer_vbox
 window.intelligent_quit

data/lib/libui_paradise/examples/complex/010_table_example.rb

@@ -2,54 +2,144 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-# Todo:
-#
-# - Add editable entry to the table
-#
-# =========================================================================== #
 # require 'libui_paradise/010_table_example.rb'
 # =========================================================================== #
-require 'libui_paradise/autoinclude'
-
-main_window = padded_window('30) Table example', 300, 200, 1)
-hbox = padded_hbox
-data = [
-  %w( cat calm meow ),
-  %w( dog loyal woof ),
-  %w( chicken bird cock-a-doodle-doo ),
-  %w( horse fast neigh ),
-  %w( cow slow moo )
-]
-
-# Protect BlockCaller objects from garbage collection.
-@block_callers = []
-def rbcallback(*args, &block)
-  args << [0] if args.size == 1 # Argument types are ommited
-  block_caller = Fiddle::Closure::BlockCaller.new(*args, &block)
-  @block_callers << block_caller
-  block_caller
-end
-
-model_handler = LibUI::FFI::TableModelHandler.malloc
-model_handler.to_ptr.free = Fiddle::RUBY_FREE
-
-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|
-  LibUI.new_table_value_string(data[row][column])
-end
-model_handler.SetCellValue = rbcallback(0, [0]) {}
-
-model = LibUI.new_table_model(model_handler)
-
-table_params = ui_table_params_malloc(model)
-
-table = ui_table(table_params)
-table.append_text_column('Animal',      0, -1)
-table.append_text_column('Description', 1, -1)
-table.append_text_column('Fancy Stuff', 2, -1)
-
-hbox.add(table, 1)
-main_window.child = hbox
-main_window.intelligent_quit
+require 'libui_paradise/base/base.rb'
+
+module LibuiParadise
+
+module GUI
+
+module LibUI
+
+class TableExample < ::LibuiParadise::Base # === LibuiParadise::GUI::LibUI::TableExample
+
+  # ========================================================================= #
+  # === DATA
+  # ========================================================================= #
+  DATA = [
+    %w( cat calm meow ),
+    %w( dog loyal woof ),
+    %w( chicken bird cock-a-doodle-doo ),
+    %w( horse fast neigh ),
+    %w( cow slow moo ),
+    %w( one two three ),
+    %w( 1 2 3 ),
+    %w( 4 5 6 ),
+    %w( 7 8 9 )
+  ]
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'A TableExample for LibUI'
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = 800
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = 520
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      run_already = true
+    )
+    reset
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    reset_the_internal_hash
+    title_width_height(TITLE, WIDTH, HEIGHT)
+  end
+
+  # ========================================================================= #
+  # === create_skeleton                            (create tag, skeleton tag)
+  # ========================================================================= #
+  def create_skeleton
+    # ======================================================================= #
+    # === @window
+    # ======================================================================= #
+    set_window(return_default_window)
+    # ======================================================================= #
+    # Protects BlockCaller objects from garbage collection.
+    # ======================================================================= #
+    @block_callers = []
+  end
+
+  # ========================================================================= #
+  # === rbcallback
+  # ========================================================================= #
+  def rbcallback(*args, &block)
+    args << [0] if args.size == 1 # Argument types are omitted
+    block_caller = Fiddle::Closure::BlockCaller.new(*args, &block)
+    @block_callers << block_caller
+    block_caller
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    super()
+    outer_vbox = padded_vbox
+    # ======================================================================= #
+    # First add the two buttons on top:
+    # ======================================================================= #
+    outer_vbox.add_hsep
+
+    grid = padded_grid
+    #                         widget, left, top, xspan, yspan, hexpand, halign, vexpand, valign
+    grid.ui_grid_append(text('Testing tables'),  0, 0, 1, 1, 0, 0.5, 1, 0)
+    outer_vbox.minimal(grid)
+
+    model_handler = ::LibUI::FFI::TableModelHandler.malloc
+    model_handler.to_ptr.free = Fiddle::RUBY_FREE
+    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|
+      ::LibUI.new_table_value_string(
+        DATA[row][column] # Pass the data here.
+      )
+    end
+    model_handler.SetCellValue = rbcallback(0, [0]) {}
+
+    model = ::LibUI.new_table_model(model_handler)
+    table_params = ui_table_params_malloc(model)
+
+    table = create_table(table_params)
+    table.append_text_column('Animal',       0)
+    table.append_text_column('Description',  1)
+    table.append_text_column('TEST',         2)
+    # table.append_text_column('TEST',       3, -1) # This would crash it.
+    # ::LibUI.table_append_text_column(table, 'Animal', 0, -1)
+
+    outer_vbox.maximal(table)
+    button1 = button('Show the current selection in the table')
+    button1.on_clicked {
+      e 'This is currently not implemented.'
+    }
+    outer_vbox.minimal(
+      button1
+    )
+    outer_vbox.minimal(quit_button)
+    main_window? << outer_vbox
+    main_window?.intelligent_exit
+    free_table_model(model)
+  end
+
+end; end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  LibuiParadise::GUI::LibUI::TableExample.new
+end

data/lib/libui_paradise/examples/complex/011_two_buttons_showing_how_to_enable_and_disable_them.rb

@@ -19,6 +19,7 @@ button2.disable # Start-state for this button.
 outer_hbox << button1
 outer_hbox << button2
 
+# The two buttons will toggle one another.
 button1.on_clicked {|widget|
   button2.enable
   button1.disable
@@ -28,5 +29,5 @@ button2.on_clicked {|widget|
   button2.disable
 }
 
-main_window.child = outer_hbox
+main_window << outer_hbox
 main_window.intelligent_exit

data/lib/libui_paradise/examples/complex/012_password_entry_example.rb

@@ -25,5 +25,5 @@ button.on_clicked {
 }
 outer_vbox.minimal(button, 0)
 
-window.child = outer_vbox
+window << outer_vbox
 window.intelligent_quit

data/lib/libui_paradise/examples/complex/013_form_example.rb

@@ -34,5 +34,5 @@ button_display_name.on_clicked {
 outer_vbox.minimal(hsep, 0)
 outer_vbox.minimal(button_display_name, 1)
 
-window.child = outer_vbox
+window << outer_vbox
 window.intelligent_quit

data/lib/libui_paradise/examples/complex/014_text_example.rb

@@ -14,5 +14,5 @@ text = ui_text
 outer_vbox.minimal(text, 1)
 
 text.set_text('Hello world!')
-window.child = outer_vbox
+window << outer_vbox
 window.intelligent_quit

data/lib/libui_paradise/examples/complex/015_text_view_example.rb

@@ -2,15 +2,15 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-# 024_text_view_example.rb
+# 015_text_view_example.rb
 # =========================================================================== #
 require 'libui_paradise/autoinclude'
 
-window = padded_main_window('Text View Example', 500, 300, 0)
+window = padded_main_window('Text View Example', :default, 300, 0)
 
 outer_vbox = padded_vbox
 text = multiline_entry('Hello world! This can be set to read only via .is_read_only().')
-# text.is_read_only
+# text.is_read_only # This can be used to set it to read-only.
 outer_vbox.minimal(text, 1)
-window.child = outer_vbox
+window << outer_vbox
 window.intelligent_quit

data/lib/libui_paradise/examples/complex/016_grid_example.rb

@@ -10,22 +10,31 @@ require 'libui_paradise/autoinclude'
 
 window = padded_main_window('A simple grid-example', 1200, 200, 15)
 
-grid = ui_padded_grid
-UI.grid_append(grid, text('Yo1'), 0, 0, 1, 1, 0, 0, 1, 0)
-UI.grid_append(grid, text('Yo2'), 1, 0, 1, 1, 0, 0, 1, 0)
-UI.grid_append(grid, text('Yo3'), 2, 0, 1, 1, 0, 0, 1, 0)
-
-UI.grid_append(grid, text('Yo4'), 0, 1, 1, 1, 0, 0, 1, 0)
-UI.grid_append(grid, text('Yo5'), 1, 1, 1, 1, 0, 0, 1, 0)
-UI.grid_append(grid, text('Yo6'), 2, 1, 1, 1, 0, 0, 1, 0)
+grid = padded_grid
+grid.grid_append(text('Yo1'))
+grid.grid_append(text('Yo2'))
+grid.grid_append(text('Yo3'))
+LibuiParadise.new_row
+  # ======================================================================= #
+  # left, top, xspan, yspan, hexpand, halign, vexpand, valign
+  #  0,    0,    1,     1,      0,      0,       1,      0
+  # ======================================================================= #
+grid.grid_append(text('Yo4'))
+grid.grid_append(text('Yo5'))
+grid.grid_append(text('Yo6'))
+LibuiParadise.new_row
 
+# ========================================================================= #
+# This one will add at a specific position - it's a little more complicated
+# than the prior methods, but this shows how it can be done.
+# ========================================================================= #
 grid.hash_grid(
   text('Yo7'),
-  { left: 2, top: 3, xspan: 3, yspan: 3, hexpand: 0, halign: 0, vexpand: 0, valign: 0 }
+  { left: 3, top: 3, xspan: 3, yspan: 3, hexpand: 1, halign: 0, vexpand: 1, valign: 0 }
 )
 
 vbox = padded_vbox
 vbox << grid
 
-window.child = vbox
-window.intelligent_exit
+#window << vbox
+window.intelligent_exit(vbox)

data/lib/libui_paradise/examples/complex/017_unicode_text_example.rb

@@ -8,7 +8,7 @@
 # =========================================================================== #
 require 'libui_paradise/autoinclude'
 
-window = ui_margined_main_window('Unicode Text Example', 1200, 200, 15)
+window = margined_main_window('Unicode Text Example', 1200, 200, 15)
 
 outer_vbox = padded_vbox
 text = text(
@@ -26,5 +26,5 @@ Let's test this next with some unicode:
 
 outer_vbox << text
 
-window.child = outer_vbox
+window << outer_vbox
 window.intelligent_quit

data/lib/libui_paradise/examples/complex/018_spinbutton_example.rb

@@ -29,5 +29,5 @@ LibUI.spinbox_on_changed(spinbutton, spinbox_changed_callback, nil)
 
 outer_vbox << spinbutton
 
-window.child = outer_vbox
+window << outer_vbox
 window.intelligent_quit

data/lib/libui_paradise/examples/complex/019_combo_box_example.rb

@@ -46,5 +46,5 @@ button_clear_the_combo_box.on_clicked {
 }
 
 box.minimal(button_clear_the_combo_box)
-main_window.child = box
+main_window << box
 main_window.intelligent_exit

data/lib/libui_paradise/examples/complex/020_checkbox_example.rb

@@ -71,11 +71,11 @@ checkbox_toggle_callback = proc { |ptr|
 UI.checkbox_on_toggled(checkbox, checkbox_toggle_callback, nil)
 inner.add(checkbox, 0)
 
-MAIN_WINDOW = UI.window('hello world', 600, HEIGHT, 1)
+MAIN_WINDOW = UI.window('hello world', :default, HEIGHT, 1)
 
-UI.window_set_margined(MAIN_WINDOW, 1)
-UI.window_set_child(MAIN_WINDOW, vbox)
+LibUI.window_set_margined(MAIN_WINDOW, 1)
+MAIN_WINDOW << vbox
 
-UI.window_on_closing(MAIN_WINDOW, should_quit_callback, nil)
+LibUI.window_on_closing(MAIN_WINDOW, should_quit_callback, nil)
 MAIN_WINDOW.control_show
-UI.main_then_quit
+LibUI.main_then_quit

data/lib/libui_paradise/examples/complex/021_font_example.rb

@@ -15,7 +15,7 @@
 class FontExample
 
   require 'libui_paradise'
-  include LibuiParadise::Extensions
+  include LibuiParadise::BaseModule
 
   # ========================================================================= #
   # === USE_THIS_FONT
@@ -45,6 +45,7 @@ class FontExample
   def initialize(
       run_already = true
     )
+    reset
     run if run_already
   end
 
@@ -67,7 +68,7 @@ class FontExample
     handler_draw_event = Fiddle::Closure::BlockCaller.new(0, [1, 1, 1]) { |_, _, adp|
       area_draw_params = LibUI::FFI::AreaDrawParams.new(adp)
       default_font = font {{
-        font_size:   USE_THIS_FONT_SIZE,
+        font_size:   USE_THIS_FONT_SIZE, # Pass in the font-size here.
         font_family: USE_THIS_FONT,
         italic:      false,
         stretch:     2,
@@ -102,7 +103,7 @@ class FontExample
 
     main_window = ui_main_window(TITLE, WIDTH, 400, 1)
     LibUI.window_set_margined(main_window, 1)
-    main_window.child = box
+    main_window << box
     main_window.simple_exit
     main_window.control_show
     main_window.intelligent_exit

data/lib/libui_paradise/examples/complex/022_simple_notepad_example.rb

@@ -6,9 +6,9 @@
 # =========================================================================== #
 require 'libui_paradise/autoinclude'
 
-window = padded_window('Notepad', 500, 300, 1)
+window = padded_window('Notepad', :default, 300, 1)
 
-vbox = ui_vbox
+vbox = create_vbox
 
 text_view = ui_text_view
 text_view.set_text(
@@ -21,5 +21,5 @@ button_show_content.on_clicked {
 }
 
 vbox << button_show_content
-window.child = vbox
+window << vbox
 window.intelligent_exit

data/lib/libui_paradise/examples/complex/023_msg_box_error.rb

@@ -7,11 +7,11 @@
 require 'libui_paradise/autoinclude'
 
 TITLE = 'msg box error'
-main_window = ui_padded_window(TITLE, 300, 200, 1)
+main_window = ui_padded_window(TITLE, 320, 240, 1)
 
-button1 = ui_button('Text (click me)')
+button1 = create_button('Text (click me)')
 button1.on_clicked {
-  LibuiParadise::Extensions.message_box_error(
+  LibuiParadise.message_box_error(
     main_window,
     'Error',
     "You clicked \nthe button"
@@ -22,6 +22,6 @@ button1.on_clicked {
 hbox = padded_hbox
 hbox << button1
 main_window.close_properly
-main_window.child = hbox
+main_window << hbox
 main_window.control_show
-UI.main_then_quit
+LibUI.main_then_quit

data/lib/libui_paradise/examples/complex/024_parse_config_file_example.rb

@@ -2,7 +2,7 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-# require '022_'
+# require '024_parse'
 # =========================================================================== #
 require 'libui_paradise/autoinclude'
 
@@ -11,5 +11,5 @@ window = LibuiParadise.parse_this_config_file(use_this_config_file)
 outer_vbox = padded_vbox
 text = text('The config file was '+use_this_config_file)
 outer_vbox << text
-window.child = outer_vbox
+window << outer_vbox
 window.intelligent_quit

data/lib/libui_paradise/examples/complex/025_colour_button.rb

@@ -49,5 +49,5 @@ LibUI.color_button_on_changed(our_colour_button, xyz, nil)
 #end
 
 outer_vbox.minimal(our_colour_button, 1)
-window.child = outer_vbox
+window << outer_vbox
 window.intelligent_quit

data/lib/libui_paradise/examples/complex/026_basic_table_image.rb

@@ -17,11 +17,11 @@ N_TIMES = 10
 # =========================================================================== #
 REMOTE_URL = 'https://www.ghibli.jp/gallery/thumb-redturtle%03d.png'
 
-main_window = ui_main_window('The Red Turtle', 310, 350, 0)
+main_window = padded_main_window('The Red Turtle', 310, 350, 0)
 
 hbox = ui_padded_hbox
 main_window.simple_exit
-main_window.child = hbox
+main_window << hbox
 
 # =========================================================================== #
 # === IMAGES
@@ -43,10 +43,8 @@ N_TIMES.times { |i|
   # Add a new image next:
   # ========================================================================= #
   image = UI.new_image(width, height)
-  UI.image_append(image, data, width, height, width * 4)
+  LibUI.image_append(image, data, width, height, width * 4)
   IMAGES << image # Store all images in the following area.
-rescue StandardError => error
-  warn url, error.message
 }
 
 # =========================================================================== #
@@ -84,8 +82,7 @@ hbox.maximal(table)
 
 main_window.show_the_controls
 
-UI.window_on_closing(main_window) {
-  e 'Bye Bye'
+LibUI.window_on_closing(main_window) {
   UI.control_destroy(main_window)
   UI.free_table_model(model)
   IMAGES.each { |i| UI.free_image(i) }
@@ -93,4 +90,4 @@ UI.window_on_closing(main_window) {
   0
 }
 
-UI.main_then_quit
+LibUI.main_then_quit