libui_paradise 0.1.49

data/lib/libui_paradise/images/README.md

@@ -0,0 +1,2 @@
+This directory only contains the libui_paradise logo that was 
+created on 27.08.2021 via cfdg, gimp, kolourpaint and pngquant.

data/lib/libui_paradise/libui_classes/area_handler.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/area_handler.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.area
+  #
+  # AreaHandler defines the functionality needed for handling events
+  # from an Area.
+  #
+  # Upstream documentation, at the least for Go, can be found here:
+  #
+  #   https://github.com/andlabs/ui/blob/master/areahandler.go
+  #
+  # ========================================================================= #
+  def self.area(
+      i = :use_new_area_handler
+    )
+    case i
+    when :use_new_area_handler,
+         :default
+      i = UI::FFI::AreaHandler.malloc
+    end
+    _ = UI.new_area(i)
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end; self.instance_eval { alias area_handler area } # === LibuiParadise::Extensions.area_handler
+
+  # ========================================================================= #
+  # === area
+  #
+  # AreaHandler defines the functionality needed for handling events
+  # from an Area.
+  #
+  # Upstream documentation, at the least for Go, can be found here:
+  #
+  #   https://github.com/andlabs/ui/blob/master/areahandler.go
+  #
+  # ========================================================================= #
+  def area(
+      i = :use_new_area_handler
+    )
+    return ::LibuiParadise::Extensions.area(i)
+  end; alias area_handler area # === area_handler
+
+end; end

data/lib/libui_paradise/libui_classes/button.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The upstream API in C can be found here:
+#
+#   https://raw.githubusercontent.com/andlabs/libui/master/unix/button.c
+#
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/button.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === bold_button
+  #
+  # This currently does not work. We have to wait until upstream libui
+  # supports bold font text.
+  # ========================================================================= #
+  def bold_button(i)
+    button(i)
+  end
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.button                         (button tag)
+  # ========================================================================= #
+  def self.button(text)
+    _ = UI.new_button(text)
+    ::LibuiParadise::Extensions.register_this_fiddle_pointer_widget(_, __method__)
+    return _
+  end; self.instance_eval { alias ui_button button } # === LibuiParadise::Extensions.ui_button
+
+  # ========================================================================= #
+  # === button                                                   (button tag)
+  # ========================================================================= #
+  def button(text)
+    text = text.to_s.dup
+    if text.start_with? '_'
+      text[0,1] = '' # Right now we do not support accelerators.
+    end
+    ::LibuiParadise::Extensions.button(text)
+  end; alias ui_button button # === ui_button
+
+  # ========================================================================= #
+  # === quit_button                                                (quit tag)
+  #
+  # This method can be used to, by default, implement a quit button
+  # that, upon a click-event, will cause the application to exit
+  # and close/quit.
+  # ========================================================================= #
+  def quit_button(
+      optional_arguments = {}
+    )
+    use_this_text = 'Quit'
+    if optional_arguments and optional_arguments.is_a?(Hash)
+      # ===================================================================== #
+      # === :text
+      # ===================================================================== #
+      if optional_arguments.has_key? :text
+        use_this_text = optional_arguments.delete(:text)
+      end
+    end
+    quit_button = button(use_this_text)
+    quit_button.on_clicked {
+      UI.quit
+      0
+    }
+    return quit_button
+  end; alias ui_quit_button quit_button # === ui_quit_button
+
+end
+
+# =========================================================================== #
+# === LibuiParadise.button
+# =========================================================================== #
+def self.button(text)
+  ::LibuiParadise::Extensions.button(text)
+end
+
+end

data/lib/libui_paradise/libui_classes/checkbox.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/checkbox.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.checkbox                     (checkbox tag)
+  # ========================================================================= #
+  def self.checkbox(i = '')
+    _ = UI.new_checkbox(i)
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end
+
+  # ========================================================================= #
+  # === checkbox
+  # ========================================================================= #
+  def checkbox(i = '')
+    ::LibuiParadise::Extensions.checkbox(i)
+  end; alias ui_checkbox     checkbox # === ui_checkbox
+       alias ui_check_button checkbox # === ui_check_button
+
+end
+
+# =========================================================================== #
+# === LibuiParadise.checkbox
+# =========================================================================== #
+def self.checkbox(i = '')
+  ::LibuiParadise::Extensions.checkbox(i)
+end
+
+end

data/lib/libui_paradise/libui_classes/color_button.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The upstream API in C can be found here:
+#
+#   https://github.com/andlabs/libui/blob/master/unix/colorbutton.c
+#
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/color_button.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.new_colour_button
+  # ========================================================================= #
+  def self.colour_button
+    _ = LibUI.new_color_button
+    ::LibuiParadise::Extensions.register_this_fiddle_pointer_widget(_, __method__)
+    return _
+  end; self.instance_eval { alias new_colour_button colour_button } # === LibuiParadise::Extensions.new_colour_button
+       self.instance_eval { alias new_color_button  colour_button } # === LibuiParadise::Extensions.new_color_button
+       self.instance_eval { alias ui_colour_button  colour_button } # === LibuiParadise::Extensions.ui_colour_button
+
+  # ========================================================================= #
+  # === colour_button
+  # ========================================================================= #
+  def colour_button
+    ::LibuiParadise::Extensions.new_colour_button
+  end; alias color_button     colour_button # === color_button
+       alias ui_colour_button colour_button # === ui_color_button
+
+end
+
+# =========================================================================== #
+# === LibuiParadise.colour_button
+# =========================================================================== #
+def self.colour_button
+  ::LibuiParadise::Extensions.new_colour_button
+end; self.instance_eval { alias color_button colour_button } # === LibuiParadise.color_button
+
+end

data/lib/libui_paradise/libui_classes/combobox.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/combobox.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.combobox
+  # ========================================================================= #
+  def self.combobox(
+      optional_array = nil, &block
+    )
+    combobox = UI.new_combobox
+    # ======================================================================= #
+    # Register it at once:
+    # ======================================================================= #
+    add_to_the_registered_widgets(combobox, __method__)
+    if block_given?
+      optional_array = yield
+    end
+    if optional_array and optional_array.is_a?(Array)
+      # append_this_array_to_that_combobox(optional_array, combobox)
+      combobox.append_this_array(optional_array)
+    end
+    return combobox
+  end; self.instance_eval { alias combo_box    combobox } # === LibuiParadise::Extensions.combo_box
+       self.instance_eval { alias ui_combo_box combobox } # === LibuiParadise::Extensions.ui_combo_box
+       self.instance_eval { alias ui_combobox  combobox } # === LibuiParadise::Extensions.ui_combobox
+
+  # ========================================================================= #
+  # === combobox
+  # ========================================================================= #
+  def combobox(
+      optional_array = nil, &block
+    )
+    return ::LibuiParadise::Extensions.combobox(optional_array, &block)
+  end; alias combo_box    combobox # === combo_box
+       alias ui_combo_box combobox # === ui_combo_box
+       alias ui_combobox  combobox # === ui_combobox
+
+  # ========================================================================= #
+  # === selected?
+  #
+  # Unsure whether this works. It appears to work, but I am not even
+  # certain as to why.
+  # ========================================================================= #
+  def selected?(pointer)
+    UI.combobox_selected(pointer).to_s
+  end
+
+end; end

data/lib/libui_paradise/libui_classes/editable_combobox.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/editable_combobox.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.editable_combobox
+  # ========================================================================= #
+  def self.editable_combobox(
+      optional_array = nil, &block
+    )
+    _ = UI.new_editable_combobox
+    if block_given?
+      optional_array = yield
+    end
+    if optional_array and optional_array.is_a?(Array)
+      append_this_array_to_that_combobox(optional_array, _)
+    end
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end; self.instance_eval { alias editable_combo_box    editable_combobox } # === LibuiParadise::Extensions.editable_combo_box
+       self.instance_eval { alias ui_editable_combo_box editable_combobox } # === LibuiParadise::Extensions.ui_editable_combo_box
+
+  # ========================================================================= #
+  # === editable_combobox
+  # ========================================================================= #
+  def editable_combobox(
+      optional_array = nil, &block
+    )
+    return ::LibuiParadise::Extensions(optional_array, &block)
+  end; alias editable_combo_box    editable_combobox # === editable_combo_box
+       alias ui_editable_combo_box editable_combobox # === ui_editable_combo_box
+
+end
+
+# =========================================================================== #
+# === LibuiParadise::Extensions.editable_combobox
+# =========================================================================== #
+def self.editable_combobox(
+    optional_array = nil, &block
+  )
+  return ::LibuiParadise::Extensions.editable_combobox(optional_array, &block)
+end; self.instance_eval { alias editable_combo_box    editable_combobox } # === LibuiParadise.editable_combo_box
+     self.instance_eval { alias ui_editable_combo_box editable_combobox } # === LibuiParadise.ui_editable_combo_box
+
+end

data/lib/libui_paradise/libui_classes/entry.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The upstream C API for libui-entry can be found here:
+#
+#   https://github.com/andlabs/libui/blob/master/unix/entry.c
+#
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/entry.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.entry                           (entry tag)
+  #
+  # This method is tapping into UI.new_entry.
+  #
+  # Usage example:
+  #
+  #   entry1 = UI.entry('ATG')
+  #
+  # ========================================================================= #
+  def self.entry(
+      optional_text = ''
+    )
+    optional_text = optional_text.to_s
+    entry = UI.new_entry
+    unless optional_text.empty?
+      UI.entry_set_text(entry, optional_text)
+    end
+    add_to_the_registered_widgets(entry, __method__)
+    return entry
+  end; self.instance_eval { alias ui_entry entry } # === LibuiParadise::Extensions.ui_entry
+
+  # ========================================================================= #
+  # === entry                                                     (entry tag)
+  #
+  # This method is tapping into UI.new_entry.
+  #
+  # Usage example:
+  #
+  #   entry1 = ui_entry('ATG')
+  #
+  # ========================================================================= #
+  def entry(
+      optional_text = ''
+    )
+    ::LibuiParadise::Extensions.entry(optional_text)
+  end; alias ui_entry entry # === ui_entry
+
+  # ========================================================================= #
+  # === text?
+  #
+  # This method will guarantee a String to be returned.
+  #
+  # This is a bit weird, though. We may have to remove this method one
+  # day. I forgot why I added it to entry.rb specifically. After all
+  # other widgets also should respond to .text?.
+  # ========================================================================= #
+  def text?(from_this_pointer)
+    _ = UI.entry_text(from_this_pointer).to_s
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end
+
+end
+
+# =========================================================================== #
+# === LibuiParadise.entry
+# =========================================================================== #
+def self.entry(
+    optional_text = ''
+  )
+  ::LibuiParadise::Extensions.entry(optional_text)
+end; self.instance_eval { alias ui_entry entry } # === LibuiParadise.ui_entry
+
+end

data/lib/libui_paradise/libui_classes/font.rb

@@ -0,0 +1,78 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/font.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.font                  (font tag, fonts tag)
+  # ========================================================================= #
+  def self.font(&block)
+    use_this_font = UI::FFI::FontDescriptor.malloc
+    if block_given?
+      yielded = yield
+      if yielded.is_a? Hash
+        # =================================================================== #
+        # === :font_size
+        # =================================================================== #
+        if yielded.has_key? :font_size
+          use_this_font.Size = yielded.delete(:font_size)
+        end
+        # =================================================================== #
+        # === :font_family
+        # =================================================================== #
+        if yielded.has_key? :font_family
+          use_this_font.Family = yielded.delete(:font_family)
+        end
+        # =================================================================== #
+        # === :stretch
+        # =================================================================== #
+        if yielded.has_key? :stretch
+          use_this_font.Stretch = yielded.delete(:stretch)
+        end
+        # =================================================================== #
+        # === :weight
+        # =================================================================== #
+        if yielded.has_key? :weight
+          use_this_font.Weight = yielded.delete(:weight)
+        end
+        # =================================================================== #
+        # === :italic
+        # =================================================================== #
+        if yielded.has_key? :italic
+          _ = yielded.delete(:italic_family)
+          if _ == true
+            _ = 1
+          elsif _ == false
+            _ = 0
+          end
+          use_this_font.Italic = _
+        end
+      end
+    end
+    return use_this_font
+  end; self.instance_eval { alias ui_font         font } # === LibuiParadise::Extensions.ui_font
+       self.instance_eval { alias font_descriptor font } # === LibuiParadise::Extensions.font_descriptor
+
+  # ========================================================================= #
+  # === font
+  # ========================================================================= #
+  def font(&block)
+    LibuiParadise::Extensions.font(&block)
+  end; alias ui_font         font # === ui_font
+       alias font_descriptor font # === font_descriptor
+
+end
+
+# =========================================================================== #
+# === LibuiParadise.font
+# =========================================================================== #
+def self.font(&block)
+  ::LibuiParadise::Extensions.font(&block)
+end
+
+end

data/lib/libui_paradise/libui_classes/font_button.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/font_button.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.font_button
+  #
+  # Create a new font button via this method.
+  # ========================================================================= #
+  def self.font_button
+    _ = UI.new_font_button
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end; self.instance_eval { alias ui_font_button font_button } # === Libuiparadise::Extensions.ui_font_button
+
+  # ========================================================================= #
+  # === font_button
+  #
+  # Create a new font button via this method.
+  # ========================================================================= #
+  def font_button
+    return ::LibuiParadise::Extensions.font_button
+  end; alias ui_font_button font_button # === ui_font_button
+
+end
+
+# =========================================================================== #
+# === LibuiParadise.font_button
+# =========================================================================== #
+def self.font_button
+  return ::LibuiParadise::Extensions.font_button
+end
+
+end

data/lib/libui_paradise/libui_classes/grid.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/grid.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === ui_padded_grid
+  # ========================================================================= #
+  def ui_padded_grid
+    _ = ui_grid
+    _.is_padded
+    return _
+  end; alias padded_grid  ui_padded_grid # === padded_grid
+       alias default_grid ui_padded_grid # === default_grid
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.grid                             (grid tag)
+  #
+  # To insert into a grid, try to use this API:
+  #
+  #   uiGridInsertAt(
+  #     uiGrid *g,
+  #     uiControl *c,
+  #     uiControl *existing,
+  #     uiAt at,
+  #     int xspan,
+  #     int yspan,
+  #     int hexpand,
+  #     uiAlign halign, int vexpand, uiAlign valign
+  #   )
+  #
+  # Example to add a new entry onto the grid:
+  #
+  #   UI.grid_append(grid, text('Yo2'), 1, 0, 1, 1, 0, 0, 1, 0)
+  #
+  # ========================================================================= #
+  def self.grid
+    _ = UI.new_grid
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end; self.instance_eval { alias ui_grid grid } # === LibuiParadise::Extensions.ui_grid
+
+  # ========================================================================= #
+  # === grid
+  # ========================================================================= #
+  def grid
+    ::LibuiParadise::Extensions.grid
+  end; alias ui_grid grid # === ui_grid
+
+end; end