libui_paradise 0.2.49 → 0.3.9

data/lib/libui_paradise/extensions/toplevel_counters.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/extensions/toplevel_counters.rb'
+# =========================================================================== #
+module LibuiParadise
+
+  # ========================================================================= #
+  # === @counter_top
+  # ========================================================================= #
+  @counter_top = 0
+
+  # ========================================================================= #
+  # === @counter_left
+  # ========================================================================= #
+  @counter_left = 0
+
+  # ========================================================================= #
+  # === LibuiParadise.counter_left?
+  # ========================================================================= #
+  def self.counter_left?
+    @counter_left
+  end; self.instance_eval { alias counter_left  counter_left? } # === LibuiParadise.counter_left
+       self.instance_eval { alias left_counter  counter_left? } # === LibuiParadise.left_counter
+       self.instance_eval { alias left_counter? counter_left? } # === LibuiParadise.left_counter?
+
+  # ========================================================================= #
+  # === LibuiParadise.counter_left=
+  # ========================================================================= #
+  def self.counter_left=(i = 1)
+    @counter_left = i
+  end
+
+  # ========================================================================= #
+  # === LibuiParadise.counter_top?
+  # ========================================================================= #
+  def self.counter_top?
+    @counter_top
+  end; self.instance_eval { alias counter_top  counter_top? } # === LibuiParadise.counter_top
+       self.instance_eval { alias top_counter  counter_top? } # === LibuiParadise.top_counter
+       self.instance_eval { alias top_counter? counter_top? } # === LibuiParadise.top_counter?
+
+  # ========================================================================= #
+  # === LibuiParadise.counter_top=
+  # ========================================================================= #
+  def self.counter_top=(i = 1)
+    @counter_top = i
+  end
+
+  # ========================================================================= #
+  # === LibuiParadise.counters?
+  # ========================================================================= #
+  def self.counters?
+    return [@counter_left, @counter_top]
+  end
+
+end

data/lib/libui_paradise/fiddle/{pointer.rb → fiddle.rb}

@@ -11,13 +11,31 @@
 # refinements, but I don't quite like the syntax of refinements,
 # so I opted for the simpler toplevel modification instead.
 # =========================================================================== #
-# require 'libui_paradise/fiddle/pointer.rb'
+# require 'libui_paradise/fiddle/fiddle.rb'
 # =========================================================================== #
 module Fiddle
 
 class Pointer # === Fiddle::Pointer
 
-  require 'libui_paradise/extensions/counters.rb'
+  require 'libui_paradise/extensions/toplevel_counters.rb'
+
+  # ========================================================================= #
+  # === enable                                                   (enable tag)
+  # ========================================================================= #
+  def enable(&block)
+    object_id = self.object_id
+    hash = LibuiParadise::Extensions.hash_fiddle_pointer_widgets?
+    type = hash[object_id].last # The last entry contains the type.
+    case type
+    # ======================================================================= #
+    # === :button
+    # ======================================================================= #
+    when :button
+      LibUI.control_enable(self)
+    else
+      e 'Not registered type in .enable(): '+type.to_s
+    end
+  end
 
   # ========================================================================= #
   # === on_changed
@@ -254,9 +272,9 @@ class Pointer # === Fiddle::Pointer
        alias start_position= set_value # === start_position=
 
   # ========================================================================= #
-  # === right                                                     (right tag)
+  # === left                                                       (left tag)
   # ========================================================================= #
-  def right(
+  def left(
       widget,
       left  = LibuiParadise.counter_left?,
       top   = LibuiParadise.counter_top?,
@@ -309,9 +327,9 @@ class Pointer # === Fiddle::Pointer
   end
 
   # ========================================================================= #
-  # === left                                                       (left tag)
+  # === right                                                     (right tag)
   # ========================================================================= #
-  def left(
+  def right(
       widget,
       left  = LibuiParadise.counter_left?,
       top   = LibuiParadise.counter_top?,
@@ -587,84 +605,8 @@ class Pointer # === Fiddle::Pointer
     #     display_this_text.to_s
     #   )
     else
-      puts 'Unhandled case in clear(): '+
-           type.to_s
-    end
-  end
-
-  # ========================================================================= #
-  # === empty?
-  # ========================================================================= #
-  def empty?(
-      type = nil
-    )
-    object_id = self.object_id
-    hash = LibuiParadise::Extensions.hash_fiddle_pointer_widgets?
-    if type.nil?
-      # ===================================================================== #
-      # In this case we must determine the type in use.
-      # ===================================================================== #
-      if hash.has_key? object_id
-        type = hash[object_id].last # The last entry contains the type.
-      end
-    end
-    case type
-    # ======================================================================= #
-    # === :entry
-    # ======================================================================= #
-    when :entry
-      self.text?.empty?
-    else
-      return true
-    end
-  end
-
-  # ========================================================================= #
-  # === is_read_only
-  # ========================================================================= #
-  def is_read_only(
-      current_widget = available_pointers?[self.object_id] # This will be an Array.
-    )
-    _pointer = current_widget.first # Not used currently in this method.
-    type     = current_widget.last
-    case type
-    # ======================================================================= #
-    # === :multiline_entry
-    # ======================================================================= #
-    when :multiline_entry
-      LibUI.multiline_entry_set_read_only(self, 1)
-    else
-      pp caller()
-      puts "#{type} (class #{type.class}) is not yet implemented in .padded=."
-    end
-  end
-
-  # ========================================================================= #
-  # === append_this_string
-  #
-  # This method can be used to append a String to an existing String.
-  # ========================================================================= #
-  def append_this_string(i)
-    ::LibUI.attributed_string_append_unattributed(self, i)
-  end
-
-  # ========================================================================= #
-  # === append_text_column
-  #
-  # This method is specifically used for libui-tables.
-  # ========================================================================= #
-  def append_text_column(text, a, b)
-    object_id = self.object_id
-    hash = LibuiParadise::Extensions.hash_fiddle_pointer_widgets?
-    type = hash[object_id].last # The last entry contains the type.
-    case type
-    # ======================================================================= #
-    # === :button
-    # ======================================================================= #
-    when :table
-      LibUI.table_append_text_column(self, text, a, b)
-    else
-      e 'Not registered type in .append_text_column(): '+type.to_s
+      puts "Unhandled case in clear(): "\
+           "#{type}"
     end
   end
 
@@ -739,24 +681,6 @@ class Pointer # === Fiddle::Pointer
     end
   end
 
-  # ========================================================================= #
-  # === enable                                                   (enable tag)
-  # ========================================================================= #
-  def enable(&block)
-    object_id = self.object_id
-    hash = LibuiParadise::Extensions.hash_fiddle_pointer_widgets?
-    type = hash[object_id].last # The last entry contains the type.
-    case type
-    # ======================================================================= #
-    # === :button
-    # ======================================================================= #
-    when :button
-      LibUI.control_enable(self)
-    else
-      e 'Not registered type in .enable(): '+type.to_s
-    end
-  end
-
   # ========================================================================= #
   # === populate
   # ========================================================================= #
@@ -780,20 +704,6 @@ class Pointer # === Fiddle::Pointer
     set_padded(1)
   end
 
-  # ========================================================================= #
-  # === show_then_main_then_quit
-  #
-  # This method ultimately combines three other method calls.
-  # ========================================================================= #
-  def show_then_main_then_quit
-    LibUI.control_show(self)
-    main_then_quit
-  end; alias elegant_exit           show_then_main_then_quit # === elegant_exit
-       alias complex_finalizer      show_then_main_then_quit # === complex_finalizer
-       alias intelligent_close_down show_then_main_then_quit # === intelligent_close_down
-       alias intelligent_quit       show_then_main_then_quit # === intelligent_quit
-       alias intelligent_exit       show_then_main_then_quit # === intelligent_exit
-
   # ========================================================================= #
   # === on_clicked
   #
@@ -810,6 +720,62 @@ class Pointer # === Fiddle::Pointer
     LibuiParadise::Extensions.hash_fiddle_pointer_widgets?
   end; alias main_hash? available_pointers? # === main_hash?
 
+  # ========================================================================= #
+  # === empty?
+  # ========================================================================= #
+  def empty?(
+      type = nil
+    )
+    object_id = self.object_id
+    hash = LibuiParadise::Extensions.hash_fiddle_pointer_widgets?
+    if type.nil?
+      # ===================================================================== #
+      # In this case we must determine the type in use.
+      # ===================================================================== #
+      if hash.has_key? object_id
+        type = hash[object_id].last # The last entry contains the type.
+      end
+    end
+    case type
+    # ======================================================================= #
+    # === :entry
+    # ======================================================================= #
+    when :entry
+      self.text?.empty?
+    else
+      return true
+    end
+  end
+
+  # ========================================================================= #
+  # === is_read_only
+  # ========================================================================= #
+  def is_read_only(
+      current_widget = available_pointers?[self.object_id] # This will be an Array.
+    )
+    _pointer = current_widget.first # Not used currently in this method.
+    type     = current_widget.last
+    case type
+    # ======================================================================= #
+    # === :multiline_entry
+    # ======================================================================= #
+    when :multiline_entry
+      LibUI.multiline_entry_set_read_only(self, 1)
+    else
+      pp caller()
+      puts "#{type} (class #{type.class}) is not yet implemented in .padded=."
+    end
+  end
+
+  # ========================================================================= #
+  # === append_this_string
+  #
+  # This method can be used to append a String to an existing String.
+  # ========================================================================= #
+  def append_this_string(i)
+    ::LibUI.attributed_string_append_unattributed(self, i)
+  end
+
   # ========================================================================= #
   # === append_this_array
   # ========================================================================= #
@@ -1009,16 +975,6 @@ class Pointer # === Fiddle::Pointer
   end; alias uses_a_margin is_margined # === uses_a_margin
        alias has_margin    is_margined # === has_margin
 
-  # ========================================================================= #
-  # === main_then_quit
-  #
-  # We use ::LibUI just in case to avoid any possible name-collisions.
-  # ========================================================================= #
-  def main_then_quit
-    ::LibUI.main
-    ::LibUI.quit
-  end
-
   # ========================================================================= #
   # === close_properly
   #
@@ -1033,15 +989,80 @@ class Pointer # === Fiddle::Pointer
     }
   end; alias simple_exit close_properly # === simple_exit
        alias sane_exit   close_properly # === sane_exit
-       alias should_quit close_properly # === should_quit
        alias do_quit     close_properly # === should_quit
+       alias should_quit close_properly # === should_quit
+
+  # ========================================================================= #
+  # === main_then_quit
+  #
+  # We use ::LibUI just in case to avoid any possible name-collisions.
+  # ========================================================================= #
+  def main_then_quit
+    ::LibUI.main
+    ::LibUI.quit
+    #::LibUI.uninit # Trying this since as of November 2023. Nope, does not work.
+  end
+
+  # ========================================================================= #
+  # === show_then_main_then_quit
+  #
+  # This method ultimately combines three other method calls.
+  # ========================================================================= #
+  def show_then_main_then_quit
+    ::LibUI.control_show(self)
+    main_then_quit
+  end; alias elegant_exit           show_then_main_then_quit # === elegant_exit
+       alias complex_finalizer      show_then_main_then_quit # === complex_finalizer
+       alias intelligent_close_down show_then_main_then_quit # === intelligent_close_down
+       alias intelligent_quit       show_then_main_then_quit # === intelligent_quit
+       alias intelligent_exit       show_then_main_then_quit # === intelligent_exit
+
+  # ========================================================================= #
+  # === append_text_column
+  #
+  # This method is specifically used for libui-tables.
+  # ========================================================================= #
+  def append_text_column(
+      text,
+      a,
+      b = -1
+    )
+    object_id = self.object_id
+    hash = LibuiParadise::Extensions.hash_fiddle_pointer_widgets?
+    type = hash[object_id].last # The last entry contains the type.
+    case type
+    # ======================================================================= #
+    # === :table
+    #
+    # This is the primary entry point for this method.
+    # ======================================================================= #
+    when :table
+      ::LibUI.table_append_text_column(self, text, a, b)
+    else
+      e 'Not registered type in .append_text_column(): '+type.to_s
+    end
+  end
+
+  # ========================================================================= #
+  # === on_key_press_event
+  # ========================================================================= #
+  def on_key_press_event(&block)
+    # e 'NOT YET IMPLEMENTED.'
+  end
+
+  # ========================================================================= #
+  # === on_button_press_event
+  # ========================================================================= #
+  def on_button_press_event(&block)
+    # e 'NOT YET IMPLEMENTED'
+  end
 
   # ========================================================================= #
-  # === Skeleton methods:
+  # === Skeleton methods
   #
-  # A "skeleton" method is one that doesn't do anything right now. These
-  # were added to increase compatibility with the gtk_paradise gem in
-  # particular.
+  # A "skeleton" method is one that doesn't do anything right now.
+  # These were added to increase compatibility with the gtk_paradise
+  # gem in particular.
   #
   # Some of these skeleton methods may become real methods one day,
   # depending on how sophisticated the libui code will be - but
@@ -1071,7 +1092,6 @@ class Pointer # === Fiddle::Pointer
   def reset_the_internal_variables; end
   def editable=(true_or_false = false); end
   def set_max_length(n = 100); end
-  def use_gtk_paradise_project_css_file; end
   def append_project_CSS_file; end
   def infer_the_size_automatically; end
   def set_column_spacing(i = 1); end
@@ -1135,24 +1155,22 @@ class Pointer # === Fiddle::Pointer
   def spacing1=(i = 2); end
   def spacing2=(i = 2); end
   def spacing=(i = 0); end
+  def light_blue_background; end
+  def hover(i = :hack_26) # Currently not in use.
+  end
+  def set_font_size(i = :hack_26) # Currently not in use.
+  end
+  def use_gtk_paradise_project_css_file; end
+  def on_hover_colour(i = '', &block); end
   def deselect; end
   # def fraction=(i = ''); end
   def return_all_entries
     []
   end
-
-  # ========================================================================= #
-  # === on_key_press_event
-  # ========================================================================= #
-  def on_key_press_event(&block)
-    # e 'NOT YET IMPLEMENTED.'
+  def drag_via_left_to_right(a, b)
+    vbox(a, b)
   end
-
-  # ========================================================================= #
-  # === on_button_press_event
-  # ========================================================================= #
-  def on_button_press_event(&block)
-    # e 'NOT YET IMPLEMENTED'
+  def default_styling(i = '')
   end
 
 end; end

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/box.rb

@@ -121,8 +121,9 @@ module Extensions # === LibuiParadise::Extensions
   # ========================================================================= #
   def vbox(*optional_widgets)
     ::LibuiParadise::Extensions.vbox(optional_widgets)
-  end; alias ui_vbox vbox # === ui_vbox
-       alias gtk_box vbox # === gtk_box
+  end; alias ui_vbox     vbox # === ui_vbox
+       alias gtk_box     vbox # === gtk_box
+       alias create_vbox vbox # === create_vbox
 
 end
 

data/lib/libui_paradise/libui_classes/grid.rb

@@ -37,10 +37,13 @@ module Extensions # === LibuiParadise::Extensions
 
   # ========================================================================= #
   # === grid
+  #
+  # This method can be used to create (and return) a new grid.
   # ========================================================================= #
   def grid
     ::LibuiParadise::Extensions.grid
-  end; alias ui_grid grid # === ui_grid
+  end; alias ui_grid             grid # === ui_grid
+       alias create_default_grid grid # === create_default_grid
 
   # ========================================================================= #
   # === ui_padded_grid