gtk_paradise 0.9.120

data/lib/gtk_paradise/toplevel_methods/register_sigint.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'gtk_paradise/toplevel_methods/register_sigint.rb'
+# Gtk.register_sigint
+# =========================================================================== #
+module Gtk
+
+  # ========================================================================= #
+  # === Gtk.register_sigint
+  # ========================================================================= #
+  def self.register_sigint
+    Signal.trap('SIGINT') { exit }
+  end
+
+end

data/lib/gtk_paradise/toplevel_methods/roebe.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'gtk_paradise/toplevel_methods/roebe.rb'
+# Gtk.is_on_roebe?
+# =========================================================================== #
+module Gtk
+
+  # ========================================================================= #
+  # === Gtk.is_on_roebe?
+  # ========================================================================= #
+  def self.is_on_roebe?
+    ENV['IS_ROEBE'].to_s == '1'
+  end; self.instance_eval { alias on_roebe?        is_on_roebe? } # === Gtk.on_roebe?
+       self.instance_eval { alias are_we_on_roebe? is_on_roebe? } # === Gtk.are_we_on_roebe?
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Gtk.is_on_roebe?
+end

data/lib/gtk_paradise/toplevel_methods/screen_resolution.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'gtk_paradise/toplevel_methods/screen_resolution.rb'
+# Gtk.resolution?
+# =========================================================================== #
+module Gtk
+
+  # ========================================================================= #
+  # === Gtk.resolution?
+  #
+  # Query the resolution of the target computer, via Gdk::Screen
+  # related methods. This will return the max-width and max-height
+  # value, respectively.
+  #
+  # Note that this method will work both with ruby-gtk2 and with ruby-gtk3.
+  #
+  # An Array will be returned by this method, such as [1920, 1080].
+  # ========================================================================= #
+  def self.resolution?
+    _ = Gdk::Screen.default
+    [_.width, _.height]
+  end; self.instance_eval { alias screen_resolution? resolution? } # === Gtk.screen_resolution?
+
+  # ========================================================================= #
+  # === Gtk.max_width?
+  #
+  # This is functionally equivalent to Gdk::Screen.default.width().
+  # ========================================================================= #
+  def self.max_width?
+    resolution?.first
+  end
+
+  # ========================================================================= #
+  # === Gtk.max_height?
+  # ========================================================================= #
+  def self.max_height?
+    resolution?.last
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  require 'gtk3'
+  pp Gtk.resolution?
+end

data/lib/gtk_paradise/toplevel_methods/select_file.rb

@@ -0,0 +1,168 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'gtk_paradise/toplevel_methods/select_file.rb'
+# Gtk.select_file
+# =========================================================================== #
+module Gtk
+
+  require 'gtk_paradise/toplevel_methods/determine_which_gtk_version_is_in_use.rb'
+  require 'gtk_paradise/toplevel_methods/roebe.rb'
+
+  # ========================================================================= #
+  # === Gtk.do_select_file
+  #
+  # This method can be used to select a specific (local) file.
+  #
+  # The filename will be returned by this method, as a String.
+  #
+  # A complex usage example follows next:
+  #
+  #   filename = ::Gtk.select_file(parent_widget_here) {{
+  #     current_folder:             current_folder,
+  #     show_hidden:                true,
+  #     extra_widget:               @extra_button,
+  #     add_these_shortcut_folders: ARRAY_ADD_THESE_SHORTCUT_FOLDERS,
+  #     use_this_file_filter:       '.pdf'
+  #   }}
+  #
+  # ========================================================================= #
+  def self.do_select_file(
+      parent_widget,
+      use_this_file_filter = nil
+    )
+    yielded = nil
+    if block_given?
+      yielded = yield
+    end
+    action_option = :open
+    # ======================================================================= #
+    # Next, handle ruby-gtk2:
+    # ======================================================================= #
+    if use_gtk2?
+      action_option = Gtk::FileChooser::ACTION_OPEN
+      dialog = Gtk::FileChooserDialog.new(
+        'Open File',
+        parent_widget,
+        action_option,
+        nil,
+        [Gtk::Stock::CANCEL, Gtk::Dialog::RESPONSE_CANCEL],
+        [Gtk::Stock::OPEN,   Gtk::Dialog::RESPONSE_ACCEPT]
+      )
+    else # else handle ruby-gtk3.
+      dialog = Gtk::FileChooserDialog.new(
+        title: 'Open File',
+        action: action_option,
+        buttons: [[Gtk::Stock::CANCEL, :cancel],
+                  [Gtk::Stock::OPEN,   :accept]]
+      )
+    end
+    if yielded and yielded.is_a?(Hash)
+      # ===================================================================== #
+      # === :current_folder
+      #
+      # Usage example for this entry point:
+      #
+      #   ::Gtk.select_file {{ current_folder: '/home/' }}
+      #
+      # ===================================================================== #
+      if yielded.has_key? :current_folder
+        _ = yielded[:current_folder]
+        dialog.set_current_folder(_)
+      end
+      # ===================================================================== #
+      # === :show_hidden
+      # ===================================================================== #
+      if yielded.has_key? :show_hidden
+        dialog.show_hidden = yielded[:show_hidden]
+      end
+      # ===================================================================== #
+      # === :extra_widget
+      # ===================================================================== #
+      if yielded.has_key? :extra_widget
+        dialog.extra_widget = yielded[:extra_widget]
+      end
+      # ===================================================================== #
+      # === :add_these_shortcut_folders
+      # ===================================================================== #
+      if yielded.has_key? :add_these_shortcut_folders
+        _ = [yielded[:add_these_shortcut_folders]].flatten.compact
+        _.each {|this_directory|
+          dialog.add_shortcut_folder(this_directory)
+        }
+      # ===================================================================== #
+      # === :additional_directories
+      # ===================================================================== #
+      elsif yielded.has_key? :additional_directories
+        _ = [yielded[:additional_directories]].flatten.compact
+        _.each {|this_directory|
+          dialog.add_shortcut_folder(this_directory)
+        }
+      end
+      # ===================================================================== #
+      # === :use_this_file_filter
+      # ===================================================================== #
+      if yielded.has_key? :use_this_file_filter
+        use_this_file_filter = yielded[:use_this_file_filter]
+      # ===================================================================== #
+      # === :filter_for_these_file_types
+      # ===================================================================== #
+      elsif yielded.has_key? :filter_for_these_file_types
+        use_this_file_filter = yielded[:filter_for_these_file_types]
+      end
+    end
+    if use_this_file_filter
+       use_this_file_filter = use_this_file_filter.to_s.dup
+       if use_this_file_filter.is_a? String
+         filter = ::Gtk::FileFilter.new
+         filter.name = use_this_file_filter.to_s+' files'
+         unless use_this_file_filter.start_with? '.'
+           use_this_file_filter.prepend('.')
+         end
+         unless use_this_file_filter.start_with? '*'
+           use_this_file_filter.prepend('*')
+         end
+         use_this_file_filter = filter.add_pattern(use_this_file_filter)
+       end
+       dialog.add_filter(use_this_file_filter)
+    end
+    # ======================================================================= #
+    # === Add some default shortcut-folders on Roebe
+    # ======================================================================= #
+    if is_on_roebe?
+      begin
+        dialog.add_shortcut_folder ENV['MY_SONGS']
+      rescue Exception; end
+      begin
+        dialog.add_shortcut_folder ENV['MY_TEMP']
+      rescue Exception; end
+      begin
+        dialog.add_shortcut_folder ENV['MY_DATA']
+      rescue Exception; end
+      begin
+        dialog.add_shortcut_folder ENV['RUBY_SRC']
+      rescue Exception; end
+      # ===================================================================== #
+      # Add some more directories by default next:
+      # ===================================================================== #
+      dialog.add_shortcut_folder '/Depot/j/'    unless Dir.pwd.include?('/Depot/j')
+      dialog.add_shortcut_folder '/Depot/jj/'   unless Dir.pwd.include?('/Depot/jj')
+      dialog.add_shortcut_folder '/Depot/jjj/'  unless Dir.pwd.include?('/Depot/jjj')
+      dialog.add_shortcut_folder '/Depot/jjjj/' unless Dir.pwd.include?('/Depot/jjjj')
+      # dialog.add_shortcut_folder '/' # <- Can not use this variant.
+    end
+    accept = :accept
+    if use_gtk2?
+      accept = Gtk::Dialog::RESPONSE_ACCEPT
+    end
+    case dialog.run
+    when accept
+      puts "filename = #{dialog.filename}"
+    end
+    result = dialog.filename
+    dialog.destroy # Clean it up here.
+    return result
+  end; self.instance_eval { alias select_file do_select_file } # === Gtk.select_file
+
+end

data/lib/gtk_paradise/toplevel_methods/spacer.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'gtk_paradise/toplevel_methods/spacer.rb'
+# ::Gtk.spacer
+# =========================================================================== #
+module Gtk
+
+  require 'gtk_paradise/toplevel_methods/determine_which_gtk_version_is_in_use.rb'
+
+  # ========================================================================= #
+  # === Gtk.spacer
+  #
+  # This method will add a horizontal spacer.
+  #
+  # Note that the Gtk::Separator widget is an abstract class, used only 
+  # for deriving the subclasses Gtk::HSeparator and Gtk::VSeparator.
+  # ========================================================================= #
+  def self.spacer
+    # ::Gtk::Separator.new(:horizontal) # ^^^ see above for an explanation why this is commented out.
+    return Gtk.horizontal_spacer
+  end
+
+  # ========================================================================= #
+  # === Gtk.horizontal_spacer
+  #
+  # We have to check whether gtk2 or gtk3 is used. Depending on this
+  # we will return a "different" separator.
+  # ========================================================================= #
+  def self.horizontal_spacer
+    if is_gtk2_in_use?
+      ::Gtk::HSeparator.new
+    else # Assume gtk3 here.
+      ::Gtk::Separator.new(:horizontal)
+    end
+  end; self.instance_eval { alias hspacer horizontal_spacer } # === Gtk.hspacer
+
+  # ========================================================================= #
+  # === Gtk.vertical_spacer
+  # ========================================================================= #
+  def self.vertical_spacer
+    if is_gtk2_in_use?
+      ::Gtk::VSeparator.new
+    else # Assume gtk3 here.
+      ::Gtk::Separator.new(:vertical)
+    end
+  end; self.instance_eval { alias vspacer vertical_spacer } # === Gtk.vspacer
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  require 'gtk2'
+  pp Gtk.is_gtk2_in_use?
+end

data/lib/gtk_paradise/toplevel_methods/text_buffer_tags.rb

@@ -0,0 +1,188 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Gtk::TextBufferTags
+#
+# This module will create some TextBufferTags.
+#
+# Usage Examples:
+#
+#   Gtk::TextBufferTags.create_default_tags
+#   Gtk::TextBufferTags.create_default_tags(@source_buffer_4)
+#   @text_buffer = Gtk::TextBufferTags.create_my_tags(@text_buffer)
+#
+# =========================================================================== #
+# require 'gtk_paradise/toplevel_methods/text_buffer_tags.rb'
+# Gtk::TextBufferTags.create_default_tags()
+# =========================================================================== #
+module Gtk
+
+module TextBufferTags # === Gtk::TextBufferTags
+
+  # ========================================================================= #
+  # === Gtk::TextBufferTags.h1_tag
+  # ========================================================================= #
+  def self.h1_tag(i)
+    i.create_tag('heading1', { 'font' => 'Sans 22'})
+  end
+
+  # ========================================================================= #
+  # === Gtk::TextBufferTags.create_default_tags
+  #
+  # The first argument must be a text-buffer.
+  # ========================================================================= #
+  def self.create_default_tags(
+      i = @text_buffer
+    )
+    unless i.respond_to? :create_tag
+      puts "The input class, #{i.class} does "\
+           "not respond to :create_tag method."
+    else # This is the default clause.
+      # =================================================================== #
+      # Create some headings first:
+      # =================================================================== #
+      # i.create_tag('heading1', { 'font' => 'Sans 22'})
+      Gtk::TextBufferTags.h1_tag(i)
+      i.create_tag('heading2', { 'font' => 'Sans 20'}) 
+      i.create_tag('heading3', { 'font' => 'Sans 18'}) 
+      i.create_tag('heading4', { 'font' => 'Sans 16'}) 
+      i.create_tag('heading5', { 'font' => 'Sans 14'}) 
+      i.create_tag('heading6', { 'font' => 'Sans 12'})
+      # =================================================================== #
+      # === Bold
+      # =================================================================== #
+      i.create_tag('b',        { weight: 600 })
+      i.create_tag('bold',     { weight: 600 })
+      # =================================================================== #
+      # === Italic
+      #
+      # i.create_tag('bold',   { 'weight' => :bold })
+      # italic:
+      # i.create_tag('i',      { :weight => :italic })
+      # =================================================================== #
+      i.create_tag('italic',   { style: :italic })
+      # oblique (kursiv):
+      # i.create_tag('o',      { 'weight' => :oblique })
+      # i.create_tag('kursiv', { 'weight' => :oblique })
+      # small caps:
+      # i.create_tag('sub',    { 'weight' => :small_caps })
+      # Comments for various languages
+      i.create_tag('comment',      { foreground: 'darkgray' })
+      i.create_tag('ruby-comment', { foreground: 'darkgray' })
+      # =================================================================== #
+      # Some colours - COLOUR TAG.
+      # =================================================================== #
+      #
+      # =================================================================== #
+      # red:
+      # =================================================================== #
+      i.create_tag('red', { foreground: 'red' })
+      # =================================================================== #
+      # darkred:
+      # =================================================================== #
+      i.create_tag('darkred', { foreground: 'darkred' })
+      # =================================================================== #
+      # green:
+      # =================================================================== #
+      i.create_tag('green', { foreground: 'green'})
+      # =================================================================== #
+      # darkgreen:
+      # =================================================================== #
+      i.create_tag('darkgreen', { foreground: 'darkgreen'})
+      # =================================================================== #
+      # lightgreen:
+      # =================================================================== #
+      i.create_tag('lightgreen', { foreground: 'lightgreen'})
+      # =================================================================== #
+      # blue:
+      # =================================================================== #
+      i.create_tag('blue',      { foreground: 'blue'})
+      # =================================================================== #
+      # steelblue:
+      # =================================================================== #
+      i.create_tag('steelblue', { foreground: 'lightblue'})
+      # =================================================================== #
+      # seagreen:
+      # =================================================================== #
+      i.create_tag('seagreen', { foreground: 'seagreen'})
+      # =================================================================== #
+      # lightblue:
+      # =================================================================== #
+      i.create_tag('lightblue', { foreground: 'lightblue'})
+      # =================================================================== #
+      # darkblue:
+      # =================================================================== #
+      i.create_tag('darkblue', { foreground: 'darkblue'})
+      # =================================================================== #
+      # slateblue:
+      # =================================================================== #
+      i.create_tag('slateblue', { foreground: 'slateblue'})
+      # =================================================================== #
+      # tomato:
+      # =================================================================== #
+      i.create_tag('tomato', { foreground: 'tomato'})
+      # =================================================================== #
+      # violet:
+      # =================================================================== #
+      i.create_tag('violet', { foreground: 'violet'})
+      # =================================================================== #
+      # yellow:
+      # =================================================================== #
+      i.create_tag('yellow', { foreground: 'yellow'})
+      # =================================================================== #
+      # === Alignments / Justifications
+      # =================================================================== #
+      i.create_tag('right_side', { justification: :right })
+      # =================================================================== #
+      # Some background colours are defined next.
+      # =================================================================== #
+      #
+      # =================================================================== #
+      # bg_red:
+      # =================================================================== #
+      i.create_tag('bg_red', { background: 'red'})
+      # =================================================================== #
+      # bg_black:
+      # =================================================================== #
+      i.create_tag('bg_black', { background: 'black'})
+      # =================================================================== #
+      # bg_blanchedalmond:
+      # =================================================================== #
+      i.create_tag('bg_blanchedalmond', { background: 'blanchedalmond'})
+      # =================================================================== #
+      # bg_honeydew:
+      # =================================================================== #
+      i.create_tag('bg_honeydew', { background: 'honeydew'})
+    end
+    return i # Finally return the text-buffer tags here.
+  end
+
+  # ========================================================================= #
+  # === create_my_tags
+  # ========================================================================= #
+  def create_my_tags(i = @text_buffer)
+    Gtk::TextBufferTags.create_my_tags
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  require 'gtk3'
+  require 'gtk_paradise/run'
+  r = Gtk.run
+  r.use_this_font = :hack_25
+  @text_buffer = Gtk.text_buffer
+  Gtk::TextBufferTags.create_my_tags(@text_buffer)
+
+  iter = @text_buffer.start_iter
+  @text_buffer.insert(iter, "This is an editor.\n")
+  iter.offset = 25
+
+  # tag = @text_buffer.tag_table.lookup(:h2)
+  # @text_buffer.insert(iter, 'A hyperlink: ', tags: [tag])
+
+  @text_view  = Gtk::TextView.new(@text_buffer)
+  r << @text_view
+  r.run
+end

data/lib/gtk_paradise/toplevel_methods/tokenizer.rb

@@ -0,0 +1,103 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Gtk::Tokenizer
+#
+# Will fontify things. Can be reused to colourize Ruby code.
+#
+# To use this class, try something like:
+#
+#   @tokenizer = Gtk::Tokenizer.new
+#
+# =========================================================================== #
+# require 'gtk_paradise/toplevel_methods/tokenizer.rb'
+# tokenizer = Gtk::Tokenizer.new
+# =========================================================================== #
+module Gtk
+
+class Tokenizer
+
+  begin
+    require 'roebe/toplevel_methods/keywords.rb'
+    # ======================================================================= #
+    # === RUBY_RESERVED_WORDS
+    # ======================================================================= #
+    RUBY_RESERVED_WORDS = Roebe.return_ruby_keywords
+    # ======================================================================= #
+    # === RUBY_RESERVED_WORDS_PATTERN
+    # ======================================================================= #
+    RUBY_RESERVED_WORDS_PATTERN = Regexp.compile(/(^|\s+)(#{RUBY_RESERVED_WORDS.collect do |pattern| 
+      Regexp.quote(pattern) 
+    end.join('|')})(\s+|$)/)
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === handle_string
+  #
+  # This piece of code simply works through a given string. 
+  # ========================================================================= #
+  def handle_string(i)
+    case i
+    when /".+?"/,
+         /'.+?'/
+      tag = :string
+    when /#.*$/,/^=begin/,/^=end/  # ,/^\/\/.*$/
+      tag = :comment
+    # the first is for empty () only IF a word is before it   
+    when /\(\)/ #/\w(\(\))$/ 
+      tag = :parens    
+    when /[A-Z][A-Za-z0-9_]+/
+      tag = :const
+    when RUBY_RESERVED_WORDS_PATTERN
+      tag = :reserved
+    else
+      tag = nil 
+    end
+    return tag, $LAST_MATCH_INFO
+  end
+  
+  # ========================================================================= #  
+  # === tokenize
+  # ========================================================================= #
+  def tokenize(
+      str   = 'hello world',
+      index = 0
+    )
+    until str.empty?
+      tag = nil
+      # ==================================================================== #
+      # Check given string and assign tags to it whenever you encounter
+      # a special meaning, such as a :string or a :comment
+      # Btw in ruby only # comment exist
+      # ==================================================================== #
+      tag, $LAST_MATCH_INFO = handle_string(str)
+      # ==================================================================== #
+      # We handled the tags, now its time to tokenize them again?
+      # ==================================================================== #
+      if tag
+        # pre_match is zb:
+        # =22
+        # e "Pre_match was:"+$LAST_MATCH_INFO.pre_match unless $LAST_MATCH_INFO.pre_match.empty?
+        #
+        tokenize($LAST_MATCH_INFO.pre_match, index) { |*args|
+          yield(*args)
+        }
+        start_pos = index + $LAST_MATCH_INFO.begin(0)
+        end_pos   = index + $LAST_MATCH_INFO.end(0)      
+        yield(tag, start_pos, end_pos)
+        index += (str.length - $LAST_MATCH_INFO.post_match.length)
+        str = $LAST_MATCH_INFO.post_match
+      else
+        index += str.length
+        str = ''.dup
+      end
+    end
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  _ = Gtk::Tokenizer.new
+  _.tokenize
+end

data/lib/gtk_paradise/toplevel_methods/tooltips.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file contains some code for gtk-tooltip related activities. It
+# should not require any other .rb file, in order to keep the logic
+# and the dependencies small and clean.
+#
+# The reason for this is that this file here may be required by other
+# files, such as gtk_classes/label.rb specifically, in order to add
+# more convenient tooltips to gtk-labels in general. So we want to
+# keep the dependency-chain minimal at all times.
+# =========================================================================== #
+# require 'gtk_paradise/toplevel_methods/tooltips.rb'
+# Gtk.set_tooltip
+# =========================================================================== #
+module Gtk
+
+  # ========================================================================= #
+  # === Gtk.set_tooltip
+  #
+  # The first argument to this method is the text that is to be displayed,
+  # as a String. For example, "Hello world!".
+  #
+  # The second argument shall be the widget that receives the tooltip.
+  # For example, a gtk-button as widget, or a gtk-label.
+  #
+  # Note that Gtk::Tooltips has been deprecated in ruby-gtk3, so this is
+  # only useful for ruby-gtk2. However had, even in ruby-gtk2 it is not
+  # recommended to use it, as there are other, simpler means to set
+  # a tooltip - namely via .tooltip_text=.
+  #
+  # Usage example:
+  #
+  #   Gtk.set_tooltip('Hello world!', widget)
+  #
+  # ========================================================================= #
+  def self.set_tooltip(
+      which_tip_to_use          = 'This is a popup.',
+      which_widget_to_use_it_on = nil
+    )
+    ::Gtk::Tooltips.new.set_tip(
+      which_widget_to_use_it_on,
+      which_tip_to_use,
+      nil
+    )
+  end; self.instance_eval { alias tooltip                     set_tooltip } # === Gtk.tooltip
+       self.instance_eval { alias tooltip_widget              set_tooltip } # === Gtk.tooltip_widget
+       self.instance_eval { alias set_tooltip_for_this_widget set_tooltip } # === Gtk.set_tooltip_for_this_widget
+
+  # ========================================================================= #
+  # === Gtk.tooltip_for
+  #
+  # This is like the above method (Gtk.set_tooltip), except that the 
+  # arguments are reversed.
+  #
+  # First comes the target-widget, then the specific message to display.
+  #
+  # Two aliass exist for this method, called Gtk.set_tooltip_for() and
+  # Gtk.fancy_tooltip=() respectively.
+  #
+  # The reason as to why this method was added was because I sometimes
+  # confused the order of arguments, so I found it simpler in these
+  # cases to use another API instead.
+  # ========================================================================= #
+  def self.tooltip_for(widget, text)
+    ::Gtk.set_tooltip(text, widget)
+  end; self.instance_eval { alias set_tooltip_for tooltip_for } # === Gtk.set_tooltip_for
+       self.instance_eval { alias fancy_tooltip=  tooltip_for } # === Gtk.fancy_tooltip=
+
+end