Class: RBT::GUI::UniversalWidgets::Notebook

Inherits:
Base show all
Includes:
UniversalWidgets::BaseModule
Defined in:
lib/rbt/gui/universal_widgets/notebook/notebook.rb

Overview

RBT::GUI::UniversalWidgets::Notebook

Constant Summary collapse

HASH_DESIGNATED_KEY_COMBINATIONS =
#

HASH_DESIGNATED_KEY_COMBINATIONS

#
{
  'alt+1': 'focus_on_this_tab(0)',
  'alt+2': 'focus_on_this_tab(1)',
  'alt+3': 'focus_on_this_tab(2)',
  'alt+4': 'focus_on_this_tab(3)',
  'alt+5': 'focus_on_this_tab(4)'
}
USE_THESE_CSS_RULES =
#

USE_THESE_CSS_RULES

#
'
'
TITLE =
#

TITLE

#
'Notebook'
WIDTH =
#

WIDTH

#
'82% or minimum 1280px'
HEIGHT =
#

HEIGHT

#
'40% or minimum 800px'
USE_THIS_FONT =
#

USE_THIS_FONT

#
:dejavu_condensed_19
LARGER_FONT =
#

LARGER_FONT

#
:dejavu_condensed_22
SMALLER_FONT =
#

SMALLER_FONT

#
:dejavu_condensed_18
USE_THIS_MONOSPACED_FONT =
#

USE_THIS_MONOSPACED_FONT

#
:hack_16

Constants inherited from LeanPrototype

LeanPrototype::ALL_COLOUR_METHODS, LeanPrototype::ARRAY_KDE_KONSOLE_COLOURS_IN_USE, LeanPrototype::DAY_NAMES, LeanPrototype::NAMESPACE, LeanPrototype::SILENT_REDIRECTION

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#cat, #cd_back_to_the_current_working_directory, #consider_reporting_how_many_programs_are_registered, #cookbook_files?, #copy_recursively, #delete_code_of_conduct?, #determine_appdir_prefix_from_this_input, #directory_validation?, #do_not_show_names, #fast_return_file_size_of_this_program, #file_last_symlinked_program?, #file_programs_version_url, #gem_version, #is_a_64bit_system?, #is_ccache_available?, #is_porg_available?, #is_this_binary_registered?, #is_this_program_included?, #make_command?, #make_install_command?, #new_cookbook_instance_for, #program_exists?, #publish_list_of_all_programs_version, #rcp, registered_binaries?, #remove_symlink, #rename_kde_konsole_tab, #repackage, #report_n_programs, #report_working_directory, #return_compile_time_statistics, #return_n_random_characters, #return_version_of_this_program, #run_make_then_make_install, #sanitize_url1_entry, #set_source_directory, #show_overview_over_available_utility_scripts, #symlink_all_files_from_this_directory_to_that_directory, #system_tags?, #upload_list_of_all_programs_version, #use_yaml_database_for_tags?, #warn_and_exit, #wget

Methods inherited from LeanPrototype

#a_or_an?, #abbreviations?, #absolute_path, #action, #add_to_the_commandline_arguments, #all_binaries?, #all_files_from, #all_libraries?, #allowed_cookbook_entries?, #appdir_location_of?, #append_onto_the_internal_hash, #append_what_into, #archive_type_of?, #available_programs?, #be_quiet?, #be_verbose?, #begins_with_a_comment?, #capitalize_first_alphabetical_character, #cd_to_the_log_directory, #cd_to_the_temp_directory, #change_directory, #change_permission, #cheering_person?, #chmod, #chop_off_archive, #clear_commandline_options, #cliner, #coloured_and_padded_e, #coloured_and_padded_esystem, #coloured_esystem, #colourize_directory_for_system_results, #colourize_this_error, #colourize_this_file_path, #colourize_this_warning, #commandline_arguments?, #commandline_arguments_without_hyphens?, #comment, #convert_dd_mm_yyyy_to_its_long_variant, #convert_env_variable, #copy_directory, #copy_files, #cpr, #create_directory, #current_hour?, #dd_mmm_yyy, #debug, #debug?, #directory_expanded_cookbooks?, #disable_colours, #display_md5sum?, #do_not_debug, #does_the_cookbook_include_this_program?, #does_this_expanded_cookbook_file_exist_for_this_program?, #does_this_file_exist?, #does_this_file_exist_and_is_it_a_file?, #e, #eblue, #ecomment, #ecrimson, #edir, #editor?, #efancy, #eimp, #enable_colours, #enable_debug, #ensure_main_encoding_for, #eparse, #esystem, #esystem_gold, #etomato, #ewarn, #exit_program, #expanded_cookbooks_directory_exists?, #extract_this_archive, #extract_to?, #file_compiled_programs?, #file_dirname_retaining_trailing_slash, #file_predefined_installation_instructions?, #file_specification_of_registered_cookbook_entries, #find_cookbook_alias_for, #find_this_yaml_file, #first_argument?, #first_non_hyphen_argument?, #get_all_directories_from, #get_all_files_from, #get_all_programs, #get_date, #get_extended_date, #get_files_and_directories_from, #go_to_base_dir, #home_dir?, #host_system?, #infer_the_namespace, #internal_hash?, #internal_hash_set_commandline_arguments, #is_an_archive?, #is_directory?, #is_file?, #is_github_url?, #is_make_available?, #is_on_gobolinux?, #is_on_windows?, #is_roebe?, #is_superuser?, #is_symlink?, #is_this_a_header?, #is_this_a_library?, #is_this_program_included?, #iso_encoding?, #load_dataset_from_this_expanded_cookbook, #load_yaml, #load_yaml_file_from_the_cookbook_directory_for_this_program, #log_directory?, #main_encoding?, #meson_build_file_exists?, #months?, #move_file, #n_programs_are_available?, #n_programs_available?, #namespace?, #no_directory_exists_at, #no_opn, #no_such_file_exists, #open_in_browser, #open_in_editor, #opncomment, #opne, #opnef, #opnerev, #opnerror, #opnesystem, #opnewarn, #opnfancy, #opnn, #packages_directory?, #path_to_this_expanded_cookbooks_dataset, #pkgconfig_directory?, #populate_the_internal_hash_with_default_values, #predefined_installation_instructions?, #prepend_this_commandline_argument, #program_version_of?, #project_base_directory?, #project_yaml_directory?, #query_path?, #rarrow?, #read_file, #read_file_in_default_encoding, #read_file_with_default_encoding, #readlines, #readlines_with_proper_encoding, #register_sigint, #registered_cookbook_entries?, #remove, #remove_archive_from_the_end, #remove_comments_from_each_line, #remove_directory, #remove_double_slashes, #remove_file, #remove_newlines, #remove_parens, #remove_symlink, #remove_this_commandline_argument, #remove_this_entry_from_the_commandline_arguments, #remove_trailing_ANSII_escape_code, #remove_unnecessary_data_from_url, #rename, #report_pwd, #require_the_rbt_aliases, #reset_the_internal_hash, #return_all_archives_from_this_directory, #return_appdir_prefix, #return_commandline_arguments_with_leading_hyphens, #return_current_hour_minutes_second, #return_date, #return_day_of_the_month_based_on_utc, #return_full_time, #return_hours_minutes_seconds_based_on_utc, #return_location_to_this_programs_yaml_file, #return_month_based_on_this_number, #return_month_based_on_utc, #return_opnn, #return_program_information, #return_program_name_for_gobolinux_systems, #return_pwd, #return_unicode_warning_symbol_or_empty_string, #return_utc, #return_utc_time_in_a_format_similar_to_slackware, #return_weekday_based_on_utc, #return_year_based_on_utc, #rev, #run_simulation=, #run_simulation?, #sdir, #sdir_return_pwd, #set_be_silent, #set_be_verbose, #set_first_commandline_argument, #set_namespace, #set_use_opn, #set_xorg_buffer, #sfancy, #sfile, #silent_redirection?, #silently_create_this_directory_if_it_does_not_yet_exist, #simp, #source_base_directory?, #ssym, #stderr, #store_into_this_directory?, #string_right_arrow?, #swarn, #symlink, #sysbin_directory?, #sysetc_directory?, #sysinclude_directory?, #syslib_directory?, #sysshare_directory?, #system_directory?, #temp_directory?, #to_bool, #to_camelcase, #to_iso_encoding, #to_unicode, #today?, #touch, #try_to_require_beautiful_url, #try_to_require_the_environment_information_gem, #try_to_require_the_extracter_gem, #try_to_require_the_open_gem, #try_to_require_the_xorg_buffer, #try_to_require_wget, #try_to_return_a_special_compile_component, #unicode_cliner, #unicode_middle_cliner, #use_colours=, #use_colours?, #use_opn=, #use_opn?, #utf_encoding?, #verbose_truth, #word_wrap, #write_what_into, #write_what_into_via_unicode, #yes_or_no

Constructor Details

#initialize(commandline_arguments = ARGV, run_already = true) ⇒ Notebook

#

initialize

#


86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 86

def initialize(
    commandline_arguments       = ARGV,
    run_already                 = true
  )
  super(:vertical) if use_gtk3?
  determine_the_GUI_to_be_used(commandline_arguments) # This must come first, even before reset().
  reset
  set_commandline_arguments(
    commandline_arguments
  )
  on_delete_event_quit_the_application
  run if run_already
end

Class Method Details

.[](i = ARGV) ⇒ Object

#

RBT::GUI::UniversalWidgets::Notebook[]

#


483
484
485
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 483

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

.run(i = ARGV) ⇒ Object

#

RBT::GUI::Gtk::Notebook.run

#


464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 464

def self.run(
    i = ARGV
  )
  require 'gtk_paradise/run'
  _ = ::RBT::GUI::Gtk::Notebook.new(i)
  r = ::Gtk.run { :add_a_new_accel_group }
  r << _
  _.set_parent_widget(r)
  _.enable_these_key_combinations(HASH_DESIGNATED_KEY_COMBINATIONS)
  r.automatic_size_then_automatic_title
  r.enable_quick_exit
  r.set_background :white
  r.is_resizable # <- This line was added due to a possible prior .maximize action.
  r.top_left_then_run
end

Instance Method Details

#border_size? ⇒ Boolean

#

border_size?

#

Returns:

  • (Boolean) 


172
173
174
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 172

def border_size?
  0
end

#connect_the_skeleton ⇒ Object

#

connect_the_skeleton (connect tag)

#


375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 375

def connect_the_skeleton
  abort_on_exception

  outer_vbox = create_vbox # A new vbox.

  @notebook = create_notebook(:useful_defaults)
  @notebook.append_this_widget(
    return_widget_containing_compile_related_components,
    'Compile a program'
  )
  @notebook.append_this_widget(
    RBT::GUI::Gtk::CompileProgram.new,
    'Compile a program (advanced widget)'
  )
  @notebook.append_this_widget(
    return_widget_containing_package_related_components,
    'Create or install packages'
  )
  @notebook.append_this_widget(
    return_widget_containing_recipe_related_components,
    'Create a new recipe'
  )
  # ======================================================================= #
  # The VTE does not work very well. We may have to
  # find a solution to this; perhaps just a custom
  # non-vte shell or something.
  #
  #   @notebook.append_this_widget(
  #     return_widget_containing_vte,
  #     'VTE'
  #   )
  # ======================================================================= #
  @notebook.append_this_widget(
    return_widget_containing_statistical_information,
    'Statistics'
  )
  outer_vbox.add(@notebook)

  window = create_window_or_runner
  window << outer_vbox

  properly_prepare_this_window(window,
    {
      title:       title?,
      font:        font?,
      width:       width?,
      height:      height?,
      padding:     padding?,
      border_size: border_size?
    }
  )
  window.show_all
  window.top_left
  do_all_startup_related_actions
  run_main
end

#consider_updating_when_this_program_was_compiled(i) ⇒ Object

#

consider_updating_when_this_program_was_compiled

#


269
270
271
272
273
274
275
276
277
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 269

def consider_updating_when_this_program_was_compiled(i)
  if RBT.is_this_program_registered?(i)
    @text_status.set_text(
      'Finished compiling <b>'+i.to_s+
      '</b> at '+Time.now.to_s+'.'
    )
    @text_status.do_markify
  end
end

#create_the_skeleton ⇒ Object

#

create_the_skeleton (create tag, skeleton tag)

#


357
358
359
360
361
362
363
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 357

def create_the_skeleton
  # ======================================================================= #
  # === @notebook
  # ======================================================================= #
  @notebook = create_notebook
  @notebook.allow_scrolling
end

#do_all_startup_related_actions ⇒ Object

#
#


454
455
456
457
458
459
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 454

def do_all_startup_related_actions
  Thread.new {
    sleep 0.3
    do_update_stuff
  }
end

#do_compile_this_program(i = @entry_compile_this_program.text?) ⇒ Object Also known as: do_compile_the_program

#

do_compile_this_program

#


242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 242

def do_compile_this_program(
    i = @entry_compile_this_program.text?
  )
  if i and !i.empty?
    _ = ::RBT::Action::Installer.new(i) { :do_not_run_yet }
    _.set_prefix(
      @entry_prefix_to_use.text?
    )
    @entry_program_path.set_text(
      _.returned_the_assumed_program_path.to_s
    )
    _.determine_which_programs_to_compile
    _.do_extract_the_archive
    _.initialize_a_new_cookbook_instance
    _.determine_the_program_path
    Dir.chdir(_.base_dir?) if File.directory?(_.base_dir?)
    text = RBT.infer_build_system.to_s
    @entry_inferred_build_type.set_text(text)
    # Thread.new { # We let the compilation run in a thread.
    _.do_initiate_batch_compilation
    consider_updating_when_this_program_was_compiled(i)
  end
end

#do_update_stuff ⇒ Object

#

do_update_stuff

#


180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 180

def do_update_stuff
  total_size = RBT.return_total_size_of_all_archives
  _n_kilobytes = total_size  / 1024.0
  _n_megabytes = _n_kilobytes / 1024.0
  n_gigabytes  = _n_megabytes / 1024.0
  
  @label_total_size_of_all_archives.set_text(
    'All local archives amount to a total size of <b>'+
    n_gigabytes.round(3).to_s+
    ' GB</b>.'
  )
  @label_total_size_of_all_archives.do_markify
  @label_total_size_of_all_archives.left_align
end

#favicon? ⇒ Boolean

#

favicon?

#

Returns:

  • (Boolean) 


126
127
128
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 126

def favicon?
  :tabble
end

#focus_on_this_tab(i = 2) ⇒ Object

#

focus_on_this_tab

#


198
199
200
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 198

def focus_on_this_tab(i = 2)
  @notebook.focus_on_this_tab(i.to_i)
end

#handle_CSS_rules ⇒ Object

#

handle_CSS_rules (CSS tag)

#


140
141
142
143
144
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 140

def handle_CSS_rules
  use_gtk_paradise_project_css_file
  append_project_css_file
  more_CSS_then_apply_it(USE_THESE_CSS_RULES)
end

#padding? ⇒ Boolean

#

padding?

#

Returns:

  • (Boolean) 


165
166
167
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 165

def padding?
  0
end

#reset ⇒ Object

#

reset (reset tag)

#


103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 103

def reset
  super() if respond_to?(:super)
  reset_the_shared_module # This can come early.
  reset_the_base_module
  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)
  if use_gtk3?
    handle_CSS_rules
  end
  infer_the_size_automatically
end

#reset_the_shared_module ⇒ Object

#

reset_the_shared_module

This method can be used for ruby-gtk3 and ruby-libui, among other toolkits.

#


152
153
154
155
156
157
158
159
160
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 152

def reset_the_shared_module
  # ======================================================================= #
  # === @array_available_programs
  # ======================================================================= #
  _ = RBT.file_available_programs
  if File.exist? _
    @array_available_programs = YAML.load_file(_)
  end
end

#return_the_combo_box_containing_all_available_programs ⇒ Object

#

return_the_combo_box_containing_all_available_programs

#


221
222
223
224
225
226
227
228
229
230
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 221

def return_the_combo_box_containing_all_available_programs
  array = @array_available_programs
  _ = create_combo_box_text(array[0 ... 751]) { :first_element_is_active }
  _.use_this_font = :hack_15
  _.on_changed {
    set_compile_this_program(_.active_text?.to_s)
  }
  _.bblack1
  return _
end

#return_widget_containing_compile_related_components ⇒ Object

#
#


303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 303

def return_widget_containing_compile_related_components
  vbox = create_vbox
  vbox.set_border_width(2)

  hbox1 = create_hbox
  hbox1 << text('Compile this program')
  @entry_compile_this_program = entry('php') # Or: gtk_entry_completion(@array_available_programs)
  @entry_compile_this_program.on_click_select_everything
  @entry_compile_this_program.bblack1
  @entry_compile_this_program.on_enter {
    do_compile_this_program(@entry_compile_this_program.text?)
  }
  hbox1.maximal(@entry_compile_this_program, 1)
  hbox1.maximal(return_the_combo_box_containing_all_available_programs, 1)
  vbox.minimal(hbox1)

  hbox2 = createhbox
  hbox2 << text('Program path:')
  @entry_program_path = createentry
  @entry_program_path.bblack1
  @entry_program_path.disallow_changes
  hbox2.maximal(@entry_program_path, 1)
  vbox.minimal(hbox2, 1)

  hbox3 = createhbox
  hbox3 << text('Prefix to use:')
  @entry_prefix_to_use = createentry('/usr/')
  @entry_prefix_to_use.bblack1
  hbox3.maximal(@entry_prefix_to_use, 1)
  vbox.minimal(hbox3, 1)

  hbox4 = hbox
  hbox4 << text('Inferred build type:')
  @entry_inferred_build_type = create_entry
  @entry_inferred_build_type.bblack1
  hbox4.maximal(@entry_inferred_build_type, 1)
  vbox.minimal(hbox4, 1)

  @compile_button = button('Compile the program')
  @compile_button.bblack1
  @compile_button.hint = 'Click this button to '\
    'compile the program.'
  @compile_button.on_clicked {
    do_compile_the_program
  }
  vbox.minimal(@compile_button, 1)
  @text_status = create_text
  vbox.minimal(@text_status, 1)
  return vbox
end

#return_widget_containing_package_related_components ⇒ Object

#

This is the widget for dealing with packages (creating or installing packages).

#


208
209
210
211
212
213
214
215
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 208

def return_widget_containing_package_related_components
  vbox = create_vbox
  vbox.set_border_width(2)
  vbox.add(create_radio_button)
  vbox.add(create_radio_button)
  vbox.add(create_text('This is incomplete.'))
  return vbox
end

#return_widget_containing_recipe_related_components ⇒ Object

#
#


435
436
437
438
439
440
441
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 435

def return_widget_containing_recipe_related_components
  require 'rbt/gui/gtk3/recipe_maker/recipe_maker.rb'
  vbox = create_vbox
  vbox.set_border_width(2)
  vbox.maximal(RBT::GUI::Gtk::RecipeMaker.new, 1)
  return vbox
end

#return_widget_containing_statistical_information ⇒ Object

#

return_widget_containing_statistical_information

#


283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 283

def return_widget_containing_statistical_information
  vbox = create_vbox
  vbox.set_border_width(2)
  @label_total_size_of_all_archives = label
  @label_total_size_of_all_archives.make_selectable

  label_n_programs_are_registered = markified_text(
    "There are a total of <b>#{RBT.available_programs?.size}</b> "\
    "programs available in the RBT project."
  )
  label_n_programs_are_registered.left_align
  label_n_programs_are_registered.make_selectable
  vbox.minimal(label_n_programs_are_registered,   2)
  vbox.minimal(@label_total_size_of_all_archives, 2)
  return vbox
end

#return_widget_containing_vte ⇒ Object

#

return_widget_containing_vte

#


446
447
448
449
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 446

def return_widget_containing_vte
  require 'gtk_paradise/widgets/gtk3/flexible_vte/flexible_vte.rb'
  return ::Gtk::FlexibleVte.new {{ n_tabs: 3 }}
end

#run ⇒ Object

#

run (run tag)

#


368
369
370
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 368

def run
  run_super
end

#set_compile_this_program(i) ⇒ Object

#

set_compile_this_program

#


235
236
237
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 235

def set_compile_this_program(i)
  @entry_compile_this_program.set_text(i.to_s)
end

#smaller_font? ⇒ Boolean

#

smaller_font?

#

Returns:

  • (Boolean) 


133
134
135
 
# File 'lib/rbt/gui/universal_widgets/notebook/notebook.rb', line 133

def smaller_font?
  SMALLER_FONT
end