rbcurse-extras 0.0.0

data/lib/rbcurse/extras/include/celleditor.rb

@@ -0,0 +1,112 @@
+
+##
+# This file gives us a mean of using a component as an editor in a list or later table.
+# The component is created once and used with each row.
+# It does not really have a form associated with it, although we do set a form
+# so it can display itself. Otherwise it is not added to the forms widget list, so the 
+# form has no idea tha this widget exists.
+#
+# Tested with Field, combo and checkbox, tables.
+#
+module RubyCurses
+  class CellEditor
+    include ConfigSetup
+    include RubyCurses::Utils
+
+    def initialize component, config={}, &block
+      @component = component
+      s = @component.class.to_s.downcase()
+      s.slice!("rubycurses::")
+      @_class = s.to_sym
+      config_setup config # @config.each_pair { |k,v| variable_set(k,v) }
+      instance_eval &block if block_given?
+    end
+    def getvalue
+      case @_class
+      when :field
+        return field_getvalue
+      when :checkbox
+        return checkbox_getvalue
+      when :combobox
+        return combobox_getvalue
+      else
+        raise "Unknown class #{@_class} in CellEditor getv"
+      end
+    end
+    # maybe this should check valid (on_leave) and throw exception
+    def field_getvalue
+      #@component.on_leave # throws exception! Added 2009-01-17 00:47 
+      @component.init_vars # 2009-01-18 01:13 should not carry over to next row curpos and pcol
+      return @component.getvalue
+    end
+    def checkbox_getvalue
+      @component.getvalue
+    end
+    def combobox_getvalue
+      #@component.on_leave # added 2009-01-19 12:12 
+      @component.getvalue
+      #@component.selected_item
+    end
+    def setvalue value
+      case @_class
+      when :field
+        @component.set_buffer value
+      when :checkbox
+        @component.checked value
+      when :combobox
+        @component.set_buffer value
+        #index = @component.list.index value
+        #@component.current_index = index
+      else
+        raise "Unknown class #{@_class} in CellEditor setv"
+      end
+    end
+    def component
+      @component
+    end
+    # should be called from on_leave_cell of table, but is beng called from editing_stopped FIXME
+    def on_leave row, col
+      f = @component
+      f.on_leave
+      if f.respond_to? :editable and f.modified?
+        f.fire_handler(:CHANGED, f) 
+      end
+    end
+    def prepare_editor parent, row, col,  value
+      #value = value.dup if value.respond_to? :dup
+      value = value.dup rescue value
+      setvalue value #.dup
+      widget = component()
+      widget.row = row
+      widget.col = col
+      # unfortunately 2009-01-11 19:47 combo boxes editable allows changing value
+      # FIXME so combo's can be editable, but no new value added
+      if @_class == :combobox
+        widget.editable = false if widget.respond_to? :editable  # chb's don't ???
+      else
+        widget.editable = true if widget.respond_to? :editable  # chb's don't ???
+      end
+      widget.focusable = true
+      widget.visible = true
+      widget.form = parent.form
+      #$log.debug " prepare editor value #{widget.display_length} displlen #{widget.maxlen}"
+      #$log.debug " prepare editor form: #{widget.form} " # 2011-11-15 12:54:41
+      #widget.display_length = widget.display_length -1
+      widget.bgcolor = 'yellow'
+      widget.color = 'black'
+      widget.on_enter
+      #widget.attr = Ncurses::A_REVERSE | Ncurses::A_BOLD
+    end
+    #This may not really be necessary since we paint the cell editor only if editing is on
+    def cancel_editor
+      widget = component()
+      # NOOO THIS IS CALLED BY CANCEL AND STOP
+      # somehow we need to ensure that if on_leave fails you can't get out. Here its a bit late
+      # i think FIXME TODO
+      #widget.on_leave # call so any triggers or validations can fire
+      widget.focusable = false
+      widget.visible = false
+      widget.attr = Ncurses::A_REVERSE 
+    end
+  end # class
+end # module

data/lib/rbcurse/extras/include/checkboxcellrenderer.rb

@@ -0,0 +1,57 @@
+require 'rbcurse/core/include/listcellrenderer'
+module RubyCurses
+
+  ## 
+  # This is a basic list cell renderer that will render the to_s value of anything.
+  # Using alignment one can use for numbers too.
+  # However, for booleans it will print true and false. If editing, you may want checkboxes
+  class CheckBoxCellRenderer < ListCellRenderer
+    dsl_accessor :value    # text of label
+    dsl_accessor :surround_chars
+
+    def initialize boolean=nil, config={}, &block
+      @value = boolean
+      @text = "" # what if someone wants to show a label later. ??? XXX
+      @editable = false
+      @focusable = false
+      config_setup config # @config.each_pair { |k,v| variable_set(k,v) }
+      instance_eval &block if block_given?
+      init_vars
+    end
+    def init_vars
+      @justify ||= :left
+      @display_length ||= 5
+      @surround_chars = ['[',']']
+    end
+    def getvalue
+      @value
+    end
+
+    ##
+    # 
+    def repaint graphic, r=@row,c=@col, row_index=-1,value=@value, focussed=false, selected=false
+        #$log.debug "label :#{@text}, #{value}, #{r}, #{c} col= #{@color}, #{@bgcolor} acolor= #{acolor} j:#{@justify} dlL: #{@display_length} "
+
+      prepare_default_colors focussed, selected
+
+      buttontext = value ? "X" : " "
+      # HOW TO DO THE TEXT ??? XXX
+      # the space in dtext next line is a cheat, to clear off the space that the
+      # editor is leaving.
+      dtext = " " #@display_length.nil? ? @text : "%-*s" % [@display_length, @text]
+      if @align_right
+        #@text_offset = 0
+        #@col_offset = dtext.length + @surround_chars[0].length + 1
+        str = "#{dtext} " + @surround_chars[0] + buttontext + @surround_chars[1] 
+      else
+        pretext = @surround_chars[0] + buttontext + @surround_chars[1] 
+        #@text_offset = pretext.length + 1
+        #@col_offset = @surround_chars[0].length
+        #@surround_chars[0] + buttontext + @surround_chars[1] + " #{@text}"
+        str = pretext + " #{dtext}"
+      end
+      graphic.printstring r, c, str, @color_pair,@attr
+    end
+  # ADD HERE 
+  end
+end

data/lib/rbcurse/extras/include/comboboxcellrenderer.rb

@@ -0,0 +1,30 @@
+module RubyCurses
+
+  ## 
+  # This is a list cell renderer that will render combo boxes.
+  # Since a combo box extends a field therefore the repaint of field is used.
+  # In other words there is nothing much to do here.
+  # 
+  class ComboBoxCellRenderer < ListCellRenderer
+    include ConfigSetup
+    include RubyCurses::Utils
+
+    def initialize text="", config={}, &block
+      @text = text
+      @editable = false
+      @focusable = false
+      config_setup config # @config.each_pair { |k,v| variable_set(k,v) }
+      instance_eval &block if block_given?
+      init_vars
+    end
+    ## me thinks this is unused
+    def getvalue
+      raise "I think this is unused. comboboxcellrenderer line 36"
+      @text
+    end
+
+    ##
+    # 
+  # ADD HERE 
+  end
+end

data/lib/rbcurse/extras/include/defaultlistselectionmodel.rb

@@ -0,0 +1,79 @@
+require 'rbcurse/extras/include/listselectable'
+##
+# Added ListSelectionEvents on 2009-02-13 23:33 
+# Data model for list selections. Uses index or indices, or value/values. Please avoid using "row"
+# as this is not clear to user, and will be deprecated.
+# 2010-09-21 19:43 source now contains List object, not this class
+
+module RubyCurses
+  class DefaultListSelectionModel
+    include EventHandler
+    attr_accessor :selection_mode
+    attr_reader :anchor_selection_index
+    attr_reader :lead_selection_index
+    attr_reader :parent
+    def initialize parent
+      raise ArgumentError "Parent cannot be nil. Please pass List while creating" if parent.nil?
+      @parent  = parent
+
+      @selected_indices=[]
+      @anchor_selection_index = -1
+      @lead_selection_index = -1
+      @selection_mode = 'multiple'
+      @_events = [:LIST_SELECTION_EVENT]
+
+      #$log.debug " created DefaultListSelectionModel XXX"
+    end
+     #def event_list
+       #return @@events if defined? @@events
+       #nil
+     #end
+
+    def clear_selection
+      ix0 = @selected_indices.first
+      ix1 = @selected_indices.last
+      @selected_indices=[]
+      return if ix0.nil?
+      lse = ListSelectionEvent.new(ix0, ix1, @parent, :DELETE)
+      fire_handler :LIST_SELECTION_EVENT, lse
+    end
+    def is_selected_index ix
+      @selected_indices.include? ix
+    end
+    def get_max_selection_index
+      @selected_indices[-1]
+    end
+    def get_min_selection_index
+      @selected_indices[0]
+    end
+    def get_selected_indices
+      @selected_indices
+    end
+    alias :get_selected_rows :get_selected_indices
+    ## TODO should go in sorted, and no dupes
+    def add_selection_interval ix0, ix1
+      $log.debug " def add_selection_interval #{ix0}, #{ix1}, mode: #{@selection_mode} "
+      if @selection_mode != :multiple
+        clear_selection
+      end
+      @anchor_selection_index = ix0
+      @lead_selection_index = ix1
+      ix0.upto(ix1) {|i| @selected_indices  << i unless @selected_indices.include? i }
+      lse = ListSelectionEvent.new(ix0, ix1, @parent, :INSERT)
+      fire_handler :LIST_SELECTION_EVENT, lse
+      $log.debug " DLSM firing LIST_SELECTION EVENT #{lse}"
+    end
+    def remove_selection_interval ix0, ix1
+      @anchor_selection_index = ix0
+      @lead_selection_index = ix1
+      @selected_indices.delete_if {|x| x >= ix0 and x <= ix1}
+      lse = ListSelectionEvent.new(ix0, ix1, @parent, :DELETE)
+      fire_handler :LIST_SELECTION_EVENT, lse
+    end
+    def insert_index_interval ix0, len
+      @anchor_selection_index = ix0
+      @lead_selection_index = ix0+len
+      add_selection_interval @anchor_selection_index, @lead_selection_index
+    end
+  end # class DefaultListSelectionModel
+end

data/lib/rbcurse/extras/include/listkeys.rb

@@ -0,0 +1,37 @@
+module RubyCurses
+  module ListKeys
+    ## Note: keeping variables gives the false feeling that one can change the var anytime.
+    # That was possible earlier, but now that i am binding the key at construction time
+    # any changes to the vars after construction won't have an effect.
+    def install_list_keys
+      #@KEY_ROW_SELECTOR ||= ?\C-x.getbyte(0)  # need to changed from C-x since used for actions # changed 2011 dts  
+      @KEY_ROW_SELECTOR ||= 32  # need to changed from C-x since used for actions
+      @KEY_BLOCK_SELECTOR ||= ?\M-x.getbyte(0)  # need to change since M-x used for commands
+      @KEY_GOTO_TOP ||= ?\M-0.getbyte(0)
+      @KEY_GOTO_BOTTOM ||= ?\M-9.getbyte(0)
+      #@KEY_ASK_FIND_FORWARD ||= ?\M-f.getbyte(0)
+      #@KEY_ASK_FIND_BACKWARD ||= ?\M-F.getbyte(0)
+      #@KEY_FIND_NEXT ||= ?\M-g.getbyte(0)
+      #@KEY_FIND_PREV ||= ?\M-G.getbyte(0)
+      @KEY_SCROLL_FORWARD ||= ?\C-d.getbyte(0)
+      @KEY_SCROLL_BACKWARD ||= ?\C-b.getbyte(0)
+      @KEY_SCROLL_RIGHT ||= ?\M-8.getbyte(0)
+      @KEY_SCROLL_LEFT ||= ?\M-7.getbyte(0)
+
+      @KEY_CLEAR_SELECTION ||= ?\M-e.getbyte(0)
+      @KEY_PREV_SELECTION ||= ?\M-".getbyte(0)
+      @KEY_NEXT_SELECTION ||= ?\M-'.getbyte(0)
+
+=begin
+      bind_key(@KEY_ROW_SELECTOR)  { toggle_row_selection }
+      bind_key(@KEY_GOTO_TOP)      { goto_top }
+      bind_key(@KEY_GOTO_BOTTOM)   { goto_bottom }
+      bind_key(@KEY_CLEAR_SELECTION) { clear_selection }
+      bind_key(@KEY_ASK_FIND_FORWARD) { ask_search_forward }
+      bind_key(@KEY_ASK_FIND_BACKWARD) { ask_search_backward }
+      bind_key(@KEY_FIND_NEXT) { find_next }
+      bind_key(@KEY_FIND_PREV) { find_prev }
+=end
+    end
+  end
+end

data/lib/rbcurse/extras/include/listselectable.rb

@@ -0,0 +1,144 @@
+# this is a companion file to defaultlistselectionmodel
+# if you use that, include this to get all the methods to use it
+require 'rbcurse/extras/include/defaultlistselectionmodel'
+
+module RubyCurses
+  module ListSelectable
+
+    ## modified on 2009-02-13 23:41 to return model if no param passed
+    # sets or returns a list selection model
+    # Also listbox listens to it for selections, so it can tell those
+    # who are interested 2010-09-21 16:02  
+    def list_selection_model(*lsm)
+      if lsm.empty?
+        @list_selection_model 
+      else
+        @list_selection_model = lsm[0]
+        # the listbox is listening to selection events on the
+        # selection model and will inform any listeners of the same.
+        @list_selection_model.bind :LIST_SELECTION_EVENT do |ev|
+          fire_handler :LIST_SELECTION_EVENT, ev
+        end
+      end
+      #@list_selection_model.selection_mode = @selection_mode || :MULTIPLE
+    end
+    def is_selected? row
+      @list_selection_model.is_selected_index row
+    end
+    # this is the old name, should be deprecated
+    alias :is_row_selected :is_selected?
+
+    def add_row_selection_interval ix0, ix1
+      $log.debug " def add_row_selection_interval #{ix0}, #{ix1}"
+      # if row_selection_allowed
+      @list_selection_model.add_selection_interval ix0, ix1
+      @repaint_required = true
+    end
+    def remove_row_selection_interval ix0, ix1
+      @list_selection_model.remove_selection_interval ix0, ix1
+    end
+    def toggle_row_selection row=@current_index
+      if is_selected? row
+        #$log.debug " deleting row #{row}"
+        remove_row_selection_interval(row, row)
+      else
+        #$log.debug " adding row #{row}"
+        add_row_selection_interval(row, row) 
+      end
+      @repaint_required = true 
+    end
+
+    def clear_selection
+      @list_selection_model.clear_selection
+      @repaint_required = true
+    end
+    # why is this commented off XXX could it override listscrollable
+    #def selected_item
+      #$log.warn "came in dummy selected_item of listselectable.rb"
+    #  @list[@current_index]
+    #end
+    # returns selected indices
+    # TODO : if array passed, set those as selected indices
+    def selected_rows
+      @list_selection_model.get_selected_rows
+    end
+    def selected_row_count
+      selected_rows.size
+    end
+    # returns index of first selected row (lowest index)
+    # TODO: if param passed set that as selected_index
+    def selected_row
+      @list_selection_model.get_min_selection_index
+    end
+    alias :selected_index :selected_row
+
+    # returns value of first selected row (lowest index)
+    def selected_value
+      #@list[@current_index].to_s # old behavior since curr row was in reverse
+      return nil if selected_row().nil?
+      @list[selected_row()].to_s
+    end
+    # returns an array of selected values
+    # or yields values to given block
+    def selected_values &block
+      ar = []
+      selected_rows().each do |i|
+        val = @list[i]
+        if block_given?
+          yield val
+        else
+          ar << val
+        end
+      end
+      return ar unless block_given?
+    end
+
+    def do_next_selection
+      return if selected_rows().length == 0 
+      row = selected_rows().sort.find { |i| i > @current_index }
+      row ||= @current_index
+      @current_index = row
+      @repaint_required = true # fire list_select XXX
+    end
+    def do_prev_selection
+      return if selected_rows().length == 0 
+      row = selected_rows().sort{|a,b| b <=> a}.find { |i| i < @current_index }
+      row ||= @current_index
+      @current_index = row
+      @repaint_required = true # fire list_select XXX
+    end
+    # NOTE: I HAD removed this and put in listbox, but its required by rtable also
+    # create a default list selection model and set it
+    # NOTE: I am now checking if one is not already created, since
+    # a second creation would wipe out any listeners on it.
+    # @see ListSelectable 
+    # @see DefaultListSelectionModel
+    def create_default_list_selection_model
+      if @list_selection_model.nil?
+        list_selection_model DefaultListSelectionModel.new(self)
+      end
+    end
+    alias :selected_index :selected_row
+    attr_accessor :row_selection_allowed
+    attr_accessor :column_selection_allowed
+  end
+  # class containing information relating to selections on a list
+  #  2010-09-21 19:46 NOTE: Earlier source contained the model object, now it returns the parent
+  #  You may do source.list_data_model() to get the model
+  #  Typical operations on source would get selected_value(s), or selected_index
+  class ListSelectionEvent
+    attr_accessor :firstrow, :lastrow, :source, :type
+    def initialize firstrow, lastrow, source, type
+      @firstrow = firstrow
+      @lastrow = lastrow
+      @source = source
+      @type = type
+    end
+    def to_s
+      "#{@type.to_s}, firstrow: #{@firstrow}, lastrow: #{@lastrow}, source: #{@source}"
+    end
+    def inspect
+      to_s
+    end
+  end
+end