Class: RBT::GUI::UniversalWidgets::UrlAction

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

Overview

RBT::GUI::UniversalWidgets::UrlAction

Constant Summary collapse

USE_THESE_CSS_RULES =
#

USE_THESE_CSS_RULES

#
'
'
TITLE =
#

TITLE

#
'URL action'
WIDTH =
#

WIDTH

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

HEIGHT

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

USE_THIS_FONT

#
:dejavu_condensed_20
LARGER_FONT =
#

LARGER_FONT

#
:dejavu_condensed_22
SMALLER_FONT =
#

SMALLER_FONT

#
:dejavu_condensed_18

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) ⇒ UrlAction

#

initialize

#


68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 68

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::UrlAction[]

#


306
307
308
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 306

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

.run(i = ARGV) ⇒ Object

#

RBT::GUI::Gtk::UrlAction.run

#


287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 287

def self.run(
    i = ARGV
  )
  require 'gtk_paradise/run'
  _ = ::RBT::GUI::Gtk::UrlAction.new(i)
  r = ::Gtk.run
  _.set_parent_widget(r) # Must come before we enable the key-combinations.
  r << _
  r.add_shortcut(1,  'focus_on_entry', :alt)
  r.add_shortcut(:a, 'focus_on_entry', :alt)
  r.automatic_size_then_automatic_title
  r.enable_quick_exit
  r.set_background :white
  r.top_left_then_run
end

Instance Method Details

#border_size?Boolean

#

border_size?

#

Returns:

  • (Boolean)


222
223
224
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 222

def border_size?
  2
end

#connect_the_skeletonObject

#

connect_the_skeleton (connect tag)

#


245
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
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 245

def connect_the_skeleton
  abort_on_exception

  outer_vbox = create_vbox # A new vbox.

  outer_vbox.maximal(@entry,  4)
  mini_hbox = create_hbox
  mini_hbox.minimal(@button)
  outer_vbox.minimal(mini_hbox, 4)
  outer_vbox.add(@source_view)

  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

#create_scrolled_windowsObject

#

create_scrolled_windows

#


177
178
179
180
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 177

def create_scrolled_windows
  @source_buffer = create_text_buffer
  @source_view   = create_text_view(@source_buffer) 
end

#create_the_buttonsObject

#

create_the_buttons (buttons tag)

#


192
193
194
195
196
197
198
199
200
201
202
203
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 192

def create_the_buttons
  # ======================================================================= #
  # === @button
  # ======================================================================= #
  @button = button('_Send Message', self, :use_mnemonics) {
    :send_message_to_url_action_from_the_main_entry
  }
  @button.clear_background
  @button.on_hover(:lightgreen)
  @button.pad8px
  @button.bblack2  
end

#create_the_entriesObject

#

create_the_entries

#


155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 155

def create_the_entries
  # ========================================================================== #
  # === @entry
  # ========================================================================== #
  @entry = create_entry
  @entry.set_max_length 50
  # @entry.set_activates_default(true)
  @entry.signal_connect(:key_press_event) { |widget, event|
    key_pressed = Gdk::Keyval.to_name(event.keyval)
    case key_pressed
    when 'Return','KP_Enter'
      @entry.set_focus true
      @button.signal_emit :clicked
    else # debug info
      # pp key_pressed
    end
  }
end

#create_the_skeletonObject

#

create_the_skeleton (create tag, skeleton tag)

#


229
230
231
232
233
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 229

def create_the_skeleton
  create_scrolled_windows
  create_the_buttons
  create_the_entries
end
#
#


278
279
280
281
282
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 278

def do_all_startup_related_actions
  Thread.new {
    sleep 0.0001
  }
end

#favicon?Boolean

#

favicon?

#

Returns:

  • (Boolean)


112
113
114
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 112

def favicon?
  :tabble
end

#handle_CSS_rulesObject

#

handle_CSS_rules (CSS tag)

#


126
127
128
129
130
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 126

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)


215
216
217
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 215

def padding?
  4
end

#resetObject

#

reset (reset tag)

#


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 85

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
  # ======================================================================= #
  # === @url_action
  # ======================================================================= #
  @url_action = ::RBT::UrlAction.new('', :do_not_run_yet)
end

#reset_the_shared_moduleObject

#

reset_the_shared_module

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

#


138
139
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 138

def reset_the_shared_module
end

#runObject

#

run (run tag)

#


238
239
240
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 238

def run
  run_super
end

#send_message_to_url_action(this_action = 'query/wget') ⇒ Object

#

send_message_to_url_action

#


144
145
146
147
148
149
150
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 144

def send_message_to_url_action(
    this_action = 'query/wget'
  )
  @url_action.set_action(this_action)
  @url_action.run
  set_buffer_text(@url_action.result)
end

#send_message_to_url_action_from_the_main_entryObject

#

send_message_to_url_action_from_the_main_entry

#


185
186
187
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 185

def send_message_to_url_action_from_the_main_entry
  send_message_to_url_action(@entry.text)
end

#set_buffer_text(i) ⇒ Object

#

set_buffer_text

#


208
209
210
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 208

def set_buffer_text(i)
  @source_buffer.text = i
end

#smaller_font?Boolean

#

smaller_font?

#

Returns:

  • (Boolean)


119
120
121
# File 'lib/rbt/gui/universal_widgets/url_action/url_action.rb', line 119

def smaller_font?
  SMALLER_FONT
end