Class: Roebe::GUI::UniversalWidgets::SendEmail

Inherits:
Base
  • Object
show all
Includes:
UniversalWidgets::BaseModule
Defined in:
lib/roebe/gui/universal_widgets/send_email/send_email.rb

Overview

Roebe::GUI::UniversalWidgets::SendEmail

Constant Summary collapse

TITLE =
#

TITLE

#
'Send Email'
WIDTH =
#

WIDTH

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

HEIGHT

#
'30% or minimum 880px'
USE_THIS_FONT =
#

USE_THIS_FONT

#
:dejavu_condensed_18
LARGER_FONT =
#

LARGER_FONT

#
:hack_25
SMALLER_FONT =
#

SMALLER_FONT

#
:hack_20

Constants inherited from Base

Base::COLOURS, Base::HOME_DIRECTORY_OF_USER_X, Base::N, Base::NAMESPACE

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#actions, #append_this_onto_that_file, #append_what_into, #be_silent, #be_verbose?, #beautiful_url, #burlywood, #call_next, #chdir, #cheerful_guy, #cliner, #complex_esystem, #convert_global_env, #copy_directory, #copy_file, #cornflowerblue, #create_directory, #crimson, #current_month?, #current_time?, #current_year?, #cyan, #darkcyan, #darkgreen, #darkkhaki, #darkslateblue, #deeppink, #delete_symlink, #do_not_use_the_base_colours, #do_use_the_base_colours, #e, #ecomment, #editor_to_use?, #efancy, #eimp, #emphasis, #ensure_main_encoding, #ensure_utf_encoding, #eparse, #erev, #esteelblue, #etomato, #ewarn, #exit_program, #firebrick, #get_current_day, #get_current_month, #get_files_and_directories, #get_files_from, #get_german_name_for_this_weekday, #gold, #green, #grey, #hh_mm_ss, #hh_mm_ss_day_month_year, #home_dir?, #home_directory_of_user_x?, #infer_the_namespace, #internal_hash?, #is_a_directory?, #is_a_file?, #is_a_jpg_file?, #is_an_image_file?, #is_archive?, #is_audio_file?, #is_in_studium_dir?, #is_multimedia_file?, #is_on_roebe?, #is_on_windows?, #is_studium_available?, #is_symlink?, #is_this_a_ruby_file?, #is_video_file?, #iso_encoding?, #le, #left_colour, #lightblue, #lightgreen, #lightseagreen, #lightsteelblue, #lime, #limegreen, #localhost_to_data, #log_directory?, #main_encoding?, #mediumorchid, #mediumpurple, #mediumseagreen, #mediumslateblue, #mediumspringgreen, #mediumturquoise, #mkdir_p, #mv, #n_days_in_this_month, #n_pages_in_this_pdf_file?, #namespace?, #no_file_exists_at, #ogrey, #olive, #olivedrab, #open_in_browser, #opne, #opnesystem, #opnn, #orange, #orchid, #orev, #palegoldenrod, #palevioletred, #pink, #powderblue, #programs_dir?, #project_base_dir?, #random_html_colour, #rds, #read_file_in_iso_encoding, #read_file_via_the_default_encoding, #read_lines_via_iso_encoding, #readlines_with_main_encoding, #red, #register_sigint, #remove, #remove_directory, #remove_file, #rename_kde_konsole_tab, #replace_localhost_with_data, #report_pwd, #require_rescue, #reset_the_internal_hash, #return_all_directories_from_this_directory, #return_all_files_from_this_directory, #return_current_directory, #return_dd_mm_yyyy, #return_file_or_directory_of, #return_files_from_pwd, #return_last_part_of_the_current_directory, #return_utc, #rev, #right_arrow?, #right_colour, #roebe_log_directory?, #rosybrown, #royalblue, #ruby_base_directory?, #run_in_background, #run_rcfiles_then_run_ata_via_qdbus, #sandybrown, #sdir, #seagreen, #set_be_verbose, #set_xorg_buffer, #sfancy, #sfile, #show_help, #silent_redirection?, #simp, #simple_esystem, #skyblue, #slateblue, #slategray, #springgreen, #steelblue, #string_italic, #swarn, #symlink, #teal, #temp_dir?, #to_camelcase, #to_counted_hash, #tomato, #touch, #try_to_require_the_beautiful_url_gem, #try_to_require_the_html_template, #try_to_require_the_open_gem, #try_to_require_the_program_information_gem, #try_to_require_the_xorg_buffer, #use_colours?, #verbose_truth, #weekday?, #word_wrap, #write_what_into, #yellow

Methods included from Base::CommandlineArguments

#append_onto_the_commandline_arguments, #clear_commandline_arguments, #commandline_arguments?, #commandline_arguments_as_string?, #commandline_arguments_without_leading_hyphens?, #first_argument?, #first_argument_without_leading_hyphens?, #has_an_argument_been_passed?, #remove_hyphened_arguments_from_the_commandline_arguments, #return_commandline_arguments_with_leading_hyphens, #second_argument?, #set_commandline_arguments

Constructor Details

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

#

initialize

#


67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 67

def initialize(
    commandline_arguments = nil,
    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

#

Roebe::GUI::UniversalWidgets::SendEmail[]

#


380
381
382
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 380

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

.run(i = ARGV) ⇒ Object

#

Roebe::GUI::Gtk::SendEmail.run

#


362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 362

def self.run(
    i = ARGV
  )
  require 'gtk_paradise/run'
  _ = ::Roebe::GUI::Gtk::SendEmail.new(i)
  r = ::Gtk.run
  _.set_parent_widget(r) # Must come before we enable the key-combinations.
  _.enable_these_key_combinations(HASH_DESIGNATED_KEY_COMBINATIONS)
  r << _
  r.automatic_size_then_automatic_title
  r.enable_quick_exit
  r.set_background :white
  r.top_left_then_run
end

Instance Method Details

#add_the_scrollview_widget ⇒ Object

#

add_the_scrollview_widget

#


308
309
310
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 308

def add_the_scrollview_widget
  @main_vbox.maximal(@scrollview_widget, 0)
end

#border_size? ⇒ Boolean

#

border_size?

#

Returns:

  • (Boolean) 


142
143
144
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 142

def border_size?
  2
end

#connect_the_skeleton ⇒ Object

#

connect_the_skeleton (connect tag)

#


158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 158

def connect_the_skeleton
  abort_on_exception

  # ======================================================================= #
  # Next, add the widget where the user can write the body of the
  # email.
  # ======================================================================= #
  content_for_the_scrolled_window = create_vbox
  content_for_the_scrolled_window.minimal(
    bold_label('Input below this line the content of the email (the body)'),
    0
  )
  content_for_the_scrolled_window.minimal(
    create_hspacer, 2
  )
  @text_buffer = create_text_buffer
  @text_viewer = create_text_view(@text_buffer)
  @text_viewer.the_cursor_is_visible
  content_for_the_scrolled_window.maximal(@text_viewer, 5)
  @scrollview_widget = create_scrolled_window(content_for_the_scrolled_window) { :default_policy }

  window = create_window_or_runner(nil, width?, height?, title?)
  add_the_scrollview_widget

  @main_vbox.minimal(@error_widget, 0)
  # ======================================================================= #
  # Add the send-button next.
  # ======================================================================= #
  @main_vbox.minimal(
    @button_send_the_email, 0
  )

  window << @main_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_the_buttons ⇒ Object

#

create_the_buttons (button tag, buttons tag)

#


248
249
250
251
252
253
254
255
256
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 248

def create_the_buttons
  @button_send_the_email = bold_button('📧 Send the email')
  @button_send_the_email.on_hover(:lightgreen)
  @button_send_the_email.on_clicked {
    do_send_the_email
  }
  @button_send_the_email.hint =
    '<b>Send</b> the email by clicking on this button.'
end

#create_the_error_widget ⇒ Object

#

create_the_error_widget

#


326
327
328
329
330
331
332
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 326

def create_the_error_widget
  require 'gtk_paradise/widgets/gtk3/error_widget/error_widget.rb'
  # ======================================================================= #
  # === @error_widget
  # ======================================================================= #
  @error_widget = ::Gtk::ErrorWidget.new
end

#create_the_main_vbox ⇒ Object

#

create_the_main_vbox

#


337
338
339
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 337

def create_the_main_vbox
  @main_vbox = create_vbox
end

#create_the_skeleton ⇒ Object

#

create_the_skeleton (create tag, skeleton tag)

#


279
280
281
282
283
284
285
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 279

def create_the_skeleton
  create_the_main_vbox
  create_the_error_widget
  create_then_add_the_recipient_email_address
  create_then_add_the_sent_by_entry
  create_the_buttons
end

#create_then_add_the_recipient_email_address ⇒ Object

#

create_then_add_the_recipient_email_address

#


344
345
346
347
348
349
350
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 344

def create_then_add_the_recipient_email_address
  @entry_for_the_email_address = create_entry
  mini_hbox = create_hbox
  mini_hbox.minimal(text('Enter the target email address → '), 0)
  mini_hbox.maximal(@entry_for_the_email_address, 0)
  @main_vbox.minimal(mini_hbox, 0)
end

#create_then_add_the_sent_by_entry ⇒ Object

#

create_then_add_the_sent_by_entry

This will add the entry for the email address.

#


292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 292

def create_then_add_the_sent_by_entry
  @entry_for_the_sent_by_email_address = create_entry
  mini_hbox = create_hbox
  mini_hbox.minimal(text('Enter your email address → '), 0)
  mini_hbox.maximal(@entry_for_the_sent_by_email_address, 0)
  @main_vbox.minimal(mini_hbox, 0)
  if is_on_roebe?
    @entry_for_the_sent_by_email_address.set_text(
      '[email protected]'
    )
  end
end

#do_all_startup_related_actions ⇒ Object

#
#


149
150
151
152
153
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 149

def do_all_startup_related_actions
  if ::Roebe.is_on_roebe?
    fill_main_entry_with_email_data
  end
end

#do_send_the_email(target = main_entry?.text.to_s, sent_from = @entry_for_the_sent_by_email_address.text.to_s) ⇒ Object

#

do_send_the_email (send tag)

#


261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 261

def do_send_the_email(
    target    = main_entry?.text.to_s,
    sent_from = @entry_for_the_sent_by_email_address.text.to_s
  )
  target = target.to_s.dup
  if target.empty?
    e 'Please provide a valid remote URL as target.'
  else
    e
    e 'Sending the email next to '+Colours.sfancy(target)+':'
    e
    failsafe_delegate_towards_the_mail_gem(target, sent_from)
  end
end

#entry_for_the_email_address? ⇒ Boolean Also known as: main_entry?

#

entry_for_the_email_address?

#

Returns:

  • (Boolean) 


241
242
243
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 241

def entry_for_the_email_address?
  @entry_for_the_email_address
end

#failsafe_delegate_towards_the_mail_gem(target = main_entry?.text.to_s, sent_from = @entry_for_the_sent_by_email_address.text.to_s) ⇒ Object

#

failsafe_delegate_towards_the_mail_gem

This method depends on the mail-gem.

#


213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 213

def failsafe_delegate_towards_the_mail_gem(
    target    = main_entry?.text.to_s,
    sent_from = @entry_for_the_sent_by_email_address.text.to_s
  )
  begin
    mail_object = ::Mail.deliver {
      from     sent_from
      to       target
      subject  'Test subjct'
      body     'Some content'
      # ===================================================================== #
      # If we want to add a file-attachment.
      #   add_file '/full/path/to/somefile.png'
      # ===================================================================== #
    }
    mail_object.delivery_method :sendmail
    mail_object.deliver
  rescue Exception => error
    # An error happened. We propagate this error into the error-widget.
    e Colours.tomato('Error!')
    pp error
    @error_widget.capture_this_error(error)
  end
end

#fill_main_entry_with_email_data ⇒ Object

#

fill_main_entry_with_email_data

#


315
316
317
318
319
320
321
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 315

def fill_main_entry_with_email_data
  _ = 'rabert.'.tr('a','o').dup
  _ << 'konz'.tr('o','u')
  _ << '@'
  _ << 'students.boku.ac.atTTTTTTTTTT'
  @entry_for_the_email_address.set_text(_)
end

#handle_CSS_rules ⇒ Object

#

handle_CSS_rules (CSS tag)

#


114
115
116
117
118
119
120
121
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 114

def handle_CSS_rules
  use_gtk_paradise_project_css_file
  append_project_css_file
  more_CSS_then_apply_it '


'
end

#padding? ⇒ Boolean

#

padding?

#

Returns:

  • (Boolean) 


135
136
137
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 135

def padding?
  0
end

#reset ⇒ Object

#

reset (reset tag)

#


84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 84

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.

#


129
130
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 129

def reset_the_shared_module
end

#run ⇒ Object

#

run (run tag)

#


355
356
357
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 355

def run
  run_super
end

#smaller_font? ⇒ Boolean

#

smaller_font?

#

Returns:

  • (Boolean) 


107
108
109
 
# File 'lib/roebe/gui/universal_widgets/send_email/send_email.rb', line 107

def smaller_font?
  SMALLER_FONT
end