gtk_paradise 0.9.120 → 0.11.19

data/lib/gtk_paradise/gtk_classes/label.rb

@@ -15,9 +15,103 @@ 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_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
+
+  # ========================================================================= #
+  # === cursor_is_on_the_right
+  #
+  # This does not work. For some selectable labels we should be able to
+  # position the cursor programmatically.
   # ========================================================================= #
-  alias left_rotate angle= # === left_rotate
+  # def cursor_is_on_the_right
+  #   self.position = -1
+  # end
 
   # ========================================================================= #
   # === align_left
@@ -27,12 +121,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
@@ -102,19 +221,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 +251,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 +303,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 +361,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 +428,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 +569,13 @@ end
        self.instance_eval { alias label        create_label } # === Gtk.label
 
   # ========================================================================= #
-  # === 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
+  # === Gtk.simple_text
   #
-  # 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)
+  # This method has been specifically createdfor the gir-bindings for
+  # ruby-gtk3.
   # ========================================================================= #
-  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/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?

data/lib/gtk_paradise/gtk_classes/notebook.rb

@@ -13,65 +13,74 @@ class Notebook # === Gtk::Notebook
   require 'gtk_paradise/toplevel_methods/determine_which_gtk_version_is_in_use.rb'
 
   # ========================================================================= #
-  # === focus_entry
-  #
-  # This method allows you to focus on the notebook tab.
+  # === allow_rearrangement_of_the_tabs
   #
-  # Some aliases exist to this method; note that the alias name called
-  # `focus_on_tab_number` will not necessarily be guaranteed to start
-  # counting at 0; we will simply use whatever the method set_page()
-  # uses there.
+  # This unfortunately does not work.
   # ========================================================================= #
-  def focus_entry(i = 1)
-    set_page(i.to_i) 
-  end; alias focus_on_this_tab   focus_entry # === focus_on_this_tab
-       alias focus_on_tab_number focus_entry # === focus_on_tab_number
-       alias focus               focus_entry # === focus
+  # def allow_rearrangement_of_the_tabs
+  #   pages.each {|this_tab|
+  #     set_tab_reorderable(this_tab, true)
+  #   }
+  # end
 
   # ========================================================================= #
-  # === focus_on_the_first_tab
+  # === the_tabs_appear_on_top
+  #
+  # This method will make the tabs appear on top.
   # ========================================================================= #
-  def focus_on_the_first_tab
-    set_page(0)
-  end
+  def the_tabs_appear_on_top
+    tab_position = :top
+    tab_position = ::Gtk::POS_TOP if ::Gtk.use_gtk2?
+    set_tab_pos(tab_position)
+  end; alias position_on_top the_tabs_appear_on_top # === position_on_top
+       alias on_top          the_tabs_appear_on_top # === on_top
 
   # ========================================================================= #
-  # === position_the_tabs_right
+  # === first_tab?
+  #
+  # This method will return the first tab.
   # ========================================================================= #
-  def position_the_tabs_right
-    tab_position = :right
-    tab_position = ::Gtk::POS_RIGHT if ::Gtk.use_gtk2?
-    set_tab_pos(tab_position)
-  end; alias position_on_the_right_hand_side position_the_tabs_right # === position_on_the_right_hand_side
-       alias position_to_the_right           position_the_tabs_right # === position_to_the_right
+  def first_tab?
+    get_nth_page(0)
+  end
 
   # ========================================================================= #
-  # === position_the_tabs_left
+  # === entry
+  #
+  # This is like add_tab() but in reverse order.
   # ========================================================================= #
-  def position_the_tabs_left
-    tab_position = :left
-    tab_position = ::Gtk::POS_LEFT if ::Gtk.use_gtk2?
-    set_tab_pos(tab_position)
-  end; alias position_on_the_left_hand_side position_the_tabs_left # === position_on_the_left_hand_side
-       alias position_to_the_left           position_the_tabs_left # === position_to_the_left
+  def entry(
+      text        = '',
+      this_widget = ::Gtk::Box.new # The argument is just a dummy.
+    )
+    add_tab(this_widget, text)
+  end
 
   # ========================================================================= #
-  # === n_pages?
+  # === focus_entry
+  #
+  # This method allows you to focus on the notebook tab.
+  #
+  # Some aliases exist to this method; note that the alias name called
+  # `focus_on_tab_number` will not necessarily be guaranteed to start
+  # counting at 0; we will simply use whatever the method set_page()
+  # uses there.
   # ========================================================================= #
-  def n_pages?
-    n_pages
-  end
+  def focus_entry(i = 1)
+    set_page(i.to_i)
+  end; alias focus_on_this_tab   focus_entry # === focus_on_this_tab
+       alias focus_on_tab_number focus_entry # === focus_on_tab_number
+       alias focus_on_tab        focus_entry # === focus_on_tab
+       alias focus               focus_entry # === focus
+       alias activate_this_tab   focus_entry # === activate_this_tab
 
   # ========================================================================= #
-  # === remove_the_last_tab
+  # === add_page
   #
-  # This method must be guaranteed to remove the very last tab of a notebook.
+  # This is similar to add_tab() but the arguments are reversed.
   # ========================================================================= #
-  def remove_the_last_tab
-    _ = n_pages? - 1
-    last_tab = get_nth_page(_)
-    remove_page(_)
-    return last_tab # Return it as well here.
+  def add_page(a, b)
+    add_tab(b, a)
   end
 
   # ========================================================================= #
@@ -130,37 +139,62 @@ class Notebook # === Gtk::Notebook
        alias add_flexible_tab   add_tab # === add_flexible_tab
 
   # ========================================================================= #
-  # === do_show_the_border
-  #
-  # This method enables "show the border" on a notebook.
+  # === focus_on_the_first_tab
   # ========================================================================= #
-  def do_show_the_border
-    set_show_border(true)
-  end; alias do_show_border do_show_the_border # === do_show_border
+  def focus_on_the_first_tab
+    set_page(0)
+  end
 
   # ========================================================================= #
-  # === the_tabs_appear_on_top
-  #
-  # This method will make the tabs appear on top.
+  # === position_the_tabs_right
   # ========================================================================= #
-  def the_tabs_appear_on_top
-    tab_position = :top
-    tab_position = ::Gtk::POS_TOP if ::Gtk.use_gtk2?
+  def position_the_tabs_right(
+      tab_position = :right
+    )
+    tab_position = ::Gtk::POS_RIGHT if ::Gtk.use_gtk2?
     set_tab_pos(tab_position)
-  end; alias position_on_top the_tabs_appear_on_top # === position_on_top
+  end; alias position_on_the_right_hand_side position_the_tabs_right # === position_on_the_right_hand_side
+       alias position_to_the_right           position_the_tabs_right # === position_to_the_right
 
   # ========================================================================= #
-  # === entry
-  #
-  # This is like add_tab() but in reverse order.
+  # === position_the_tabs_left
   # ========================================================================= #
-  def entry(
-      text        = '',
-      this_widget = ::Gtk::Box.new # The argument is just a dummy.
+  def position_the_tabs_left(
+      tab_position = :left
     )
-    add_tab(this_widget, text)
+    tab_position = ::Gtk::POS_LEFT if ::Gtk.use_gtk2?
+    set_tab_pos(tab_position)
+  end; alias position_on_the_left_hand_side position_the_tabs_left # === position_on_the_left_hand_side
+       alias position_to_the_left           position_the_tabs_left # === position_to_the_left
+
+  # ========================================================================= #
+  # === n_pages?
+  # ========================================================================= #
+  def n_pages?
+    n_pages
   end
 
+  # ========================================================================= #
+  # === remove_the_last_tab
+  #
+  # This method must be guaranteed to remove the very last tab of a notebook.
+  # ========================================================================= #
+  def remove_the_last_tab
+    _ = n_pages? - 1
+    last_tab = get_nth_page(_)
+    remove_page(_)
+    return last_tab # Return it as well here.
+  end
+
+  # ========================================================================= #
+  # === do_show_the_border
+  #
+  # This method enables "show the border" on a notebook.
+  # ========================================================================= #
+  def do_show_the_border
+    set_show_border(true)
+  end; alias do_show_border do_show_the_border # === do_show_border
+
   # ========================================================================= #
   # === is_scrollable
   # ========================================================================= #
@@ -204,6 +238,13 @@ class Notebook # === Gtk::Notebook
 
 end
 
+# =========================================================================== #
+# === Gtk.add_reorderable_notebook
+# =========================================================================== #
+def self.add_reorderable_notebook(*widgets, &block)
+  ::Gtk.add_notebook(widgets) { :reorderable }
+end
+
 # =========================================================================== #
 # === Gtk.add_notebook
 #
@@ -211,20 +252,29 @@ end
 #
 # The first input argument to this method should contain the sub-widgets
 # that are part of this Notebook.
+#
+# Usage example:
+#
+#   Gtk.add_notebook(label1, label2, label3) { :reorderable }
+#
 # =========================================================================== #
-def self.add_notebook(*widgets) # ← These are the subwidgets.
+def self.add_notebook(*widgets, &block) # ← These are the subwidgets.
   enable_drag_and_drop_support_for_this_widget = false
   if block_given?
     yielded = yield
     case yielded
-    when :enable_drag_and_support
+    # ======================================================================= #
+    # === :enable_drag_and_support
+    # ======================================================================= #
+    when :enable_drag_and_support,
+         :reorderable
       enable_drag_and_drop_support_for_this_widget = true
     end
   end
   notebook = ::Gtk::Notebook.new
   notebook.set_scrollable(true)
   notebook.set_show_tabs(true)
-  widgets.each {|widget|
+  widgets.flatten.each {|widget|
     name = widget.class.to_s
     if name.include? '::'
       name = name.split('::').last