bioroebe 0.12.24 → 0.13.31

data/lib/bioroebe/gui/{shared_code/dna_to_reverse_complement_widget/dna_to_reverse_complement_widget_module.rb → universal_widgets/dna_to_reverse_complement_widget/dna_to_reverse_complement_widget.rb}

@@ -2,63 +2,218 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-# === Bioroebe::GUI::DnaToReverseComplementWidgetModule
+# === Bioroebe::GUI::UniversalWidgets::DnaToReverseComplementWidget
+#
+# Usage example:
+#
+#   Bioroebe::GUI::UniversalWidgets::DnaToReverseComplementWidget.new(ARGV)
+#
 # =========================================================================== #
-# require 'bioroebe/gui/shared_code/dna_to_reverse_complement_widget/dna_to_reverse_complement_widget_module.rb'
-# include Bioroebe::GUI::DnaToReverseComplementWidgetModule
+# require 'bioroebe/gui/universal_widgets/hamming_distance/hamming_distance.rb'
 # =========================================================================== #
+require 'universal_widgets/base/base.rb'
+
 module Bioroebe
 
 module GUI
 
-module DnaToReverseComplementWidgetModule # === Bioroebe::GUI::DnaToReverseComplementWidgetModule
+module UniversalWidgets
 
-  require 'bioroebe/requires/require_sequence.rb'
-  require 'bioroebe/sequence/dna.rb'
-  require 'bioroebe/toplevel_methods/complement.rb'
+class DnaToReverseComplementWidget < ::UniversalWidgets::Base # === Bioroebe::GUI::UniversalWidgets::DnaToReverseComplementWidget
+
+  require 'bioroebe/base/commandline_application/commandline_arguments.rb'
+  include ::Bioroebe::CommandlineArguments
 
   require 'bioroebe/constants/GUIs.rb'
   include Bioroebe::GUI
 
+  require 'bioroebe/toplevel_methods/toplevel_methods.rb'
+  require 'bioroebe/requires/require_sequence.rb'
+  require 'bioroebe/sequence/dna.rb'
+
   # ========================================================================= #
   # === TITLE
+  #
+  # Specify which title to use for this small widget.
   # ========================================================================= #
   TITLE = 'DNA to Reverse Complement'
 
   # ========================================================================= #
   # === WIDTH
   # ========================================================================= #
-  WIDTH  = '70%'
+  WIDTH = '65% or 500px minimum'
 
   # ========================================================================= #
   # === HEIGHT
   # ========================================================================= #
-  HEIGHT = '20% or minimum 200px'
+  HEIGHT = '55% or 300px minimum'
 
   # ========================================================================= #
-  # === USE_THIS_FONT
+  # === MONOSPACED_FONT
+  #
+  # 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
+
+  # ========================================================================= #
+  # === SMALLER_FONT
   # ========================================================================= #
-  USE_THIS_FONT = :dejavu_condensed_22
+  SMALLER_FONT = :hack_16
 
   # ========================================================================= #
-  # === reset_shared_module
+  # === USE_THIS_SLIGHTLY_SMALLER_FONT
   # ========================================================================= #
-  def reset_shared_module
-    title_width_height(TITLE, WIDTH, HEIGHT)
+  USE_THIS_SLIGHTLY_SMALLER_FONT = :hack_16
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  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
 
   # ========================================================================= #
-  # === padding?
+  # === reset                                                     (reset tag)
   # ========================================================================= #
-  def padding?
-    2
+  def reset
+    super() if respond_to?(:super)
+    reset_the_internal_variables
+    reset_the_base_module # This must come after reset_the_internal_variables().
+    infer_the_namespace
+    # ======================================================================= #
+    # === @configuration
+    # ======================================================================= #
+    @configuration = [true, __dir__, namespace?]
+    # ======================================================================= #
+    # === 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?
   end
 
   # ========================================================================= #
-  # === border_size?
+  # === do_sync_the_fields
+  #
+  # This method will sync between the two main widgets - the DNA input
+  # field on the left, and the reverse complement on the right side.
   # ========================================================================= #
-  def border_size?
-    0
+  def do_sync_the_fields
+    consider_sanitizing_the_left_input_field_for_dna
+    _ = @left_input_field_dna.text?
+    if ::Bioroebe.const_defined? :Controller
+      # ===================================================================== #
+      # Ok, in this case we can store the dataset via a class-method.
+      # ===================================================================== #
+      ::Bioroebe::GUI::Controller.set_dna_sequence(_)
+    end
+    # ======================================================================= #
+    # Next, we must translate from DNA to the reverse complement sequence.
+    # ======================================================================= #
+    _ = ::Bioroebe.complement(_)
+    set_reverse_complement(_.reverse)
+    n_nucleotides = _.size
+    @label_n_nucleotides.set_text(
+      'This DNA sequence contains <b>'+n_nucleotides.to_s+'</b> nucleotides.'
+    )
+    @label_n_nucleotides.do_markify
+  end
+
+  # ========================================================================= #
+  # === return_dna_sequence_label
+  # ========================================================================= #
+  def return_dna_sequence_label
+    bold_label('DNA sequence')
+  end
+
+  # ========================================================================= #
+  # === let_the_left_entry_react_to_enter_events
+  # ========================================================================= #
+  def let_the_left_entry_react_to_enter_events
+    @left_input_field_dna.on_enter {
+      do_sync_the_fields unless @left_input_field_dna.text?.empty?
+    }
+  end
+
+  # ========================================================================= #
+  # === create_the_top_labels
+  #
+  # The two top labels denote which widget is the one for the DNA
+  # sequence, and which one is for the aminoacid sequence.
+  # ========================================================================= #
+  def create_the_top_labels
+    @dna_sequence_label = return_dna_sequence_label
+    @reverse_complement_sequence_label = return_reverse_complement_to_that_dna_sequence
+  end
+
+  # ========================================================================= #
+  # === return_reverse_complement_to_that_dna_sequence
+  # ========================================================================= #
+  def return_reverse_complement_to_that_dna_sequence
+    bold_label('Reverse complement to that DNA sequence')
+  end
+
+  # ========================================================================= #
+  # === create_button_trigger_conversion
+  # ========================================================================= #
+  def create_button_trigger_conversion
+    # ======================================================================= #
+    # === @button_trigger_conversion
+    # ======================================================================= #
+    @button_trigger_conversion = bold_button('_Trigger Conversion', self, :use_mnemonics) {
+      :do_sync_the_fields
+    }
+    @button_trigger_conversion.clear_background
+    @button_trigger_conversion.set_background_colour :whitesmoke
+    @button_trigger_conversion.on_hover(:lightgreen)
+    @button_trigger_conversion.bblack1
+    # ======================================================================= #
+    # Use a tooltip as well for our button:
+    # ======================================================================= #
+    @button_trigger_conversion.hint = 
+      "Clicking on this button will convert from a <b>DNA</b>\n"\
+      "<b>sequence</b> to the <b>corresponding reverse "\
+      "complement sequence</b>.\n\nMake sure you input the DNA sequence "\
+      "on the left hand side."
+  end
+
+  # ========================================================================= #
+  # === create_input_fields
+  #
+  # These are the two input fields, also known as "gtk-entries".
+  # ========================================================================= #
+  def create_input_fields
+    # ======================================================================= #
+    # The DNA widget, a gtk-entry widget.
+    # ======================================================================= #
+    @left_input_field_dna = input_field
+    @left_input_field_dna.width_height(600, 20)
+    @left_input_field_dna.very_light_yellowish_background
+    @left_input_field_dna.hint = 'Input your DNA sequence here. Upon '\
+      'clicking on the arrow or hitting the <b>enter</b> key, the sequence is '\
+      'first converted to DNA, and then the reverse complement is '\
+      'calculated. Afterwards the result is shown on the right input '\
+      'field.'
+    # ======================================================================= #
+    # === The right widget.
+    # ======================================================================= #
+    @right_input_field_aa = input_field
+    @right_input_field_aa.very_light_yellowish_background
+    # ======================================================================= #
+    # The AA widget. Will be highlighted on a click event.
+    # ======================================================================= #
+    if @right_input_field_aa.respond_to? :on_click_event
+      @right_input_field_aa.on_click_event { :highlight_text }
+    end
   end
 
   # ========================================================================= #
@@ -156,129 +311,164 @@ module DnaToReverseComplementWidgetModule # === Bioroebe::GUI::DnaToReverseCompl
   end
 
   # ========================================================================= #
-  # === do_sync_fields
-  #
-  # This method will sync between the two main widgets - the DNA input
-  # field on the left, and the reverse complement on the right side.
+  # === padding?
   # ========================================================================= #
-  def do_sync_fields
-    consider_sanitizing_the_left_input_field_for_dna
-    _ = @left_input_field_dna.text?
-    if ::Bioroebe.const_defined? :Controller
-      # ===================================================================== #
-      # Ok, in this case we can store the dataset via a class-method.
-      # ===================================================================== #
-      ::Bioroebe::GUI::Controller.set_dna_sequence(_)
-    end
-    # ======================================================================= #
-    # Next, we must translate from DNA to the reverse complement sequence.
-    # ======================================================================= #
-    _ = ::Bioroebe.complement(_)
-    set_reverse_complement(_.reverse)
-    n_nucleotides = _.size
-    @label_n_nucleotides.set_text(
-      'This DNA sequence contains <b>'+n_nucleotides.to_s+'</b> nucleotides.'
-    )
-    @label_n_nucleotides.do_markify
+  def padding?
+    2
   end
 
   # ========================================================================= #
-  # === return_dna_sequence_label
+  # === border_size?
   # ========================================================================= #
-  def return_dna_sequence_label
-    bold_label('DNA sequence')
+  def border_size?
+    0
   end
 
   # ========================================================================= #
-  # === let_the_left_entry_react_to_enter_events
+  # === main_font?
   # ========================================================================= #
-  def let_the_left_entry_react_to_enter_events
-    @left_input_field_dna.on_enter {
-      do_sync_fields unless @left_input_field_dna.text?.empty?
-    }
+  def main_font?
+    USE_THIS_FONT
   end
 
   # ========================================================================= #
-  # === create_the_top_labels
-  #
-  # The two top labels denote which widget is the one for the DNA
-  # sequence, and which one is for the aminoacid sequence.
+  # === slightly_smaller_font?
   # ========================================================================= #
-  def create_the_top_labels
+  def slightly_smaller_font?
+    USE_THIS_SLIGHTLY_SMALLER_FONT
+  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 '
+
+ grid {
+      padding: 20px;
+    }
+    '
+    apply_the_CSS_rules
+  end; alias handle_CSS handle_CSS_rules # === handle_CSS
+
+  # ========================================================================= #
+  # === create_the_skeleton                        (create tag, skeleton tag)
+  # ========================================================================= #
+  def create_the_skeleton
+    @label_n_nucleotides = text
+    create_input_fields
+    # ======================================================================= #
+    # === @dna_sequence_label
+    # ======================================================================= #
     @dna_sequence_label = return_dna_sequence_label
-    @reverse_complement_sequence_label = return_reverse_complement_to_that_dna_sequence
+    create_the_grid
+    create_the_event_box
+    create_button_trigger_conversion
+    create_the_top_labels
   end
 
   # ========================================================================= #
-  # === return_reverse_complement_to_that_dna_sequence
+  # === run                                                         (run tag)
   # ========================================================================= #
-  def return_reverse_complement_to_that_dna_sequence
-    bold_label('Reverse complement to that DNA sequence')
+  def run
+    run_super
   end
 
   # ========================================================================= #
-  # === create_button_trigger_conversion
+  # === create_the_event_box
   # ========================================================================= #
-  def create_button_trigger_conversion
+  def create_the_event_box
     # ======================================================================= #
-    # === @button_trigger_conversion
+    # === @event_box_containing_the_right_arrow
     # ======================================================================= #
-    @button_trigger_conversion = bold_button('_Trigger Conversion')
-    @button_trigger_conversion.clear_background
-    @button_trigger_conversion.lightgreen
-    @button_trigger_conversion.bblack1
-    @button_trigger_conversion.set_background_colour :whitesmoke
-    @button_trigger_conversion.on_hover(:lightblue)
-    @button_trigger_conversion.on_clicked {
-      do_sync_fields
+    @event_box_containing_the_right_arrow = create_eventbox(
+      create_label(:arrow_right)
+    )
+    @event_box_containing_the_right_arrow.on_clicked {
+      do_sync_the_fields
     }
-    # ======================================================================= #
-    # Use a tooltip as well for our button:
-    # ======================================================================= #
-    @button_trigger_conversion.hint = 
-      "Clicking on this button will convert from a <b>DNA</b>\n"\
-      "<b>sequence</b> to the <b>corresponding reverse "\
-      "complement sequence</b>.\n\nMake sure you input the DNA sequence "\
-      "on the left hand side."
   end
 
   # ========================================================================= #
-  # === create_input_fields
-  #
-  # These are the two input fields, also known as "gtk-entries".
+  # === create_the_grid
   # ========================================================================= #
-  def create_input_fields
+  def create_the_grid
     # ======================================================================= #
-    # The DNA widget, a gtk-entry widget.
+    # === @grid
     # ======================================================================= #
-    @left_input_field_dna = input_field
-    @left_input_field_dna.width_height(600, 20)
-    @left_input_field_dna.very_light_yellowish_background
-    @left_input_field_dna.hint = 'Input your DNA sequence here. Upon '\
-      'clicking on the arrow or hitting the <b>enter</b> key, the sequence is '\
-      'first converted to DNA, and then the reverse complement is '\
-      'calculated. Afterwards the result is shown on the right input '\
-      'field.'
-    # ======================================================================= #
-    # === The right widget.
-    # ======================================================================= #
-    @right_input_field_aa = input_field
-    @right_input_field_aa.very_light_yellowish_background
-    # ======================================================================= #
-    # The AA widget. Will be highlighted on a click event.
-    # ======================================================================= #
-    if @right_input_field_aa.respond_to? :on_click_event
-      @right_input_field_aa.on_click_event { :highlight_text }
-    end
+    @grid = default_grid
+    @grid.set_column_spacing(6)
+    @grid.set_row_spacing(6)
   end
 
   # ========================================================================= #
-  # === run                                                         (run tag)
+  # === connect_the_skeleton                      (connect tag, skeleton tag)
   # ========================================================================= #
-  def run
-    super()
+  def connect_the_skeleton
+    abort_on_exception
+
+    vbox = create_vbox
+
+    @grid.left  @dna_sequence_label
+    @grid.middle text('')
+    @grid.right @reverse_complement_sequence_label
+    @grid.left  @left_input_field_dna
+    @grid.middle @event_box_containing_the_right_arrow
+    @grid.right @right_input_field_aa
+    @grid.full_row(
+      @button_trigger_conversion,
+      :default,
+      :default,
+      3
+    )
+    vbox.minimal(@grid)
+    vbox.minimal(horizontal_separator)
+    vbox.minimal(@label_n_nucleotides)
+
+    window = runner_widget(nil, width?, height?, title?)
+    window << vbox
+
+    ::UniversalWidgets.set_main_window(window)
+    upon_delete_event_quit_the_application
     handle_commandline_arguments # This must come after the GUI skeleton was created.
     let_the_left_entry_react_to_enter_events
+
+    window.use_this_font = font?
+    window.show_all
+    window.set_size_request(width?, height?)
+    window.set_default_size(width?, height?)
+    window.set_padding(padding?)
+    window.set_border_size(border_size?)
+    window.set_size_request(80, 100)
+    window.top_left
+    run_main
   end
 
-end; end; end
+  # ========================================================================= #
+  # === Bioroebe::GUI::UniversalWidgets::DnaToReverseComplementWidget[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+  # ========================================================================= #
+  # === Bioroebe::GUI::Gtk::DnaToReverseComplementWidget.run
+  # ========================================================================= #
+  def self.run(
+      i = ARGV
+    )
+    r = ::Gtk.runner_factory(
+      ::Bioroebe::GUI::Gtk::DnaToReverseComplementWidget.new(i)
+    )
+    r.modify_background(:normal, :mintcream)
+    return r
+  end; self.instance_eval { alias run_gtk3_widget       run } # === Bioroebe::GUI::Gtk::DnaToReverseComplementWidget.run_gtk3_widget
+       self.instance_eval { alias start_gui_application run } # === Bioroebe::GUI::Gtk::DnaToReverseComplementWidget.start_gui_application
+
+end; end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Bioroebe::GUI::UniversalWidgets::DnaToReverseComplementWidget.new(ARGV)
+end # gtkdnatoreversecomplementwidget