gtk_paradise 0.9.120 → 0.12.25

data/lib/gtk_paradise/gtk_classes/hbox.rb

@@ -0,0 +1,145 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Gtk::HBox
+#
+# This variant should only be pulled in if we are using ruby-gtk2.
+# =========================================================================== #
+# require 'gtk_paradise/gtk_classes/hbox.rb'
+# =========================================================================== #
+require 'gtk_paradise/toplevel_methods/determine_which_gtk_version_is_in_use.rb'
+
+return unless Gtk.do_we_use_gtk2?
+
+module Gtk
+
+class HBox
+
+  alias pack pack_start # === pack
+
+  # ========================================================================= #
+  # === add_these
+  #
+  # This method can be used to batch-add other widget into the VBox,
+  # such as if you'd normally call add() yourself.
+  # ========================================================================= #
+  def add_these(*widgets)
+    widgets.each {|this_widget|
+      add(this_widget)
+    }
+  end
+
+end
+
+# =========================================================================== #
+# === Gtk.padded_hbox
+# =========================================================================== #
+def self.padded_hbox(
+    n_padding_to_use = 8
+  )
+  _ = hbox
+  _.set_border_width(n_padding_to_use)
+  return _
+end
+
+# =========================================================================== #
+# === Gtk.create_paned_hbox
+#
+# This method will create a HBox with several widgets inside of it.
+#
+# The widgets go into the only parameter for this method, aptly
+# called *widgets.
+#
+# You can pass in a block to specify the (optional) padding.
+#
+# An example for this would be:
+#
+#   Gtk.create_paned_hbox(widget1, widget2) { 10 }
+#
+# Usage examples:
+#
+#   Gtk.create_paned_hbox(Gtk::Button.new,Gtk::Button.new, Gtk::Button.new)
+#   Gtk.create_paned_hbox(widget1, widget2)
+#   Gtk.paned(a, b, c)
+#
+# =========================================================================== #
+def self.create_paned_hbox(*widgets)
+  widgets.flatten!
+  default_padding = block_given? ? yield : 2
+  # if do_we_use_gtk2?
+    hbox = Gtk::HBox.new
+  # else
+  #   hbox = Gtk::Box.new(:horizontal)
+  # end
+  widgets.size.times { |entry| # Next batch-add it onto the hbox here.
+    hbox.pack_start(widgets[entry],true,true, default_padding)
+  }
+  return hbox.show
+end; self.instance_eval { alias chbox       create_paned_hbox } # === Gtk.chbox
+     self.instance_eval { alias create_hbox create_paned_hbox } # === Gtk.create_hbox
+     self.instance_eval { alias hbox        create_paned_hbox } # === Gtk.hbox
+     self.instance_eval { alias add_hbox    create_paned_hbox } # === Gtk.add_hbox
+     self.instance_eval { alias hpaned      create_paned_hbox } # === Gtk.hpaned
+     self.instance_eval { alias paned_hbox  create_paned_hbox } # === Gtk.paned_hbox
+
+# =========================================================================== #
+# === Gtk.create_paned_hbox_last_big
+#
+# First widget takes up most space here. hbox means "horizontal box".
+#
+# Usage example via the gtk-paradise gem:
+#
+#   Gtk.create_paned_hbox_last_bigg(gtk_button, gtk_button, gtk_button)
+#
+# =========================================================================== #
+def self.create_paned_hbox_last_big(*widgets)
+  how_many_slots = widgets.size
+  hbox = ::Gtk::HBox.new
+  how_many_slots.times { |t|
+    case t
+    when 0
+      hbox.pack_start(widgets[t], false, true,1)
+    else
+      hbox.pack_start(widgets[t], true, true, 1)
+    end
+  }
+  return hbox.show
+end
+
+# =========================================================================== #
+# === Gtk.create_paned_hbox_first_big
+#
+# First widget takes up most space here.
+#
+#   Gtk.create_paned_hbox_first_big(Gtk::Button.new, Gtk::Button.new, Gtk::Button.new)
+#
+# =========================================================================== #
+def self.create_paned_hbox_first_big(*widgets)
+  widgets.flatten! # Don't forget to flatten here.
+  hbox = ::Gtk::HBox.new
+  widgets.size.times { |t|
+    if t == 0
+      hbox.pack_start(widgets[t], true, true, 1)
+    else
+      hbox.pack_start(widgets[t], false, true,1)
+    end
+  }
+  return hbox.show
+end
+
+# =========================================================================== #
+# === Gtk.create_hbox
+# =========================================================================== #
+def self.create_hbox(i = ARGV)
+  # The arguments are currently ignored.
+  ::Gtk::HBox.new
+end; self.instance_eval { alias hbox        create_hbox } # === Gtk.hbox
+     self.instance_eval { alias return_hbox create_hbox } # === Gtk.return_hbox
+
+# =========================================================================== #
+# === Add an alias to HBox if we use ruby-gtk2
+# =========================================================================== #
+Hbox = HBox
+
+end # end the gtk2-check.

data/lib/gtk_paradise/gtk_classes/header_bar.rb

@@ -8,7 +8,26 @@
 # =========================================================================== #
 module Gtk
 
-class HeaderBar
+class HeaderBar # === Gtk::HeaderBar
+
+  # ========================================================================= #
+  # These aliases are used to designate another main widget in use, for
+  # a Gtk::HeaderBar.
+  # ========================================================================= #
+  if respond_to?(:set_custom_title) # ruby-gtk2 does not have support for this.
+    alias use_this_as_the_main_widget set_custom_title # === use_this_as_the_main_widget
+    alias widget=                     set_custom_title # === widget=
+    alias central_element             set_custom_title # === central_element
+  end
+
+  # ========================================================================= #
+  # === set_main_title
+  # ========================================================================= #
+  def set_main_title(i)
+    set_title(i)
+  end; alias middle_text set_main_title # === middle_text
+       alias text        set_main_title # === text
+       alias main_text=  set_main_title # === main_text=
 
   # ========================================================================= #
   # === add_right
@@ -39,13 +58,6 @@ class HeaderBar
        alias pack_left  add_left # === pack_left
        alias place_left add_left # === place_left
 
-  # ========================================================================= #
-  # === set_main_title
-  # ========================================================================= #
-  def set_main_title(i)
-    set_title(i)
-  end; alias middle_text set_main_title # === middle_text
-
 end
 
 # =========================================================================== #

data/lib/gtk_paradise/gtk_classes/image.rb

@@ -8,10 +8,12 @@
 # =========================================================================== #
 module Gtk
 
-class Image
+class Image # === Gtk::Image
 
-  alias set_location set_file # === set_location
-  alias set_path     set_file # === set_path
+  alias set_location   set_file # === set_location
+  alias set_path       set_file # === set_path
+  alias use_this_path= set_file # === use_this_path=
+  alias path=          set_file # === path=
 
   # ========================================================================= #
   # === align_to_the_left

data/lib/gtk_paradise/gtk_classes/label.rb

@@ -15,9 +15,130 @@ class Label # === Gtk::Label
   require 'gtk_paradise/toplevel_methods/determine_which_gtk_version_is_in_use.rb'
 
   # ========================================================================= #
-  # The next alias is to allow "tilted", aka slanted, text.
+  # === make_selectable
+  #
+  # This will make the given Gtk::Label selectable.
+  # ========================================================================= #
+  def make_selectable
+    self.selectable = true
+  end; alias enable_on_click_actions make_selectable # === enable_on_click_actions
+       alias is_selectable           make_selectable # === is_selectable
+
+  # ========================================================================= #
+  # === reposition_the_cursor_to_the_right
   # ========================================================================= #
-  alias left_rotate angle= # === left_rotate
+  def reposition_the_cursor_to_the_right
+    #_ = text?
+    # set_cursor_position(_.size - 1)
+    # do_move_cursor(step, count, extend_selection)
+  end
+
+  # ========================================================================= #
+  # === cursor_is_on_the_right
+  #
+  # This does not work. For some selectable labels we should be able to
+  # position the cursor programmatically.
+  # ========================================================================= #
+  # def cursor_is_on_the_right
+  #   self.position = -1
+  # end
+
+  # ========================================================================= #
+  # === set_bold_text
+  # ========================================================================= #
+  def set_bold_text(i)
+    set_text(i.to_s)
+    make_bold
+  end
+
+  # ========================================================================= #
+  # === make_bold
+  #
+  # This method will make the whole Gtk::Label instance bold.
+  #
+  # The second argument will determine whether we will use a mnemonic or 
+  # whether we will not.
+  # ========================================================================= #  
+  def make_bold(
+      old_text     = text,
+      use_mnemonic = :default
+    )
+    case old_text
+    # ======================================================================= #
+    # === :default
+    #
+    # This entry point here will simply use the original text.
+    # ======================================================================= #
+    when :default,
+         :use_the_default_text
+      old_text = text
+    # ======================================================================= #
+    # === :retain_mnemonic
+    # ======================================================================= #
+    when :retain_mnemonic,
+         :use_mnemonic
+      old_text = text
+      use_mnemonic = true
+    end
+    case use_mnemonic
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default
+      use_mnemonic = false
+    end
+    old_text = old_text.dup if old_text.frozen?
+    if old_text.include? '&'
+      # ===================================================================== #
+      # Oddly enough, ruby-gtk2 complains about this character.
+      # The warning was: "Gtk-WARNING **: Failed to set text from
+      # markup due to error parsing markup" [...] Entity did not 
+      # end with a semicolon; most likely you used an ampersand 
+      # character without intending to start an entity - escape 
+      # ampersand as &"
+      # So we do this ^^^.
+      # ===================================================================== #
+      old_text.gsub!(/&/, '&')
+    end
+    # ======================================================================= #
+    # === Handle ruby-gtk2 next
+    #
+    # Next, we must differ between gtk2 and gtk3.
+    # ======================================================================= #
+    if Gtk.are_we_using_gtk2?
+      set_markup(
+        %Q(<span weight="bold">#{old_text}</span>),
+        use_mnemonic
+      )
+    # ======================================================================= #
+    # === Check for ruby-gtk4 next:
+    #
+    # We may have to use a CSS rule here such as "font-weight: 500;".
+    # ======================================================================= #
+    elsif Gtk.are_we_using_gtk4?
+      #e 'Not yet implemented .make_bold() for ruby-gtk4.'
+      css_class('bold_font')
+    else # else we use gtk3.
+      # ===================================================================== #
+      # === Handle ruby-gtk3 next
+      #
+      # set_markup(
+      #   %Q(<span weight="bold">#{old_text}</span>),
+      #   use_underline: use_mnemonic
+      # )
+      # ===================================================================== #
+      # An alternative may be to do this here:
+      #
+      #   override_font(Pango::FontDescription.new('bold'))
+      #
+      # In fact, we are trying this as of December 2020 for ruby-gtk3.
+      # ===================================================================== #
+      override_font(
+        Pango::FontDescription.new('bold')
+      )
+    end
+  end; alias bold      make_bold # === bold
+       alias text_bold make_bold # === text_bold
 
   # ========================================================================= #
   # === align_left
@@ -27,12 +148,37 @@ class Label # === Gtk::Label
   # 2020. So we'll stick to that for the time being. 
   # ========================================================================= #
   def align_left
-    set_alignment(0, 1)
-  end; alias left                              align_left # === left
+    set_alignment(0, 1) if respond_to?(:set_alignment) # ruby-gtk4 does not have this.
+  end; alias left_align                        align_left # === left_align
+       alias left                              align_left # === left
        alias align_to_the_left                 align_left # === align_to_the_left
        alias to_the_left                       align_left # === to_the_left
        alias the_text_appears_on_the_left_side align_left # === the_text_appears_on_the_left_side
-       alias left_align                        align_left # === left_align
+       alias align_towards_the_left            align_left # === align_towards_the_left
+
+  # ========================================================================= #
+  # === left_rotate
+  #
+  # The next alias is to allow "tilted", aka slanted, text. It currently
+  # only works for ruby-gtk3.
+  # ========================================================================= #
+  if Gtk.do_we_use_gtk3?
+    alias left_rotate angle= # === left_rotate
+  end
+
+  # ========================================================================= #
+  # === parse_hyperlinks
+  #
+  # This method can be used to "parse" hyperlinks - simply enabling
+  # markup on the given label.
+  #
+  # The idea of this method was initially to custom-parse the answers
+  # in the studium-gem, but this has not yet been implemented here.
+  # ========================================================================= #
+  def parse_hyperlinks
+    enable_markup
+  end; alias enable_hyperlinks parse_hyperlinks # === enable_hyperlinks
+       alias fancy_parse       parse_hyperlinks # === fancy_parse
 
   # ========================================================================= #
   # === set_markup_text
@@ -76,16 +222,6 @@ class Label # === Gtk::Label
        alias right_align        align_right # === right_align
        alias align_to_the_right align_right # === align_to_the_right
 
-  # ========================================================================= #
-  # === make_selectable
-  #
-  # This will make the given Gtk::Label selectable.
-  # ========================================================================= #
-  def make_selectable
-    self.selectable = true
-  end; alias enable_on_click_actions make_selectable # === enable_on_click_actions
-       alias is_selectable           make_selectable # === is_selectable
-
   require 'gtk_paradise/emojis/emojis.rb'
   # ========================================================================= #
   # === set_emoji
@@ -102,19 +238,6 @@ class Label # === Gtk::Label
     make_bold
   end
 
-  # ========================================================================= #
-  # === parse_hyperlinks
-  #
-  # This method can be used to "parse" hyperlinks - simply enabling
-  # markup on the given label.
-  #
-  # The idea of this method was initially to custom-parse the answers
-  # in the studium-gem, but this has not yet been implemented here.
-  # ========================================================================= #
-  def parse_hyperlinks
-    enable_markup
-  end; alias enable_hyperlinks parse_hyperlinks # === enable_hyperlinks
-
   # ========================================================================= #
   # === colourize
   #
@@ -145,84 +268,6 @@ class Label # === Gtk::Label
     set_text("#{text}#{i}")
   end; alias << append # === <<
 
-  # ========================================================================= #
-  # === make_bold
-  #
-  # This method will make the whole Gtk::Label instance bold.
-  #
-  # The second argument will determine whether we will use a mnemonic or 
-  # whether we will not.
-  # ========================================================================= #  
-  def make_bold(
-      old_text     = text,
-      use_mnemonic = :default
-    )
-    case old_text
-    # ======================================================================= #
-    # === :default
-    #
-    # This entry point here will simply use the original text.
-    # ======================================================================= #
-    when :default,
-         :use_the_default_text
-      old_text = text
-    # ======================================================================= #
-    # === :retain_mnemonic
-    # ======================================================================= #
-    when :retain_mnemonic,
-         :use_mnemonic
-      old_text = text
-      use_mnemonic = true
-    end
-    case use_mnemonic
-    when :default
-      use_mnemonic = false
-    end
-    old_text = old_text.dup if old_text.frozen?
-    if old_text.include? '&'
-      # ===================================================================== #
-      # Oddly enough, ruby-gtk2 complains about this character.
-      # The warning was: "Gtk-WARNING **: Failed to set text from
-      # markup due to error parsing markup" [...] Entity did not 
-      # end with a semicolon; most likely you used an ampersand 
-      # character without intending to start an entity - escape 
-      # ampersand as &amp;"
-      # So we do this ^^^.
-      # ===================================================================== #
-      old_text.gsub!(/&/, '&amp;')
-    end
-    # ======================================================================= #
-    # === Handle ruby-gtk2 next
-    #
-    # Next, we must differ between gtk2 and gtk3.
-    # ======================================================================= #
-    if Gtk.are_we_using_gtk2?
-      set_markup(
-        %Q(<span weight="bold">#{old_text}</span>),
-        use_mnemonic
-      )
-    else # else we use gtk3.
-      # ===================================================================== #
-      # === Handle ruby-gtk3 next
-      #
-      # set_markup(
-      #   %Q(<span weight="bold">#{old_text}</span>),
-      #   use_underline: use_mnemonic
-      # )
-      # ===================================================================== #
-      # An alternative may be to do this here:
-      #
-      #   override_font(Pango::FontDescription.new('bold'))
-      #
-      # In fact, we are trying this as of December 2020 for ruby-gtk3.
-      # ===================================================================== #
-      override_font(
-        Pango::FontDescription.new('bold')
-      )
-    end
-  end; alias bold      make_bold # === bold
-       alias text_bold make_bold # === text_bold
-
   # ========================================================================= #
   # === center
   # ========================================================================= #
@@ -275,10 +320,10 @@ end
       _.set_markup(
         %Q[<markup><span foreground="#{colour}">#{name} </span></markup>], true
       )
-    else
+    else # else use ruby-gtk3
       _.set_markup(
         %Q[<markup><span foreground="#{colour}">#{name} </span></markup>], 
-        use_underline: true
+        { use_underline: true }
       )
     end
     unless justify.nil?
@@ -333,7 +378,8 @@ end
     colour = random_colour if colour == 'rand'
     _ = create_label(name) # Instantiate a new Gtk::Label widget here.
     _.set_markup(
-      %Q[<markup><span weight='bold' foreground="#{colour}">#{name} </span></markup>], true
+      %Q[<markup><span weight='bold' foreground="#{colour}">#{name} </span></markup>],
+      { use_underline: true }
     )
     justify_right = :right
     if use_gtk2?
@@ -399,6 +445,47 @@ end
     return _ 
   end
 
+  # ========================================================================= #
+  # === Gtk.bold_label
+  #
+  # This is like Gtk.label() but it makes the font in use bold.
+  # ========================================================================= #
+  def self.bold_label(
+      default_text  = '',
+      use_mnemonics = false
+    )
+    _ = ::Gtk.label(default_text, use_mnemonics)
+    _.make_bold
+    return _
+  end
+
+  # ========================================================================= #
+  # === Gtk.markup_label
+  #
+  # Use this if you want to modify an existing label. It uses an extremely
+  # simplified model. Ah never mind ... it currently is TOTALLY broken ;)
+  #
+  # markup_label(label, blalalala)
+  # ========================================================================= #
+  def self.markup_label(
+      label_to_modify,
+      text,
+      colour_to_use = 'slateblue'
+    )
+
+    super_string = "<markup>
+      <span weight='bold' foreground='black'>
+    
+      #{text}
+    </span>"
+ 
+    label_to_modify.set_markup(%Q[#{super_string}
+      <span weight='bold' foreground='#{colour_to_use}'>test bold?</span>
+      </markup>],
+      true
+    )
+  end
+
   # ========================================================================= #
   # === Gtk.create_label
   #
@@ -499,44 +586,13 @@ end
        self.instance_eval { alias label        create_label } # === Gtk.label
 
   # ========================================================================= #
-  # === Gtk.bold_label
+  # === Gtk.simple_text
   #
-  # This is like Gtk.label() but it makes the font in use bold.
+  # This method has been specifically createdfor the gir-bindings for
+  # ruby-gtk3.
   # ========================================================================= #
-  def self.bold_label(
-      default_text  = '',
-      use_mnemonics = false
-    )
-    _ = ::Gtk.label(default_text, use_mnemonics)
-    _.make_bold
-    return _
-  end
-
-  # ========================================================================= #
-  # === Gtk.markup_label
-  #
-  # Use this if you want to modify an existing label. It uses an extremely
-  # simplified model. Ah never mind ... it currently is TOTALLY broken ;)
-  #
-  # markup_label(label, blalalala)
-  # ========================================================================= #
-  def self.markup_label(
-      label_to_modify,
-      text,
-      colour_to_use = 'slateblue'
-    )
-
-    super_string = "<markup>
-      <span weight='bold' foreground='black'>
-    
-      #{text}
-    </span>"
- 
-    label_to_modify.set_markup(%Q[#{super_string}
-      <span weight='bold' foreground='#{colour_to_use}'>test bold?</span>
-      </markup>],
-      true
-    )
+  def self.simple_text(i = '')
+    return Gtk::Label.new(i)
   end
 
 end

data/lib/gtk_paradise/gtk_classes/list_store.rb

@@ -18,11 +18,24 @@ class ListStore # === Gtk::ListStore
   # ========================================================================= #
   alias do_empty clear
 
+  # ========================================================================= #
+  # === append_this_string
+  # ========================================================================= #
+  def append_this_string(i = 'Karl')
+    iter = self.append
+    set_value(iter, 0, i)
+  end
+
   # ========================================================================= #
   # === attach_this_array
   #
   # This method should only be used for a simplifed array, aka only one
   # entry per line. We will only add a simple Array.
+  #
+  # Usage example:
+  #
+  #   .attach_this_array( %w( one two three four five ) )
+  #
   # ========================================================================= #
   def attach_this_array(array)
     array.each { |entry|

data/lib/gtk_paradise/gtk_classes/menu.rb

@@ -8,7 +8,7 @@
 # =========================================================================== #
 module Gtk
 
-class Gtk::Menu
+class Menu # === Gtk::Menu
 
   require 'gtk_paradise/toplevel_methods/determine_which_gtk_version_is_in_use.rb'
 
@@ -17,7 +17,10 @@ class Gtk::Menu
   # ========================================================================= #
   def popup_based_on_this_event(event)
     popup(
-      nil, nil, event.button, event.time
+      nil,
+      nil,
+      event.button,
+      event.time
     )
   end
 
@@ -61,7 +64,8 @@ end
   def self.return_gtk_menu(
       use_this_accelgroup = Gtk::AccelGroup.new
     )
-    use_this_logo = '/home/x/DATA/images/GUI/GTK/STOCK_ITEMS/stock_stop_24.png'
+    use_this_logo = '/home/x/data/images/GUI/GTK/STOCK_ITEMS/'\
+                    'stock_stop_24.png'
     cal_stock  = Proc.new {|d, _item| p "StockItem, #{d}"}
     cal_quit   = Proc.new { Gtk.main_quit} # Quitting.
     cal_check  = Proc.new {|d, _item| p "CheckItem, #{d}"}

data/lib/gtk_paradise/gtk_classes/menu_bar.rb

@@ -6,7 +6,7 @@
 # =========================================================================== #
 module Gtk
 
-class MenuBar
+class MenuBar # === Gtk::MenuBar
 
   # ========================================================================= #
   # === add_these

data/lib/gtk_paradise/gtk_classes/menu_item.rb

@@ -6,7 +6,7 @@
 # =========================================================================== #
 module Gtk
 
-class MenuItem
+class MenuItem # === Gtk::MenuItem
 
   # ========================================================================= #
   # === text?