Class: Studium::GUI::UniversalWidgets::ShowUpcomingExams

Inherits:
Base
  • Object
show all
Includes:
ShowUpcomingExamsModule, UniversalWidgets::BaseModule
Defined in:
lib/studium/gui/universal_widgets/show_upcoming_exams/show_upcoming_exams.rb

Overview

Studium::GUI::UniversalWidgets::ShowUpcomingExams

Constant Summary

Constants included from ShowUpcomingExamsModule

ShowUpcomingExamsModule::HEIGHT, ShowUpcomingExamsModule::LARGER_FONT, ShowUpcomingExamsModule::SMALLER_FONT, ShowUpcomingExamsModule::TITLE, ShowUpcomingExamsModule::USE_THESE_CSS_RULES, ShowUpcomingExamsModule::USE_THIS_FONT, ShowUpcomingExamsModule::USE_THIS_FONT_FOR_THE_TREE_VIEW, ShowUpcomingExamsModule::USE_THIS_MONOSPACED_FONT, ShowUpcomingExamsModule::WIDTH

Constants inherited from Base

Base::COMMON_YEAR_DAYS_IN_MONTH, Base::LEFT_PADDING, Base::NAMESPACE, Base::N_CHARACTERS_PER_LINE

Constants included from Colours

Colours::COLOURS

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ShowUpcomingExamsModule

#border_size?, #do_all_startup_related_actions, #favicon?, #padding?, #remove_german_weekdays, #reset_the_shared_module, #smaller_font?

Methods inherited from Base

#add_proper_year_entry_to_this_line, #already_solved_this_lva_number?, #append_what_into, #available_topics_as_short_name, #average_grade, #bachelor_master_or_diploma, #be_silent, #be_verbose?, #beautiful_url, #change_directory, #cheering_person, #chmod, #cliner, #colour_for_ects_points, #colourize_percentage, #convert_this_array_of_lectures_into_the_full_dataset, #copy, #course_filter, #cpruby, #create_directory, #create_file, #csv_file?, #current_month?, #current_semester?, #dataset?, #datum?, #day_month_year, #debug?, #delete_file, #directory_of_the_exam_topics?, #directory_to_my_exam_topics, #directory_to_the_exam_topics?, #disable_colours, #disable_colours_globally, #do_not_be_verbose, #do_not_use_opn, #do_these_curricula_include_both_a_bachelor_and_a_master_curriculum?, #does_this_line_include_a_german_weekday?, #does_this_line_include_a_html_colour?, #does_this_line_include_an_english_weekday?, #does_this_line_start_with_a_german_weekday?, #e, #ecomment, #editor?, #ee, #egrey, #enable_colours, #enable_colours_globally, #enable_debug, #encoding?, #english_to_german_weekday, #ensure_that_a_base_directory_exists_for_this_file, #ensure_that_the_log_directory_exists, #eparse, #esystem, #etomato, #exit_program, #extract_dd_mm_yyyy, #fetch_this_curriculum, #file_important_exams?, #file_lecture_information?, #file_passed_exams_per_month, #file_read_with_proper_encoding, #filter_away_already_answered_questions, #filter_away_invalid_questions, #filter_for_all_passed_exams, #find_corresponding_exam_topic, #from_curriculum_id_to_university, #german_date_notation, #german_weekday?, #german_weekdays?, #german_weekend_for?, #german_yes_or_no, #has_a_bachelor_and_a_master_curriculum?, #has_a_bachelor_curriculum?, #has_a_master_curriculum?, #has_lva_dates_registered?, #has_this_exam_topic_been_solved?, #has_year_entry?, #hh_mm_ss_dd_mm_yyyy, #horizontal_bar?, #html_log_directory?, #infer_the_namespace, #initialize_the_internal_hash, #internal_hash?, #is_a_master_lecture?, #is_a_registered_curriculum?, #is_a_weekday?, #is_connected_to_the_www?, #is_german_weekday?, #is_on_roebe?, #is_prüfungsimmanent?, #is_this_a_registered_exam_topic?, #is_this_a_valid_html_colour?, #is_this_day_today?, #is_this_lecture_a_practical_course?, #konsole_support?, #last_file?, #lectures_from_indi1, #lectures_from_indi2, #lectures_from_indi3, #lectures_from_indi4, #lectures_from_the_bachelor_genetik_curriculum, #lectures_from_the_individual_vektor_curricula, #left_arrow?, #load_yaml_dataset, #map_input_to_this_curriculum_filename, #move_file, #n_days_difference_from_today_to_this_day, #n_seconds_to_n_days, #namespace?, #no_ext_name, #no_file_exists_at, #number_to_month, #obtain, #obtain_lectures_from_this_curriculum, #open_in_browser, #open_in_editor, #opne, #opnerev, #opnn, #padded_current_month?, #parse_dd_mm_yyyy, #parse_this_line_for_date_entry, #path_to_exam_topic?, #project_yaml_directory?, #rds, #read_dataset_from_a_curriculum_file, #read_in_exam_dataset_from_this_file, #read_this_file_with_default_encoding, #readlines_from_this_input_file, #register_sigint, #remove_empty_strings, #remove_escape_sequences, #remove_internal_comments, #remove_leading_comments, #remove_leading_weekday_names_from, #remove_newlines, #remove_tags_from_this_input, #rename_kde_konsole_tab, #rename_konsole_tab?, #replace_all_html_colours_in_this, #replace_bold_token_with_default_colour, #replace_italic_token_with_default_colour, #replace_italic_token_with_this_colour, #replace_regular_numbers_with_unicode_numbers, #replace_underline_token_with_default_colour, #replace_underline_token_with_this_colour, #require_open_uri, #reset_the_internal_state, #return_all_bachelor_lectures, #return_all_exams_on_this_day, #return_all_numbers_from, #return_all_registered_curricula, #return_all_steop_lectures, #return_current_year, #return_dataset_for_this_topic, #return_dataset_from_this_curriculum_file, #return_dd_mm_yy_and_time_from, #return_directory_for, #return_ects_points_from_these_lectures, #return_either_grey_or_the_custom_colour_for_answers, #return_either_grey_or_the_custom_colour_for_questions, #return_file_for_this_curriculum, #return_german_name_for_this_english_month, #return_german_weekday_of?, #return_hh_mm_ss_from, #return_hour_from_this, #return_lectures_from_bachelor_vektor_curriculum, #return_lectures_with_at_the_least_one_upcoming_exam, #return_local_path_of_this_pwdstud, #return_lva_number_of_this_lecture, #return_month_fitting_to_this_input, #return_n_days_until_monday, #return_n_days_until_sunday, #return_n_exam_questions_in, #return_n_questions_were_answered_for_this_topic, #return_name_of_the_weekday, #return_name_of_this_curriculum, #return_name_of_this_curriculum_based_on_its_id_number, #return_opnn, #return_passed_courses, #return_pwd, #return_random_curriculum, #return_sanitized_dataset_from_the_file_lecture_information, #return_solved_lectures, #return_steop_lectures, #return_the_remote_homepage_url, #return_this_line_has_n_characters_as_html_colour_tags, #return_title_from_this_curriculum_file, #right_arrow?, #rinstall2, #roebe_exam_directory?, #roebe_path_to_file_lecture_information?, #ruby_src_dir_at_home?, #sanitize_this_topic, #sanitize_url, #select_for_prüfungsimmanente_LVs, #select_lectures_with_this_key, #set_be_verbose, #set_this_cd_alias_to, #set_xorg_buffer, #sfancy, #shall_we_make_use_of_unicode_symbols?, #show_todays_date, #silently_open_in_browser, #simp, #sort_these_lecture_names_by_time, #spacer, #studium_log_dir?, #this_month_has_n_days?, #total_ects_points_passed, #translate_dd_mm_yyyy_to_weekday, #try_to_require_html_templates, #try_to_require_the_open_gem, #try_to_require_the_rcfiles, #try_to_require_the_verbose_truth_gem, #turn_this_array_into_the_full_dataset, #unicode_blocks_line, #use_colours?, #use_opn?, #vertical_bar?, #web_liner, #weekday?, #weekdays?, #word_wrap, #write_what_into, #www_connection_is_unavailable, #yaml_dir?, #yellowrev, #yes_or_no

Methods included from RunmodeModule

#commandline?, #runmode?, #set_commandline_mode, #set_runmode, #set_www_mode, #www_mode?

Methods included from CommandlineArgumentsModule

#commandline_arguments?, #commandline_arguments_joined, #commandline_arguments_with_hyphens?, #commandline_arguments_without_leading_hyphens?, #first_argument?, #first_non_hyphen_argument?, #reset_the_commandline_arguments, #set_commandline_arguments, #set_first_argument

Methods included from HtmlColoursModule

#aquamarine, #blanchedalmond, #brown, #cadetblue, #chocolate, #coral, #cornflowerblue, #crimson, #cyan, #darkblue, #darkcyan, #darkgoldenrod, #darkgreen, #darkkhaki, #darkolivegreen, #darkorange, #darkred, #darkseagreen, #darkslateblue, #darkslategray, #darkturquoise, #deepskyblue, #firebrick, #forestgreen, #gold, #goldenrod, #green, #grey, #indianred, #khaki, #lavender, #lawngreen, #lightblue, #lightcoral, #lightgreen, #lightred, #lightseagreen, #lightskyblue, #lightslategray, #lightslategrey, #lime, #limegreen, #mediumaquamarine, #mediumblue, #mediumpurple, #mediumseagreen, #mediumslateblue, #mediumspringgreen, #mediumturquoise, #mediumvioletred, #mintcream, #moccasin, #oldlace, #olive, #olivedrab, #orange, #orangered, #orchid, #palegoldenrod, #palegreen, #paleturquoise, #palevioletred, #peru, #plum, #powderblue, #red, #rosybrown, #royalblue, #saddlebrown, #salmon, #sandybrown, #seagreen, #sienna, #silver, #skyblue, #slateblue, #slategray, #springgreen, #steelblue, #tan, #teal, #thistle, #tomato, #turquoise, #violet, #whitesmoke, #yellow, #yellowgreen

Methods included from Colours

#bold_blue, #bold_red, #bold_yellow, cadetblue, #cadetblue, #chartreuse, #coral, coral, #cornflowerblue, cornflowerblue, crimson, #cyan, cyan, darkgoldenrod, #darkgoldenrod, #darkgray, darkgreen, darkolivegreen, darkseagreen, #darkslateblue, darkslateblue, #darkslategray, darkslategray, #darkturquoise, darkturquoise, #deepskyblue, deepskyblue, default_colour, #dimgray, disable_colours, #dodgerblue, e, #efancy, enable_colours, #erev, #ewarn, #forestgreen, forestgreen, gold, #goldenrod, goldenrod, #grey, grey, indianred, #indianred, khaki, #khaki, lawngreen, #lawngreen, lightblue, lightgreen, lightsalmon, #lightseagreen, lightseagreen, lightskyblue, #lightskyblue, #lightslategray, lightslategray, #lightsteelblue, lime, #lime, limegreen, #limegreen, #mediumaquamarine, mediumaquamarine, #mediumorchid, #mediumpurple, mediumpurple, #mediumseagreen, mediumseagreen, #mediumslateblue, mediumslateblue, #mediumspringgreen, mediumspringgreen, #mediumturquoise, mediumturquoise, #oldlace, olive, #olive, olivedrab, #olivedrab, orange, orangered, #orchid, orchid, palegreen, #palegreen, paleturquoise, #paleturquoise, palevioletred, #papayawhip, peru, #peru, plum, #plum, #powderblue, powderblue, rev, #rev?, royalblue, saddlebrown, #saddlebrown, #sandybrown, sandybrown, sdir, #sdir, seagreen, #seagreen, sfancy, #sfancy, sfile, #sfile, #simp, simp, #skyblue, skyblue, slateblue, #slategray, slategray, springgreen, #springgreen, #steelblue, steelblue, #swarn, swarn, #tan, tan, teal, #teal, #tomato, tomato, turquoise, use_colours?, use_this_colour_for_exam_answers, use_this_colour_for_exam_questions, #yellow, yellowgreen, #yellowgreen

Constructor Details

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

#

initialize

#


33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/studium/gui/universal_widgets/show_upcoming_exams/show_upcoming_exams.rb', line 33

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

#

Studium::GUI::UniversalWidgets::ShowUpcomingExams[]

#


244
245
246
 
# File 'lib/studium/gui/universal_widgets/show_upcoming_exams/show_upcoming_exams.rb', line 244

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

.run(i = ARGV) ⇒ Object

#

Studium::GUI::Gtk::ShowUpcomingExams.run

#


226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/studium/gui/universal_widgets/show_upcoming_exams/show_upcoming_exams.rb', line 226

def self.run(
    i = ARGV
  )
  require 'gtk_paradise/run'
  _ = ::Studium::GUI::Gtk::ShowUpcomingExams.new(i)
  r = ::Gtk.run
  r << _
  _.set_parent_widget(r)
  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

#connect_the_skeleton ⇒ Object

#

connect_the_skeleton (connect tag)

#


97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/studium/gui/universal_widgets/show_upcoming_exams/show_upcoming_exams.rb', line 97

def connect_the_skeleton
  abort_on_exception

  outer_vbox = create_vbox # A new vbox.

  populate_the_liststore
  header_upcoming_exams = h1('Upcoming exams') # '•'
  header_upcoming_exams.align_to_the_left
  header_upcoming_exams.make_bold
  hbox = create_hbox
  hbox.minimal(image_starred, 10)
  hbox.maximal(header_upcoming_exams, 0)
  outer_vbox.minimal(hbox)
  outer_vbox.maximal(@scrolled_window, 2)

  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.set_size_request(width?, height?)
  window.set_default_size(width?, height?)
  window.top_left
  do_all_startup_related_actions
  run_main
end

#create_the_liststore ⇒ Object

#

create_the_liststore

#


209
210
211
 
# File 'lib/studium/gui/universal_widgets/show_upcoming_exams/show_upcoming_exams.rb', line 209

def create_the_liststore
  @list_store = ::Gtk::ListStore.new(*([String] * 3))
end

#create_the_scrolled_window ⇒ Object

#

create_the_scrolled_window

#


82
83
84
85
 
# File 'lib/studium/gui/universal_widgets/show_upcoming_exams/show_upcoming_exams.rb', line 82

def create_the_scrolled_window
  @scrolled_window = create_scrolled_window(@tree_view) { :automatic_scrolling }
  @scrolled_window.set_size_request(400, 200)
end

#create_the_skeleton ⇒ Object

#

create_the_skeleton (create tag, skeleton tag)

#


216
217
218
219
220
221
 
# File 'lib/studium/gui/universal_widgets/show_upcoming_exams/show_upcoming_exams.rb', line 216

def create_the_skeleton
  @renderer = create_cell_renderer_text
  create_the_liststore
  create_the_treeview
  create_the_scrolled_window
end

#create_the_treeview(i = @list_store) ⇒ Object

#

create_the_treeview

#


196
197
198
199
200
201
202
203
204
 
# File 'lib/studium/gui/universal_widgets/show_upcoming_exams/show_upcoming_exams.rb', line 196

def create_the_treeview(
    i = @list_store
  )
  @tree_view = create_tree_view(i)
  @tree_view.deselect_on_right_click
  @tree_view.use_this_font = USE_THIS_FONT_FOR_THE_TREE_VIEW
  @tree_view.enable_drag_and_drop
  @tree_view.enable_search
end

#handle_CSS_rules ⇒ Object

#

handle_CSS_rules (CSS tag)

#


73
74
75
76
77
 
# File 'lib/studium/gui/universal_widgets/show_upcoming_exams/show_upcoming_exams.rb', line 73

def handle_CSS_rules
  use_gtk_paradise_project_css_file
  append_project_css_file
  more_CSS_then_apply_it(USE_THESE_CSS_RULES)
end

#populate_the_liststore(list_store = @list_store) ⇒ Object

#

populate_the_liststore

#


136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
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
 
# File 'lib/studium/gui/universal_widgets/show_upcoming_exams/show_upcoming_exams.rb', line 136

def populate_the_liststore(
    list_store = @list_store
  )
  # ======================================================================= #
  # First, set up the three headers via a convenience method.
  # ======================================================================= #
  @tree_view.use_these_headers(
    '#', 'Name of the course', 'Exam Date'
  )
  @tree_view.use_clickable_headers
  @tree_view.is_resizeable
  # ======================================================================= #
  # If we want to align a column to the middle we could use the following
  # line of code:
  #   @tree_view.get_column(1).align_to_the_middle
  # ======================================================================= #
  index = 0
  @dataset.each {|the_name_of_the_course, inner_hash| index += 1
    name_of_the_course = the_name_of_the_course
    exam_date = inner_hash['exams'] # Obtain the next exam date here.
    if exam_date.is_a? Array
      exam_date = exam_date.first
    end
    iter = list_store.append
    iter[0] = index.to_s 
    iter[1] = name_of_the_course
    if exam_date
      iter[2] = exam_date.squeeze(' ')
    else
      e '(Upcoming exams in a gtk-tree-view) '\
        'Problem with '+the_name_of_the_course.to_s
    end
  }
  # ======================================================================= #
  # Allow sorting on the last entry of the TreeView:
  # ======================================================================= #
  list_store.set_sort_func(2) { |_model, iter1, iter2|
    value1 = remove_german_weekdays(iter1[2].to_s).strip
    if value1.include?(',')
      value1 = value1.split(',').first
    end
    value2 = remove_german_weekdays(iter2[2].to_s).strip
    if value2.include?(',')
      value2 = value2.split(',').first
    end
    value1 = ::Time.parse(value1)
    value2 = ::Time.parse(value2)
    value1 <=> value2
  }
  # ======================================================================= #
  # Sort on the index:
  # ======================================================================= #
  list_store.set_sort_func(0) { |_model, iter1, iter2|
    iter1[0].to_i <=> iter2[0].to_i
  }
end

#reset ⇒ Object

#

reset (reset tag)

#


50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/studium/gui/universal_widgets/show_upcoming_exams/show_upcoming_exams.rb', line 50

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

#run ⇒ Object

#

run (run tag)

#


90
91
92
 
# File 'lib/studium/gui/universal_widgets/show_upcoming_exams/show_upcoming_exams.rb', line 90

def run
  run_super
end