libui_paradise 0.2.49

data/lib/libui_paradise/generic_window/README.md

@@ -0,0 +1,9 @@
+The main purpose of the class in this directory is to provide
+a simplified toplevel window for the libui_paradise gem. That
+way a user can directly tap into this, or use the base class
+called LibuiParadise::GUI::LibUI::Base, to quickly display a
+window.
+
+I needed this functionality in September 2022 to quickly 
+show a "Backup has finished!" message on windows specifically,
+to indicate that backup has, well - finished.

data/lib/libui_paradise/generic_window/generic_window.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === LibuiParadise::GenericWindow
+# =========================================================================== #
+# require 'libui_paradise/generic_window/generic_window.rb'
+# LibuiParadise::GenericWindow.new(ARGV)
+# =========================================================================== #
+require 'libui_paradise/base/base.rb'
+
+module LibuiParadise
+
+class GenericWindow < LibuiParadise::Base # === LibuiParadise::GenericWindow
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'Generic Window'
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = 500
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = 300
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      *use_these_widgets,
+      &block
+    )
+    reset
+    # ======================================================================= #
+    # === Handle blocks given to this method next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :do_not_run_yet
+      # ===================================================================== #
+      when :do_not_run_yet,
+           :dont_run_already
+        run_already = false
+      end
+    end
+    if run_already # This is coupled to batch-adding widgets.
+      add_these_widgets_to_the_main_window(
+        use_these_widgets
+      )
+      run
+    end
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    super()
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    super()
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  LibuiParadise::GUI::LibUI::GenericWindow.new
+end

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

@@ -0,0 +1,156 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/libui_classes/box.rb'
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.vbox                            (vbox tag)
+  #
+  # This method will create a vertical box.
+  # ========================================================================= #
+  def self.vbox(*optional_widgets)
+    _ = ::LibUI.new_vertical_box
+    add_to_the_registered_widgets(_, __method__)
+    if optional_widgets and !optional_widgets.empty?
+      optional_widgets.flatten.each {|this_widget| _ << this_widget }
+    end
+    return _
+  end; self.instance_eval { alias ui_vbox vbox } # === ui_vbox
+
+  # ========================================================================= #
+  # === ui_padded_vbox
+  #
+  # This method will call .is_padded on the vbox after it has been
+  # initialized.
+  # ========================================================================= #
+  def ui_padded_vbox(*optional_widgets)
+    _ = ui_vbox(optional_widgets)
+    _.is_padded
+    return _
+  end; alias padded_vbox ui_padded_vbox # === padded_vbox
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.hbox                             (hbox tag)
+  #
+  # This method will create a horizontal box.
+  # ========================================================================= #
+  def self.hbox(*optional_widgets)
+    _ = ::LibUI.new_horizontal_box
+    add_to_the_registered_widgets(_, __method__)
+    if optional_widgets and !optional_widgets.flatten.empty?
+      optional_widgets.flatten.each {|this_widget|
+        _.add(this_widget)
+      }
+    end
+    return _
+  end; self.instance_eval { alias ui_hbox     hbox } # === ui_hbox
+       self.instance_eval { alias create_hbox hbox } # === create_hbox
+
+  # ========================================================================= #
+  # === ui_hbox                                                    (hbox tag)
+  # ========================================================================= #
+  def hbox(*optional_widgets)
+    ::LibuiParadise::Extensions.hbox(optional_widgets)
+  end; alias ui_hbox     hbox # === ui_hbox
+       alias create_hbox hbox # === create_hbox
+       alias libui_hbox  hbox # === libui_hbox
+
+  # ========================================================================= #
+  # === ui_padded_hbox
+  #
+  # If you want to add optional widgets then simply pass them as argument
+  # to this method.
+  # ========================================================================= #
+  def ui_padded_hbox(*optional_widgets)
+    _ = ui_hbox(optional_widgets)
+    _.is_padded
+    return _
+  end; alias padded_hbox       ui_padded_hbox # === padded_hbox
+       alias libui_padded_hbox ui_padded_hbox # === libui_padded_hbox
+
+  # ========================================================================= #
+  # === two_elements_hbox
+  #
+  # This method will return a horizontal box (hbox) that is accepting
+  # two arguments (two widgets) that will be embedded onto that hbox.
+  # Then the result is returned.
+  # ========================================================================= #
+  def two_elements_hbox(
+      widget1,
+      widget2,
+      options = {
+        layout_to_use: :maximal # This is the default.
+      }
+    )
+    _ = ui_padded_hbox
+    # ======================================================================= #
+    # === Handle :layout_to_use
+    #
+    # This is mostly done to distinguish between maximal() and minimal()
+    # for widgets.
+    # ======================================================================= #
+    if options.is_a?(Hash) and options.has_key?(:layout_to_use)
+      case options[:layout_to_use]
+      # ===================================================================== #
+      # === :maximal
+      # ===================================================================== #
+      when :maximal
+        _.maximal(widget1)
+        _.maximal(widget2)
+      # ===================================================================== #
+      # === :minimal
+      # ===================================================================== #
+      when :minimal
+        _.minimal(widget1)
+        _.minimal(widget2)
+      end
+    else
+      _.minimal(widget1)
+      _.minimal(widget2)
+    end
+    return _
+  end
+
+  # ========================================================================= #
+  # === vbox
+  # ========================================================================= #
+  def vbox(*optional_widgets)
+    ::LibuiParadise::Extensions.vbox(optional_widgets)
+  end; alias ui_vbox vbox # === ui_vbox
+       alias gtk_box vbox # === gtk_box
+
+end
+
+# ========================================================================= #
+# === LibuiParadise.hbox
+#
+# This toplevel-method can be used to instantiate a new hbox.
+# ========================================================================= #
+def self.hbox(*optional_widgets)
+  ::LibuiParadise::Extensions.hbox(optional_widgets)
+end; self.instance_eval { alias ui_hbox     hbox } # === LibuiParadise.ui_hbox
+     self.instance_eval { alias create_hbox hbox } # === LibuiParadise.create_hbox
+
+# =========================================================================== #
+# === LibuiParadise.padded_vbox
+# =========================================================================== #
+def self.padded_vbox
+  _ = ::LibuiParadise::Extensions.vbox
+  _.is_padded
+  return _
+end
+
+
+# =========================================================================== #
+# === LibuiParadise.vbox
+# =========================================================================== #
+def self.vbox
+  ::LibuiParadise::Extensions.vbox
+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/libui_classes/grid.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === 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
+    _ = ::LibUI.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
+
+  # ========================================================================= #
+  # === 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; end