visualruby 1.0.19 → 3.0.2

data/vrlib/lib/treeview/columns/CalendarCol.rb

@@ -0,0 +1,89 @@
+
+module VR
+
+#  The CalendarCol class is a simple calendar window where you can edit
+#  the date:
+#  
+#  http://visualruby.net/img/calendar.jpg
+#  
+#  This class is very useful when you want to display and edit dates
+#  in a VR::ListView.  You can define a column with the type VR::CalendarCol
+#  and the column will display as a date, and when the user clicks on the
+#  date, a calendar window will appear so he/she can edit it:
+#  
+#   @view = VR::ListView.new(:name => String, :birthday => VR::CalendarCol)
+#   row = @view.add_row
+#   row[:name] = "Eric"
+#   row[:birthday] = VR::CalendarCol.new(DateTime.new(1966, 7, 14))
+#  
+#  See the example project, "listview_objects" for more.
+
+	class CalendarCol 
+
+		include GladeGUI
+
+		attr_accessor :date, :date_format, :show_time, :show_calendar
+#  
+#  - datetime - Instance of DateTime class that holds the date value.
+#  - date_format - String that holds the Ruby date format. Default: "%d %b %Y   %I:%M%p"
+#  - show_time - true/false If this is false, the time will not appear in the edit window.
+#  - show_calendar - true/false If this is false, Calendar will not appear.  Only time will edit.
+#  
+		def initialize(datetime, flags = {})  #flags = :hide_date => true, hide_time => true, :format => "%d %b %Y   %I:%M%p"
+			@format = flags[:format]
+			@format ||= flags[:hide_date] ? "%I:%M%p" : "%d %b %Y   %I:%M%p"
+			@format ||= flags[:hide_time] ? "%d %b %Y" : @date_format
+			@hide_date = flags[:hide_date]
+			@hide_time = flags[:hide_time]
+			@show_calendar = show_calendar
+			@date = datetime
+			@hour = @date.strftime("%I").to_f
+			@minute = @date.min()
+			@am = (@date.hour < 12)
+			@pm = !@am
+		end
+
+		def show_glade(parent = nil)
+			super			
+			@builder["hboxTime"].hide if @hide_time
+			@builder["date"].hide if @hide_date
+		end
+
+# displays time according to the @date_format instance variable.  If you want to
+# change the appearance of this object, assign a new vale to @date_format.
+	
+		def to_s
+			@date.strftime(@format)
+		end
+
+		def am__toggled(*args) # :nodoc:
+			@builder["pm"].active = !@builder["am"].active?
+		end
+
+		def pm__toggled(*args) # :nodoc:
+			@builder["am"].active = !@builder["pm"].active? 
+		end
+
+		def buttonSave__clicked(*args) # :nodoc:
+			get_glade_variables()
+			m = @builder["am"].active? ? "AM" : "PM"
+			t = DateTime.strptime("#{@hour.to_i.to_s} #{@minute.to_i.to_s} #{m}", "%I %M %p")
+			@date = DateTime.new(@date.year, @date.month, @date.day, t.hour, t.min, 0)
+			@builder["window1"].destroy
+		end
+
+		def buttonCancel__clicked(*args) # :nodoc:
+			@builder["window1"].destroy			
+		end
+
+		def <=>(calendar)
+			return @date <=> calendar.date
+		end
+
+		def value
+			@date
+		end
+
+	end
+
+end

data/vrlib/lib/treeview/columns/CellRendererCombo.rb

@@ -0,0 +1,66 @@
+module VR
+
+#  This class is a helper to VR::ListView and VR::TreeView.  When
+#  colums are created, this class is used as the renderer because
+#  it adds functionality to the Gtk Renderer.
+#  
+#  When you call ListView#render(model_col) an instance of this class
+#  will be returned.  It is a subclass of
+#  
+#  {Gtk::CellRendererCombo}[http://ruby-gnome2.sourceforge.jp/hiki.cgi?Gtk%3A%3ACellRendererCombo]
+#  
+#  So it has all the functionality of its parent, plus the methods listed here.
+#  
+
+
+  class CellRendererCombo < Gtk::CellRendererCombo
+  
+  	attr_accessor :edited_callback, :validate_block 
+		attr_reader :model_col, :column, :model_sym
+  
+  	def initialize(model_col, column, view, model_sym) # :nodoc:
+  		super()
+  		@model_col = model_col
+  		@column = column
+  		@view = view
+			@model_sym = model_sym
+			@view.model.set_sort_func(@model_col) { |m,x,y| x[@model_col].selected <=> y[@model_col].selected }
+  		@validate_block = Proc.new { |text, model_sym, row, view | true } 
+			self.editable = true
+			self.has_entry = false
+			@edited_callback = nil
+    	self.signal_connect('edited') do |ren, path, text| # iter for
+    		iter = @view.model.get_iter(path)
+  			if @validate_block.call(text, @model_sym, @view.vr_row(iter), @view)
+  				iter[@model_col].selected = text 
+					@edited_callback.call(@model_sym, @view.vr_row(iter)) if @edited_callback
+  			end	
+    	end
+  	end
+
+#  This sets the renderer's "editable" property to true, and makes it save
+#  the edited value to the model.  When a user edits a row in the ListView
+#  the value isn't automatically saved by Gtk.  This method groups both actions
+#  together, so setting edit_save=true, allows both editing and saving of
+#  the field.  
+#  
+#  Also, you can use VR::ListView and VR::TreeView's convenience methods to
+#  envoke call this method:
+#  
+#   NAME = 0
+#   ADDR = 1
+#   @view.set_attr([NAME, ADDR], :edit_save => true)  #sets model_col = 0, 1 
+#   @view.set_edit_save( 0 => true, 1 => false)
+#  
+#  is_editable = boolean
+#  
+ 
+  	def set_model(vr_combo) # :nodoc:
+  		self.model = Gtk::ListStore.new(String)
+  		vr_combo.selections.each { |s| r = self.model.append ; r[0] = s }
+  		self.text_column = 0
+  	end
+  
+  end
+
+end

data/vrlib/lib/treeview/columns/CellRendererDate.rb

@@ -0,0 +1,45 @@
+module VR
+
+#  This class is a helper to VR::ListView and VR::TreeView.  When
+#  colums are created, this class is used as the renderer because
+#  it adds functionality to the Gtk Renderer.
+#  
+#  When you call ListView#render(model_col) an instance of this class
+#  will be returned.  It is a subclass of
+#  
+#  {Gtk::CellRendererText}[http://ruby-gnome2.sourceforge.jp/hiki.cgi?Gtk%3A%3ACellRendererText]
+#  
+#  So it has all the functionality of its parent, plus the methods listed here.
+
+  class CellRendererDate < Gtk::CellRendererText
+  
+  	attr_accessor :date_format, :edited_callback, :model_col, :column, :model_sym
+
+  	def initialize(model_col, column, view, model_sym) # :nodoc:
+  		super()
+			@model_col = model_col
+			@column = column
+			@view = view
+			@model_sym = model_sym
+			@view.model.set_sort_func(@model_col) { |m,x,y| x[@model_col] <=> y[@model_col] }
+			@date_format = "%m-%d-%Y"
+  		@validate_block = Proc.new { |text, model_sym, row, view| 
+				begin
+					Date.strptime(text, @date_format)
+					true
+				rescue
+					alert("Unrecognized date format:  " + text)
+					false 
+				end } 
+			@edited_block = nil
+      self.signal_connect('edited') do |ren, path, text|
+    		next unless iter = @view.model.get_iter(path)
+    		if @validate_block.call(text, @model_sym, @view.vr_row(iter), @view)
+    			iter[@model_col] = DateTime.strptime(text, @date_format)
+  				@edited_callback.call(@model_sym, @view.vr_row(iter)) if @edited_callback
+    		end
+      end
+		end
+	end
+
+end

data/vrlib/lib/treeview/columns/CellRendererObject.rb

@@ -0,0 +1,57 @@
+module VR
+
+#  This class is a helper to VR::ListView and VR::TreeView.  When
+#  colums are created, this class is used as the renderer because
+#  it adds functionality to the Gtk Renderer.
+#  
+#  When you call ListView#render(model_col) an instance of this class
+#  will be returned.  It is a subclass of
+#  
+#  {Gtk::CellRendererText}[http://ruby-gnome2.sourceforge.jp/hiki.cgi?Gtk%3A%3ACellRendererText]
+#  
+#  So it has all the functionality of its parent, plus the methods listed here.
+
+  class CellRendererObject < Gtk::CellRendererText
+  
+  	attr_accessor :model_col, :column, :edited_callback, :visual_attributes_method, :model_sym
+
+  	def initialize(model_col, column, view, model_sym) # :nodoc:
+			super()
+  		@model_col = model_col
+			@model_sym = model_sym
+			@view = view
+			@column = column
+			@edit = true
+			@edited_callback = nil
+			@visual_attributes_method = "visual_attributes"
+			@view.model.set_sort_func(@model_col) { |m,x,y| x[@model_col] <=> y[@model_col] } 
+			@show_block = Proc.new { |obj| obj.show_glade() if obj.respond_to? "show_glade" }
+			@view.signal_connect("row_activated") do | view, path, col |
+				next if !@edit or !col.eql? @column
+				iter = @view.model.get_iter(path)
+				obj = iter[@model_col]
+				@show_block.call(obj)
+				block = @edited_callback ? @edited_callback.call(@model_sym, @view.vr_row(iter)) : true 
+				@view.signal_emit_stop("row_activated") if block	
+			end
+  	end
+  
+		alias :set_editable :editable=  
+  	def editable=(e)
+			@edit = e
+  	end
+	
+		def render_object(iter)
+			obj = iter[@view.id(@model_col)]
+			self.text = obj.respond_to?(:to_s) ?  obj.to_s : "Define to_s!"
+			if obj.respond_to? @visual_attributes_method
+				return unless attrib = obj.send(@visual_attributes_method)
+				attrib.each_pair do | key, val |
+					self.send( key.to_s + "=", val)
+				end
+			end
+		end
+ 
+	end
+
+end

data/vrlib/lib/treeview/columns/CellRendererPhone.rb

@@ -0,0 +1,45 @@
+module VR
+
+#  This class is a helper to VR::ListView and VR::TreeView.  When
+#  colums are created, this class is used as the renderer because
+#  it adds functionality to the Gtk Renderer.
+#  
+#  When you call ListView#render(model_col) an instance of this class
+#  will be returned.  It is a subclass of
+#  
+#  {Gtk::CellRendererText}[http://ruby-gnome2.sourceforge.jp/hiki.cgi?Gtk%3A%3ACellRendererText]
+#  
+#  So it has all the functionality of its parent, plus the methods listed here.
+
+  class CellRendererPhone < Gtk::CellRendererText
+  
+  	attr_accessor :phone_format, :edited_callback, :model_col, :column, :model_sym
+
+  	def initialize(model_col, column, view, model_sym) # :nodoc:
+  		super()
+			@model_col = model_col
+			@column = column
+			@view = view
+			@model_sym = model_sym
+			@view.model.set_sort_func(@model_col) { |m,x,y| x[@model_col] <=> y[@model_col] }
+			@phone_format = "%3-%3-%4"
+  		@validate_block = Proc.new { |text, model_sym, row, view| 
+				only_numbers = text.gsub(/[^0-9]/, "")
+				if (only_numbers.size == 10)
+					true
+				else
+					alert("Unrecognized phone number:  " + text)
+					false 
+				end } 
+			@edited_block = nil
+      self.signal_connect('edited') do |ren, path, text|
+    		next unless iter = @view.model.get_iter(path)
+    		if @validate_block.call(text, @model_sym, @view.vr_row(iter), @view)
+    			iter[@model_col] = DateTime.strptime(text, @date_format)
+  				@edited_callback.call(@model_sym, @view.vr_row(iter)) if @edited_callback
+    		end
+      end
+		end
+	end
+
+end

data/vrlib/lib/treeview/columns/CellRendererPixbuf.rb

@@ -0,0 +1,16 @@
+module VR
+
+  class CellRendererPixbuf < Gtk::CellRendererPixbuf # :nodoc:
+  
+  	attr_reader :model_col, :column, :model_sym
+  
+  	def initialize(model_col, column, view, model_sym)
+  		super()
+  		@column = column
+  		@model_col = model_col
+			@model_sym = model_sym
+  		@view = view
+  	end
+  end
+
+end

data/vrlib/lib/treeview/columns/CellRendererProgress.rb

@@ -0,0 +1,17 @@
+module VR
+
+  class CellRendererProgress < Gtk::CellRendererProgress # :nodoc:
+  
+  	attr_reader :model_col, :column, :model_sym
+  
+  	def initialize(model_col, column, view, model_sym)
+  		super()
+  		@model_col = model_col
+			@model_sym = model_sym
+  		@column = column
+  		@view = view	
+  	end
+  
+  end
+
+end

data/vrlib/lib/treeview/columns/CellRendererSpin.rb

@@ -0,0 +1,37 @@
+module VR
+
+#  This class is a helper to VR::ListView and VR::TreeView.  When
+#  colums are created, this class is used as the renderer because
+#  it adds functionality to the Gtk Renderer.
+#  
+#  When you call ListView#render(column_id) an instance of this class
+#  will be returned.  It is a subclass of
+#  
+#  GtkCellRendererSpin
+#  
+#  So it has all the functionality of its parent, plus the methods listed here.
+
+  class CellRendererSpin < Gtk::CellRendererSpin
+  
+  	attr_reader :model_col, :column, :model_sym
+		attr_accessor :edited_callback  
+
+  	def initialize(model_col, column, view, model_sym) # :nodoc:
+  		super()
+  		@model_col = model_col
+			@model_sym = model_sym
+  		@column = column
+  		@view = view
+  		self.editable = true
+			@view.model.set_sort_func(@model_col) { |m,x,y| x[@model_col].value <=> y[@model_col].value }
+			@edited_callback = nil
+    	self.signal_connect('edited') do |ren, path, text|
+    		next unless iter = @view.model.get_iter(path)
+    		iter[@model_col].value = text.to_f if (iter)
+				@edited_callback.call(@model_sym, @view.vr_row(iter)) if @edited_callback
+    	end
+  	end
+  
+  end
+
+end

data/vrlib/lib/treeview/columns/CellRendererText.rb

@@ -0,0 +1,38 @@
+module VR
+
+#  This class is a helper to VR::ListView and VR::TreeView.  When
+#  colums are created, this class is used as the renderer because
+#  it adds functionality to the Gtk Renderer.
+#  
+#  When you call ListView#render(model_col) an instance of this class
+#  will be returned.  It is a subclass of
+#  
+#  {Gtk::CellRendererText}[http://ruby-gnome2.sourceforge.jp/hiki.cgi?Gtk%3A%3ACellRendererText]
+#  
+#  So it has all the functionality of its parent, plus the methods listed here.
+
+  class CellRendererText < Gtk::CellRendererText
+  
+  	attr_accessor :validate_block, :edited_callback
+  	attr_reader :model_col, :column, :model_sym
+
+  	def initialize(model_col, column, view, model_sym) # :nodoc:
+  		super()
+  		@column = column
+			@model_sym = model_sym
+  		@model_col = model_col
+  		@view = view
+  		@validate_block = Proc.new { |text, model_sym, row, view| true }
+			@edited_callback = nil
+    	self.signal_connect('edited') do |ren, path, text|
+  			next unless iter = @view.model.get_iter(path)
+  			if @validate_block.call(text, @model_sym, @view.vr_row(iter), @view)
+  				iter[@model_col] = (iter[@model_col].is_a? String) ? text : text.to_f
+					@edited_callback.call(@model_sym, @view.vr_row(iter)) if @edited_callback
+  			end
+    	end 
+  	end
+  
+  end
+
+end

data/vrlib/lib/treeview/columns/CellRendererToggle.rb

@@ -0,0 +1,47 @@
+module VR
+
+#
+#  This renderer has a slightly different validate_block than the others.  Its validate_block will be called with three
+#  parameters:
+#  
+#   @view.renderer(:name).validate_block = Proc.new { | model_sym, row, view |
+#     (row[:name].length < 3)
+#   }
+#  
+#  Also, you can use the VR::CellRendererToggle#edited= method to allow editing.
+#
+
+  class CellRendererToggle < Gtk::CellRendererToggle
+  
+  	attr_accessor :validate_block, :edited_callback 
+  	attr_reader :model_col, :column, :model_sym
+
+  	def initialize(model_col, column, view, model_sym)
+  		super()
+  		@model_col = model_col
+			@model_sym = model_sym
+  		@column = column
+  		@view = view
+			@edited_callback = nil
+  		@validate_block = Proc.new { |model_sym, row, view | true }
+  		self.signal_connect('toggled') do |ren, path|
+  			@view.model.each { |mod, path, iter| iter[@model_col] = false } if self.radio?
+      	next unless iter = @view.model.get_iter(path)
+  			if @validate_block.call(@model_sym, @view.vr_row(iter), @view)
+  				iter[model_col] = !iter[model_col]
+ 					@edited_callback.call(@model_col, iter) if @edited_callback
+       	end
+      end
+  	end
+	
+		def editable=(is_editable)
+			self.sensitive = is_editable
+		end
+
+		def set_editable(is_editable)
+			self.sensitive = is_editable
+		end
+  
+  end
+ 
+end 

data/vrlib/lib/treeview/columns/ComboCol.rb

@@ -0,0 +1,43 @@
+
+	
+module VR 
+
+#  The Combo class is for use with VR::ListView and VR::TreeView.  It
+#  simply holds the values for a combobox to be displayed in the view.
+#  It is not a visual component, it just holds data.
+#  
+#  It is one of the data types that you can pass to the constructors for VR::ListView and
+#  VR::TreeView.  For example, to make the second column render as a combobox:
+#  
+#  	@view = VR::Treeview.new(Gdk::Pixbuf, VR::Combo, String)
+#  
+#  Then when you add data to the model:
+#  
+#  	@view.add_row(@pixbuf, VR::Combo.new("Mr", "Mr", "Mrs", "Ms"), "Hello World")
+#  
+#  This would set the combobox for this row so that "Mr" is selected, and "Mr", "Mrs", and "Ms" are the choices. 
+
+
+  class ComboCol # can't subclass String tried twice!!!
+  
+  	attr_accessor :selected, :selections	
+  
+#  This defines a combobox for a row in VR::ListView or VR::TreeView.  You pass three or more strings
+#  to the constructor, and the first string is the selected value that appears in the row in the 
+#  view.
+#  
+#  - current_selection (type String)
+#  - selections (comma separated list of Strings)	
+#  
+  	def initialize(current_selection, *selections)
+			@selected = current_selection
+  		@selections = selections
+  	end
+
+		def valid?(str)
+			@selections.include?(str)
+		end
+
+  end
+
+end

data/vrlib/lib/treeview/columns/CurrencyCol.rb

@@ -0,0 +1,23 @@
+	
+module VR 
+
+  class CurrencyCol
+  	
+  	attr_accessor :value, :format
+  
+  	def initialize(value, format = "$%.2f")
+  		set_value(value, format)
+  	end
+  
+  	def set_value(value, format = "$%.2f")
+  		@value = value
+  		@format = format
+  	end
+  
+  	def to_s
+  		format % @value.to_f
+  	end
+  
+  end
+
+end

data/vrlib/lib/treeview/columns/DateCol.rb

@@ -0,0 +1,20 @@
+
+	
+module VR 
+
+class DateCol
+	
+	attr_accessor :date
+
+	def initialize(date, format = "%Y-%m-%d")
+		set_date(date, format)
+	end
+
+	def set_date(date, format = "%Y-%m-%d")
+		@date = date
+#		gsub!(self, @date.strftime(format))
+	end
+
+end
+
+end

data/vrlib/lib/treeview/columns/ImageCol.rb

@@ -0,0 +1,27 @@
+
+module VR
+
+	class ImageCol #< Gdk::Pixbuf
+
+		include GladeGUI
+ 
+		def initialize(image)
+#			super(File.dirname(__FILE__) + "/../../../img/image-x-generic.png")
+			@image1 = image
+		end
+
+		def before_show()
+			@builder["window1"].resize 500, 360
+		end
+
+		def to_s
+			"<Img>"
+		end
+
+#		def visual_attributes
+#			{ :pixbuf => self }
+#		end
+
+	end
+
+end

data/vrlib/lib/treeview/columns/ProgressCol.rb

@@ -0,0 +1,27 @@
+
+#  ==The VR Module hold all the classes of the vrlib gem.  The most useful APIs are:
+#  
+#  ===GladeGUI -- loads glade form 
+#  ===VR::ListView -- makes Gtk::TreeView easy!
+
+
+module VR
+
+#  This class is simply a wrapper for an Integer.  It signals VR::Listview's
+#  and VR::Treeviews constructor to make this column a progressbar using
+#  VR::CellRendererProgress.  For example, whwn you create a VR::ListView,
+#  you can pass VR::Progress as a column type:
+#  
+#   @view = VR::ListView.new(String, VR::Progress, Gdk::Pixbif)
+#  
+#  This makes model_col #1 a progress bar.  When you set the value of the column,
+#  provide an integer value from 0 to 100:
+#  
+#  @view.add_row("Hello World", 65, @pixbuf)
+#  
+#  
+
+  class ProgressCol < Integer 
+  end
+
+end

data/vrlib/lib/treeview/columns/SpinCol.rb

@@ -0,0 +1,11 @@
+module VR
+
+	class SpinCol < Gtk::Adjustment
+
+		def initialize(val, min, max, step)
+			super(val, min, max, step, 0, 0)
+		end
+
+	end
+
+end

data/vrlib/lib/treeview/columns/TextCol.rb

@@ -0,0 +1,65 @@
+
+module VR
+
+#  The TextCol class is a simple text editor for editing strings of data:
+#  
+#  http://visualruby.net/img/textcol.jpg
+#  
+#  It is a very useful class when you want to display and edit long strings
+#  of data in a VR::ListView.  To create a coulmn of long strings in a VR::ListView,
+#  simply define the column type as VR::TextCol:
+#  
+#   @view = VR::ListView.new(:name => String, :quote => VR::TextCol)
+#   row = @view.add_row
+#   row[:name] = "Eric"
+#   row[:quote] = VR::TextCol.new("I have come to believe that the whole world is an enigma, a harmless enigma that is made terrible by our own mad attempt to interpret it as though it had an underlying truth.  - Umberto Eco) ")
+#  
+#  The above listview will only display the first 20 characters of the quote, so
+#  it won't destroy the appearance of the listview.  When a user clicks on the
+#  quote column, a window like the one above will appear.
+#  
+#  See the example project, "listview_objects" for more.
+
+	class TextCol 
+
+		include GladeGUI
+
+		attr_accessor :text, :length_to_display
+#  
+#  - text - String value of the field
+#  - length_to_display - Integer number of characters to display in the listview. Default: 20
+#  
+		def initialize(text, length_to_display = 20)
+			@length_to_display = length_to_display
+			@text = text
+		end
+
+		def before_show()
+			@builder["window1"].resize 650, 360
+		end
+
+#  The to_s method outputs the string that is shown in the VR::ListView.  By default
+#  it will display the first 20 characters of the string.  If you
+#  want to change the number of characters it displays, change the
+#  value of the length_to_display variable.
+
+		def to_s
+			(@text.size > @length_to_display ? @text[0, @length_to_display - 4] + "..." :  @text).gsub("\n"," ")
+		end
+
+		def buttonSave__clicked(*args) # :nodoc:
+			get_glade_variables()
+			@builder["window1"].destroy
+		end
+
+		def buttonCancel__clicked(*args) # :nodoc:
+			@builder["window1"].destroy
+		end
+
+		def <=>(text_col)
+			self.text <=> text_col.text
+		end
+
+	end
+
+end