gtk_paradise 0.9.120 → 0.11.19

data/lib/gtk_paradise/base_module/gtk_buttons.rb

@@ -1,562 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'gtk_paradise/base_module/buttons.rb'
-# =========================================================================== #
-module Gtk
-
-module BaseModule
-
-  # ========================================================================= #
-  # Pull in the Gtk::Button modifications first.
-  # ========================================================================= #
-  require 'gtk_paradise/gtk_classes/button.rb'
-  require 'gtk_paradise/base_module/return_corresponding_gtk_stock_item.rb'
-
-  # ========================================================================= #
-  # === gtk_button
-  #
-  # The first input-argument to this method should be a String. It does,
-  # however had, also support Hashes or block arguments.
-  #
-  # The block argument can look like this, for a tooltip:
-  #
-  #   {{ tooltip: "Clicking this button will generate a random aminoacid sequence."}}
-  #
-  # ========================================================================= #
-  def gtk_button(
-      i             = nil,
-      use_underline = false,
-      &block
-    )
-    # ======================================================================= #
-    # The next case menu has some symbol-shortcuts for stock items.
-    # That way we can avoid having to type (and remember) these long
-    # constants.
-    # ======================================================================= #
-    if i.is_a? Symbol
-      i = return_corresponding_gtk_stock_item(i)
-    end
-    if i and i.is_a?(String)
-      if i.start_with? '_'
-        use_underline = true
-      end
-    end
-    # ======================================================================= #
-    # === Handle hashes next - this should be fine for gtk2 at the least.
-    # ======================================================================= #
-    if i.is_a? Hash
-      # ===================================================================== #
-      # === :label
-      # ===================================================================== #
-      if i.has_key? :label
-        i = i.delete(:label) # Keep in mind that this line here is destructive.
-      end
-    end
-    button = ::Gtk.button(i, use_underline, &block)
-    # ======================================================================= #
-    # Append the button to the @internal_hash next.
-    # ======================================================================= #
-    @internal_hash[:buttons] << button if @internal_hash
-    return button
-  end; alias gtk_button_new gtk_button # === gtk_button
-       alias button         gtk_button # === button
-
-  begin
-    require 'gtk_paradise/widgets/version_agnostic/coloured_button.rb'
-  rescue LoadError => error; pp error; end
-  # ========================================================================= #
-  # === gtk_coloured_button
-  #
-  # The first argument to this method should be a String.
-  #
-  # A typical usage example goes like this:
-  #
-  #   coloured_button('_DBGET_ivory', false)
-  #
-  # ========================================================================= #
-  def gtk_coloured_button(
-      i                        = '',
-      optional_second_argument = false
-    )
-    i = i.dup if i.frozen?
-    unless i.empty?
-      if i.count('_') < 2
-        # =================================================================== #
-        # In this case we must append the default colour, via a leading
-        # '_' token.
-        # =================================================================== #
-        i << "_#{Gtk::ColouredButton.default_colour?}"
-      end
-    end
-    coloured_button = ::Gtk::ColouredButton.new(i, optional_second_argument)
-    @internal_hash[:buttons] << coloured_button if @internal_hash
-    return coloured_button
-  end; alias coloured_button gtk_coloured_button # === coloured_button
-
-  # ========================================================================= #
-  # === hbutton_box
-  #
-  # This is for the horizontal variant of a Gtk::ButtonBox.
-  # ========================================================================= #
-  def hbutton_box
-    return button_box(:horizontal)
-  end
-
-  # ========================================================================= #
-  # === vbutton_box
-  #
-  # This is for the vertical variant of a Gtk::ButtonBox.
-  # ========================================================================= #
-  def vbutton_box
-    return button_box(:vertical)
-  end
-
-  # ========================================================================= #
-  # === gtk_button_with_this_image
-  # ========================================================================= #
-  def gtk_button_with_this_image(image)
-    _ = gtk_button
-    _.add(image)
-    return _
-  end
-
-  # ========================================================================= #
-  # === gtk_button_with_label
-  #
-  # This variant is for creating a gtk-button with a label. It has been
-  # specifically added if we just want to create a button in ruby-gtk3
-  # as-is.
-  # ========================================================================= #
-  def gtk_button_with_label(
-      use_this_label     = '',
-      shall_we_underline = true
-    )
-    return ::Gtk::Button.new(
-      label:         use_this_label,
-      use_underline: shall_we_underline
-    ) 
-  end
-
-  # ========================================================================= #
-  # === gtk_left_aligned_button
-  # ========================================================================= #
-  def gtk_left_aligned_button(
-      i             = nil,
-      use_underline = false,
-      &block
-    )
-    button = gtk_button(i, use_underline, &block)
-    button.left_align
-    return button
-  end
-
-  # ========================================================================= #
-  # === gtk_bold_check_button
-  #
-  # This method will create a check-button but will also make the button
-  # widget bold (the label on it).
-  # ========================================================================= #
-  def gtk_bold_check_button(
-      i             = '',
-      use_underline = :do_not_underline
-    )
-    _ = ::Gtk.check_button(i, use_underline)
-    _.make_bold
-    return _
-  end
-
-  require 'gtk_paradise/gtk_classes/scale_button.rb'
-  # ========================================================================= #
-  # === return_scale_button
-  # ========================================================================= #
-  def return_scale_button(
-      i = :default_icon
-    )
-    ::Gtk.return_scale_button(i)
-  end; alias scale_button     return_scale_button # === scale_button
-       alias gtk_scale_button return_scale_button # === gtk_scale_button
-
-  # ========================================================================= #
-  # === coloured_quit_button
-  #
-  # This variant can be called like this:
-  #
-  #   coloured_quit_button(colour: 'honeydew')
-  #
-  # ========================================================================= #
-  def coloured_quit_button(optional_hash = {})
-    use_this_colour = ''.dup # No colour by default.
-    unless use_this_colour.empty?
-      use_this_colour.prepend('_') unless use_this_colour.start_with? '_'
-    end
-    _ = coloured_button("_Quit#{use_this_colour}", true)
-    # ======================================================================= #
-    # Next, add the quit-specific action to this button.
-    # ======================================================================= #
-    _.signal_connect(:clicked) { |widget| ::Gtk.main_quit }
-    return _
-  end
-
-  # ========================================================================= #
-  # === quit_button
-  #
-  # This method will create a simple quit-button. The actual code for
-  # this is stored in the method called gtk_button().
-  #
-  # The method must be sufficiently flexible to allow the following use
-  # cases as well:
-  #
-  #   button_quit = quit_button('_Quit_lightgreen')
-  #
-  # ========================================================================= #
-  def quit_button(
-      optional_string = '_Quit',
-      &block
-    )
-    case optional_string
-    # ======================================================================= #
-    # === :use_image
-    # ======================================================================= #
-    when :use_image
-      _ = ::Gtk::Button.new
-      _.set_always_show_image(true)
-      icon  = ::Gtk.load_icon('application-exit', 32, 0)
-      image = gtk_pixbuf(icon)
-      hbox  = gtk_hbox
-      hbox.add(image)
-      hbox.add(gtk_label('Quit', :do_use_mnemonics)) # The mnemonics currently do not work.
-      _.add(hbox)
-    # ======================================================================= #
-    # === :use_emoji
-    # ======================================================================= #
-    when :use_emoji
-      _ = gtk_button('🛑 Quit', &block) # This is the stop-sign emoji.
-    else
-      if optional_string and optional_string.empty?
-        _ = gtk_button(optional_string, &block)
-      else
-        _ = gtk_button(:quit, &block)
-      end
-    end
-    _.on_clicked { exit_the_application }
-    return _
-  end; alias gtk_quit_button quit_button # === gtk_quit_button
-
-  # ========================================================================= #
-  # === gtk_toggle_button
-  # ========================================================================= #
-  def gtk_toggle_button(optional_content = '')
-    if optional_content and optional_content.is_a?(String) and use_gtk3?
-      optional_content = { label: optional_content }
-    end
-    toggle_button = ::Gtk::ToggleButton.new(optional_content)
-    @internal_hash[:toggle_buttons] << toggle_button if @internal_hash
-    return toggle_button
-  end
-
-  # ========================================================================= #
-  # === all_check_buttons?
-  # ========================================================================= #
-  def all_check_buttons?
-    @internal_hash[:check_buttons]
-  end; alias return_all_check_buttons all_check_buttons? # === return_all_check_buttons
-       alias check_buttons?           all_check_buttons? # === check_buttons?
-
-  # ========================================================================= #
-  # === all_toggle_buttons?
-  # ========================================================================= #
-  def all_toggle_buttons?
-    @internal_hash[:toggle_buttons]
-  end; alias return_all_toggle_buttons all_toggle_buttons? # return_all_toggle_buttons
-       alias toggle_buttons?           all_toggle_buttons? # === toggle_buttons?
-
-  # ========================================================================= #
-  # === all_buttons?
-  # ========================================================================= #
-  def all_buttons?
-    @internal_hash[:buttons]
-  end; alias return_all_buttons all_buttons? # === return_all_buttons
-
-  # ========================================================================= #
-  # === gtk_radio_button
-  # ========================================================================= #
-  def gtk_radio_button(
-      text               = '',
-      member_of          = nil,
-      shall_we_underline = true
-    )
-    if member_of
-      _ = ::Gtk::RadioButton.new(
-        label: text,
-        use_underline: shall_we_underline
-      )
-    else
-      _ = ::Gtk::RadioButton.new(
-        member: member_of,
-        label: text,
-        use_underline: shall_we_underline
-      )
-    end
-    return _
-  end
-
-  # ========================================================================= #
-  # === gtk_colour_button
-  # ========================================================================= #
-  def gtk_colour_button
-    ::Gtk::ColorButton.new
-  end; alias gtk_color_button gtk_colour_button # === gtk_color_button
-
-  # ========================================================================= #
-  # === gtk_button_accel
-  #
-  # This is like gtk_button, except that the first character will be
-  # guaranteed to be a '_', if the input argument is a String. That
-  # way we ensure that the gtk-button at hand will be an accel-button,
-  # meaning that alt+first_character key press event will trigger
-  # their default action.
-  # ========================================================================= #
-  def gtk_button_accel(
-      i = 'Example for an accelerated button',
-      &block
-    )
-    if i.is_a?(String) and !i.start_with?('_')
-      i = "_#{i}" # Prepend the _ in this case.
-    end
-    gtk_button(
-      i, true, &block
-    )
-  end; alias gtk_button_underline gtk_button_accel # === gtk_button_underline
-
-  # ========================================================================= #
-  # === gtk_bold_button
-  #
-  # This is similar to gtk_button() above, but will have a bold label by
-  # default.
-  # ========================================================================= #
-  def gtk_bold_button(
-      i             = '',
-      use_underline = false,
-      &block
-    )
-    button = gtk_button(i, use_underline, &block)
-    button.make_bold
-    return button
-  end; alias bold_button gtk_bold_button # === bold_button
-
-  # ========================================================================= #
-  # === gtk_centered_spin_button
-  # ========================================================================= #
-  def gtk_centered_spin_button(
-      start_position = 0,
-      end_position   = 100,
-      increment_size = 1,
-      &block
-    )
-    _ = gtk_spin_button(start_position, end_position, increment_size, &block)
-    _.center
-    return _
-  end
-
-  require 'gtk_paradise/gtk_classes/check_button.rb'
-  # ========================================================================= #
-  # === gtk_check_button
-  # ========================================================================= #
-  def gtk_check_button(
-      i             = '',
-      use_underline = :do_not_underline,
-      &block
-    )
-    if i.include? '_'
-      use_underline = true
-    end
-    button = ::Gtk.check_button(i, use_underline, &block)
-    # ======================================================================= #
-    # Append the button to the @internal_hash next.
-    # ======================================================================= #
-    @internal_hash[:check_buttons] << button
-    return button
-  end; alias check_button    gtk_check_button # === check_button
-       alias gtk_checkbutton gtk_check_button # === gtk_checkbutton
-       alias gtk_checkbox    gtk_check_button # === gtk_checkbox
-       alias gtk_check_box   gtk_check_button # === gtk_check_box
-
-  # ========================================================================= #
-  # === gtk_button_box_spread
-  # ========================================================================= #
-  def gtk_button_box_spread(*i)
-    _ = button_box(:horizontal) {{ layout: :spread }}
-    _.spacing = 1
-    i.flatten.each {|widget|
-      _.add(widget)
-    }
-    return _
-  end
-
-  require 'gtk_paradise/gtk_classes/button_box.rb'
-  # ========================================================================= #
-  # === gtk_button_box
-  #
-  # This method will instantiate a new Gtk::ButtonBox.
-  #
-  # The usage can be quite complex, as the following example shows:
-  #
-  #  button_box = gtk_button_box(
-  #    @button_choose_file,
-  #    @button_analyse
-  #  ) {{ layout:  :horizontal,
-  #       padding: 2,
-  #       fill:    true }}
-  #
-  # But you can also simplify this a bit if you'd like to:
-  #
-  #   button_box = button_box(:horizontal)
-  #   button_box = button_box(:vertical)
-  #
-  # ========================================================================= #
-  def gtk_button_box(
-      *i,
-      &block
-    )
-    orientation_to_use = :horizontal # This is the default orientation to use.
-    shall_we_fill_the_elements = false
-    padding_to_use = 0
-    if i.is_a?(Array) and i.first.is_a?(Symbol)
-      orientation_to_use = i.shift # Remove the first element as well.
-    end
-    button_box = ::Gtk::ButtonBox.new(orientation_to_use)
-    # ======================================================================= #
-    # === Handle blocks next
-    # ======================================================================= #
-    if block_given?
-      yielded = yield
-      # ===================================================================== #
-      # === Handle Hashes next, when given as Block variant
-      # ===================================================================== #
-      if yielded.is_a? Hash
-        # =================================================================== #
-        # === :layout
-        # =================================================================== #
-        if yielded.has_key? :layout
-          orientation_to_use = yielded[:layout]
-        # =================================================================== #
-        # === :spread
-        # =================================================================== #
-        elsif yielded.has_key? :spread
-          # orientation_to_use = yielded[:spread]
-          button_box.layout = :spread
-        end
-        # =================================================================== #
-        # === :padding
-        # =================================================================== #
-        if yielded.has_key? :padding
-          padding_to_use = yielded[:padding]
-        end
-        # =================================================================== #
-        # === :fill
-        # =================================================================== #
-        if yielded.has_key? :fill
-          shall_we_fill_the_elements = yielded[:fill]
-        end
-      end
-    # ======================================================================= #
-    # === Handle Symbols next
-    # ======================================================================= #
-    elsif yielded.is_a? Symbol
-      case yielded
-      # ===================================================================== #
-      # === :spread
-      # ===================================================================== #
-      when :spread
-        button_box.layout = :spread
-      # ===================================================================== #
-      # === :center
-      # ===================================================================== #
-      when :center
-        button_box.layout = :center
-      end
-    end
-    # ======================================================================= #
-    # Next iterate over the given arguments 1:1 as-is:
-    # ======================================================================= #
-    i.flatten.compact.each {|this_widget|
-      button_box.pack_start(
-        this_widget,
-        padding: padding_to_use,
-        expand:  true,
-        fill:    shall_we_fill_the_elements
-      )
-    }
-    # ======================================================================= #
-    # Sanitize the orientation a bit, if it is a symbol.
-    # ======================================================================= #
-    case orientation_to_use
-    # ======================================================================= #
-    # === :spread
-    # ======================================================================= #
-    when :spread
-      button_box.layout = :spread
-    else
-      button_box.orientation = orientation_to_use
-    end
-    return button_box
-  end; alias gtk_buttonbox     gtk_button_box # === gtk_buttonbox
-       alias button_box        gtk_button_box # === button_box
-       alias return_button_box gtk_button_box # === return_button_box
-
-  require 'gtk_paradise/gtk_classes/spin_button.rb'
-  # ========================================================================= #
-  # === gtk_spin_button
-  #
-  # Note that the values that are given to Gtk::SpinButton specify
-  # min, max and range. The default that is used in the method
-  # must make "sense", meaning it has to refer to "the most commonly
-  # assumed use case" for a spin-button. I somewhat arbitrarily
-  # decided that this means to start at 0, count up to 100, in
-  # steps of 1. Obviously this is arbitrary, but other values are
-  # just about as arbitrary as well - so I thought counting up to
-  # 100 would make sense here.
-  #
-  # Usage examples:
-  #
-  #   gtk_spin_button(0, 300, 1)
-  #   spinner_button = gtk_spinner_button {{ start_point: 1 }}
-  #
-  # ========================================================================= #
-  def gtk_spin_button(
-      start_position = 0,
-      end_position   = 100,
-      increment_size = 1,
-      &block
-    )
-    return ::Gtk.spin_button(start_position, end_position, increment_size)
-  end; alias spin_button             gtk_spin_button # === spin_button
-       alias spinbutton              gtk_spin_button # === spinbutton
-       alias gtk_spinner_button      gtk_spin_button # === gtk_spinner_button
-       alias gtk_spinbutton          gtk_spin_button # === gtk_spinbutton
-       alias gtk_up_and_down_counter gtk_spin_button # === gtk_up_and_down_counter
-       alias up_and_down_counter     gtk_spin_button # === up_and_down_counter
-
-  # ========================================================================= #
-  # === simplified_button_box
-  #
-  # Usage example:
-  #
-  #   simplified_button_box(button1, button2, button3) { :center }
-  #
-  # ========================================================================= #
-  def simplified_button_box(*i, &block)
-    if block_given?
-      _ = gtk_button_box(&block)
-    else
-      _ = gtk_button_box { :spread }
-    end
-    i.flatten.each {|entry|
-      _.add(entry)
-    }
-    return _
-  end
-
-end; end

data/lib/gtk_paradise/base_module/gtk_entry.rb

@@ -1,126 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'gtk_paradise/base_module/gtk_entry.rb'
-# =========================================================================== #
-module Gtk
-
-module BaseModule
-
-  require 'gtk_paradise/gtk_classes/entry.rb'
-  # ========================================================================= #
-  # === gtk_entry
-  #
-  # Make a new Gtk::Entry widget.
-  #
-  # Some code-variants can be used, such as:
-  #
-  #   gtk_entry { :align_center }
-  #
-  # This would align the text contained in the Gtk::Entry widget into the
-  # center (middle).
-  #
-  # Another variant would be:
-  #
-  #   gtk_entry { :read_only }
-  #
-  # This would mean to make the Gtk::Entry widget read-only - in other
-  # words, the user is not allowed to make changes to it.
-  # ========================================================================= #
-  def gtk_entry(i = '')
-    if i.is_a? Float
-      i = i.to_s
-    end
-    gtk_entry = ::Gtk.entry(i)
-    # ======================================================================= #
-    # === Handle blocks next
-    # ======================================================================= #
-    if block_given?
-      yielded = yield
-      # ===================================================================== #
-      # === Handle Hashes next
-      # ===================================================================== #
-      if yielded.is_a? Hash
-        # =================================================================== #
-        # === :set_text
-        # =================================================================== #
-        if yielded.has_key? :set_text
-          gtk_entry.set_text(yielded.delete(:set_text))
-        end
-        # =================================================================== #
-        # === :max_length
-        #
-        # This entry point allows for setting the max-length value quickly.
-        #
-        # Usage example:
-        #
-        #   entry = gtk_entry {{ max_length: 50 }}
-        #
-        # =================================================================== #
-        if yielded.has_key? :max_length
-          gtk_entry.set_max_length(yielded.delete(:max_length))
-        end
-      # ===================================================================== #
-      # === Handle Symbols next
-      # ===================================================================== #
-      elsif yielded.is_a? Symbol
-        case yielded
-        # =================================================================== #
-        # === :read_only
-        #
-        # This entry point will disable any modifications to the
-        # gtk-entry at hand.
-        # =================================================================== #
-        when :read_only
-          gtk_entry.editable = false
-        # =================================================================== #
-        # === :on_click_select_all
-        # =================================================================== #
-        when :on_click_select_all
-          gtk_entry.on_click_highlight_all
-        # =================================================================== #
-        # === :align_center
-        #
-        # This will essentially center the gtk-entry at hand, by
-        # making use of .xalign=.
-        # =================================================================== #
-        when :align_center,
-             :align_to_the_center,
-             :do_center
-          gtk_entry.xalign = 0.5
-        end
-      end
-    end
-    @internal_hash[:entries] << gtk_entry if @internal_hash
-    return gtk_entry
-  end; alias gtk_input gtk_entry # === gtk_input
-       alias input     gtk_entry # === input
-       alias entry     gtk_entry # === entry
-
-  # ========================================================================= #
-  # === gtk_entry_with_secondary_icon_name
-  # ========================================================================= #
-  def gtk_entry_with_secondary_icon_name(this_icon_name)
-    _ = gtk_entry
-    _.set_secondary_icon_name(this_icon_name)
-    return _
-  end
-
-  # ========================================================================= #
-  # === gtk_entry_with_icon_name
-  # ========================================================================= #
-  def gtk_entry_with_icon_name(this_icon_name)
-    _ = gtk_entry
-    _.set_primary_icon_name(this_icon_name)
-    return _
-  end
-
-  # ========================================================================= #
-  # === all_entries?
-  # ========================================================================= #
-  def all_entries?
-    @internal_hash[:entries]
-  end; alias return_all_entries all_entries? # === return_all_entries
-
-end; end

data/lib/gtk_paradise/base_module/gtk_fixed.rb

@@ -1,18 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'gtk_paradise/base_module/gtk_fixed.rb'
-# =========================================================================== #
-module Gtk
-
-module BaseModule
-
-  # ========================================================================= #
-  # === gtk_fixed
-  # ========================================================================= #
-  def gtk_fixed
-    ::Gtk::Fixed.new
-  end
-
-end; end