bioroebe 0.12.24 → 0.13.31

data/lib/bioroebe/gui/{gtk3/show_codon_table/misc.rb → universal_widgets/show_codon_table/show_codon_table.rb}

@@ -2,42 +2,118 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-# require 'bioroebe/gui/gtk3/show_codon_table/misc.rb'
+# === Bioroebe::GUI::UniversalWidgets::ShowCodonTable
+#
+# Usage example:
+#
+#   Bioroebe::GUI::UniversalWidgets::ShowCodonTable.new(ARGV)
+#
 # =========================================================================== #
-require 'gtk_paradise/require_gtk3'
+# require 'bioroebe/gui/universal_widgets/nucleotide_analyser/nucleotide_analyser.rb'
+# =========================================================================== #
+require 'universal_widgets/base/base.rb'
 
 module Bioroebe
 
 module GUI
 
-module Gtk
+module UniversalWidgets
+
+class ShowCodonTable < ::UniversalWidgets::Base # === Bioroebe::GUI::UniversalWidgets::ShowCodonTable
+
+  require 'bioroebe/base/commandline_application/commandline_arguments.rb'
+  include ::Bioroebe::CommandlineArguments
+
+  require 'bioroebe/constants/GUIs.rb'
+  include Bioroebe::GUI
+
+  require 'bioroebe/codons/codon_tables.rb'
+  require 'bioroebe/toplevel_methods/toplevel_methods.rb'
+
+  # ========================================================================= #
+  # === TITLE
+  #
+  # Specify which title to use for this widget.
+  # ========================================================================= #
+  TITLE = 'Show Codon Table'
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = '75% or 2000px minimum'
 
-class ShowCodonTable < ::Gtk::BaseModuleBox # === Bioroebe::GUI::Gtk::ShowCodonTable
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = '55% or 500px minimum'
 
-  require 'bioroebe/gui/shared_code/show_codon_table/show_codon_table_module.rb'
-  include Bioroebe::GUI::ShowCodonTableModule
+  # ========================================================================= #
+  # === FONT_LARGE
+  # ========================================================================= #
+  FONT_LARGE = 'Calibri 32'
 
   # ========================================================================= #
-  # === USE_THIS_FONT
+  # === MONOSPACED_FONT
   #
-  # We need a mono-spaced font here; Source Code Pro seems fine.
+  # When this font is changed, don't forget to also change the font
+  # at SMALLER_FONT.
+  # ========================================================================= #
+  MONOSPACED_FONT = :hack_20
+    USE_THIS_FONT = MONOSPACED_FONT
+    USE_THIS_MONOFONT = MONOSPACED_FONT
+
+  # ========================================================================= #
+  # === SMALLER_FONT
+  # ========================================================================= #
+  SMALLER_FONT = :hack_16
+
+  # ========================================================================= #
+  # === USE_THIS_SLIGHTLY_SMALLER_FONT
+  # ========================================================================= #
+  USE_THIS_SLIGHTLY_SMALLER_FONT = :hack_16
+
+  # ========================================================================= #
+  # === HEADER_TO_USE_FOR_THE_TREE_VIEW
+  # ========================================================================= #
+  HEADER_TO_USE_FOR_THE_TREE_VIEW = [
+    'Local Path',
+    'File size',
+    'n nucleotides',
+    '%GC'
+  ]
+
+  # ========================================================================= #
+  # === initialize
   # ========================================================================= #
-  USE_THIS_FONT = :hack_18 # :source_code_pro_18
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    determine_the_GUI_to_be_used(commandline_arguments)
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
 
   # ========================================================================= #
   # === reset                                                     (reset tag)
   # ========================================================================= #
   def reset
+    super() if respond_to?(:super)
     reset_the_internal_variables
-    reset_the_shared_module
+    reset_the_base_module # This must come after reset_the_internal_variables().
     infer_the_namespace
     # ======================================================================= #
     # === @configuration
     # ======================================================================= #
     @configuration = [true, __dir__, namespace?]
-    set_use_this_font(USE_THIS_FONT)
-    handle_CSS
-    infer_the_size_automatically
+    # ======================================================================= #
+    # === Set the title, width, height and the font in use.
+    # ======================================================================= #
+    title_width_height_font(TITLE, WIDTH, HEIGHT, USE_THIS_FONT)
+    handle_CSS if use_gtk3?
     # ======================================================================= #
     # === @main_hash
     #
@@ -229,6 +305,13 @@ class ShowCodonTable < ::Gtk::BaseModuleBox # === Bioroebe::GUI::Gtk::ShowCodonT
     @table.attach_defaults(bold_G(), 5,6, 16, 17)
   end
 
+  # ========================================================================= #
+  # === active_text?
+  # ========================================================================= #
+  def active_text?
+    @combo_box_containing_the_registered_codon_tables.selected?.to_s
+  end; alias selected? active_text? # === selected?
+
   # ========================================================================= #
   # === A
   # ========================================================================= #
@@ -310,21 +393,10 @@ class ShowCodonTable < ::Gtk::BaseModuleBox # === Bioroebe::GUI::Gtk::ShowCodonT
   end
 
   # ========================================================================= #
-  # === uniform_length
-  # ========================================================================= #
-  def uniform_length(i)
-    i = i.dup
-    if i.size > 45
-      i[45 ..-1] = '[...]'
-    end
-    return i
-  end
-
-  # ========================================================================= #
-  # === return_all_codon_tables
+  # === padding?
   # ========================================================================= #
-  def return_all_codon_tables
-    ::Bioroebe.codon_tables
+  def padding?
+    2
   end
 
   # ========================================================================= #
@@ -334,63 +406,13 @@ class ShowCodonTable < ::Gtk::BaseModuleBox # === Bioroebe::GUI::Gtk::ShowCodonT
     2
   end
 
-  # ========================================================================= #
-  # === change_label
-  # ========================================================================= #
-  def change_label(i)
-    case i.label.to_s
-    when 'A'
-      i.set_text('C')
-    when 'C'
-      i.set_text('T')
-    when 'T'
-      i.set_text('G')
-    when 'G'
-      i.set_text('A')
-    end
-    i.make_bold
-    determine_the_codon_for_the_last_button
-  end
-
-  # ========================================================================= #
-  # === determine_the_codon_for_the_last_button
-  # ========================================================================= #
-  def determine_the_codon_for_the_last_button
-    first  = @button1.text?.to_s
-    second = @button2.text?.to_s
-    third  = @button3.text?.to_s
-    codon = first+second+third
-    if @main_hash.has_key? codon
-      @button4.set_text(@main_hash[codon])
-      @button4.make_bold
-    end
-  end
-
-  # ========================================================================= #
-  # === create_the_scrolled_window_then_add_the_table_into_it
-  # ========================================================================= #
-  def create_the_scrolled_window_then_add_the_table_into_it
-    # ======================================================================= #
-    # === @scrolled_window
-    # ======================================================================= #
-    @scrolled_window = gtk_scrolled_window(@table) { :automatic }
-    @scrolled_window.bblack1
-    @scrolled_window.pad6px
-    @scrolled_window.set_size_request(240, 780)
-    @scrolled_window.use_this_font = smaller_font?
-  end
-
   # ========================================================================= #
   # === create_the_combo_box_containing_the_available_codon_tables
   #
   # This method will create the main combo-box.
   # ========================================================================= #
   def create_the_combo_box_containing_the_available_codon_tables
-    if use_gtk2?
-      @combo_box_containing_the_registered_codon_tables = gtk_combo_box
-    else
-      @combo_box_containing_the_registered_codon_tables = gtk_combo_box_text
-    end
+    @combo_box_containing_the_registered_codon_tables = combo_box_text
     @combo_box_containing_the_registered_codon_tables.bblack1
     @combo_box_containing_the_registered_codon_tables.pad4px
     do_populate_the_combo_box
@@ -450,7 +472,7 @@ class ShowCodonTable < ::Gtk::BaseModuleBox # === Bioroebe::GUI::Gtk::ShowCodonT
   # === create_the_main_table                                     (table tag)
   # ========================================================================= #
   def create_the_main_table
-    @table = gtk_table(8, 20, true)
+    @table = create_table(8, 20, true)
     @table.set_name('table_bblack1')
     @table.set_column_spacings(5) # And a decent column spacing as well.
     @table.set_row_spacings(1)    # Also use a decent row-spacing.
@@ -465,10 +487,91 @@ class ShowCodonTable < ::Gtk::BaseModuleBox # === Bioroebe::GUI::Gtk::ShowCodonT
   end
 
   # ========================================================================= #
-  # === smaller_font?
+  # === change_label
   # ========================================================================= #
-  def smaller_font?
-    :hack_16
+  def change_label(i)
+    case i.label.to_s
+    when 'A'
+      i.set_text('C')
+    when 'C'
+      i.set_text('T')
+    when 'T'
+      i.set_text('G')
+    when 'G'
+      i.set_text('A')
+    end
+    i.make_bold
+    determine_the_codon_for_the_last_button
+  end
+
+  # ========================================================================= #
+  # === determine_the_codon_for_the_last_button
+  # ========================================================================= #
+  def determine_the_codon_for_the_last_button
+    first  = @button1.text?.to_s
+    second = @button2.text?.to_s
+    third  = @button3.text?.to_s
+    codon = first+second+third
+    if @main_hash.has_key? codon
+      @button4.set_text(@main_hash[codon])
+      @button4.make_bold
+    end
+  end
+
+  # ========================================================================= #
+  # === create_the_scrolled_window_then_add_the_table_into_it
+  # ========================================================================= #
+  def create_the_scrolled_window_then_add_the_table_into_it
+    # ======================================================================= #
+    # === @scrolled_window
+    # ======================================================================= #
+    @scrolled_window = create_scrolled_window(@table) { :automatic }
+    @scrolled_window.bblack1
+    @scrolled_window.pad6px
+    @scrolled_window.set_size_request(240, 780)
+    @scrolled_window.use_this_font = smaller_font?
+  end
+
+  # ========================================================================= #
+  # === uniform_length
+  # ========================================================================= #
+  def uniform_length(i)
+    i = i.dup
+    if i.size > 45
+      i[45 ..-1] = '[...]'
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === return_all_codon_tables
+  # ========================================================================= #
+  def return_all_codon_tables
+    ::Bioroebe.codon_tables
+  end
+
+  # ========================================================================= #
+  # === main_font?
+  # ========================================================================= #
+  def main_font?
+    USE_THIS_FONT
+  end
+
+  # ========================================================================= #
+  # === slightly_smaller_font?
+  # ========================================================================= #
+  def slightly_smaller_font?
+    USE_THIS_SLIGHTLY_SMALLER_FONT
+  end
+
+  # ========================================================================= #
+  # === create_the_top_vbox
+  # ========================================================================= #
+  def create_the_top_vbox
+    @top_vbox = create_vbox
+    @top_vbox.add(horizontal_spacer)
+    @top_vbox.add(@title_bar)
+    @top_vbox.add(horizontal_spacer)
   end
 
   # ========================================================================= #
@@ -513,23 +616,6 @@ class ShowCodonTable < ::Gtk::BaseModuleBox # === Bioroebe::GUI::Gtk::ShowCodonT
     }
   end; alias sync_the_dataset_onto_the_main_table sync_this_dataset_onto_the_main_table # === sync_the_dataset_onto_the_main_table
 
-  # ========================================================================= #
-  # === handle_CSS
-  # ========================================================================= #
-  def handle_CSS
-    use_gtk_paradise_project_css_file
-    use_project_css_file
-    more_CSS '
-tooltip {
-  padding:      25px;
-  border-width: 3px;
-  border-style: dotted;
-  border-color: orange;
-}
-'
-    apply_the_CSS
-  end
-
   # ========================================================================= #
   # === clear_the_main_hash_before_syncing_the_dataset_onto_the_main_table
   # ========================================================================= #
@@ -550,13 +636,14 @@ tooltip {
     # ======================================================================= #
     # === @label_and_combo_box
     # ======================================================================= #
-    @label_and_combo_box = gtk_vbox
+    @label_and_combo_box = create_vbox
     @label_and_combo_box.minimal(
       left_aligned_label(
         ' Select the codon table (default: <b>eukaryotes</b>)'
       ), 8
     )
-    hbox = gtk_hbox
+    @label_and_combo_box.make_selectable
+    hbox = create_hbox
     hbox.minimal(@combo_box_containing_the_registered_codon_tables, 2)
     @label_and_combo_box.minimal(
       hbox, 2
@@ -571,7 +658,7 @@ tooltip {
   def return_widget_containing_the_toggle_buttons
     hbox = create_hbox
     hbox.pad8px
-    @button1 = create_bold_button('T')
+    @button1 = bold_button('T')
     @button1.foreground_colour = :royalblue
     @button1.bblack1
     @button1.on_clicked {
@@ -614,18 +701,111 @@ tooltip {
     return hbox
   end
 
+  # ========================================================================= #
+  # === handle_CSS_rules                                   (CSS tag, css tag)
+  # ========================================================================= #
+  def handle_CSS_rules
+    use_gtk_paradise_project_css_file
+    append_project_css_file
+    add_these_custom_CSS_rules '
+tooltip {
+  padding:      25px;
+  border-width: 3px;
+  border-style: dotted;
+  border-color: orange;
+}
+'
+    apply_the_CSS_rules
+  end; alias handle_CSS handle_CSS_rules # === handle_CSS
+
+  # ========================================================================= #
+  # === create_the_skeleton                        (create tag, skeleton tag)
+  # ========================================================================= #
+  def create_the_skeleton
+    create_the_title_bar
+    create_the_combo_box_containing_the_available_codon_tables
+    create_the_box_containing_the_label_and_the_combobox
+    create_the_top_vbox # Must come after create_the_title_bar().
+    create_the_main_table
+    attach_all_proper_values_to_the_main_table
+    create_the_scrolled_window_then_add_the_table_into_it
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    run_super
+  end
+
+  # ========================================================================= #
+  # === smaller_font?
+  # ========================================================================= #
+  def smaller_font?
+    SMALLER_FONT
+  end
+
+  # ========================================================================= #
+  # === connect_the_skeleton                      (connect tag, skeleton tag)
+  # ========================================================================= #
+  def connect_the_skeleton
+    abort_on_exception
+
+    # ======================================================================= #
+    # The left vbox will contain the scrolled-window.
+    # ======================================================================= #
+    left_vbox = create_vbox
+    left_vbox.minimal(@scrolled_window)
+    right_vbox = create_vbox
+    right_vbox.minimal(@label_and_combo_box,                         2)
+    right_vbox.minimal(gtk_horizontal_spacer,                        2)
+    right_vbox.minimal(return_widget_containing_the_toggle_buttons, 12)
+    _ = drag_it_left_to_right(left_vbox, right_vbox)
+    _.position = width? / 4.5
+    main_box = can_be_dragged_up_and_down(
+      top_box?,
+      _
+    )
+
+    window = runner_widget(nil, width?, height?, title?)
+    window << main_box
+
+    ::UniversalWidgets.set_main_window(window)
+    upon_delete_event_quit_the_application
+    clear_the_main_hash_before_syncing_the_dataset_onto_the_main_table
+    window.use_this_font = font?
+    window.show_all
+    window.set_padding(padding?)
+    window.set_border_size(border_size?)
+    window.set_size_request(width?, height?)
+    window.set_default_size(width?, height?)
+    window.top_left
+    run_main
+  end
+
+  # ========================================================================= #
+  # === Bioroebe::GUI::UniversalWidgets::ShowCodonTable[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
   # ========================================================================= #
   # === Bioroebe::GUI::Gtk::ShowCodonTable.run
   # ========================================================================= #
   def self.run(
       i = ARGV
     )
-    require 'gtk_paradise/run'
-    _ = ::Bioroebe::GUI::Gtk::ShowCodonTable.new(i)
-    r = ::Gtk.run
-    r << _
-    r.automatic_top_left_then_run
-    r.easy_exit
-  end
+    r = ::Gtk.runner_factory(
+      ::Bioroebe::GUI::Gtk::ShowCodonTable.new(i)
+    )
+    r.background_colour(:white)
+    return r
+  end; self.instance_eval { alias run_gtk3_widget       run } # === Bioroebe::GUI::Gtk::ShowCodonTable.run_gtk3_widget
+       self.instance_eval { alias start_gui_application run } # === Bioroebe::GUI::Gtk::ShowCodonTable.start_gui_application
+
+end; end; end; end
 
-end; end; end; end
+if __FILE__ == $PROGRAM_NAME
+  Bioroebe::GUI::UniversalWidgets::ShowCodonTable.new(ARGV)
+end # gtkshowcodontable