tkxxs 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjI5OGY5YjdkM2I1ZmRmY2I4ZWQ3NTI4NWNjNjUyNDFlZWFjODMzMg==
+  data.tar.gz: !binary |-
+    M2E4NjdlNTU4ZjM3ZjRhZTVkMGM2ZTJhOGIzNTkzMmQ2ZTA1NDI1Yg==
+SHA512:
+  metadata.gz: !binary |-
+    N2U0MjBlMmZmMGQ2NGMxYzRlYWFhNWZkOWM5NDNhZWMwZDBmNWM0ZmUwMzk4
+    NzhmOTIwYTRmMWE1MjU0ZTZmNmQzMjI3ZTc3MzZhODRkODI2NzZkMDE5ODBh
+    N2NmMjdmOTZjNGFhOGZiZDZjZWU1Yzg2ZmZjNWU2YmQzNjIyZTc=
+  data.tar.gz: !binary |-
+    Y2Y2MTAyZDhkZmNiY2QyNjRiMmZlMzQ3NzVlMzQwYjU5YzZhNzViY2IwMzRj
+    NGYzNmU2MGM4OTJjM2ExOGUwZDQ5NWI1YjU1MzVkNDA3NjQ5ODYxMzAyNWM1
+    NWUxOGZiZTExZGIwZDg3MmVlOWI5NjMxOGE5Y2YyNjg2YzMzM2U=

data/.autotest

@@ -0,0 +1,25 @@
+# -*- ruby -*-
+
+require "autotest/restart"
+
+# Autotest.add_hook :initialize do |at|
+#   at.testlib = "minitest/unit"
+#
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception "vendor"
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/CONTRIBUTORS

@@ -0,0 +1,2 @@
+
+* Axel Friedrich: axel  dod  friedrich_smail  ad  gmx  dod  de

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.1.0 / 2014-01-01
+
+* 1 major enhancement
+
+  * Birthday!
+

data/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Axel Friedrich and contributors (see the CONTRIBUTORS file)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,20 @@
+.autotest
+CONTRIBUTORS
+History.txt
+LICENSE
+Manifest.txt
+README.txt
+Rakefile
+ext/readme.txt
+ext/tkballoonhelp.rb
+ext/tkballoonhelp_ORIGINAL.rb
+images/screenshot.png
+lib/icon.gif
+lib/tkxxs.rb
+lib/tkxxs/conf.rb
+lib/tkxxs/tkxxs_classes.rb
+lib/tkxxs/version.rb
+rdoc_developers_hanna.bat
+rdoc_users_hanna.bat
+samples/big_example.rb
+samples/small_example.rb

data/README.txt

@@ -0,0 +1,168 @@
+= TKXXS
+
+* https://github.com/Axel2
+
+== References
+
+* Reference for input dialogs: TKXXS
+* Reference for the output window: TKXXS::OutW
+
+TKXXS_CLASSES is intended for developers only.
+
+
+== Description
+
+TKXXS provides a very simple and very easy to use GUI (graphical user interface) for Ruby; It gives you a persistent output window and popping up (modal) dialogs for input; For a screenshot, see: images/screenshot.png; Tested on Windows, only.
+
+TKXXS shall:
+
+* improve the usability of little applications, which otherwise would use a command line interface (CLI); for example by a GUI-file chooser
+* give a simple GUI front-end for apps, which take parameters on the command line. (stdout can easily be redirected to the OutputWindow.)
+* take only little more effort and coding time over programming a CLI;
+* be able to easily upgrade existing CLI-applications;
+* be comfortable in use (e.g. provide incremental search, tool-tip-help, ...);
+* be easy to install.
+
+
+Drawbacks:
+* I'v tested it only on Windows. Other operating system probably will need modifications, which I would like to merge in.
+* For sure some more drawbacks which I'm not aware of now.
+
+
+TKXXS uses TK (easy to install).
+
+
+== Dialogs
+
+As of now, the following dialogs exist:
+
+* ask_single_line
+* single_choice
+* multi_choice
+* open_file
+* open_files
+* choose_dir
+* save_file      
+
+All dialog-methods have three arguments:
+
+* Arg #1: (mostly optional) "The most important thing for this dialog" 
+  * ask_single_line -> question
+  * single_choice -> choices (not optional)
+  * multi_choice -> choices (not optional)
+  * open_file -> initialdir
+  * open_files -> initialdir
+  * choose_dir -> initialdir
+  * save_file -> filename      
+* Arg #2: (optional) Help string, which is shown in the balloon help
+* Arg #3: (optional) Hash, which takes additional arguments and optionally Arg#1 and Arg#2.
+
+== Small Example (see: samples/small_example.rb)
+
+  require 'tkxxs'
+  include TKXXS
+  
+  class MyTinyUI
+    
+    def initialize(  )
+      @outW = OutW.new  # create Output Window
+      @outW.puts "Hello"
+      ask_name
+      
+      Tk.mainloop  # You always needs this!
+    end # initialize
+  
+    def ask_name(  )
+      name = ask_single_line("Your name?")
+      @outW.puts "Hello #{name}."
+    end # ask_name
+  end
+  
+  MyTinyUI.new
+
+
+When running this script, you should resize the popping up windows as you like; size and position will be stored for the next time.
+
+You close the application simply by clicking the close-icon on top of the output window.
+
+== More elaborated example
+
+See samples/big_example.rb
+
+
+== Installation
+
+=== Prerequisites
+
+* Tested only on Windows
+* Ruby 1.8.7 or 1.9.x with TK (e.g. RubyInstaller)
+* gem Platform (starting with capital letter "P"!)
+
+=== Install
+
+  gem install tkxxs
+
+== Misc
+
+TKXXS stands for "TK very very small".
+
+== TODO
+
+* TODO: Encodings OK?
+* TODO: Write instruction for using OCRA with TKXXS.
+* TODO: There are several not-so-good things; I marked them with "TODO" in the doc and in the source code.
+* TODO: Find somebody to improve the English wording.
+* TODO: Prepare for localization (at least, translation). May be these are a starting points: 
+  * discussion[https://www.ruby-forum.com/topic/178478]
+  * discussion[https://www.ruby-forum.com/topic/4402551]
+  * ruby-gettext[http://www.yotabanana.com/hiki/ruby-gettext.html]
+  * r18n[https://github.com/ai/r18n]
+  * i18n[http://guides.rubyonrails.org/i18n.html]
+
+== Future
+
+2013-12-29: I wrote this code several years ago. Now I thought I should document it and give it to public. I'll _not_ develop it further, but I'll try to include pull requests.
+
+== For developers
+
+* For user's doc, tkxxs_classes.rb is not rdoc'ed in order to get a clearer documentation.
+* To create documentation of all files: 
+  <tt>rdoc -t TKXXS --force-update [-f hanna] -x ./samples --main ./tkxxs/README.rdoc ./tkxxs/README.rdoc ./lib</tt>
+* Class names inside module TKXXS_CLASSES end with capital letter D.
+* Arguments of "initialize" in tkxxs_classes.rb are documented at the corresponding module methods of TKXXS, if they exist (to avoid duplicates of documentation).
+
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010-2014 Axel Friedrich and contributors (see the CONTRIBUTORS file)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+
+
+
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,42 @@
+# -*- ruby -*-
+
+require "rubygems"
+require "hoe"
+
+Hoe.plugin :isolate
+Hoe.plugin :seattlerb
+
+# Hoe.plugin :compiler
+# Hoe.plugin :doofus
+# Hoe.plugin :email
+# Hoe.plugin :gem_prelude_sucks
+# Hoe.plugin :git
+# Hoe.plugin :history
+# Hoe.plugin :inline
+# Hoe.plugin :isolate
+# Hoe.plugin :minitest
+# Hoe.plugin :perforce
+# Hoe.plugin :racc
+# Hoe.plugin :rcov
+# Hoe.plugin :rubyforge
+# Hoe.plugin :seattlerb
+
+Hoe.spec "tkxxs" do
+  developer "Axel Friedrich", "axel dod friedrich underscore smail ad gmx dod de"
+  license "MIT"
+
+  spec_extras[:rdoc_options] = proc do |ary|
+    #rdoc.bat -t TKXXS --force-update -f hanna --op ./doc  -x lib/tkxxs/tkxxs_classes.rb -x lib/tkxxs/samples --main ./README.txt ./README.txt ./lib/tkxxs.rb
+
+
+    ary.push "-x", "lib/tkxxs/tkxxs_classes.rb"
+    ary.push "-x", "lib/tkxxs/samples"
+    ary.push "-x", "lib/tkxxs/conf.rb"
+  end
+
+  dependency "Platform", "~> 0.4.0"
+end
+
+# vim: syntax=ruby
+
+

data/ext/readme.txt

@@ -0,0 +1,3 @@
+I took  /ext/tk/sample/tkballonhelp.rb from Hidetoshi NAGAI (nagai@ai.kyutech.ac.jp) and modified it. A copy of the original file is tkballoonhelp_ORIGINAL.rb. As far as I know, licence is Ruby's licence. Newer version of this file are available here: http://svn.ruby-lang.org/repos/ruby/branches/ruby_1_9_3/ext/tk/sample/
+
+Axel Friedrich

data/ext/tkballoonhelp.rb

@@ -0,0 +1,332 @@
+#
+# tkballoonhelp.rb : simple balloon help widget
+#                       by Hidetoshi NAGAI (nagai@ai.kyutech.ac.jp)
+#
+# Add a balloon help to a widget.
+# This widget has only poor featureas. If you need more useful features,
+# please try to use the Tix extension of Tcl/Tk under Ruby/Tk.
+#
+# The interval time to display a balloon help is defined 'interval' option
+# (default is 750ms).
+#
+# Modifications by Axel Friedrich:
+# * 2010-03-01: 
+# * 2010-01-31: Shifting position of balloon if it is out of screen
+# * TODO: wraplength
+require 'tk'
+
+module Tk
+  module RbWidget
+    class BalloonHelp<TkLabel
+    end
+  end
+end
+class Tk::RbWidget::BalloonHelp<TkLabel
+  DEFAULT_FOREGROUND = 'black'
+  DEFAULT_BACKGROUND = 'white'
+  DEFAULT_INTERVAL   = 750
+
+  def _balloon_binding(interval)
+    @timer = TkAfter.new(interval, 1, proc{show})
+    def @timer.interval(val)
+      @sleep_time = val
+    end
+    @bindtag = TkBindTag.new
+    @bindtag.bind('Enter',  proc{@timer.start})
+    @bindtag.bind('Motion', proc{@timer.restart; erase})
+    @bindtag.bind('Any-ButtonPress', proc{@timer.restart; erase})
+    @bindtag.bind('Leave',  proc{@timer.stop; erase})
+    tags = @parent.bindtags
+    idx = tags.index(@parent)
+    unless idx
+      ppath = TkComm.window(@parent.path)
+      idx = tags.index(ppath) || 0
+    end
+    tags[idx,0] = @bindtag
+    @parent.bindtags(tags)
+  end
+  private :_balloon_binding
+
+  def initialize(parent=nil, keys={})
+    @parent = parent || Tk.root
+
+    @frame = TkToplevel.new(@parent)
+    if defined?($tkxxs_) && $tkxxs_[:userscreenx]
+      $balloonhlp_ = Hash.new
+      $balloonhlp_[:userscreenx]      = $tkxxs_[:userscreenx]
+      $balloonhlp_[:userscreeny]      = $tkxxs_[:userscreeny]
+      $balloonhlp_[:userscreenwidth]  = $tkxxs_[:userscreenwidth]
+      $balloonhlp_[:userscreenheight] = $tkxxs_[:userscreenheight]
+    elsif !defined?($balloonhlp_) || !$balloonhlp_[:userscreenx]
+      userscreen(@frame)
+    end
+    @frame.withdraw
+    @frame.overrideredirect(true)
+    @frame.transient(TkWinfo.toplevel(@parent))
+    @epath = @frame.path
+
+    if keys
+      keys = _symbolkey2str(keys)
+    else
+      keys = {}
+    end
+
+    @command = keys.delete('command')
+
+    @interval = keys.delete('interval'){DEFAULT_INTERVAL}
+    _balloon_binding(@interval)
+
+    # @label = TkLabel.new(@frame, 'background'=>'bisque').pack
+    @label = TkLabel.new(@frame, 
+                         ## :wraplength => '2i',  # Axel
+                         'foreground'=>DEFAULT_FOREGROUND, 
+                         ## 'background'=>DEFAULT_BACKGROUND).pack # -Axel
+                         'background'=>DEFAULT_BACKGROUND).pack(:expand=>1, :fill=>:both)
+    @label.configure(_symbolkey2str(keys)) unless keys.empty?
+    @path = @label
+  end
+
+  def userscreen( root )
+    # TODO: Screen "pops"; other way?
+    root.state('zoomed') 
+    root.update
+
+    if RUBY_PLATFORM[/mingw|mswin|bccwin/ix] # Windows
+      root.state('zoomed') # OK on Windows, bad on Linux
+    else
+      # Linux: works
+      # Other: not tested
+      root.height = root.winfo_screenheight
+      root.width = root.winfo_screenwidth
+    end
+
+    root.winfo_geometry  =~ /(\d+)x(\d+)\+([+-]?\d+)\+([+-]?\d+)/
+    xwg = $3.to_i 
+    ywg = $4.to_i
+    root.geometry =~ /(\d+)x(\d+)\+([+-]?\d+)\+([+-]?\d+)/ 
+    gw = $1.to_i 
+    gh = $2.to_i 
+    
+    ## sw = root.winfo_screenwidth 
+    ## sh = root.winfo_screenheight 
+    
+    rx = root.winfo_rootx 
+    ry = root.winfo_rooty  # maybe, taskbar height 
+    
+    border = -[xwg,ywg].min
+    userscreenx = xwg + border
+    userscreeny= ywg + border
+    userscreenwidth = gw
+    userscreenheight = gh + ry - ywg - border
+
+    $balloonhlp_ ||= Hash.new
+    $balloonhlp_[:userscreenx     ] =  userscreenx
+    $balloonhlp_[:userscreeny     ] =  userscreeny
+    $balloonhlp_[:userscreenwidth ] =  userscreenwidth
+    $balloonhlp_[:userscreenheight] =  userscreenheight
+
+    root.state('normal')
+    nil
+  end # userscreen
+
+  def epath
+    @epath
+  end
+
+  def interval(val)
+    if val
+      @timer.interval(val)
+    else
+      @interval
+    end
+  end
+
+  def command(cmd = Proc.new)
+    @command = cmd
+    self
+  end
+
+  def show
+    x = TkWinfo.pointerx(@parent)
+    y = TkWinfo.pointery(@parent)
+    ## @frame.geometry("+#{x+1}+#{y+1}")
+
+    if @command
+      case @command.arity
+      when 0
+        @command.call
+      when 2
+        @command.call(x - TkWinfo.rootx(@parent), y - TkWinfo.rooty(@parent))
+      when 3
+        @command.call(x - TkWinfo.rootx(@parent), y - TkWinfo.rooty(@parent),
+                      self)
+      else
+        @command.call(x - TkWinfo.rootx(@parent), y - TkWinfo.rooty(@parent),
+                      self, @parent)
+      end
+    end
+
+    @frame.geometry("+#{x+1}+#{y+1}")
+    @frame.update
+
+    rw = TkWinfo.reqwidth(@frame)
+    rh = TkWinfo.reqheight(@frame)
+    geom1 = geom(x,y,rw,rh) 
+    @frame.geometry(geom1)
+
+    @frame.deiconify
+    @frame.raise
+
+    ## @org_cursor = @parent['cursor'] # -patch Nagai
+    ## @parent.cursor('crosshair')     # -patch Nagai
+    begin                                        # +patch Nagai
+      @org_cursor = @parent.cget('cursor')       # +patch Nagai
+    rescue                                       # +patch Nagai
+      @org_cursor = @parent['cursor']            # +patch Nagai
+    end                                          # +patch Nagai
+    begin                                        # +patch Nagai
+      @parent.configure('cursor', 'crosshair')   # +patch Nagai
+    rescue                                       # +patch Nagai
+      @parent.cursor('crosshair')                # +patch Nagai
+    end                                          # +patch Nagai
+
+    @frame.update
+  end
+
+  def geom( x,y,rw,rh, gapx=1, gapy=10 ) # gap: pixels; may not be 0!
+    xcorrected = false
+    ## rw = TkWinfo.reqwidth(@frame)
+    ## rh = TkWinfo.reqheight(@frame)
+    xmin = $balloonhlp_[:userscreenx]
+    ymin = $balloonhlp_[:userscreeny]
+    xmax= xmin + $balloonhlp_[:userscreenwidth]
+    ymax= ymin + $balloonhlp_[:userscreenheight]
+
+    origx = x
+    x += gapx
+    y += gapy
+    
+    if x + rw > xmax
+      x = [(xmax-rw), xmin].max # Shift left
+      xcorrected = true
+    end
+    
+    y = y - gapy - rh  if y + rh > ymax # Shift up
+
+    if y < ymin # height will overlap pointer
+      y = ymin
+      x = origx - rw - gapx  if xcorrected # Shift left
+    end
+
+    if x < xmin # to big
+      x = xmin
+      wrap_help
+    end
+    geom = "+#{ x }+#{ y }" # balloon may not overlap cursor - why?
+   
+    geom
+  end # geom
+
+  
+  def wrap_help(  )
+    #TODO: Introduce "wraplength"
+    puts 'Cannot show balloon help: to big.'
+  end # wrap_help
+  
+
+  def erase
+    ## @parent.cursor(@org_cursor) # -patch Nagai
+    begin                                           # +patch Nagai
+      @parent.configure('cursor', @org_cursor)      # +patch Nagai
+    rescue                                          # +patch Nagai
+      @parent.cursor(@org_cursor)                   # +patch Nagai
+    end                                             # +patch Nagai
+    @frame.withdraw
+  end
+
+  def destroy
+    @frame.destroy
+  end
+end
+
+################################################
+# test
+################################################
+if __FILE__ == $0
+  TkButton.new('text'=>'This button has a balloon help') {|b|
+    pack('fill'=>'x')
+    Tk::RbWidget::BalloonHelp.new(b, 'text'=>' Message ')
+  }
+  TkButton.new('text'=>'This button has another balloon help') {|b|
+    pack('fill'=>'x')
+    Tk::RbWidget::BalloonHelp.new(b, 
+                        'text'=>"CONFIGURED MESSAGE\nchange colors, and so on",
+                        'interval'=>200, 'font'=>'courier',
+                        'background'=>'gray', 'foreground'=>'red')
+  }
+
+  sb = TkScrollbox.new.pack(:fill=>:x)
+  sb.insert(:end, *%w(aaa bbb ccc ddd eee fff ggg hhh iii jjj kkk lll mmm))
+=begin
+  # CASE1 : command takes no arguemnt
+  bh = Tk::RbWidget::BalloonHelp.new(sb, :interval=>500,
+                           :relief=>:ridge, :background=>'white',
+                           :command=>proc{
+                             y = TkWinfo.pointery(sb) - TkWinfo.rooty(sb)
+                             bh.text "current index == #{sb.nearest(y)}"
+                           })
+=end
+=begin
+  # CASE2 : command takes 2 arguemnts
+  bh = Tk::RbWidget::BalloonHelp.new(sb, :interval=>500,
+                           :relief=>:ridge, :background=>'white',
+                           :command=>proc{|x, y|
+                             bh.text "current index == #{sb.nearest(y)}"
+                           })
+=end
+=begin
+  # CASE3 : command takes 3 arguemnts
+  Tk::RbWidget::BalloonHelp.new(sb, :interval=>500,
+                      :relief=>:ridge, :background=>'white',
+                      :command=>proc{|x, y, bhelp|
+                        bhelp.text "current index == #{sb.nearest(y)}"
+                      })
+=end
+=begin
+  # CASE4a : command is a Proc object and takes 4 arguemnts
+  cmd = proc{|x, y, bhelp, parent|
+    bhelp.text "current index == #{parent.nearest(y)}"
+  }
+
+  Tk::RbWidget::BalloonHelp.new(sb, :interval=>500,
+                      :relief=>:ridge, :background=>'white',
+                      :command=>cmd)
+
+  sb2 = TkScrollbox.new.pack(:fill=>:x)
+  sb2.insert(:end, *%w(AAA BBB CCC DDD EEE FFF GGG HHH III JJJ KKK LLL MMM))
+  Tk::RbWidget::BalloonHelp.new(sb2, :interval=>500,
+                      :padx=>5, :relief=>:raised,
+                      :background=>'gray25', :foreground=>'white',
+                      :command=>cmd)
+=end
+#=begin
+  # CASE4b : command is a Method object and takes 4 arguemnts
+  def set_msg(x, y, bhelp, parent)
+    bhelp.text "current index == #{parent.nearest(y)}"
+  end
+  cmd = self.method(:set_msg)
+
+  Tk::RbWidget::BalloonHelp.new(sb, :interval=>500,
+                                :relief=>:ridge, :background=>'white',
+                                :command=>cmd)
+
+  sb2 = TkScrollbox.new.pack(:fill=>:x)
+  sb2.insert(:end, *%w(AAA BBB CCC DDD EEE FFF GGG HHH III JJJ KKK LLL MMM))
+  Tk::RbWidget::BalloonHelp.new(sb2, :interval=>500,
+                                :padx=>5, :relief=>:raised,
+                                :background=>'gray25', :foreground=>'white',
+                                :command=>cmd)
+#=end
+
+  Tk.mainloop
+end