libui_paradise 0.1.49

data/lib/libui_paradise/libui_classes/hbox.rb

@@ -0,0 +1,98 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/hbox.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.hbox                             (hbox tag)
+  #
+  # This method will create a horizontal box.
+  # ========================================================================= #
+  def self.hbox(*optional_widgets)
+    _ = UI.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_padded_hbox
+  # ========================================================================= #
+  def ui_padded_hbox(*optional_widgets)
+    _ = ui_hbox(optional_widgets)
+    _.is_padded
+    return _
+  end; alias padded_hbox ui_padded_hbox # === padded_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
+
+  # ========================================================================= #
+  # === 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
+
+end
+
+# ========================================================================= #
+# === LibuiParadise.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
+
+end

data/lib/libui_paradise/libui_classes/horizontal_separator.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/horizontal_separator.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.horizontal_separator
+  # ========================================================================= #
+  def self.horizontal_separator
+    UI.new_horizontal_separator
+  end; self.instance_eval { alias ui_hseparator     horizontal_separator } # === LibuiParadise::Extensions.ui_hseparator
+       self.instance_eval { alias ui_hsep           horizontal_separator } # === LibuiParadise::Extensions.ui_hsep
+       self.instance_eval { alias hspacer           horizontal_separator } # === LibuiParadise::Extensions.hspacer
+       self.instance_eval { alias horizontal_spacer horizontal_separator } # === LibuiParadise::Extensions.horizontal_spacer
+
+  # ========================================================================= #
+  # === horizontal_separator
+  # ========================================================================= #
+  def horizontal_separator
+    ::LibuiParadise::Extensions.horizontal_separator
+  end; alias ui_hseparator     horizontal_separator # === ui_hseparator
+       alias ui_hsep           horizontal_separator # === ui_hsep
+       alias hspacer           horizontal_separator # === hspacer
+       alias horizontal_spacer horizontal_separator # === hspacer
+
+end
+
+# ========================================================================= #
+# === LibuiParadise.horizontal_separator
+# ========================================================================= #
+def self.horizontal_separator
+  ::LibuiParadise::Extensions.horizontal_separator
+end; self.instance_eval { alias ui_hseparator horizontal_separator } # === LibuiParadise.ui_hseparator
+     self.instance_eval { alias ui_hsep       horizontal_separator } # === LibuiParadise.ui_hsep
+
+end

data/lib/libui_paradise/libui_classes/image.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/image.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+  
+  # ========================================================================= #
+  # === Libuiparadise::Extensions.image
+  #
+  # This is currently limited to .png files only, due to ChunkyPng.
+  #
+  # At some later point in the future this limitation may be lifted. For
+  # now it has to remain in place.
+  # ========================================================================= #
+  def self.image(
+      this_file,
+      width  = :try_to_infer_automatically,
+      height = :infer_automatically
+    )
+    if (width  == :infer_automatically) or
+       (height == :infer_automatically)
+      unless Object.const_defined? :ChunkyPNG
+        begin
+          require 'chunky_png'
+        rescue LoadError; end
+      end
+      canvas = ChunkyPNG::Canvas.from_file(this_file)
+      data   = canvas.to_rgba_stream
+      width  = canvas.width
+      height = canvas.height
+      _ = UI.new_image(width, height) # Create the image here.
+      add_to_the_registered_widgets(_, __method__)
+      UI.image_append(
+        _,
+        data,
+        width,
+        height,
+        width
+      )
+      return _
+    end
+    nil
+  end; self.instance_eval { alias ui_image image } # === LibuiParadise::Extensions.ui_image
+
+  # ========================================================================= #
+  # === image
+  #
+  # This is currently limited to .png files only, due to ChunkyPng.
+  #
+  # At some later point in the future this limitation may be lifted. For
+  # now it has to remain in place.
+  # ========================================================================= #
+  def image(
+      this_file,
+      width  = :try_to_infer_automatically,
+      height = :infer_automatically
+    )
+    Libuiparadise::Extensions.image(
+      this_file, width, height
+    )
+  end; alias ui_image image # === ui_image
+
+end
+
+# ========================================================================= #
+# === Libuiparadise.image
+# ========================================================================= #
+def self.image(
+    this_file,
+    width  = :try_to_infer_automatically,
+    height = :infer_automatically
+  )
+  ::LibuiParadise::Extensions.image(
+    this_file, width, height
+  )
+end; self.instance_eval { alias ui_image image } # === LibuiParadise.ui_image
+
+end

data/lib/libui_paradise/libui_classes/label.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/label.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.label                (text tag, label tag)
+  #
+  # Add text to the widget at hand. This is actually called a "label".
+  # ========================================================================= #
+  def self.label(
+      i = ''
+    )
+    _ = UI.new_label(i.to_s)
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end; self.instance_eval { alias text     label } # === LibuiParadise::Extensions.text
+       self.instance_eval { alias ui_text  label } # === LibuiParadise::Extensions.ui_text
+       self.instance_eval { alias ui_label label } # === LibuiParadise::Extensions.ui_label
+
+  # ========================================================================= #
+  # === label
+  # ========================================================================= #
+  def label(
+      i = ''
+    )
+    ::LibuiParadise::Extensions.label(i)
+  end; alias text     label # === text
+       alias ui_text  label # === ui_text
+       alias ui_label label # === ui_label
+
+  # ========================================================================= #
+  # === bold_label
+  #
+  # This currently does not work properly. We may have to re-examine this
+  # eventually at a later point.
+  # ========================================================================= #
+  def bold_label(i = '')
+    return label(i)
+  end
+
+  # ========================================================================= #
+  # === bold_text
+  #
+  # This currently does NOT make the text bold - the method exists solely
+  # as a placeholder, until upstream libui supports bold text as such.
+  # ========================================================================= #
+  def bold_text(i = '')
+    return label(i)
+  end
+
+  # ========================================================================= #
+  # === fancy_text
+  #
+  # This text variant can be styled.
+  # ========================================================================= #
+  def fancy_text(i = '')
+    _ = UI.new_attributed_string(i.to_s)
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end; alias attributed_string fancy_text # === attributed_string
+
+end
+
+# ========================================================================= #
+# === LibuiParadise.label
+#
+# Toplevel method to create a new label, aka new text.
+# ========================================================================= #
+def self.label(
+    i = ''
+  )
+  ::LibuiParadise::Extensions.label(i)
+end; self.instance_eval { alias text     label } # === LibuiParadise.text
+     self.instance_eval { alias ui_text  label } # === LibuiParadise.ui_text
+     self.instance_eval { alias ui_label label } # === LibuiParadise.ui_label
+
+end

data/lib/libui_paradise/libui_classes/menu.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/menu.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.menu                             (menu tag)
+  # ========================================================================= #
+  def self.menu(title = '')
+    _ = UI.new_menu(title)
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end; self.instance_eval { alias ui_menu menu } # === ui_menu
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(title = '')
+    return menu(title)
+  end; alias ui_menu menu # === ui_menu
+
+end
+
+# =========================================================================== #
+# === LibuiParadise.menu
+# =========================================================================== #
+def self.menu(title = '')
+  return LibuiParadise::Extensions.menu(title)
+end; self.instance_eval { alias ui_menu menu } # === LibuiParadise.ui_menu
+
+end

data/lib/libui_paradise/libui_classes/msg_box.rb

@@ -0,0 +1,97 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Official API documentation can be found here:
+#
+#   https://github.com/andlabs/libui/blob/master/unix/stddialogs.c
+#
+# The API signature of msgbox is:
+#
+#   GtkWindow *parent
+#   const char *title
+#   const char *description
+#   GtkMessageType type
+#   GtkButtonsType buttons
+#
+# So the first string is the title and the second string is the description.
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/msg_box.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.msg_box
+  #
+  # This method is a convenience-wrapper over UI.msg_box().
+  # ========================================================================= #
+  def self.msg_box(
+      main_window        = :default_window,
+      title_to_use       = '',
+      description_to_use = ''
+    )
+    case main_window
+    # ======================================================================= #
+    # === :default_window
+    # ======================================================================= #
+    when :default_window,
+         :default
+      require 'libui_paradise/libui_classes/window.rb'
+      main_window = ::LibuiParadise.main_window?
+    end
+    _ = ::LibUI.msg_box(
+      main_window,
+      title_to_use,
+      description_to_use
+    )
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end; self.instance_eval { alias ui_msg_box             msg_box } # === LibuiParadise::Extensions.ui_msg_box
+       self.instance_eval { alias message_to_the_user    msg_box } # === LibuiParadise::Extensions.message_to_the_user
+       self.instance_eval { alias message_box            msg_box } # === LibuiParadise::Extensions.message_box
+       self.instance_eval { alias popup_over_this_widget msg_box } # === LibuiParadise::Extensions.popup_over_this_widget
+
+  # ========================================================================= #
+  # === ui_msg_box
+  #
+  # This method is a convenience-wrapper over UI.msg_box().
+  # ========================================================================= #
+  def ui_msg_box(
+      main_window  = :default_window,
+      title_to_use = '',
+      whatever     = ''
+    )
+    ::LibuiParadise::Extensions.msg_box(
+      main_window,
+      title_to_use,
+      whatever
+    )
+  end; alias message_to_the_user    ui_msg_box # === message_to_the_user
+       alias message_box            ui_msg_box # === message_box
+       alias popup_over_this_widget ui_msg_box # === popup_over_this_widget
+       alias popup_message          ui_msg_box # === popup_message
+
+end
+
+# =========================================================================== #
+# === LibuiParadise.msg_box
+# =========================================================================== #
+def self.msg_box(
+    main_window  = :default_window,
+    title_to_use = '',
+    whatever     = ''
+  )
+  ::LibuiParadise::Extensions.msg_box(
+    main_window,
+    title_to_use,
+    whatever
+  )
+end; self.instance_eval { alias ui_msg_box             msg_box } # === LibuiParadise.ui_msg_box
+     self.instance_eval { alias message_to_the_user    msg_box } # === LibuiParadise.message_to_the_user
+     self.instance_eval { alias message_box            msg_box } # === LibuiParadise.message_box
+     self.instance_eval { alias popup_over_this_widget msg_box } # === LibuiParadise.popup_over_this_widget
+     self.instance_eval { alias popup_message          msg_box } # === LibuiParadise.popup_message
+
+end

data/lib/libui_paradise/libui_classes/msg_box_error.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/msg_box_error.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.msg_box_error
+  # ========================================================================= #
+  def self.msg_box_error(
+      main_window  = LibuiParadise.main_window?,
+      title_to_use = '',
+      whatever     = ''
+    )
+    _ = UI.msg_box_error(
+      main_window,
+      title_to_use,
+      whatever
+    )
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end; self.instance_eval { alias ui_msg_box_error          msg_box_error } # === LibuiParadise::Extensions.ui_msg_box_error
+       self.instance_eval { alias ui_error_msg              msg_box_error } # === LibuiParadise::Extensions.ui_error_msg
+       self.instance_eval { alias ui_error_message          msg_box_error } # === LibuiParadise::Extensions.ui_error_message
+       self.instance_eval { alias error_message_to_the_user msg_box_error } # === LibuiParadise::Extensions.error_message_to_the_user
+
+  # ========================================================================= #
+  # === msg_box_error
+  # ========================================================================= #
+  def msg_box_error(
+      main_window  = LibuiParadise.main_window?,
+      title_to_use = '',
+      whatever     = ''
+    )
+    return ::LibuiParadise::Extensions.msg_box_error(
+      main_window,
+      title_to_use,
+      whatever
+    )
+  end; alias ui_msg_box_error          msg_box_error # === ui_msg_box_error
+       alias ui_error_msg              msg_box_error # === ui_error_msg
+       alias ui_error_message          msg_box_error # === ui_error_message
+       alias error_message_to_the_user msg_box_error # === error_message_to_the_user
+
+end; end

data/lib/libui_paradise/libui_classes/multiline_entry.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/libui_classes/multiline_entry.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.multiline_entry       (multiline_entry tag)
+  #
+  # A textview is a widget that allows the user to input text and modify
+  # that text as well.
+  # ========================================================================= #
+  def self.multiline_entry(optional_content = nil)
+    _ = UI.new_multiline_entry
+    add_to_the_registered_widgets(_, __method__)
+    if optional_content and optional_content.is_a?(String) and !optional_content.empty?
+      _.set_text(optional_content)
+    end
+    return _
+  end; self.instance_eval { alias ui_multiline_entry multiline_entry } # === LibuiParadise::Extensions.ui_multiline_entry
+       self.instance_eval { alias textview           multiline_entry } # === LibuiParadise::Extensions.textview
+       self.instance_eval { alias text_view          multiline_entry } # === LibuiParadise::Extensions.text_view
+       self.instance_eval { alias ui_text_view       multiline_entry } # === LibuiParadise::Extensions.ui_text_view
+       self.instance_eval { alias ui_textview        multiline_entry } # === LibuiParadise::Extensions.ui_textview
+       self.instance_eval { alias ui_text_buffer     multiline_entry } # === LibuiParadise::Extensions.ui_text_buffer
+       self.instance_eval { alias input_field        multiline_entry } # === LibuiParadise::Extensions.input_field
+
+  # ========================================================================= #
+  # === multiline_entry
+  # ========================================================================= #
+  def multiline_entry(optional_content = nil)
+    ::LibuiParadise::Extensions.multiline_entry(optional_content)
+  end; alias ui_multiline_entry multiline_entry # === ui_multiline_entry
+       alias textview           multiline_entry # === textview
+       alias text_view          multiline_entry # === text_view
+       alias ui_text_view       multiline_entry # === ui_text_view
+       alias ui_textview        multiline_entry # === ui_textview
+       alias ui_text_buffer     multiline_entry # === ui_text_buffer
+       alias input_field        multiline_entry # === input_field
+
+end
+
+# =========================================================================== #
+# === LibuiParadise.multiline_entry
+# =========================================================================== #
+def self.multiline_entry(optional_content = nil)
+  ::LibuiParadise::Extensions.multiline_entry(optional_content)
+end; self.instance_eval { alias textview           multiline_entry } # === LibuiParadise.textview
+     self.instance_eval { alias text_view          multiline_entry } # === LibuiParadise.text_view
+     self.instance_eval { alias ui_text_view       multiline_entry } # === LibuiParadise.ui_text_view
+     self.instance_eval { alias ui_textview        multiline_entry } # === LibuiParadise.ui_textview
+     self.instance_eval { alias ui_text_buffer     multiline_entry } # === LibuiParadise.ui_text_buffer
+     self.instance_eval { alias input_field        multiline_entry } # === LibuiParadise.input_field
+
+end

data/lib/libui_paradise/libui_classes/non_wrapping_multiline_entry.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The upstream C API can be found here:
+#
+#   https://raw.githubusercontent.com/andlabs/libui/master/unix/multilineentry.c
+#
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/new_non_wrapping_multiline_entry.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.non_wrapping_multiline_entry
+  # ========================================================================= #
+  def self.non_wrapping_multiline_entry
+    _ = UI.new_non_wrapping_multiline_entry
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.non_wrapping_multiline_entry
+  # ========================================================================= #
+  def non_wrapping_multiline_entry
+    return ::LibuiParadise::Extensions.non_wrapping_multiline_entry
+  end
+
+end
+
+# =========================================================================== #
+# === LibuiParadise.non_wrapping_multiline_entry
+# =========================================================================== #
+def self.non_wrapping_multiline_entry
+  return ::LibuiParadise::Extensions.non_wrapping_multiline_entry
+end
+
+end

data/lib/libui_paradise/libui_classes/open_file.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/open_file.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.open_file
+  # ========================================================================= #
+  def self.open_file(
+      main_window = LibuiParadise::Extensions.main_window?
+    )
+    _ = UI.open_file(main_window)
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end; self.instance_eval { alias ui_open_file open_file } # === LibuiParadise::Extensions.ui_open_file
+
+  # ========================================================================= #
+  # === open_file
+  # ========================================================================= #
+  def open_file(
+      main_window = LibuiParadise::Extensions.main_window?
+    )
+    return ::LibuiParadise::Extensions.open_file(main_window)
+  end; alias ui_open_file open_file # === ui_open_file
+
+end
+
+# =========================================================================== #
+# === LibuiParadise.open_file
+# =========================================================================== #
+def self.open_file(
+    main_window = LibuiParadise::Extensions.main_window?
+  )
+  return ::LibuiParadise::Extensions.open_file(main_window)
+end; self.instance_eval { alias ui_open_file open_file } # === LibuiParadise.ui_open_file
+
+end

data/lib/libui_paradise/libui_classes/password_entry.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/password_entry.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.password_entry
+  #
+  # This method will create and returns a new password entry widget. This
+  # means that input will be "disguised" via the '*' character.
+  #
+  # Usage example:
+  #
+  #   entry = LibuiParadise::Extensions.password_entry
+  #
+  # ========================================================================= #
+  def self.password_entry
+    entry = UI.new_password_entry
+    add_to_the_registered_widgets(entry, __method__)
+    return entry
+  end; self.instance_eval { alias ui_password_entry password_entry } # === LibuiParadise::Extensions.ui_password_entry
+
+  # ========================================================================= #
+  # === password_entry
+  #
+  # Usage example:
+  #
+  #   entry = ui_password_entry
+  #
+  # ========================================================================= #
+  def password_entry
+    ::LibuiParadise::Extensions.password_entry
+  end; alias ui_password_entry password_entry # === ui_password_entry
+
+end
+
+# =========================================================================== #
+# === LibuiParadise.password_entry
+# =========================================================================== #
+def self.password_entry
+  ::LibuiParadise::Extensions.password_entry
+end; self.instance_eval { alias ui_password_entry password_entry } # === LibuiParadise.ui_password_entry
+
+end