libui_paradise 0.2.49 → 0.4.13

data/lib/libui_paradise/generic_window/generic_window.rb

@@ -69,7 +69,7 @@ class GenericWindow < LibuiParadise::Base # === LibuiParadise::GenericWindow
   # === run
   # ========================================================================= #
   def run
-    super()
+    super() # Call any parent method.
   end
 
 end; end

data/lib/libui_paradise/images/README.md

@@ -1,2 +1,5 @@
-This directory only contains the libui_paradise logo that was 
-created on 27.08.2021 via cfdg, gimp, kolourpaint and pngquant.
+This directory contains the libui_paradise logo that was created on 
+27.08.2021 via cfdg, gimp, kolourpaint and pngquant.
+
+Additional images may also be stored here, in regards to documentation
+for the libui_paradise gem.

data/lib/libui_paradise/libui_classes/button.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/libui_classes/button.rb'
+# =========================================================================== #
+module LibuiParadise
+
+  require 'libui_paradise/toplevel_methods/add_to_the_registered_widgets.rb'
+
+  # ========================================================================= #
+  # === LibuiParadise.button                                     (button tag)
+  #
+  # The upstream API for buttons, in C, can be found here at the
+  # following github repository for libui-ng:
+  #
+  #   https://github.com/libui-ng/libui-ng/blob/master/unix/button.c
+  #
+  # ========================================================================= #
+  def self.button(text)
+    text = text.to_s.dup.strip
+    if text.start_with? '_'
+      text[0,1] = '' # Right now we do not support accelerators.
+    end
+    _ = ::LibUI.new_button(text) # Create the button here, by delegating towards LibUI.
+    register_this_fiddle_pointer_widget(_, __method__)
+    return _ # Last but not least, always return the button.
+  end; self.instance_eval { alias ui_button     button } # === LibuiParadise.ui_button
+       self.instance_eval { alias create_button button } # === LibuiParadise.create_button
+
+end

data/lib/libui_paradise/libui_classes/entry.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/libui_classes/entry.rb'
+# =========================================================================== #
+module LibuiParadise
+
+  # ========================================================================= #
+  # === LibuiParadise.entry                                       (entry tag)
+  #
+  # The upstream C API for libui-entry can be found here:
+  #
+  #   https://github.com/andlabs/libui/blob/master/unix/entry.c
+  #
+  # This method is tapping into LibUI.new_entry.
+  #
+  # Usage example:
+  #
+  #   entry1 = LibUI.entry('ATG')
+  #
+  # ========================================================================= #
+  def self.entry(
+      optional_text = ''
+    )
+    optional_text = optional_text.to_s
+    entry = ::LibUI.new_entry # Create the new entry here.
+    unless optional_text.empty?
+      ::LibUI.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.ui_entry
+
+end

data/lib/libui_paradise/libui_classes/grid.rb

@@ -2,14 +2,17 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-# require 'libui_paradise/libui_classes/grid.rb
+# require 'libui_paradise/libui_classes/grid.rb'
 # =========================================================================== #
 module LibuiParadise
 
-module Extensions # === LibuiParadise::Extensions
+  require 'libui_paradise/toplevel_methods/toplevel_counters.rb'
 
   # ========================================================================= #
-  # === LibuiParadise::Extensions.grid                             (grid tag)
+  # === LibuiParadise.grid                                         (grid tag)
+  #
+  # This method will create a new grid, via LibUI.new_grid(), and then
+  # return this widget object.
   #
   # To insert into a grid, try to use this API:
   #
@@ -30,26 +33,14 @@ module Extensions # === LibuiParadise::Extensions
   #
   # ========================================================================= #
   def self.grid
-    _ = ::LibUI.new_grid
+    _ = ::LibUI.new_grid # Create the grid here.
+    # ======================================================================= #
+    # Register it at once:
+    # ======================================================================= #
     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
-
-  # ========================================================================= #
-  # === ui_padded_grid
-  # ========================================================================= #
-  def ui_padded_grid
-    _ = ui_grid # This is defined in the method above ^^^ this method.
-    _.is_padded
-    return _
-  end; alias padded_grid  ui_padded_grid # === padded_grid
-       alias default_grid ui_padded_grid # === default_grid
+  end; self.instance_eval { alias ui_grid     grid } # === LibuiParadise.ui_grid
+       self.instance_eval { alias create_grid grid } # === LibuiParadise.create_grid
+       self.instance_eval { alias create_default_grid create_grid } # === LibuiParadise.create_default_grid
 
-end; end
+end

data/lib/libui_paradise/libui_classes/hbox.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/libui_classes/hbox.rb'
+# =========================================================================== #
+module LibuiParadise
+
+  # ========================================================================= #
+  # === LibuiParadise.hbox                                         (hbox tag)
+  #
+  # This toplevel-method can be used to create a horizontal box.
+  # ========================================================================= #
+  def self.hbox(*optional_widgets)
+    _ = ::LibUI.new_horizontal_box
+    add_to_the_registered_widgets(_, __method__)
+    optional_widgets.flatten!
+    if optional_widgets and !optional_widgets.empty?
+      optional_widgets.flatten.each {|this_widget| _ << this_widget }
+    end
+    return _
+  end; self.instance_eval { alias horizontal_box hbox } # === LibuiParadise.horizontal_box
+       self.instance_eval { alias ui_hbox        hbox } # === LibuiParadise.ui_hbox
+       self.instance_eval { alias create_hbox    hbox } # === LibuiParadise.create_hbox
+
+  # ========================================================================= #
+  # === LibuiParadise.ui_padded_hbox
+  #
+  # This method will call .is_padded on the hbox after it has been
+  # initialized.
+  # ========================================================================= #
+  def self.ui_padded_hbox(*optional_widgets)
+    _ = ::LibUI.ui_hbox(optional_widgets)
+    _.is_padded
+    return _
+  end; self.instance_eval { alias padded_hbox       ui_padded_hbox } # === LibuiParadise.padded_hbox
+       self.instance_eval { alias libui_padded_hbox ui_padded_hbox } # === LibuiParadise.libui_padded_hbox
+
+end