vr-corelib 0.0.36

data/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) { |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/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) { |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
+					VR.msg("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/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) { |x,y| x[@model_col] <=> y[@model_col] } 
+			@show_block = Proc.new { |obj| obj.show() if obj.respond_to? "show" }
+			@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[@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/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) { |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
+					VR.msg("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/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/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/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) { |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/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/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/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/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