libui_paradise 0.1.49

data/lib/libui_paradise/examples/018_image_example.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This example display a single image. This is hardcoded to a local
+# path, so change that constant if you want another image.
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+require 'chunky_png'
+
+# =========================================================================== #
+# === THIS_FILE
+# =========================================================================== #
+THIS_FILE = '/home/x/data/images/NJOY/MEDITERRANEAN.png'
+main_window = ui_main_window('The Red Turtle', 310, 350, 0)
+
+hbox = ui_padded_hbox
+main_window.child = hbox
+main_window.intelligent_exit
+
+# =========================================================================== #
+# === IMAGES
+#
+# Must store it here to free it up lateron again.
+# =========================================================================== #
+IMAGES = []
+
+canvas = ChunkyPNG::Canvas.from_file(THIS_FILE)
+data = canvas.to_rgba_stream
+width = canvas.width
+height = canvas.height
+# ========================================================================= #
+# Add a new image here:
+# ========================================================================= #
+image = UI.new_image(width, height)
+UI.image_append(image, data, width, height, width*4)
+IMAGES << image # Store all images in the following area.
+
+# =========================================================================== #
+# Protects BlockCaller objects from garbage collection.
+# =========================================================================== #
+@blockcaller = []
+# =========================================================================== #
+# === rbcallback
+# =========================================================================== #
+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) { 1 }
+model_handler.CellValue    = rbcallback(1, [1, 1, 1, 1]) 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', -1)
+hbox.add(table)
+
+main_window.show_the_controls
+
+UI.window_on_closing(main_window) {
+  UI.control_destroy(main_window)
+  UI.free_table_model(model)
+  IMAGES.each { |i| UI.free_image(i) }
+  UI.quit
+  0
+}
+
+UI.main_then_quit

data/lib/libui_paradise/examples/019_open_file_button_example.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This example shows how to use the grid-related aspects of ruby-libui.
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+window = ui_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
+    e "The filename was: #{filename}"
+  rescue ArgumentError => error # Rescue from "NULL pointer given"
+    pp error
+  end
+}
+outer_vbox << button_open_file
+
+window.child = outer_vbox
+window.intelligent_quit

data/lib/libui_paradise/examples/020_unicode_text_example.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This example just shows that unicode text works.
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+window = ui_margined_main_window('Unicode Text Example', 1200, 200, 15)
+
+outer_vbox = ui_padded_vbox
+text = ui_text(
+"This is some text. You do not even have to wrap it - the newlines will
+appear in the text as-is.
+
+If something is supported then unicode should be able to show that.
+
+Let's test this next with some unicode:
+
+  🎉 用户界面 사용자 인터페이스
+    ₀₁₂₃₄₅₆₇₈₉
+
+")
+
+outer_vbox << text
+
+window.child = outer_vbox
+window.intelligent_quit

data/lib/libui_paradise/examples/021_spinbutton_example.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This example just shows a spinbutton example.
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+window = ui_main_window('Spinbutton Example', 200, 100, 1)
+
+outer_vbox = ui_padded_vbox
+spinbutton = ui_spinbutton(0, 100)
+spinbutton.set_value(42)
+
+spinbox_changed_callback = proc { |ptr|
+  puts "Changed value to: #{UI.spinbox_value(ptr)}"
+  0
+}
+
+UI.spinbox_on_changed(spinbutton, spinbox_changed_callback, nil)
+
+outer_vbox << spinbutton
+
+window.child = outer_vbox
+window.intelligent_quit

data/lib/libui_paradise/examples/022_text_example.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+window = ui_main_window('Text Example', 200, 100, 1)
+
+outer_vbox = ui_padded_vbox
+text = ui_text
+
+outer_vbox << text
+
+text.set_text('Hello world!')
+window.child = outer_vbox
+window.intelligent_quit

data/lib/libui_paradise/examples/023_parse_config_file_example.config

@@ -0,0 +1,6 @@
+width:                                      1000
+height:                                      150
+padding:                                       5
+title:                 Parse Config File Example
+favicon:                                 :tabble
+font_in_use:                             Sans 22

data/lib/libui_paradise/examples/023_parse_config_file_example.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+use_this_config_file = '023_parse_config_file_example.config'
+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.intelligent_quit

data/lib/libui_paradise/examples/024_text_view_example.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+window = ui_main_window('Text View Example', 500, 300, 0)
+
+outer_vbox = ui_padded_vbox
+text = multiline_entry
+text.set_text('Hello world!')
+outer_vbox << text
+window.child = outer_vbox
+window.intelligent_quit

data/lib/libui_paradise/examples/025_scrolling_area.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This example currently does not work.
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+window = padded_window('Scrolling Area', 500, 300, 0)
+
+outer_vbox = padded_vbox
+text = ui_text('OK!')
+scrolling_area = LibuiParadise.scrolling_area(text)
+outer_vbox << scrolling_area
+window.child = outer_vbox
+window.intelligent_quit

data/lib/libui_paradise/examples/026_colour_button.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This button doesn't work properly right now. :(
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+window = main_window('Colour Button', 500, 300, 0)
+outer_vbox = padded_vbox
+our_colour_button = ui_colour_button
+
+# colour_button.on_changed {|callback|
+#   pp callback.class
+#   rgba = callback.color
+#   pp rgba
+# }
+
+# on_changed_proc = proc {|callback|
+#   rgba = callback.color
+#   pp rgba
+# }
+
+xyz = proc {|pointer|
+  # rgba = pointer.color
+  #pp rgba
+  pp pointer.to_s
+  nil
+}
+
+LibUI.color_button_on_changed(our_colour_button, xyz, nil)
+#   # rgba = pointer.color
+#   # pp rgba
+#   pp pointer
+#   pp pointer.to_s
+# }
+
+
+# UI.color_button_on_changed(color_button) do
+#   UI.area_queue_redraw_all(histogram)
+# end
+
+#, on_changed_proc.call, nil)
+
+#UI.spinbox_on_changed(spinbox) do |ptr|
+#  puts "New Spinbox value: #{UI.spinbox_value(ptr)}"
+#end
+
+outer_vbox.minimal(our_colour_button, 1)
+window.child = outer_vbox
+window.intelligent_quit

data/lib/libui_paradise/examples/027_form_example.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require '027_form_example.rb'
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+window = margined_window('Form Example', 250, 150, 0)
+
+outer_vbox = padded_vbox
+
+hbox1 = padded_hbox
+hbox1.minimal(ui_text('First Name'), 0)
+@first_name_entry = ui_entry
+hbox1.minimal(@first_name_entry, 0)
+outer_vbox.minimal(hbox1, 0)
+
+hbox2 = padded_hbox
+hbox2.minimal(ui_text('Last Name'), 0)
+@last_name_entry = ui_entry
+hbox2.minimal(@last_name_entry, 0)
+outer_vbox.minimal(hbox2, 0)
+
+button_display_name = button('Display Name')
+button_display_name.on_clicked {
+  ui_msg_box(
+    :default,
+    'Name',
+    "#{@first_name_entry.text?} #{@last_name_entry.text?}"
+  )
+}
+
+outer_vbox.minimal(button_display_name, 1)
+
+window.child = outer_vbox
+window.intelligent_quit

data/lib/libui_paradise/examples/028_password_entry_example.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require '028_password_entry_example.rb'
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+window = margined_window('Password Entry Example', 280, 80, 0)
+
+outer_vbox = padded_vbox
+entry = ui_password_entry
+outer_vbox.minimal(ui_text('Password: '), 0)
+outer_vbox.minimal(entry, 0)
+
+window.child = outer_vbox
+window.intelligent_quit

data/lib/libui_paradise/examples/029_two_buttons_showing_how_to_enable_and_disable_them.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require '029_two_buttons_showing_how_to_enable_and_disable_them.rb'
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+main_window = padded_main_window(
+  'Two buttons showing how to enable and disable them', 300, 60, 0
+)
+
+outer_hbox = padded_hbox
+
+button1 = button('Button #1')
+button2 = button('Button #2')
+button2.disable # Start-state for this button.
+
+outer_hbox.minimal(button1, 1)
+outer_hbox.minimal(button2, 1)
+
+button1.on_clicked {|widget|
+  button2.enable
+  button1.disable
+}
+button2.on_clicked {|widget|
+  button1.enable
+  button2.disable
+}
+
+main_window.child = outer_hbox
+main_window.intelligent_exit

data/lib/libui_paradise/examples/030_table_example.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Todo:
+# - Add editable entry to the table
+# =========================================================================== #
+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|
+  UI.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

data/lib/libui_paradise/experimental/dsl.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+def do_call_this_method
+  e 'Hello World!'
+end
+
+window {
+
+ button {
+  
+ }
+
+}

data/lib/libui_paradise/extensions/extensions.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === LibuiParadise::Extensions
+# =========================================================================== #
+# require 'libui_paradise/extensions/extensions.rb
+# include Libuiparadise::Extensions
+# =========================================================================== #
+require 'libui' # Mandatory require-call.
+
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  require 'libui_paradise/extensions/hash_fiddle_pointer_widgets.rb'
+  require 'libui_paradise/fiddle/pointer.rb'
+  require 'libui_paradise/libui_classes/window.rb'
+  require 'libui_paradise/extensions/misc.rb'
+
+end; end
+
+alias e puts
+
+LibuiParadise::Extensions.initializer # Make UI known here.

data/lib/libui_paradise/extensions/hash_fiddle_pointer_widgets.rb

@@ -0,0 +1,129 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/extensions/hash_fiddle_pointer_widgets.rb'
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === @hash_fiddle_pointer_widgets
+  # ========================================================================= #
+  @hash_fiddle_pointer_widgets = {}
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.hash_fiddle_pointer_widgets?
+  # ========================================================================= # 
+  def self.hash_fiddle_pointer_widgets?
+    @hash_fiddle_pointer_widgets
+  end
+
+  # ========================================================================= #
+  # === main_hash?
+  # ========================================================================= #
+  def main_hash?
+    ::LibuiParadise::Extensions.hash_fiddle_pointer_widgets?
+  end
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.register_this_fiddle_pointer_widget
+  #
+  # This method registers the particular widget in use.
+  #
+  # Every new_* method available on UI.new* - actually on LibUI.new* -
+  # that creates a new widget be registered via this method here. That
+  # way we have a Hash that contains lots of Fiddle::Pointers and we
+  # can, at a later time, modify these Fiddle::Pointer or call
+  # toplevel methods with these registered pointers. This will only work
+  # if we have registered these pointers though, which is why each 
+  # method that creates a new libui-widget has to make use of this method
+  # here.
+  #
+  # The only exception to the above rule is the main window. The main
+  # window is always stored at @main_window instead. Perhaps it
+  # should also use the method here, but I found it simpler to
+  # just refer to it via @main_window.
+  #
+  # The mandatory entries must be:
+  #
+  #   object_id -> [:the_fiddle_pointer_widget, :the_type]
+  #
+  # The object_id will be determined automatically, so it can be
+  # omitted.
+  #
+  # The very last argument of the two-member Array should be a symbol,
+  # such as :grid. This is automatically ensured via a call to
+  # __method__ which returns a Symbol.
+  # ========================================================================= #
+  def self.register_this_fiddle_pointer_widget(
+      the_fiddle_pointer_widget,
+      the_type_of_the_widget = nil
+    )
+    object_id_to_use = the_fiddle_pointer_widget.object_id
+    # ======================================================================= #
+    # Next, store it on the main Hash.
+    # ======================================================================= #
+    @hash_fiddle_pointer_widgets[object_id_to_use] =
+      [
+        the_fiddle_pointer_widget,
+        the_type_of_the_widget
+      ]
+  end; self.instance_eval { alias add_to_the_registered_widgets register_this_fiddle_pointer_widget } # === LibuiParadise::Extensions.add_to_the_registered_widgets
+
+  # ========================================================================= #
+  # === last_pointer?
+  #
+  # This used to return the "current" widget pointer, but past September
+  # 2021 this is rarely in use anymore. Use current_widget_pointer? 
+  # instead, based on the main Hash that keeps all widgets registered.
+  # ========================================================================= #
+  def last_pointer?
+    LibuiParadise::Extensions.current_widget_pointer?
+  end; alias current_pointer?        last_pointer? # === current_pointer?
+       alias current_widget_pointer? last_pointer? # === current_widget_pointer?
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.current_widget_pointer?
+  # ========================================================================= #
+  def self.current_widget_pointer?
+    LibuiParadise::Extensions.hash_fiddle_pointer_widgets?.values.last.first
+  end
+
+  # ========================================================================= #
+  # === current_widget_pointer_type?
+  # ========================================================================= #
+  def current_widget_pointer_type?
+    LibuiParadise::Extensions.hash_fiddle_pointer_widgets?.values.last.last
+  end
+
+  # ========================================================================= #
+  # === register_this_fiddle_pointer_widget
+  # ========================================================================= #
+  def register_this_fiddle_pointer_widget(
+      the_fiddle_pointer_widget,
+      the_type_of_the_widget = nil
+    )
+    ::LibuiParadise::Extensions.register_this_fiddle_pointer_widget(
+      the_fiddle_pointer_widget,
+      the_type_of_the_widget
+    )
+  end; alias add_to_the_registered_widgets register_this_fiddle_pointer_widget # === add_to_the_registered_widgets
+
+end
+
+# ========================================================================= #
+# === LibuiParadise.register_this_fiddle_pointer_widget
+# ========================================================================= #
+def self.register_this_fiddle_pointer_widget(
+    the_fiddle_pointer_widget,
+    the_type_of_the_widget = nil
+  )
+  ::LibuiParadise::Extensions.register_this_fiddle_pointer_widget(
+    the_fiddle_pointer_widget,
+    the_type_of_the_widget
+  )
+end; self.instance_eval { alias add_to_the_registered_widgets register_this_fiddle_pointer_widget } # === LibuiParadise.add_to_the_registered_widgets
+
+end