gtk_paradise 0.9.120 → 0.12.25

data/lib/gtk_paradise/gtk_classes/notebook.rb

@@ -12,76 +12,15 @@ 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.
-  #
-  # 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 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
-
-  # ========================================================================= #
-  # === focus_on_the_first_tab
-  # ========================================================================= #
-  def focus_on_the_first_tab
-    set_page(0)
-  end
-
-  # ========================================================================= #
-  # === position_the_tabs_right
-  # ========================================================================= #
-  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
-
-  # ========================================================================= #
-  # === position_the_tabs_left
-  # ========================================================================= #
-  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
-
-  # ========================================================================= #
-  # === 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
-
   # ========================================================================= #
   # === add_tab
   #
   # Note that append_page() can not handle Strings, which is why we have to
   # convert this into a Gtk::Label widget.
   #
-  # The first argument to this method must be the widget that has to be
-  # added; the second argument to this method is the title for that widget.
+  # The first argument to the method .add_tab() must be the widget that has
+  # to be added; the second argument to this method is the title for
+  # that widget.
   #
   # Usage examples:
   #
@@ -128,15 +67,72 @@ class Notebook # === Gtk::Notebook
     set_tab_reorderable(widget, true)
   end; alias append_this_widget add_tab # === append_this_widget
        alias add_flexible_tab   add_tab # === add_flexible_tab
+       alias tab1=              add_tab # === tab1=
+       alias tab2=              add_tab # === tab2=
+       alias tab3=              add_tab # === tab3=
+       alias tab4=              add_tab # === tab4=
+       alias tab5=              add_tab # === tab5=
+       alias tab6=              add_tab # === tab6=
+       alias tab7=              add_tab # === tab7=
+       alias tab8=              add_tab # === tab8=
+       alias tab9=              add_tab # === tab9=
 
   # ========================================================================= #
-  # === do_show_the_border
+  # === remove_the_last_tab
   #
-  # This method enables "show the border" on a notebook.
+  # This method must be guaranteed to remove the very last tab of a notebook.
   # ========================================================================= #
-  def do_show_the_border
-    set_show_border(true)
-  end; alias do_show_border do_show_the_border # === do_show_border
+  def remove_the_last_tab
+    _ = n_pages? - 1
+    last_tab = get_nth_page(_)
+    remove_page(_)
+    return last_tab # Return it as well here.
+  end
+
+  # ========================================================================= #
+  # === append_page_with_index
+  #
+  # This is currently not in use. The idea was that we can pass an index,
+  # which can then be used to remove the tab at hand via a number.
+  # ========================================================================= #
+  def append_page_with_index(
+      widget1,
+      widget2,
+      index = 0
+    )
+    widget2.set_index(index)
+    append_page(widget1, widget2)
+  end
+
+  # ========================================================================= #
+  # === all_pages?
+  #
+  # This method will return all pages. In gtk4 this is no longer needed,
+  # so the method serves primarily a use case on gtk3.
+  #
+  # Actually this returns an incorrect result ...
+  # ========================================================================= #
+  def all_pages?
+    array = []
+    (0..100).each {|position|
+      result = get_nth_page(position)
+      if result
+        array << result
+      elsif result.nil?
+        return array # Early return in this case.
+      end
+    }
+    return array
+  end
+
+  # ========================================================================= #
+  # === can_be_rearranged
+  # ========================================================================= #
+  def can_be_rearranged(i = children)
+    i.each {|this_tab|
+      set_tab_reorderable(this_tab, true)
+    }
+  end; alias allow_rearrangement_of_the_tabs can_be_rearranged # === allow_rearrangement_of_the_tabs
 
   # ========================================================================= #
   # === the_tabs_appear_on_top
@@ -148,6 +144,23 @@ class Notebook # === Gtk::Notebook
     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
+
+  # ========================================================================= #
+  # === first_tab?
+  #
+  # This method will return the first tab.
+  # ========================================================================= #
+  def first_tab?
+    get_nth_page(0)
+  end
+
+  # ========================================================================= #
+  # === nth_page
+  # ========================================================================= #
+  def nth_page(i = 0)
+    get_nth_page(i)
+  end
 
   # ========================================================================= #
   # === entry
@@ -161,6 +174,78 @@ class Notebook # === Gtk::Notebook
     add_tab(this_widget, text)
   end
 
+  # ========================================================================= #
+  # === 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 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
+
+  # ========================================================================= #
+  # === add_page
+  #
+  # This is similar to add_tab() but the arguments are reversed.
+  # ========================================================================= #
+  def add_page(a, b)
+    add_tab(b, a)
+  end
+
+  # ========================================================================= #
+  # === focus_on_the_first_tab
+  # ========================================================================= #
+  def focus_on_the_first_tab
+    set_page(0)
+  end
+
+  # ========================================================================= #
+  # === position_the_tabs_right
+  # ========================================================================= #
+  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
+
+  # ========================================================================= #
+  # === position_the_tabs_left
+  # ========================================================================= #
+  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
+
+  # ========================================================================= #
+  # === n_pages?
+  # ========================================================================= #
+  def n_pages?
+    n_pages
+  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 +289,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 +303,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

data/lib/gtk_paradise/gtk_classes/paned.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Gtk::Paned
+# =========================================================================== #
+# require 'gtk_paradise/gtk_classes/paned.rb'
+# =========================================================================== #
+module Gtk
+
+class Paned # === Gtk::Paned
+
+  alias set_old_position position= # === set_old_position
+
+  # ========================================================================= #
+  # === position=
+  #
+  # The second option is to allow for some flexibility, e. g. when
+  # determining the width or height.
+  # ========================================================================= #
+  def position=(
+      i,
+      use_width_or_height = :width
+    )
+    if i.is_a?(String) and i.include?('%')
+      case use_width_or_height
+      # ===================================================================== #
+      # === :default
+      #
+      # This is for the width.
+      # ===================================================================== #
+      when :default,
+           :width
+        use_width_or_height = Gdk::Screen.default.width.to_f
+      # ===================================================================== #
+      # === :height
+      # ===================================================================== #
+      when :height
+        use_width_or_height = Gdk::Screen.default.height.to_f
+      else
+        puts 'Not registered: '+use_width_or_height.to_s
+      end
+      # ===================================================================== #
+      # Calculate the percentage value next.
+      # ===================================================================== #
+      i = (use_width_or_height * i.delete('%').to_i / 100).to_i
+      # puts "Debug: the new position is at #{i}" # Toggle this as necessary.
+    end
+    set_old_position(i)
+  end
+
+end; end

data/lib/gtk_paradise/gtk_classes/radio_menu_item.rb

@@ -6,8 +6,33 @@
 # =========================================================================== #
 module Gtk
 
+class RadioMenuItem # === Gtk::RadioMenuItem
+
   require 'gtk_paradise/toplevel_methods/determine_which_gtk_version_is_in_use.rb'
 
+  # ========================================================================= #
+  # === checked?
+  # ========================================================================= #
+  def checked?
+    active?
+  end
+
+  # ========================================================================= #
+  # === is_active
+  # ========================================================================= #
+  def is_active
+    set_active(true)
+  end
+
+  # ========================================================================= #
+  # === is_inactive
+  # ========================================================================= #
+  def is_inactive
+    set_active(false)
+  end; alias is_not_checked is_inactive # === is_not_checked
+
+end
+
   # ========================================================================= #
   # === Gtk.gtk_radio_menu_item
   #
@@ -32,7 +57,7 @@ module Gtk
         label_for_the_text,
         use_underline
       )
-    else # else assume ruby-gtk3.
+    elsif ::Gtk.use_gtk3? # else assume ruby-gtk3.
       ::Gtk::RadioMenuItem.new(
         group_to_use,
         label_for_the_text,

data/lib/gtk_paradise/gtk_classes/scale_button.rb

@@ -25,7 +25,22 @@ module Gtk
     # ======================================================================= #
     when :default,
          :default_icon
-      use_this_as_icon = ::Gtk::IconSize::BUTTON
+      # ===================================================================== #
+      # Note that ::Gtk::IconSize::BUTTON will only work for ruby-gtk3.
+      # In ruby-gtk4 this has changed.
+      # ===================================================================== #
+      if ::Gtk.use_gtk3?
+        use_this_as_icon = ::Gtk::IconSize::BUTTON
+      elsif ::Gtk.use_gtk4?
+        scale_button = ::Gtk::ScaleButton.new
+        scale_button.set_icons(
+          %w(
+            gtk-go-down
+            gtk-go-up
+          )
+        )
+        return scale_button
+      end
     end
     ::Gtk::ScaleButton.new(use_this_as_icon)
   end; self.instance_eval { alias scale_button return_scale_button } # === Gtk.scale_butotn

data/lib/gtk_paradise/gtk_classes/scrolled_window.rb

@@ -17,14 +17,14 @@ class ScrolledWindow # === Gtk::ScrolledWindow
   # ========================================================================= #
   # === use_etched_in_shadow
   # ========================================================================= #
-  def use_etched_in_shadow
+  def use_etched_in_shadow(
+      i = :etched_in # Default value for ruby-gtk3.
+    )
     if ::Gtk.use_gtk2?
-      _ = ::Gtk::SHADOW_ETCHED_IN
-    else # assume gtk3
-      _ = :etched_in
+      i = ::Gtk::SHADOW_ETCHED_IN
     end
-    set_shadow_type()
-  end
+    set_shadow_type(i)
+  end; alias etched_in_shadow use_etched_in_shadow # === etched_in_shadow 
 
   # ========================================================================= #
   # === set_shadow_type_in
@@ -71,6 +71,14 @@ class ScrolledWindow # === Gtk::ScrolledWindow
     this_child_widget.set_text(i) if this_child_widget.respond_to? :set_text
   end
 
+  # ========================================================================= #
+  # === text?
+  # ========================================================================= #
+  def text?
+    this_child_widget = children.first.children.first
+    this_child_widget.text? if this_child_widget.respond_to? :text?
+  end
+
   # ========================================================================= #
   # === policy=
   #
@@ -83,10 +91,12 @@ class ScrolledWindow # === Gtk::ScrolledWindow
     )
     if ::Gtk.use_gtk2?
       case a
+      # === :never
       when :never
         a = ::Gtk::POLICY_NEVER
       end
       case b
+      # === :automatic
       when :automatic,
            :automatic_policy
          b = ::Gtk::POLICY_AUTOMATIC

data/lib/gtk_paradise/gtk_classes/search_bar.rb

@@ -8,7 +8,7 @@
 # =========================================================================== #
 module Gtk
 
-class SearchBar
+class SearchBar # === Gtk::SearchBar
 
   # ========================================================================= #
   # === appear

data/lib/gtk_paradise/gtk_classes/source_buffer.rb

@@ -1,11 +1,6 @@
 #!/usr/bin/ruby -w
 # Encoding: UTF-8
 # frozen_string_literal: true
-# =========================================================================== #
-# require 'gtk_paradise/gtk_classes/source_buffer.rb'
-# =========================================================================== #
-module Gtk
-
 # =========================================================================== #
 # === Gtk::SourceBuffer
 #
@@ -14,6 +9,10 @@ module Gtk
 #
 # You might want to use Gtk::TextView.new instead.
 # =========================================================================== #
+# require 'gtk_paradise/gtk_classes/source_buffer.rb'
+# =========================================================================== #
+module Gtk
+
 class SourceBuffer
 
   # ========================================================================= #

data/lib/gtk_paradise/gtk_classes/spin_button.rb

@@ -3,6 +3,12 @@
 # frozen_string_literal: true
 # =========================================================================== #
 # === Gtk::SpinButton
+#
+# The upstream API for gtk3 can be found here:
+#
+#   https://lazka.github.io/pgi-docs/Gtk-3.0/classes/SpinButton.html
+#   https://docs.gtk.org/gtk3/class.SpinButton.html
+#
 # =========================================================================== #
 # require 'gtk_paradise/gtk_classes/spin_button.rb'
 # =========================================================================== #
@@ -11,22 +17,13 @@ module Gtk
 class SpinButton # === Gtk::SpinButton
 
   # ========================================================================= #
-  # === on_value_changed
+  # === set_max_value
   # ========================================================================= #
-  def on_value_changed(&block)
-    signal_connect(:value_changed, &block)
+  def set_max_value(max)
+    min = range.first
+    set_range(min, max)
   end
 
-  # ========================================================================= #
-  # === start_value=
-  #
-  # This method can be used to designate the start value displayed.
-  # ========================================================================= #
-  def start_value=(i)
-    set_value(i.to_i)
-  end; alias set_start_point start_value= # === set_start_point
-       alias start_position= start_value= # === start_position=
-
   # ========================================================================= #
   # === range_span
   # ========================================================================= #
@@ -40,6 +37,31 @@ class SpinButton # === Gtk::SpinButton
     set_climb_rate(increment)
   end
 
+  # ========================================================================= #
+  # === text?
+  # ========================================================================= #
+  def text?
+    text.to_s
+  end
+
+  # ========================================================================= #
+  # === on_value_changed
+  # ========================================================================= #
+  def on_value_changed(&block)
+    signal_connect(:value_changed, &block)
+  end
+
+  # ========================================================================= #
+  # === start_value=
+  #
+  # This method can be used to designate the start value used and 
+  # displayed by a spin-button.
+  # ========================================================================= #
+  def start_value=(i)
+    set_value(i.to_i)
+  end; alias set_start_point start_value= # === set_start_point
+       alias start_position= start_value= # === start_position=
+
 end
 
 # =========================================================================== #

data/lib/gtk_paradise/gtk_classes/spinner.rb

@@ -10,19 +10,49 @@ module Gtk
 
 class Spinner # === Gtk::Spinner
 
+  require 'gtk_paradise/toplevel_methods/determine_which_gtk_version_is_in_use.rb'
+
+  # ========================================================================= #
+  # === is_still_spinning?
+  # ========================================================================= #
+  def is_still_spinning?
+    if ::Gtk.use_gtk3?
+      active?
+    elsif ::Gtk.use_gtk4?
+      spinning?
+    end
+  end
+
+  # ========================================================================= #
+  # Add two aliases to the above method if we are using ruby-gtk4.
+  # ========================================================================= #
+  if ::Gtk.use_gtk4?
+    alias active?  is_still_spinning? # === active?
+    alias spinning is_still_spinning? # === spinning?
+  end
+
   # ========================================================================= #
   # === is_active
   # ========================================================================= #
   def is_active
-    set_active(true)
+    if ::Gtk.use_gtk3?
+      set_active(true)
+    elsif ::Gtk.use_gtk4?
+      set_spinning(true)
+    end
   end; alias go_and_spin_now is_active # === go_and_spin_now
        alias start_spinning  is_active # === start_spinning
+       alias start_to_spin   is_active # === start_to_spin
 
   # ========================================================================= #
   # === is_inactive
   # ========================================================================= #
   def is_inactive
-    set_active(false)
+    if ::Gtk.use_gtk3?
+      set_active(false)
+    elsif ::Gtk.use_gtk4?
+      set_spinning(false)
+    end
   end; alias stop_spinning is_inactive # === stop_spinning
   
 end

data/lib/gtk_paradise/gtk_classes/status_icon.rb

@@ -25,6 +25,8 @@ class StatusIcon
       set_icon_name(
         i.delete_suffix(File.extname(i))
       ) 
+    else
+      e "No file found at `#{i}`."
     end
   end; alias favicon= favicon # === favicon=
 

data/lib/gtk_paradise/gtk_classes/statusbar.rb

@@ -33,6 +33,7 @@ class Statusbar # === Gtk::Statusbar
     push(context_id, display_this_message)
   end; alias add_to_statusbar add_this_message # === add_to_statusbar
        alias display          add_this_message # === display
+       alias push_message     add_this_message # === push_message
 
   # ========================================================================= #
   # === set_text