gtk_paradise 0.9.120 → 0.11.19

data/lib/gtk_paradise/base_module/pango.rb

@@ -1,24 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'gtk_paradise/base_module/pango.rb'
-# =========================================================================== #
-module Gtk
-
-module BaseModule
-
-  require 'gtk_paradise/constants/fonts.rb'
-
-  # ========================================================================= #
-  # === pango_font_description
-  #
-  # This is simply a wrapper over Pango::FontDescription.
-  # ========================================================================= #
-  def pango_font_description(
-      i = USE_THIS_FONT
-    )
-    Pango::FontDescription.new(i)
-  end; alias font_description pango_font_description # === font_description
-
-end; end

data/lib/gtk_paradise/base_module/popover.rb

@@ -1,241 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'gtk_paradise/base_module/popover.rb'
-# =========================================================================== #
-module Gtk
-
-module BaseModule
-
-  require 'gtk_paradise/fonts/fonts.rb'
-
-  # ========================================================================= #
-  # === popup_over_this_widget
-  #
-  # The third argument is the container-widget. That way you can build
-  # up your own custom widgets quickly.
-  #
-  # Usage examples:
-  #
-  #   popup_over_this_widget(main_entry?, 'Please assign a file to work with first.')
-  #   popup_over_this_widget(main_entry?, 'Please assign a file to work with first.', container_widget)
-  #   popover_on(this_widget: @search_entry, use_this_message: 'ABC <b>'+_+'</b>.')
-  #   pop_up_widget(over_this_widget: @entry_consensus_sequence, text: 'abc def')
-  #   pop_up_widget(over_this_widget: @entry_consensus_sequence, text: 'abc def', custom_widget: hbox)
-  #
-  # ========================================================================= #
-  def popup_over_this_widget(
-      this_widget,
-      text                      = '',
-      use_this_container_widget = nil
-    )
-    # ======================================================================== #
-    # === Handle Hashes first
-    # ======================================================================== #
-    if this_widget.is_a? Hash
-      # ====================================================================== #
-      # === :custom_widget
-      # ====================================================================== #
-      if this_widget.has_key? :custom_widget
-        use_this_container_widget = this_widget.delete(:custom_widget)
-      end
-      # ====================================================================== #
-      # === :use_this_message
-      #
-      # Only check for a few things in this case.
-      # ====================================================================== #
-      if this_widget.has_key? :use_this_message
-        text = this_widget.delete(:use_this_message)
-      # ====================================================================== #
-      # === :text
-      # ====================================================================== #
-      elsif this_widget.has_key? :text
-        text = this_widget.delete(:text)
-      end
-      # ====================================================================== #
-      # === :this_widget
-      # ====================================================================== #
-      if this_widget.has_key? :this_widget
-        this_widget = this_widget.delete(:this_widget)
-      # ====================================================================== #
-      # === :over_this_widget
-      # ====================================================================== #
-      elsif this_widget.has_key? :over_this_widget
-        this_widget = this_widget.delete(:over_this_widget)
-      end
-    end
-    return_popover(
-      text,
-      this_widget,
-      :default_padding, # This is the default padding to use.
-      use_this_container_widget
-    ).popup
-  end; alias popover_on    popup_over_this_widget # === popover_on
-       alias pop_up_widget popup_over_this_widget # === pop_up_widget
-
-  # ========================================================================= #
-  # === popup_this_text_over_that_widget
-  #
-  # Usage example:
-  #
-  #   pop_up_this_text_over_that_widget('Backup complete!', @button_backup_audio)
-  #
-  # ========================================================================= #
-  def popup_this_text_over_that_widget(
-      text, widget
-    )
-    do_popup(
-      {
-        message:          text,
-        over_this_widget: widget
-      } 
-    )
-  end; alias pop_up_this_text_over_that_widget popup_this_text_over_that_widget # === pop_up_this_text_over_that_widget
-
-  # ========================================================================= #
-  # === return_popover
-  #
-  # The second argument of this method is the widget to which the
-  # popover should appear.
-  #
-  # Do not forget to invoke .popup() to show the widget.
-  #
-  # Usage example:
-  #
-  #   return_popover('The exam topic can be set to the right side, or below this text.')
-  #   return_popover('Use this title.', use_this_widget, padding_value_to_use_20)
-  #   return_popover('The exam topic can be set to the right side, or below this text.', @entry, 20)
-  #   return_popover('The exam topic can be set to the right side, or below this text.', @entry, 20).popup
-  #
-  # ========================================================================= #
-  def return_popover(
-      title_to_use              = '',          # (1) Title (or widget) to use
-      this_widget               = @main_image, # (2) The widget relative to the popover widget
-      padding_to_use            = 15,          # (3) How much to pad
-      use_this_container_widget = nil          # (4) The container widget to use
-    )
-    case padding_to_use
-    # ======================================================================= #
-    # === :default
-    # ======================================================================= #
-    when :default,
-         :default_padding,
-         :default_padding_to_use
-      padding_to_use = 15
-    end
-    # ======================================================================= #
-    # Create the popover next.
-    # ======================================================================= #
-    @popover = gtk_popover
-    # ======================================================================= #
-    # === Handle Hashes next
-    # ======================================================================= #
-    if this_widget.is_a? Hash
-      # ===================================================================== #
-      # === :font_to_use
-      # ===================================================================== #
-      if this_widget.has_key? :font_to_use
-        _ = this_widget[:font_to_use]
-        if _.is_a? Symbol
-          _ = ::Gtk.expand_this_font(_)
-        end
-        @popover.override_font(Pango::FontDescription.new(_))
-      end
-      # ===================================================================== #
-      # === :use_this_widget
-      #
-      # This should come last in this if-clause.
-      # ===================================================================== #
-      if this_widget.has_key? :use_this_widget
-        this_widget = this_widget[:use_this_widget]
-      end
-    end
-    use_this_label = title_to_use
-    if use_this_label.is_a? String
-      use_this_label = gtk_label(title_to_use)
-      use_this_label.do_markify
-    end
-    # ======================================================================= #
-    # Determine which container-widget to use next.
-    # ======================================================================= #
-    if use_this_container_widget
-      smaller_vbox = gtk_vbox
-      smaller_vbox.minimal(use_this_label) # Always use a label nonetheless.
-      smaller_vbox.maximal(use_this_container_widget)
-      @popover.add(smaller_vbox)
-    else
-      vbox = gtk_vbox
-      vbox.pack_start(
-        use_this_label,
-        fill: false,
-        expand: true, padding: padding_to_use
-      )
-      @popover.add(vbox)
-    end
-    @popover.set_position(:bottom)
-    @popover.set_relative_to(this_widget)
-    @popover.show_all
-    # @popover.popup # ← Use this in your application, if you want the popover to show.
-    return @popover
-  end; alias popover_message return_popover # === popover_message
-       alias popover_message return_popover # === popover_message
-       alias popover         return_popover # === popover
-
-  # ========================================================================= #
-  # === gtk_popover
-  #
-  # Usage example:
-  #
-  #   gtk_popover(self)
-  #
-  # ========================================================================= #
-  def gtk_popover(
-      this_widget = nil
-    )
-    if ::Gtk.const_defined? :Popover # This check is for ruby-gtk3.
-      return ::Gtk::Popover.new(this_widget)
-    end
-  end
-
-  # ========================================================================= #
-  # === do_popup
-  #
-  # This variant expects a Hash as input.
-  #
-  # Typical usage example would go like this:
-  #
-  #   do_popup(
-  #     message:          _+' is now in use.',
-  #     over_this_widget: @entry_multimedia_player_in_use
-  #   )
-  #
-  # ========================================================================= #
-  def do_popup(
-      i = {}
-    )
-    title_to_use   = ''
-    this_widget    = nil
-    padding_to_use = 15
-    if i.is_a? Hash
-      # ===================================================================== #
-      # === :message
-      # ===================================================================== #
-      if i.has_key? :message
-        title_to_use = i[:message]
-      end
-      # ===================================================================== #
-      # === :over_this_widget
-      # ===================================================================== #
-      if i.has_key? :over_this_widget
-        this_widget = i[:over_this_widget]
-      end
-    end
-    return_popover(
-      title_to_use,
-      this_widget,
-      padding_to_use
-    ).popup
-  end
-
-end; end

data/lib/gtk_paradise/base_module/register_sigint.rb

@@ -1,20 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'gtk_paradise/base_module/register_sigint.rb'
-# =========================================================================== #
-module Gtk
-
-module BaseModule
-
-  require 'gtk_paradise/toplevel_methods/register_sigint.rb'
-
-  # ========================================================================= #
-  # === register_sigint
-  # ========================================================================= #
-  def register_sigint
-    ::Gtk.register_sigint
-  end
-
-end; end

data/lib/gtk_paradise/base_module/reset.rb

@@ -1,128 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'gtk_paradise/base_module/reset.rb'
-# =========================================================================== #
-module Gtk
-
-module BaseModule
-
-  # ========================================================================= #
-  # === reset                                                     (reset tag)
-  #
-  # This method will have to initialize a very important instance variables.
-  #
-  # It was disabled as of January 2021. I initially thought I may bring
-  # this method back, but it may be better to not use it - we'll see
-  # at a later time.
-  # ========================================================================= #
-  # def reset
-  #   reset_the_internal_variables
-  # end
-
-  # ========================================================================= #
-  # === reset_the_internal_variables
-  # ========================================================================= #
-  def reset_the_internal_variables(
-      i = nil
-    )
-    # ======================================================================= #
-    # === @configuration
-    #
-    # This variable keeps track of any "meta-data" associated with any
-    # class that includes this module. In the past this variable was
-    # called @config_file, but @configuration as name is, in my opinion,
-    # more appropriate.
-    #
-    # By default @configuration will be set to nil, so it is up to
-    # the responsibility of the subclass-implementation to initialize
-    # this variable properly, via their own reset() method usually.
-    #
-    # A typical value for @configuration may look like this:
-    #
-    #   @configuration = [true, __dir__, NAMESPACE]
-    #
-    # - The first entry determines whether the class will make use of a
-    #   config file.
-    #
-    # - The second entry gives us information about the base directory
-    #   of the application at hand.
-    #
-    # - The last entry will yield the Namespace, such as Foo::Bar.
-    #
-    # ======================================================================= #
-    unless i == :do_not_reset_the_configuration_variable
-      @configuration = nil
-    end
-    # ======================================================================= #
-    # === @title
-    # ======================================================================= #
-    @title  = nil
-    # ======================================================================= #
-    # === @height
-    # ======================================================================= #
-    @height = nil
-    # ======================================================================= #
-    # === @width
-    # ======================================================================= #
-    @width  = nil
-    # ======================================================================= #
-    # === @internal_hash
-    #
-    # This is the Hash that can be used to keep track of internal-states,
-    # such as all buttons and so forth..
-    # ======================================================================= #
-    @internal_hash = {}
-    # ======================================================================= #
-    # === @internal_hash[:css_rules_to_apply]
-    #
-    # This must be a String. It will contain all CSS rules that will
-    # apply for the target gtk-widget at hand.
-    #
-    # Note that before August 2021 this was stored in @css_string, but
-    # it was lateron renamed and moved into @internal_hash instead.
-    # ======================================================================= #
-    @internal_hash[:css_rules_to_apply] = ''.dup
-    # ======================================================================= #
-    # === @internal_hash[:buttons]
-    # ======================================================================= #
-    @internal_hash[:buttons] = []
-    # ======================================================================= #
-    # === @internal_hash[:check_buttons]
-    # ======================================================================= #
-    @internal_hash[:check_buttons] = []
-    # ======================================================================= #
-    # === @internal_hash[:toggle_buttons]
-    # ======================================================================= #
-    @internal_hash[:toggle_buttons] = []
-    # ======================================================================= #
-    # === @internal_hash[:entries]
-    # ======================================================================= #
-    @internal_hash[:entries] = []
-    # ======================================================================= #
-    # === @internal_hash[:label]
-    # ======================================================================= #
-    @internal_hash[:label] = []
-    # ======================================================================= #
-    # === @internal_hash[:debug]
-    # ======================================================================= #
-    @internal_hash[:debug] = false
-    # ======================================================================= #
-    # The next method-call may have to be re-evaluated in the
-    # future (Feb 2021).
-    # ======================================================================= #
-    # check_for_a_manifest_yaml_file
-  end
-
-  # ========================================================================= #
-  # === use_a_popular_reset_variant
-  #
-  # This method can be used to quickly "bootstrap" from scratch,
-  # without having to rely on reset().
-  # ========================================================================= #
-  def use_a_popular_reset_variant
-    reset_the_internal_variables
-  end
-
-end; end

data/lib/gtk_paradise/base_module/return_corresponding_gtk_stock_item.rb

@@ -1,92 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'gtk_paradise/base_module/return_corresponding_gtk_stock_item.rb'
-# return_corresponding_gtk_stock_item
-# =========================================================================== #
-module Gtk
-
-module BaseModule
-
-  # ========================================================================= #
-  # === return_corresponding_gtk_stock_item
-  #
-  # This method will replace a Symbol such as :quit with the corresponding
-  # Gtk::Stock item. Make sure that the input is registered in the
-  # table here.
-  # ========================================================================= #
-  def return_corresponding_gtk_stock_item(
-      i = :default
-    )
-    case i # case tag
-    # ======================================================================= #
-    # === :open_local_file
-    # ======================================================================= #
-    when :open_local_file
-      i = image_document_open
-    # ======================================================================= #
-    # === :weather_icon
-    #
-    # This is not a gtk-stock item, but we will retain it here for the
-    # time being anyway. At a later time it may be relocated, though.
-    # (The above was written at 05.12.2020).
-    # ======================================================================= #
-    when :weather_icon
-      i = "#{PROJECT_BASE_DIRECTORY}images/misc/weather.png"
-    # ======================================================================= #
-    # === :open
-    # ======================================================================= #
-    when :open,
-         :stock_open
-      i = ::Gtk::Stock::OPEN
-    # ======================================================================= #
-    # === :quit
-    # ======================================================================= #
-    when :quit,
-         :default
-      i = ::Gtk::Stock::QUIT 
-    # ======================================================================= #
-    # === :save
-    # ======================================================================= #
-    when :save
-      i = ::Gtk::Stock::SAVE
-    # ======================================================================= #
-    # === :delete
-    # ======================================================================= #
-    when :delete
-      i = ::Gtk::Stock::DELETE
-    # ======================================================================= #
-    # === :close
-    #
-    # This is the "close-button".
-    # ======================================================================= #
-    when :close
-      i = ::Gtk::Stock::CLOSE
-    # ======================================================================= #
-    # === :find
-    # ======================================================================= #
-    when :find
-      i = ::Gtk::Stock::FIND
-    # ======================================================================= #
-    # === :edit
-    # ======================================================================= #
-    when :edit
-      i = ::Gtk::Stock::EDIT
-    # ======================================================================= #
-    # === :print_preview
-    # ======================================================================= #
-    when :print_preview,
-         :print
-      i = ::Gtk::Stock::PRINT_PREVIEW
-    # ======================================================================= #
-    # === :refresh
-    # ======================================================================= #
-    when :refresh,
-         :update
-      i = ::Gtk::Stock::REFRESH
-    end
-    return i
-  end
-
-end; end

data/lib/gtk_paradise/base_module/roebe.rb

@@ -1,19 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'gtk_paradise/base_module/roebe.rb'
-# =========================================================================== #
-module Gtk
-
-module BaseModule
-
-  require 'gtk_paradise/toplevel_methods/roebe.rb'
-  # ========================================================================= #
-  # === is_on_roebe?
-  # ========================================================================= #
-  def is_on_roebe?
-    ::Gtk.is_on_roebe?
-  end
-
-end; end