Class: Bioroebe::GUI::UniversalWidgets::BlosumMatrixViewer

Inherits:
UniversalWidgets::Base
  • Object
show all
Includes:
CommandlineArguments, Bioroebe::GUI
Defined in:
lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb

Overview

Bioroebe::GUI::UniversalWidgets::BlosumMatrixViewer

Constant Summary collapse

TITLE =
#

TITLE

Specify which title to use for this widget.

#
'Blosum Matrix Viewer'
WIDTH =
#

WIDTH

#
'75% or 2000px minimum'
HEIGHT =
#

HEIGHT

#
'55% or 500px minimum'
FONT_LARGE =
#

FONT_LARGE

#
'Calibri 32'
MONOSPACED_FONT =
#

MONOSPACED_FONT

When this font is changed, don’t forget to also change the font at SMALLER_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
TEXT1 =
#

TEXT1

#
'Available BLOSUM matrices:'

Constants included from Bioroebe::GUI

ARRAY_ALL_GTK_WIDGETS, FONT_SIZE, OLD_VERBOSE_VALUE, Bioroebe::GUI::USE_THIS_FONT_FAMILY_FOR_GUI_APPLICATIONS

Constants included from ColoursForBase

ColoursForBase::ARRAY_HTML_COLOURS_IN_USE

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Bioroebe::GUI

#disable_warnings, #enable_warnings, #log_dir?

Methods included from CommandlineArguments

#commandline_arguments?, #commandline_arguments_that_are_files?, #e, #first?, #first_non_hyphen_argument?, #remove_hyphens_from_the_commandline_arguments, #return_commandline_arguments_as_string, #return_commandline_arguments_that_are_not_files, #return_entries_without_two_leading_hyphens, #select_commandline_arguments, #select_entries_starting_with_two_hyphens, #set_commandline_arguments

Methods included from ColoursForBase

#colourize_this_aminoacid_sequence_for_the_commandline, #colourize_this_nucleotide_sequence, #disable_colours, #ecomment, #efancy, #egold, #enable_colours, #eorange, #eparse, #erev, #red, #remove_trailing_escape_part, #return_colour_for_nucleotides, #rev, #sdir, #set_will_we_use_colours, #sfancy, #sfile, #simp, #swarn, #use_colours?, #use_colours_within_the_bioroebe_namespace?

Constructor Details

#initialize(commandline_arguments = nil, run_already = true) ⇒ BlosumMatrixViewer

#

initialize

#


84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 84

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

Class Method Details

.[](i = ARGV) ⇒ Object

#

Bioroebe::GUI::UniversalWidgets::BlosumMatrixViewer[]

#


307
308
309
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 307

def self.[](i = ARGV)
  new(i)
end

.run(i = ARGV) ⇒ Object

#

Bioroebe::GUI::Gtk::BlosumMatrixViewer.run

#


314
315
316
317
318
319
320
321
322
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 314

def self.run(
    i = ARGV
  )
  r = ::Gtk.runner_factory(
    ::Bioroebe::GUI::Gtk::BlosumMatrixViewer.new(i)
  )
  r.background_colour(:white)
  return r
end

Instance Method Details

#border_size? ⇒ Boolean

#

border_size?

#

Returns:

  • (Boolean) 


190
191
192
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 190

def border_size?
  2
end

#combo_box? ⇒ Boolean

#

combo_box?

#

Returns:

  • (Boolean) 


135
136
137
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 135

def combo_box?
  @combo_box
end

#connect_the_skeleton ⇒ Object

#

connect_the_skeleton (connect tag, skeleton tag)

#


246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 246

def connect_the_skeleton
  abort_on_exception

  vbox = create_vbox
  header = left_aligned_label(TEXT1)
  header.use_this_font = main_font?
  first_row = create_hbox
  first_row.minimal(header, 5)
  hbox = create_hbox
  hbox.minimal(@combo_box)
  first_row.minimal(hbox, 10)
  vbox.minimal(first_row, 1)
  let_the_combo_box_sync_towards_the_main_text_buffer
  vbox.minimal(scrolled_window?)
  do_sync_the_combo_box_text_onto_the_text_buffer

  window = runner_widget(nil, width?, height?, title?)
  window << vbox

  ::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

#create_the_combo_box ⇒ Object

#

create_the_combo_box

#


142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 142

def create_the_combo_box
  # ======================================================================= #
  # === @combo_box
  # ======================================================================= #
  @combo_box = create_combo_box(
    Bioroebe.available_blosum_matrices? - ['blosum_matrix']
  )
  @combo_box.clear_background
  @combo_box.bblack2
  @combo_box.css_class('BG_very_light_yellowish')
end

#create_the_scrolled_window ⇒ Object

#

create_the_scrolled_window

#


290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 290

def create_the_scrolled_window
  # ======================================================================= #
  # === @scrolled_window
  # ======================================================================= #
  @scrolled_window = scrolled_window(@text_view) { :top_to_bottom }
  @scrolled_window.remove_background
  @scrolled_window.bblack1
  @scrolled_window.width_height(500, 740)
  @scrolled_window.pad5px
  @scrolled_window.css_class('mar5px')
  @scrolled_window.css_class('darkblue')
  @scrolled_window.use_this_font = :hack_18
end

#create_the_skeleton ⇒ Object

#

create_the_skeleton (create tag, skeleton tag)

#


223
224
225
226
227
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 223

def create_the_skeleton
  create_the_text_view
  create_the_combo_box
  create_the_scrolled_window
end

#create_the_text_buffer ⇒ Object

#

create_the_text_buffer

#


280
281
282
283
284
285
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 280

def create_the_text_buffer
  # ======================================================================= #
  # === @text_buffer
  # ======================================================================= #
  @text_buffer = create_text_buffer
end

#create_the_text_view ⇒ Object

#

create_the_text_view

#


118
119
120
121
122
123
124
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 118

def create_the_text_view
  create_the_text_buffer
  # ======================================================================= #
  # === @text_view
  # ======================================================================= #
  @text_view = create_text_view(@text_buffer)
end

#do_sync_the_combo_box_text_onto_the_text_buffer ⇒ Object

#

do_sync_the_combo_box_text_onto_the_text_buffer

#


166
167
168
169
170
171
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 166

def do_sync_the_combo_box_text_onto_the_text_buffer
  _ = combo_box?.text?
  text_buffer?.set_text(
    Bioroebe::BlosumParser.return_as_2D_table(_).tr('｜','|')
  )
end

#handle_CSS_rules ⇒ Object Also known as: handle_CSS

#

handle_CSS_rules (CSS tag, css tag)

#


212
213
214
215
216
217
218
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 212

def handle_CSS_rules
  use_gtk_paradise_project_css_file
  append_project_css_file
  add_these_custom_CSS_rules '
'
  apply_the_CSS_rules
end

#let_the_combo_box_sync_towards_the_main_text_buffer ⇒ Object

#

let_the_combo_box_sync_towards_the_main_text_buffer

#


157
158
159
160
161
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 157

def let_the_combo_box_sync_towards_the_main_text_buffer
  combo_box?.on_changed {
    do_sync_the_combo_box_text_onto_the_text_buffer
  }
end

#main_font? ⇒ Boolean

#

main_font?

#

Returns:

  • (Boolean) 


197
198
199
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 197

def main_font?
  USE_THIS_FONT
end

#padding? ⇒ Boolean

#

padding?

#

Returns:

  • (Boolean) 


183
184
185
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 183

def padding?
  12
end

#reset ⇒ Object

#

reset (reset tag)

#


99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 99

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

#run ⇒ Object

#

run (run tag)

#


232
233
234
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 232

def run
  run_super
end

#scrolled_window? ⇒ Boolean

#

scrolled_window?

#

Returns:

  • (Boolean) 


128
129
130
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 128

def scrolled_window?
  @scrolled_window
end

#slightly_smaller_font? ⇒ Boolean

#

slightly_smaller_font?

#

Returns:

  • (Boolean) 


204
205
206
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 204

def slightly_smaller_font?
  USE_THIS_SLIGHTLY_SMALLER_FONT
end

#smaller_font? ⇒ Boolean

#

smaller_font?

#

Returns:

  • (Boolean) 


239
240
241
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 239

def smaller_font?
  SMALLER_FONT
end

#text_buffer? ⇒ Boolean

#

text_buffer?

#

Returns:

  • (Boolean) 


176
177
178
 
# File 'lib/bioroebe/gui/universal_widgets/blosum_matrix_viewer/blosum_matrix_viewer.rb', line 176

def text_buffer?
  @text_buffer
end