libui_paradise 0.1.49

data/lib/libui_paradise/libui_classes/progressbar.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://github.com/andlabs/libui/blob/master/unix/progressbar.c
+#
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/progressbar.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.new_progress_bar
+  # ========================================================================= #
+  def self.new_progress_bar
+    _ = LibUI.new_progress_bar
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end
+
+  # ========================================================================= #
+  # === new_progress_bar
+  # ========================================================================= #
+  def new_progress_bar
+    return ::LibuiParadise::Extensions.new_progress_bar
+  end
+
+end
+
+# =========================================================================== #
+# === LibuiParadise.new_progress_bar
+# =========================================================================== #
+def self.new_progress_bar
+  return ::LibuiParadise::Extensions.new_progress_bar
+end
+
+end

data/lib/libui_paradise/libui_classes/radio_buttons.rb

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

data/lib/libui_paradise/libui_classes/scrolling_area.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/scrolling_area.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.scrolling_area
+  #
+  # It seems as if scrolling is not yet easily available in libui.
+  #
+  # The upstream API is like this:
+  #
+  #   uiArea *area = uiNewScrollingArea(&handler, 400, 400);
+  #
+  # The two numbers are width and height, as integers, respectively.
+  # In total three arguments are required. The first argument is
+  # a so-called "AreaHandler".
+  #
+  # The code may be found here:
+  #
+  #   https://github.com/andlabs/libui/blob/master/windows/areascroll.cpp
+  #
+  # ========================================================================= #
+  def self.scrolling_area(
+      widget,
+      width           = 400,
+      height          = 400
+    )
+    case width
+    when :default, nil
+      width = 400
+    end
+    case height
+    when :default, nil
+      height = 400
+    end
+    _ = LibUI.new_scrolling_area(widget, width, height)
+    # ======================================================================= #
+    # The next part does not yet work - is it even possible to add widgets
+    # to a scrolling area in libui?
+    # if optional_widget
+    #   _.add(optional_widget)
+    # end
+    # ======================================================================= #
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end; self.instance_eval { alias ui_scrolling_area  scrolling_area } # === LibuiParadise::Extensions.ui_scrolling_area
+       self.instance_eval { alias ui_scrolled_window scrolling_area } # === LibuiParadise::Extensions.ui_scrolling_window
+
+  # ========================================================================= #
+  # === scrolling_area
+  #
+  # It seems as if scrolling is not yet easily available in libui.
+  #
+  # The upstream API is like this:
+  #
+  #   uiArea *area = uiNewScrollingArea(&handler, 400, 400);
+  #
+  # ========================================================================= #
+  def scrolling_area(
+      optional_widget = nil
+    )
+    LibuiParadise::Extensions.scrolling_area(optional_widget)
+  end; alias ui_scrolling_area  scrolling_area # === ui_scrolling_area
+       alias ui_scrolled_window scrolling_area # === ui_scrolling_window
+
+end
+
+# =========================================================================== #
+# === LibuiParadise.scrolling_area
+# =========================================================================== #
+def self.scrolling_area(
+    widget,
+    width  = :default,
+    height = :default
+  )
+  ::LibuiParadise::Extensions.scrolling_area(widget, width, height)
+end
+
+end

data/lib/libui_paradise/libui_classes/search_entry.rb

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

data/lib/libui_paradise/libui_classes/spinbox.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/spinbox.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.spinbox
+  #
+  # This method will return a spin-button, also called a spin-box.
+  # ========================================================================= #
+  def self.spinbox(
+      start_point = 0,
+      end_point   = 100
+    )
+    _ = UI.new_spinbox(start_point.to_i, end_point.to_i)
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end; self.instance_eval { alias ui_spinbox    spinbox } # === LibuiParadise::Extensions.ui_spinbox
+       self.instance_eval { alias ui_spinbutton spinbox } # === LibuiParadise::Extensions.ui_spinbutton
+       self.instance_eval { alias spinbutton    spinbox } # === LibuiParadise::Extensions.spinbutton
+
+  # ========================================================================= #
+  # === spinbox
+  #
+  # This method will return a spin-button, also called a spin-box.
+  # ========================================================================= #
+  def spinbox(
+      start_point = 0,
+      end_point   = 100
+    )
+    ::LibuiParadise::Extensions.spinbox(start_point, end_point)
+  end; alias ui_spinbox    spinbox # === ui_spinbox
+       alias ui_spinbutton spinbox # === ui_spinbutton
+       alias spinbutton    spinbox # === spinbutton
+
+end
+
+# =========================================================================== #
+# === LibuiParadise.spinbox
+# =========================================================================== #
+def self.spinbox(
+    start_point = 0,
+    end_point   = 100
+  )
+  ::LibuiParadise::Extensions.spinbox(start_point, end_point)
+end; self.instance_eval { alias ui_spinbox    spinbox } # === LibuiParadise.ui_spinbox
+     self.instance_eval { alias ui_spinbutton spinbox } # === LibuiParadise.ui_spinbutton
+     self.instance_eval { alias spinbutton    spinbox } # === LibuiParadise.spinbutton
+
+end

data/lib/libui_paradise/libui_classes/tab.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/tab.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.tab
+  #
+  # This could be also called "notebook_tab".
+  # ========================================================================= #
+  def self.tab
+    _ = UI.new_tab
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end; self.instance_eval { alias ui_tab       tab } # === LibuiParadise::Extensions.ui_tab
+       self.instance_eval { alias ui_tabs      tab } # === LibuiParadise::Extensions.ui_tabs
+       self.instance_eval { alias notebook     tab } # === LibuiParadise::Extensions.notebook
+       self.instance_eval { alias ui_notebook  tab } # === LibuiParadise::Extensions.ui_notebook
+       self.instance_eval { alias notebook_tab tab } # === LibuiParadise::Extensions.notebook_tab
+
+  # ========================================================================= #
+  # === tab
+  #
+  # This could be also called "notebook_tab".
+  # ========================================================================= #
+  def tab
+    ::LibuiParadise::Extensions.tab
+  end; alias ui_tab       tab # === ui_tab
+       alias ui_tabs      tab # === ui_tabs
+       alias notebook     tab # === notebook
+       alias ui_notebook  tab # === ui_notebook
+       alias notebook_tab tab # === notebook_tab
+
+end; end

data/lib/libui_paradise/libui_classes/table.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/table.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.table
+  #
+  # The argument should be of type table_params.
+  #
+  # Example for this:
+  #
+  #   table_params = LibUI::FFI::TableParams.malloc
+  #   table_params.Model = model
+  #   table_params.RowBackgroundColorModelColumn = -1
+  #
+  # ========================================================================= #
+  def self.table(i)
+    _ = LibUI.new_table(i)
+    LibuiParadise::Extensions.register_this_fiddle_pointer_widget(_, __method__)
+    return _
+  end; self.instance_eval { alias ui_table table } # === LibuiParadise::Extensions.ui_table
+
+  # ========================================================================= #
+  # === table
+  # ========================================================================= #
+  def table(i)
+    ::LibuiParadise::Extensions.table(i)
+  end; alias ui_table table # === ui_table
+
+end
+
+# =========================================================================== #
+# === LibuiParadise.table
+# =========================================================================== #
+def self.table(i)
+  ::LibuiParadise::Extensions.table(i)
+end; self.instance_eval { alias ui_table table } # === LibuiParadise.ui_table
+
+end

data/lib/libui_paradise/libui_classes/text_layout.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/text_layout.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.text_layout
+  # ========================================================================= #
+  def self.text_layout(
+      i = ''
+    )
+    _ = UI.draw_new_text_layout(i.to_s)
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end
+
+  # ========================================================================= #
+  # === text_layout
+  # ========================================================================= #
+  def text_layout(
+      i = ''
+    )
+    ::LibuiParadise::Extensions.text_layout(i)
+  end
+
+end
+
+# =========================================================================== #
+# === LibuiParadise.text_layout
+# =========================================================================== #
+def self.text_layout(
+    i = ''
+  )
+  ::LibuiParadise::Extensions.text_layout(i)
+end
+
+end

data/lib/libui_paradise/libui_classes/vbox.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/libui_classes/vbox.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.vbox                            (vbox tag)
+  #
+  # This method will create a vertical box.
+  # ========================================================================= #
+  def self.vbox
+    _ = UI.new_vertical_box
+    add_to_the_registered_widgets(_, __method__)
+    return _
+  end; self.instance_eval { alias ui_vbox vbox } # === ui_vbox
+
+  # ========================================================================= #
+  # === vbox
+  # ========================================================================= #
+  def vbox
+    ::LibuiParadise::Extensions.vbox
+  end; alias ui_vbox vbox # === ui_vbox
+       alias gtk_box vbox # === gtk_box
+
+  # ========================================================================= #
+  # === ui_padded_vbox
+  #
+  # This method will call .is_padded on the vbox after it has been
+  # initialized.
+  # ========================================================================= #
+  def ui_padded_vbox
+    _ = ui_vbox
+    _.is_padded
+    return _
+  end; alias padded_vbox ui_padded_vbox # === padded_vbox
+
+end
+
+# =========================================================================== #
+# === LibuiParadise.vbox
+# =========================================================================== #
+def self.vbox
+  ::LibuiParadise::Extensions.vbox
+end
+
+end

data/lib/libui_paradise/libui_classes/window.rb

@@ -0,0 +1,167 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/ui_classes/window.rb
+# =========================================================================== #
+module LibuiParadise
+
+module Extensions # === LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === @main_window
+  #
+  # This variable can be used to keep track of the main window in use.
+  # ========================================================================= #
+  @main_window = nil
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.main_window?
+  # ========================================================================= #
+  def self.main_window?
+    @main_window
+  end
+
+  # ========================================================================= #
+  # === main_window?
+  # ========================================================================= #
+  def main_window?
+    ::LibuiParadise::Extensions.main_window?
+  end
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.set_main_window
+  # ========================================================================= #
+  def self.set_main_window(i)
+    @main_window = i
+  end
+
+  # ========================================================================= #
+  # === LibuiParadise::Extensions.window                         (window tag)
+  #
+  # This method will create a new main-window.
+  #
+  # It will also call UI.simple_exit(). This is done mostly so that we
+  # can omit that line whenever we use e. g. ui_main_window().
+  # ========================================================================= #
+  def self.window(
+      the_title   = '',  # Pick a title for the window here.
+      width       = 500, # width  in n pixels.
+      height      = 300, # height in n pixels.
+      has_menubar =   1, # hasMenubar or has not.
+      &block
+    )
+    raw_has_menubar = 0
+    if has_menubar.is_a? Numeric
+      raw_has_menubar = has_menubar
+    end
+    # ======================================================================= #
+    # Instantiate a new main-window next:
+    # ======================================================================= #
+    main_window = LibUI.new_window(
+      the_title,
+      width,
+      height,
+      raw_has_menubar
+    )
+    set_main_window(main_window) # Keep a reference stored here.
+    # ======================================================================= #
+    # Since as of 30.08.2021 we will also register the main-window.
+    #
+    # In the long run we may obsolete and deprecate @main_window, since
+    # it is no longer needed - but for now we will retain that variable.
+    # ======================================================================= #
+    add_to_the_registered_widgets(main_window, __method__)
+    if has_menubar and has_menubar.is_a?(Hash)
+      if has_menubar.has_key? :margin
+        if has_menubar[:margin] == true
+          main_window.has_margin
+        end
+      end
+    end
+    UI.simple_exit(main_window)
+    if block_given?
+      yield
+    end
+    return main_window # Always return it here.
+  end; self.instance_eval { alias main_window     window } # === LibuiParadise::Extensions.main_window
+       self.instance_eval { alias ui_main_window  window } # === LibuiParadise::Extensions.ui_main_window
+       self.instance_eval { alias margined_window window } # === LibuiParadise::Extensions.margined_window
+       self.instance_eval { alias ui_window       window } # === LibuiParadise::Extensions.ui_window
+
+  # ========================================================================= #
+  # === window
+  # ========================================================================= #
+  def window(
+      the_title   = '',  # Pick a title for the window here.
+      width       = 500, # width  in n pixels.
+      height      = 300, # height in n pixels.
+      has_menubar =   1  # hasMenubar or has not.
+    )
+    LibuiParadise::Extensions.window(
+      the_title, width, height, has_menubar
+    )
+  end; alias main_window window # === main_window
+
+  # ========================================================================= #
+  # === ui_margined_main_window
+  #
+  # This variant is like ui_main_window() but it will automatically
+  # put a margin on the window, via .is_margined().
+  #
+  # Note that the variant name "ui_padded_main_window" is a misnomer,
+  # since it is a margin rather than padding - but I found that it
+  # is easier to not care about this, so for the time being (September
+  # 2021) this is how it is. It may be subject to change in the future,
+  # though.
+  # ========================================================================= #
+  def ui_margined_main_window(
+      the_title   = '',  # Pick a title for the window here.
+      width       = 500, # width  in n pixels.
+      height      = 300, # height in n pixels.
+      has_menubar =   1  # hasMenubar or has not.
+    )
+    _ = LibuiParadise.window(the_title, width, height, has_menubar)
+    _.is_margined
+    return _
+  end; alias ui_margined_window    ui_margined_main_window # === ui_margined_window
+       alias ui_padded_main_window ui_margined_main_window # === ui_padded_main_window
+       alias margined_window       ui_margined_main_window # === margined_window
+       alias padded_window         ui_margined_main_window # === padded_window
+       alias padded_main_window    ui_margined_main_window # === padded_main_window
+       alias ui_main_window        ui_margined_main_window # === ui_main_window
+       alias ui_window             ui_margined_main_window # === ui_window
+
+end
+
+# =========================================================================== #
+# === LibuiParadise.window
+# =========================================================================== #
+def self.window(
+    the_title   = '',  # Pick a title for the window here.
+    width       = 500, # width  in n pixels.
+    height      = 300, # height in n pixels.
+    has_menubar =   1  # hasMenubar or has not.
+  )
+  ::LibuiParadise::Extensions.window(
+    the_title,
+    width,
+    height,
+    has_menubar
+  )
+end; self.instance_eval { alias main_window           window } # === LibuiParadise.main_window
+     self.instance_eval { alias margined_window       window } # === LibuiParadise.margined_window
+     self.instance_eval { alias ui_window             window } # === LibuiParadise.ui_window
+     self.instance_eval { alias ui_main_window        window } # === LibuiParadise.ui_main_window
+     self.instance_eval { alias ui_padded_main_window window } # === LibuiParadise.margined_window
+     self.instance_eval { alias padded_window         window } # === LibuiParadise.padded_window
+     self.instance_eval { alias padded_main_window    window } # === LibuiParadise.padded_main_window
+
+# =========================================================================== #
+# === LibuiParadise.main_window?
+# =========================================================================== #
+def self.main_window?
+  LibuiParadise::Extensions.main_window?
+end
+
+end

data/lib/libui_paradise/project/project.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/project/project.rb'
+# LibuiParadise.project_base_dir?
+# =========================================================================== #
+module LibuiParadise
+
+  # ========================================================================= #
+  # === PROJECT_BASE_DIRECTORY
+  # ========================================================================= #
+  PROJECT_BASE_DIRECTORY =
+    File.absolute_path("#{__dir__}/..")+'/'
+    BASE_DIR = PROJECT_BASE_DIRECTORY
+
+  # ========================================================================= #
+  # === LibuiParadise.project_base_dir?
+  # ========================================================================= #
+  def self.project_base_dir?
+    PROJECT_BASE_DIRECTORY
+  end; self.instance_eval { alias project_base_dir        project_base_dir? } # === LibuiParadise.project_base_dir
+       self.instance_eval { alias project_base_dir?       project_base_dir? } # === LibuiParadise.project_base_dir?
+       self.instance_eval { alias project_base_directory? project_base_dir? } # === LibuiParadise.project_base_directory?
+
+end

data/lib/libui_paradise/prototype/README.md

@@ -0,0 +1,3 @@
+The .rb file in this directory can be used to quickly copy/paste a
+working skeleton that can be adjusted and modifed for quick GUI
+prototyping via libui.