tk-doubleslider 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f2017932a98ff943f05066b9e8e77c6f0d998d5
+  data.tar.gz: 1b7aedd78ff5f2f85bc664ab70dc3db2873834f0
+SHA512:
+  metadata.gz: 26cd45d3211fc4b549ea1d0cb8f3386c04528e2bd53db992f559eb4561599812238aafa082a2516ff68746c0103a28480b25cc2d1832ca6fbac952f39fb82ed2
+  data.tar.gz: 78446d42e156067ac7982faad07352dcabeac9244582d46287e6e7446e7c757b4f901d87fa872b6e8175b76943467d7ceda5ca055baca7b499176c8e489e5563

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-*
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tk-doubleslider.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 chrislee35
+
+MIT License
+
+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/README.md

@@ -0,0 +1,126 @@
+# Tk::Doubleslider
+
+A double-headed slider widget allows for a range to be specified.  This implementation works for Ruby Tk and provides ways to provide customized formatting of values, non-linear values, and log-based sliders (i.e., lots of accuracy for low values, but not for high values).
+
+This has been tested in:
+* ruby-1.8.7-p371
+* ruby-1.9.3-p392
+* ruby-2.0.0-p0
+	
+RVM install command example (rvm doesn't install with tk or tcl by default):
+
+	rvm reinstall 1.9.3 --enable-shared --enable-pthread --with-tk --with-tcl
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tk-doubleslider'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tk-doubleslider
+
+## Usage
+
+Within a Tk project, you'll need to have a Window with a Frame to place the Doubleslider within.  Here is a minimalistic example:
+
+	require 'tk'
+	
+	def minimal_example()
+		# create the root window for this Tk app
+		root = TkRoot.new() {
+			title "Tk::DoubleSlider Test"
+			protocol('WM_DELETE_WINDOW', proc{ exit })
+		}
+		# bind ctrl-c to exit
+		root.bind('Control-c', proc{ exit })
+		# create a frame to place the Doubleslider within
+		left_frame = TkFrame.new(root)
+		left_frame.grid(:row=>0,:column=>0,:sticky=>'new')
+		# create a "time window" from 7 days ago until now
+		time_min = Time.now.to_i - (7*24*60*60)
+		time_max = Time.now.to_i
+		# create a "time slider" with a value formatter in HH:MM format and a delta formatter of 0.00 hours.
+		timeslide = Tk::Doubleslider.new( left_frame, 
+			:min=>time_min, # what's the minimal possible value
+			:max=>time_max, # what's the maximum possible value
+			:low=>time_min, # what's the current minimum value
+			:high=>time_max, # what's the current max
+			:snap => 300, # when you slide the slider, by what increments (for this example, it's every 5 minutes)
+			:label=>'Time', # what do you call this slider
+			:valuefmt => proc { |x| Time.at(x).strftime("%H:%M") }, # how shall we format the values
+			:deltafmt => proc { |x| sprintf("%0.2f hours", (x/3600.0)) } # how shall we format the delta
+		)
+		# pack everything together
+		timeslide.pack()
+		# enter the main loop
+		Tk.mainloop()
+	end
+	
+
+Great, so what options can Tk::Doubleslider take and what are their defaults?
+
+	height = 36.0    # height in pixels
+	width = 360.0    # width in pixel
+	min = 0.0        # minimum possible value
+	max = 0.0        # maximum possible value
+	low = 0.0        # the current minimum value
+	high = 0.0       # the current high value
+	ballsize = 5     # the size in pixels of the header (the knob)
+	snap = false     # snap increments in value
+	logbase = false  # use logirithms to scale the slider (pretty cool stuff)
+	# colors for the slider
+	colors = {
+		:background => 'grey20',
+		:line => 'grey75',
+		:low_head => '#996666',
+		:high_head => '#996666',
+		:text => 'white',
+		:delta => 'white',
+	}
+	# margins
+	left_margin = 10.0
+	right_margin = 20.0
+	top_margin = 6.0
+	bottom_margin = 4.0
+	change_cb = nil  # callback to call when a selection has changed, object must have a method called, "call", which must accept a low and high value (see example below)
+	# how to format the value
+	valuefmt = proc { |x| sprintf "%d", x }
+	# how to format the delta (defaults to valuefmt)
+	deltafmt = nil
+	# the label to display on the slider, a string
+	label = nil
+
+Now, how about that callback that I promised you?
+
+	class TkDS_Callback
+		def call(low, high)
+			puts "#{low} #{high}"
+			if low < 90
+				puts "Maybe you should reconsider your answer"
+			end
+		end
+	end
+	
+	timeslide = Tk::Doubleslider.new( left_frame, :min => 0, :max => 100, :low => 90, :high => 100,
+		:cb => TkDS_Callback.new, :label => 'your love for TkDS')
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+Copyright (c) 2011 Chris Lee, PhD. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.test_files = FileList['test/test_*.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/tk/doubleslider.rb

@@ -0,0 +1,174 @@
+#require "tk/doubleslider/version"
+# DESCRIPTION: provides a TK widget with two "heads", a high and a low.
+# Copyright (C) 2007 Christopher Lee
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+module Tk
+	class Doubleslider
+    VERSION = "0.1.1"
+
+		def pack(*args)
+			@canvas.pack(*args)
+		end
+
+		def redraw
+			@canvas.delete('all');
+			x1 = value2x(@low)
+			x2 = value2x(@high)
+			y = @height/2
+			TkcText.new(@canvas, 2, @height - 2, :text=>@label, :anchor=>'sw', :fill => @colors[:text]) if @label
+			TkcLine.new(@canvas, @left_margin, y, @width - @right_margin, y, :fill => @colors[:line], :width => 1, :tags => ['track'])
+			TkcLine.new(@canvas, @left_margin, y, @width - @right_margin, y, :fill => @colors[:line], :width => 4, :tags => ['selection'])
+			TkcOval.new(@canvas, x1 - @ballsize, y - @ballsize, x1 + @ballsize, y + @ballsize, :fill => @colors[:low_head], :width => 1, :tags => ['low'])
+			TkcOval.new(@canvas, x2 - @ballsize, y - @ballsize, x2 + @ballsize, y + @ballsize, :fill => @colors[:high_head], :width => 1, :tags => ['high'])
+			if @valuefmt
+				TkcText.new(@canvas, x1, @top_margin, :text => @valuefmt.call(@low), :tags => ['lowvalue'], :fill => @colors[:text])
+				TkcText.new(@canvas, x2, @height - @bottom_margin, :text => @valuefmt.call(@high), :tags => ['highvalue'], :fill => @colors[:text])
+				fmt = @deltafmt || @valuefmt  # use delta format instead of value format if it is defined
+				TkcText.new(@canvas, (x1+x2)/2, y, :text => fmt.call(@high - @low), :tags => ['delta'], :fill => @colors[:delta])
+				coords = @canvas.bbox('delta')
+				TkcRectangle.new(@canvas,coords[0], coords[1], coords[2], coords[3], :fill => @colors[:background], :tags => ['deltabg'], :outline => @colors[:background]) if coords.length > 0
+				@canvas.raise('delta','all')
+			end
+			@canvas.itembind('low', 'ButtonPress-1', proc { @sel = 'low' })
+			@canvas.itembind('high', 'ButtonPress-1', proc { @sel = 'high' })
+			@canvas.itembind('all', 'ButtonRelease-1', proc { @sel = nil })
+			@canvas.itembind('low||high', 'Button1-Motion', proc { |x,y| move(@sel,x,y) }, "%x %y")  
+		end
+
+		def move(tag, x, y)
+			return unless @sel
+			@canvas.raise @sel, 'all'
+			x = @left_margin if x < @left_margin
+			x = @width - @right_margin if x > @width - @right_margin
+			x = value2x(snap(x2value(x)))
+			y = @height/2
+			# don't update the text and deltas unless they need to be updated
+			return if instance_variable_get("@#{@sel}") == x2value(x)
+			instance_variable_set("@#{@sel}",x2value(x))
+			@canvas.coords(@sel, x - @ballsize, y - @ballsize, x + @ballsize, y + @ballsize)
+			if @sel == 'low' and @low > @high
+				@high = @low
+				@canvas.coords('high', x - @ballsize, y - @ballsize, x + @ballsize, y + @ballsize)
+			elsif @sel == 'high' and @high < @low
+				@low = @high
+				@canvas.coords('low', x - @ballsize, y - @ballsize, x + @ballsize, y + @ballsize)
+			end
+			lx = value2x(@low)
+			hx = value2x(@high)
+			@canvas.coords('selection', lx, y, hx, y)
+			if @valuefmt
+				@canvas.coords('lowvalue', lx, @top_margin)
+				@canvas.coords('highvalue', hx, @height - @bottom_margin)
+				@canvas.coords('delta', (lx+hx)/2, y)
+				@canvas.itemconfigure('lowvalue', :text => @valuefmt.call(@low))
+				@canvas.itemconfigure('highvalue', :text => @valuefmt.call(@high))
+				fmt = @deltafmt || @valuefmt  # use delta format instead of value format if it is defined
+				@canvas.itemconfigure('delta', :text => fmt.call(@high - @low))
+				coords = @canvas.bbox('delta')
+				w1 = coords[2] - coords[0]
+				if coords[0] < lx +5
+					if lx < @width/2
+						coords2 = @canvas.bbox('lowvalue')
+						ox = coords2[2] + 10 + (w1/2)
+						oy = @top_margin
+						@canvas.coords('delta',ox,oy)
+					else
+						coords2 = @canvas.bbox('highvalue')
+						ox = coords2[0] - 10 - (w1/2)
+						oy = @height - @bottom_margin
+						@canvas.coords('delta',ox,oy)
+					end
+				end
+				coords = @canvas.bbox('delta')
+				@canvas.coords('deltabg', coords[0], coords[1], coords[2], coords[3])
+			end
+			@change_cb.call(@low,@high) if @change_cb
+		end
+
+		def snap(x)
+			return x unless @snap
+			return @max if x > @max - @snap
+			x = (x - (x % @snap)).to_i
+			return x
+		end
+
+		def x2value(x)
+			x = @left_margin if x < @left_margin
+			r = @width - @right_margin
+			x = r if x > r
+			l = @left_margin
+			o = (x - l).to_f
+			dx = (r - l).to_f
+			frac = o/dx
+			if @logbase
+				return @max**(o/dx)
+			else
+				return @min+((o/dx)*(@max - @min))
+			end
+		end
+
+		def value2x(v)
+			v = @max if v > @max
+			v = @min if v < @min
+			w = @width - @left_margin - @right_margin
+			if @logbase
+				return @left_margin + (Math.log(v)*w/Math.log(@max))
+			else
+				return @left_margin + (((v - @min).to_f/(@max - @min).to_f)*w)
+			end
+		end
+
+		attr_accessor :change_cb, :valuefmt, :colors
+		def initialize(parent,*args)
+			@height = 36.0
+			@width = 360.0
+			@min = @max = @low = @high = 0.0
+			@ballsize = 5
+			@snap = false
+			@logbase = false
+			@colors = {
+				:background => 'grey20',
+				:line => 'grey75',
+				:low_head => '#996666',
+				:high_head => '#996666',
+				:text => 'white',
+				:delta => 'white',
+			}
+			@left_margin = 10.0
+			@right_margin = 20.0
+			@top_margin = 6.0
+			@bottom_margin = 4.0
+			@selection = nil
+			@change_cb = nil
+			@valuefmt = proc { |x| sprintf "%d", x }
+			@deltafmt = nil
+			@label = nil
+			if args.length > 0
+				args[0].each do |k,v|
+					if instance_variable_defined?("@#{k}")
+						if v =~ /^[\d\.]+$/
+							instance_variable_set("@#{k}", v.to_f)
+						else
+							instance_variable_set("@#{k}", v)
+						end
+					end
+				end
+			end
+			@canvas = TkCanvas.new(parent, :width => @width, :height => @height, :scrollregion => [0, 0, @width, @height])
+			@canvas.configure('background', @colors[:background]) if @colors[:background]
+			redraw
+		end
+	end
+end

data/lib/tk/doubleslider/version.rb

@@ -0,0 +1,5 @@
+module Tk
+  module Doubleslider
+    VERSION = "0.1.1"
+  end
+end

data/test/helper.rb

@@ -0,0 +1,3 @@
+require 'test/unit'
+require 'tk'
+require File.expand_path('../../lib/tk/doubleslider.rb', __FILE__)

data/test/test_tk-doubleslider.rb

@@ -0,0 +1,42 @@
+unless Kernel.respond_to?(:require_relative)
+  module Kernel
+    def require_relative(path)
+      require File.join(File.dirname(caller[0]), path.to_str)
+    end
+  end
+end
+
+require_relative 'helper'
+
+class TestDoubleslider < Test::Unit::TestCase
+	def test_display_double_headed_slider_with_linear_scale_and_custom_value_and_delta_formatters
+		# create the root window for this Tk app
+		root = TkRoot.new() {
+			title "Tk::DoubleSlider Test"
+			protocol('WM_DELETE_WINDOW', proc{ exit })
+		}
+		# bind ctrl-c to exit
+		root.bind('Control-c', proc{ exit })
+		# create a frame to place the Doubleslider within
+		left_frame = TkFrame.new(root)
+		left_frame.grid(:row=>0,:column=>0,:sticky=>'new')
+		# create a "time window" from 7 days ago until now
+		time_min = Time.now.to_i - (7*24*60*60)
+		time_max = Time.now.to_i
+		# create a "time slider" with a value formatter in HH:MM format and a delta formatter of 0.00 hours.
+		timeslide = Tk::Doubleslider.new( left_frame, 
+			:min=>time_min, # what's the minimal possible value
+			:max=>time_max, # what's the maximum possible value
+			:low=>time_min, # what's the current minimum value
+			:high=>time_max, # what's the current max
+			:snap => 300, # when you slide the slider, by what increments (for this example, it's every 5 minutes)
+			:label=>'Time', # what do you call this slider
+			:valuefmt => proc { |x| Time.at(x).strftime("%H:%M") }, # how shall we format the values
+			:deltafmt => proc { |x| sprintf("%0.2f hours", (x/3600.0)) } # how shall we format the delta
+		)
+		# pack everything together
+		timeslide.pack()
+		# enter the main loop
+		Tk.mainloop()
+	end
+end

data/tk-doubleslider.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tk/doubleslider/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "tk-doubleslider"
+	spec.version       = Tk::Doubleslider::VERSION
+	spec.authors       = ["chrislee35"]
+	spec.email         = ["rubygems@chrislee.dhs.org"]
+	spec.description   = %q{This provides an advanced, double-headed slider widget that allows selection of a range of values on a linear, log, square root, or cube root axis.}
+	spec.summary       = %q{A double headed slider widget for Tk}
+	spec.homepage      = "https://rubygems.org/gems/tk-doubleslider"
+	spec.license       = "MIT"
+
+	spec.files         = `git ls-files`.split($/)
+	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+	spec.require_paths = ["lib"]
+
+	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rake"
+	
+	#spec.add_runtime_dependency "tk"
+	
+	spec.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: tk-doubleslider
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- chrislee35
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This provides an advanced, double-headed slider widget that allows selection
+  of a range of values on a linear, log, square root, or cube root axis.
+email:
+- rubygems@chrislee.dhs.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tk/doubleslider.rb
+- lib/tk/doubleslider/version.rb
+- test/helper.rb
+- test/test_tk-doubleslider.rb
+- tk-doubleslider.gemspec
+homepage: https://rubygems.org/gems/tk-doubleslider
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A double headed slider widget for Tk
+test_files:
+- test/helper.rb
+- test/test_tk-doubleslider.rb