gtk_paradise 0.9.120 → 0.12.25

data/lib/gtk_paradise/widgets/shared_code/mini_clock/mini_clock_module.rb

@@ -2,9 +2,23 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
+# This widget has to remain somewhat flexible, so that we can still use
+# API elements such as:
+#
+#   ::Gtk::MiniClock.widget {{
+#     make_bold:        true,
+#     use_this_colour: :olive
+#   }}
+#
+# =========================================================================== #    
 # require 'gtk_paradise/widgets/shared_code/mini_clock/mini_clock_module.rb'
 # include ::Gtk::MiniClockModule
 # =========================================================================== #
+# For ruby-gtk3 use the following require line:
+#
+#   require 'gtk_paradise/widgets/gtk3/mini_clock/mini_clock.rb'
+#
+# =========================================================================== #
 module Gtk
 
 module MiniClockModule
@@ -12,11 +26,6 @@ module MiniClockModule
   require 'gtk_paradise/requires/require_the_base_module.rb'
   include ::Gtk::BaseModule
 
-  # ========================================================================= #
-  # === NAMESPACE
-  # ========================================================================= #
-  NAMESPACE = inspect
-
   # ========================================================================= #
   # === MAIN_FONT_SIZE
   # ========================================================================= #
@@ -42,54 +51,73 @@ module MiniClockModule
   # ========================================================================= #
   def initialize(
       i           = nil,
-      run_already = true
+      run_already = true,
+      &block
     )
     super(:vertical)
-    set_title(TITLE) if respond_to? :set_title
     reset
+    set_title(TITLE) if respond_to? :set_title
     # ======================================================================= #
     # === Handle blocks given next
     # ======================================================================= #
     if block_given?
       yielded = yield
-      case yielded
-      # ===================================================================== #
-      # === :do_not_show_the_seconds
       # ===================================================================== #
-      when :do_not_show_the_seconds
-        @show_the_seconds = false
+      # === Handle Hashes first
       # ===================================================================== #
-      # === :make_bold
-      # ===================================================================== #
-      when :make_bold,
-           :bold
-        @make_bold = true
+      if yielded.is_a? Hash
+        # =================================================================== #
+        # === :make_bold
+        # =================================================================== #
+        if yielded.has_key? :make_bold
+          set_make_bold(yielded.delete(:make_bold))
+        end
+        # =================================================================== #
+        # === :use_this_colour
+        # =================================================================== #
+        if yielded.has_key? :use_this_colour
+          set_use_this_colour(yielded.delete(:use_this_colour))
+        end
+      else
+        # =================================================================== #
+        # Handle Symbols past this point here
+        # =================================================================== #
+        case yielded
+        # =================================================================== #
+        # === :do_not_show_the_seconds
+        # =================================================================== #
+        when :do_not_show_the_seconds
+          @show_the_seconds = false
+        # =================================================================== #
+        # === :make_bold
+        # =================================================================== #
+        when :make_bold,
+             :bold
+          set_make_bold(true)
+        end
       end
     end
     run if run_already
   end
 
+  # ========================================================================= #
+  # === set_make_bold
+  # ========================================================================= #
+  def set_make_bold(i = true)
+    @make_bold = i
+  end
+
   # ========================================================================= #
   # === reset                                                     (reset tag)
   # ========================================================================= #
   def reset
     reset_the_internal_variables
+    infer_the_namespace
     # ======================================================================= #
     # === @configuration
     # ======================================================================= #
-    @configuration = [true, __dir__, NAMESPACE]
-    # ======================================================================= #
-    # === @title
-    # ======================================================================= #
-    @title  = TITLE
-    # ======================================================================= #
-    # === @width
-    # ======================================================================= #
-    set_width(WIDTH)
-    # ======================================================================= #
-    # === @height
-    # ======================================================================= #
-    set_height(HEIGHT)
+    @configuration = [true, __dir__, namespace?]
+    title_width_height(TITLE, WIDTH, HEIGHT)
     # ======================================================================= #
     # === @make_bold
     #
@@ -112,39 +140,32 @@ module MiniClockModule
     infer_the_size_automatically
   end
 
-  # ========================================================================= #
-  # === determine_the_main_font_size
-  # ========================================================================= #
-  def determine_the_main_font_size
-    @label.set_font_size(MAIN_FONT_SIZE)
-  end
-
-  # ========================================================================= #
-  # === update_label_continually
-  #
-  # This method will update the current time constantly.
-  # ========================================================================= #
-  def update_label_continually
-    Thread.new {
-      loop {
-        sleep 1
-        update_current_time
-      }
-    }
-  end
-
   # ========================================================================= #
   # === set_use_this_colour
   # ========================================================================= #
   def set_use_this_colour(i)
     @use_this_colour = i.to_sym
+    if @label
+      apply_the_colours_to_the_main_label # And do this since as of August 2022.
+    end
+  end; alias use_this_colour= set_use_this_colour # === use_this_colour=
+
+  # ========================================================================= #
+  # === create_the_main_label
+  # ========================================================================= #
+  def create_the_main_label
+    # ======================================================================= #
+    # === @label
+    # ======================================================================= #
+    @label = label
+    @label.hint = 'This small widget will show the current (local) time.'
   end
 
   # ========================================================================= #
-  # === create_skeleton
+  # === create_skeleton                                          (create tag)
   # ========================================================================= #
   def create_skeleton
-    @label = gtk_label
+    create_the_main_label
     update_current_time # Set the time at once.
     determine_the_main_font_size
     @alignment = gtk_alignment(0.25, 0.25, 0.8, 0.2)
@@ -152,46 +173,45 @@ module MiniClockModule
   end
 
   # ========================================================================= #
-  # === connect_skeleton
+  # === connect_skeleton                                        (connect tag)
   # ========================================================================= #
   def connect_skeleton
     maximal(@alignment, 1)
   end
 
   # ========================================================================= #
-  # === run                                                         (run tag)
+  # === apply_the_colours_to_the_main_label
   # ========================================================================= #
-  def run
-    create_skeleton_then_connect_skeleton
-    update_label_continually
+  def apply_the_colours_to_the_main_label
+    @label.set_use_this_colour(@use_this_colour)
   end
 
   # ========================================================================= #
-  # === Gtk::MiniClock[]
+  # === determine_the_main_font_size
   # ========================================================================= #
-  def self.[](i = '')
-    new
+  def determine_the_main_font_size(i = MAIN_FONT_SIZE)
+    @label.set_font_size(i)
   end
 
   # ========================================================================= #
-  # === Gtk::MiniClockModule.run
+  # === set_the_font_of_the_main_label
   # ========================================================================= #
-  def self.run
-    require 'gtk_paradise/run'
-    _ = Gtk::MiniClock.new(ARGV)
-    r = ::Gtk.run
-    r.set_size_request(_.width?, _.height?)
-    r.signal_connect(:delete_event) { |_widget| Gtk.main_quit }
-    r << _
-    r.automatic_title
-    r.top_left_then_run
+  def set_the_font_of_the_main_label(i)
+    @label.use_this_font = i
   end
 
   # ========================================================================= #
-  # === Gtk::MiniClockModule.widget
+  # === update_label_continually
+  #
+  # This method will update the current time constantly.
   # ========================================================================= #
-  def self.widget(&block)
-    ::Gtk::MiniClock.new(&block)
+  def update_label_continually
+    Thread.new {
+      loop {
+        sleep 1
+        update_current_time
+      }
+    }
   end
 
   # ========================================================================= #
@@ -210,7 +230,43 @@ module MiniClockModule
     else
       @label.set_text(the_current_time)
     end
-    @label.set_use_this_colour(@use_this_colour)
+    apply_the_colours_to_the_main_label
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    create_skeleton_then_connect_skeleton
+    update_label_continually
+  end
+
+  # ========================================================================= #
+  # === Gtk::MiniClock[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+  # ========================================================================= #
+  # === Gtk::MiniClockModule.widget
+  # ========================================================================= #
+  def self.widget(&block)
+    ::Gtk::MiniClock.new(&block)
+  end; self.instance_eval { alias return_clock_widget widget } # === Gtk.return_clock_widget
+
+  # ========================================================================= #
+  # === Gtk::MiniClockModule.run
+  # ========================================================================= #
+  def self.run
+    require 'gtk_paradise/run'
+    _ = Gtk::MiniClock.new(ARGV)
+    r = ::Gtk.run
+    r.set_size_request(_.width?, _.height?)
+    r.signal_connect(:delete_event) { |_widget| Gtk.main_quit }
+    r << _
+    r.automatic_title
+    r.top_left_then_run
   end
 
 end
@@ -223,6 +279,7 @@ def self.return_simple_clock_widget(&block)
 end; self.instance_eval { alias clock                      return_simple_clock_widget } # === Gtk.clock
      self.instance_eval { alias return_clock               return_simple_clock_widget } # === Gtk.return_clock
      self.instance_eval { alias return_simple_clock_widget return_simple_clock_widget } # === Gtk.return_simple_clock_widget
+     self.instance_eval { alias return_clock_widget        return_simple_clock_widget } # === Gtk.return_clock_widget
      self.instance_eval { alias mini_clock                 return_simple_clock_widget } # === Gtk.mini_clock
-
+  
 end

data/lib/gtk_paradise/widgets/shared_code/my_calendar/my_calendar_module.rb

@@ -1,327 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# === Gtk::MyCalendarModule
-# =========================================================================== #
-# require 'gtk_paradise/widgets/shared_code/my_calendar/my_calendar_module.rb'
-# include ::Gtk::MyCalendarModule
-# =========================================================================== #
-module Gtk
-
-module MyCalendarModule
-
-  require 'gtk_paradise/requires/require_the_base_module.rb'
-  include ::Gtk::BaseModule
-
-  # ========================================================================= #
-  # === NAMESPACE
-  # ========================================================================= #
-  NAMESPACE = inspect
-
-  # ========================================================================= #
-  # === TITLE
-  # ========================================================================= #
-  TITLE = 'My Calendar'
-
-  # ========================================================================= #
-  # === WIDTH
-  # ========================================================================= #
-  WIDTH = 1200
-
-  # ========================================================================= #
-  # === HEIGHT
-  # ========================================================================= #
-  HEIGHT = 500
-
-  # ========================================================================= #
-  # === initialize
-  # ========================================================================= #
-  def initialize(
-      run_already   = true
-    )
-    super(:vertical)
-    reset
-    run if run_already
-  end
-
-  # ========================================================================= #
-  # === reset
-  # ========================================================================= #
-  def reset
-    reset_the_internal_variables
-    # ======================================================================= #
-    # === @configuration
-    # ======================================================================= #
-    @configuration = [true, __dir__, NAMESPACE]
-    # ======================================================================= #
-    # === @title
-    # ======================================================================= #
-    @title = TITLE
-    # ======================================================================= #
-    # === @width
-    # ======================================================================= #
-    set_width(WIDTH)
-    # ======================================================================= #
-    # === @height
-    # ======================================================================= #
-    set_height(HEIGHT)
-    # ======================================================================= #
-    # === @day
-    # ======================================================================= #
-    @day   = nil
-    # ======================================================================= #
-    # === @month
-    # ======================================================================= #
-    @month = nil
-    # ======================================================================= #
-    # === @year
-    # ======================================================================= #
-    @year  = nil
-    # ======================================================================= #
-    # === @verbose_on_the_commandline
-    #
-    # If this variable is true then we will be verbose on the commandline.
-    # ======================================================================= #
-    @verbose_on_the_commandline = true
-    set_use_this_font(:dejavu_condensed_22)
-    use_gtk_paradise_project_css_file
-  end
-
-  # ========================================================================= #
-  # === padding?
-  # ========================================================================= #
-  def padding?
-    2
-  end
-
-  # ========================================================================= #
-  # === border_size?
-  # ========================================================================= #
-  def border_size?
-    2
-  end
-
-  # ========================================================================= #
-  # === day?
-  # ========================================================================= #
-  def day?
-    @day
-  end
-
-  # ========================================================================= #
-  # === month?
-  # ========================================================================= #
-  def month?
-    @month
-  end
-
-  # ========================================================================= #
-  # === year?
-  # ========================================================================= #
-  def year?
-    @year
-  end
-
-  # ========================================================================= #
-  # === update_time
-  # ========================================================================= #
-  def update_time
-    @date = Time.new
-    @year = @date.year
-  end
-
-  # ========================================================================= #
-  # === mark_special_day
-  #
-  # Disabled.
-  # ========================================================================= #
-  def mark_special_days
-    # puts "Now marking..."
-    # self.mark_day(24)
-  end
-
-  # ========================================================================= #
-  # === set_day
-  # ========================================================================= #
-  def set_day(i)
-    @day = i
-  end
-
-  # ========================================================================= #
-  # === set_month
-  # ========================================================================= #
-  def set_month(i)
-    @month = i
-  end
-
-  # ========================================================================= #
-  # === set_year
-  # ========================================================================= #
-  def set_year(i)
-    @year = i
-  end
-
-  # ========================================================================= #
-  # === connect_base
-  # ========================================================================= #
-  def connect_base
-    @calendar = ::Gtk::Calendar.new
-    @calendar.select_month(@date.month, @date.year)
-    @calendar.select_day(@date.day)
-    @calendar.mark_day(@date.day)
-    # self.clear_marks
-    if ::Gtk.use_gtk2?
-      @calendar.set_display_options(
-        ::Gtk::Calendar::SHOW_HEADING      |
-        ::Gtk::Calendar::SHOW_DAY_NAMES    |
-        ::Gtk::Calendar::SHOW_WEEK_NUMBERS |
-        ::Gtk::Calendar::WEEK_START_MONDAY
-      )
-    else
-      @calendar.set_display_options(
-        ::Gtk::CalendarDisplayOptions::SHOW_HEADING      |
-        ::Gtk::CalendarDisplayOptions::SHOW_DAY_NAMES    |
-        ::Gtk::CalendarDisplayOptions::SHOW_WEEK_NUMBERS
-      )
-    end
-    report_dd_mm_yyyy
-  end
-
-  # ========================================================================= #
-  # === report_dd_mm_yyyy
-  # ========================================================================= #
-  def report_dd_mm_yyyy(
-      dd_mm_yyyy_string = return_dd_mm_yyy_string
-    )
-    e "#{::Colours.rev}The date is #{teal(dd_mm_yyyy_string)}"
-  end
-
-  # ========================================================================= #
-  # === return_dd_mm_yyy_string
-  # ========================================================================= #
-  def return_dd_mm_yyy_string
-    update_time
-    year, month, day = @date.year, @date.month, @date.day
-    result = "#{day.to_s.rjust(2, '0')}.#{month.to_s.rjust(2,'0')}.#{year}"
-    return result
-  end
-
-  # ========================================================================= #
-  # === connect_signals
-  #
-  # The calendar responds to:
-  #
-  #   :day_selected
-  #   :month_changed
-  #   :day_selected_double_click
-  #   :prev_month
-  #   :next_month
-  #   :prev_year
-  #   :next_year
-  #
-  # ========================================================================= #
-  def connect_signals
-    @calendar.on_day_selected {
-      # ===================================================================== #
-      # This clause is entered when the user selects the current time/date,
-      # on a mouse-click event.
-      # ===================================================================== #
-      _ = return_dd_mm_yyy_string
-      @entry_current_selection.set_text(_.to_s)
-      if @verbose_on_the_commandline
-        year, month, day = @date
-        cliner
-        set_day(day)
-        set_month(month)
-        set_year(year)
-        e "Selected day:    #{teal(day)}"
-        e "Selected month:  #{teal(month)}"
-        report_dd_mm_yyyy(_)
-        cliner
-      end
-    }
-    @calendar.signal_connect(:month_changed) {
-      month = @date.month
-      e "changed month: #{month}"
-    }
-    @calendar.signal_connect(:day_selected_double_click) {
-      day = @date.day
-      e "double-clicked day: #{day}"
-    }
-    @calendar.signal_connect(:prev_month) {
-      month = @date.month
-      e "prev month: #{month}"
-    }
-    @calendar.signal_connect(:next_month) {
-      month = @date.month
-      e "next_month: #{month}"
-    }
-    @calendar.signal_connect(:prev_year) {
-      year = @date.year
-      e "prev_year: #{year}"
-    }
-    @calendar.signal_connect(:next_year) {
-      year = @date.year
-      e "next year: #{year}"
-    }
-  end
-
-  # ========================================================================= #
-  # === teal
-  # ========================================================================= #
-  def teal(i = '')
-    ::Colours.teal(i.to_s)
-  end
-
-  # ========================================================================= #
-  # === Gtk::MyCalendar.width?
-  # ========================================================================= #
-  def self.width?
-    450
-  end
-
-  # ========================================================================= #
-  # === Gtk::MyCalendar.height?
-  # ========================================================================= #
-  def self.height?
-    350
-  end
-
-  # ========================================================================= #
-  # === connect_skeleton
-  # ========================================================================= #
-  def connect_skeleton
-    connect_base
-    connect_signals
-  end
-
-  # ========================================================================= #
-  # === run
-  # ========================================================================= #
-  def run
-    update_time
-    connect_skeleton
-    mark_special_days
-    maximal(@calendar)
-    @entry_current_selection = gtk_entry
-    @entry_current_selection.to_center
-    add(@entry_current_selection)
-  end
-
-  # ========================================================================= #
-  # === Gtk::MyCalendarModule.run
-  # ========================================================================= #
-  def self.run
-    require 'gtk_paradise/run'
-    _ = ::Gtk::MyCalendar.new
-    r = ::Gtk.run
-    r << _
-    r.set_size_request(
-      _.width?,
-      _.height?
-    )
-    r.top_left_then_run
-  end
-
-end; end