rbcurse 1.1.5 → 1.2.0.pre

data/lib/rbcurse/rinputdataevent.rb

@@ -8,6 +8,10 @@
   * License:
     Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
 
+NOTE: this is how we used to write code in the Java days. Anyone reading this source,
+this is NOT how to code in rubyland. Please see this link, for how to code such as class:
+http://blog.grayproductions.net/articles/all_about_struct
+
 =end
 require 'rubygems'
 
@@ -24,6 +28,8 @@ module RubyCurses
       @row = row
       @text = text
     end
+    # until now to_s was returning inspect, but to make it easy for users let us return the value
+    # they most expect which is the text that was changed
     def to_s
       inspect
     end
@@ -32,5 +38,11 @@ module RubyCurses
       #"#{@type.to_s}, #{@source}, ind0:#{@index0}, ind1:#{@index1}, row:#{@row}, text:#{@text}"
       "#{@type.to_s}, ind0:#{@index0}, ind1:#{@index1}, row:#{@row}, text:#{@text}"
     end
+    # this is so that earlier applications were getting source in the block, not an event. they 
+    # were doing a fld.getvalue, so we must keep those apps running
+    # @since 1.2.0  added 2010-09-11 12:25 
+    def getvalue
+      @source.getvalue
+    end
   end
 end

data/lib/rbcurse/rlistbox.rb

@@ -5,14 +5,17 @@
   * Date: 2008-11-19 12:49 
   * License: Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
   * This file started on 2009-01-13 22:18 (broken off rwidgets.rb)
+NOTE: listbox now traps RETURN/ENTER/13 so if you are trapping it, please use bind :PRESS
 TODO 
+  Perhaps keep printed data created by convert_value_to_text cached, and used for searching
+  cursor movement and other functions. 
+  [ ] XXX Can we separate editing out. Make a ReadonlyList, and extend it as EditableList. This way the usual
+  use case remains cleaner.
 =end
-require 'rubygems'
-require 'ncurses'
-require 'logger'
 require 'rbcurse'
 require 'rbcurse/listcellrenderer'
 require 'rbcurse/listkeys'
+require 'forwardable'
 
 
 include Ncurses
@@ -46,8 +49,9 @@ module RubyCurses
     attr_accessor :selected_index
     attr_reader :last_regex # should i really keep here as public or maintain in listbox
 
-    def initialize anarray
+    def initialize anarray=[]
       @list = anarray.dup
+      @_events = [:LIST_DATA_EVENT, :ENTER_ROW]
     end
     # changd on 2009-01-14 12:28 based on ..
     # http://www.ruby-forum.com/topic/175637#769030
@@ -95,8 +99,10 @@ module RubyCurses
       return ret
     end
     def remove_all
+      return if @list.nil? || @list.empty? # 2010-09-21 13:25 
       lde = ListDataEvent.new(0, @list.size, self, :INTERVAL_REMOVED)
       @list = []
+      @current_index = 0
       fire_handler :LIST_DATA_EVENT, lde
     end
     def delete obj
@@ -110,11 +116,14 @@ module RubyCurses
     def include?(obj)
       return @list.include?(obj)
     end
+    # returns a `dup()` of the list
     def values
       @list.dup
     end
+    # why do we have this here in data, we should remove this
+    # @deprecated this was just eye candy for some demo
     def on_enter_row object
-      #$log.debug " XXX on_enter_row of list_data"
+      $log.debug " XXX on_enter_row of list_data"
       fire_handler :ENTER_ROW, object
     end
     # ##
@@ -186,10 +195,10 @@ module RubyCurses
   #  
 
   ##
+  # TODO CAN WE MOVE THIS OUT TO ANOTHER FILE as confusing me
   # pops up a list of values for selection
   # 2008-12-10
   class PopupList
-    include DSL
     include RubyCurses::EventHandler
     dsl_accessor :title
     dsl_accessor :row, :col, :height, :width
@@ -246,12 +255,15 @@ module RubyCurses
       @window.wrefresh
       handle_keys
     end
+    # class popup
     def list alist=nil
       return @list if alist.nil?
       @list = ListDataModel.new(alist)
+      @repaint_required = true
       #  will we need this ? listbox made each time so data should be fresh
       #@list.bind(:LIST_DATA_EVENT) { |e| list_data_changed() }
     end
+    # class popup
     def list_data_model ldm
       raise "Expecting list_data_model" unless ldm.is_a? RubyCurses::ListDataModel
       @list = ldm
@@ -301,7 +313,7 @@ module RubyCurses
         # $log.debug "popup ENTER :  #{field.name}" if !field.nil?
           @stop = true
           return
-        when 9
+        when KEY_TAB
           @form.select_next_field 
         else
           # fields must return unhandled else we will miss hotkeys. 
@@ -372,9 +384,17 @@ module RubyCurses
     end
   end # class PopupList
   ##
-  # this is the new LISTBOX, based on new scrollable.
+  # A control for displaying a list of data or values. 
+  # The list will be editable if @cell_editing_allowed
+  # is set to true when creating. By default, multiple selection is allowed, but may be set to :single.
+  # TODO: were we not going to force creation of datamodel and listener on startup by putting a blank
+  # :list in config, if no list or list_variable or model is there ?
+  # Or at end of constructor check, if no listdatamodel then create default.
+  # TODO : perhaps when datamodel created, attach listener to it, so we can fire to callers when
+  # they want to be informed of changes. As we did with selection listeners.
   #
   class Listbox < Widget
+
     require 'rbcurse/listscrollable'
     require 'rbcurse/listselectable'
     require 'rbcurse/defaultlistselectionmodel'
@@ -382,6 +402,7 @@ module RubyCurses
     include ListScrollable
     include ListSelectable
     include RubyCurses::ListKeys
+    extend Forwardable
     dsl_accessor :height
     dsl_accessor :title
     dsl_property :title_attrib   # bold, reverse, normal
@@ -404,29 +425,36 @@ module RubyCurses
     dsl_property :left_margin
     # please set these in he constructor block. Settin them later will have no effect
     # since i would have bound them to actions
-    dsl_accessor :KEY_ROW_SELECTOR
-    dsl_accessor :KEY_GOTO_TOP
-    dsl_accessor :KEY_GOTO_BOTTOM
-    dsl_accessor :KEY_CLEAR_SELECTION
-    dsl_accessor :KEY_NEXT_SELECTION
-    dsl_accessor :KEY_PREV_SELECTION
-    dsl_accessor :valign  # 2009-01-17 18:32 
+    dsl_accessor :KEY_ROW_SELECTOR          # this is going to go XXX TODO
+    dsl_accessor :KEY_GOTO_TOP          # this is going to go
+    dsl_accessor :KEY_GOTO_BOTTOM          # this is going to go
+    dsl_accessor :KEY_CLEAR_SELECTION          # this is going to go
+    dsl_accessor :KEY_NEXT_SELECTION          # this is going to go
+    dsl_accessor :KEY_PREV_SELECTION          # this is going to go
+    dsl_accessor :valign  # 2009-01-17 18:32  vertical alignment used in combos
+    dsl_accessor :justify  #  2010-09-27 12:41 used by renderer
     attr_accessor :one_key_selection # will pressing a single key select or not
+    dsl_accessor :border_attrib, :border_color # 
+    dsl_accessor :sanitization_required
+    dsl_accessor :suppress_borders #to_print_borders
+
 
     def initialize form, config={}, &block
       @focusable = true
       @editable = false
+      @sanitization_required = true
       @row = 0
       @col = 0
-      # data of listbox
-      @list = []
+      # data of listbox this is not an array, its a pointer to the  listdatamodel
+      @list = nil 
       # any special attribs such as status to be printed in col1, or color (selection)
       @list_attribs = {}
+      @suppress_borders = false
+      @row_offset = @col_offset = 1 # for borders
       super
+      @_events.push(*[:ENTER_ROW, :LEAVE_ROW, :LIST_SELECTION_EVENT, :PRESS])
       @current_index ||= 0
-      @row_offset = @col_offset = 1
-      @content_rows = @list.length
-      @selection_mode ||= 'multiple'
+      @selection_mode ||= :multiple # default is multiple, anything else given becomes single
       @win = @graphic    # 2010-01-04 12:36 BUFFERED  replace form.window with graphic
       # moving down to repaint so that scrollpane can set should_buffered
       # added 2010-02-17 23:05  RFED16 so we don't need a form.
@@ -443,21 +471,32 @@ module RubyCurses
       init_vars
       install_list_keys
 
-      if !@list.selected_index.nil? 
+      if @list && !@list.selected_index.nil? 
         set_focus_on @list.selected_index # the new version
       end
     end
+    # this is called several times, from constructor
+    # and when list data changed, so only put relevant resets here.
+    # why can't current_index be set to 0 here
     def init_vars
-      @to_print_borders ||= 1
       @repaint_required = true
       @toprow = @pcol = 0
+
+      @row_offset = @col_offset = 0 if @suppress_borders
       if @show_selector
         @row_selected_symbol ||= '>'
         @row_unselected_symbol ||= ' '
         @left_margin ||= @row_selected_symbol.length
       end
       @left_margin ||= 0
-      @one_key_selection ||= true
+      @one_key_selection = true if @one_key_selection.nil?
+      # we reduce internal_width from width while printing
+      @internal_width = 2 # taking into account borders accounting for 2 cols
+      @internal_width = 0 if @suppress_borders # should it be 0 ???
+
+    end
+    def map_keys
+      return if @keys_mapped
       bind_key(?f){ ask_selection_for_char() }
       bind_key(?\M-v){ @one_key_selection = false }
       bind_key(?j){ next_row() }
@@ -466,38 +505,96 @@ module RubyCurses
       bind_key([?g,?g]){ goto_top() }
       bind_key(?/){ ask_search() }
       bind_key(?n){ find_more() }
-
-    end
-    def install_bindings
-
+      bind_key(32){ toggle_row_selection() }
+      bind_key(10){ fire_action_event }
+      bind_key(13){ fire_action_event }
+      @keys_mapped = true
     end
 
     ##
     # getter and setter for selection_mode
     # Must be called after creating model, so no duplicate. Since one may set in model directly.
     def selection_mode(*val)
-      raise "ListSelectionModel not yet created!" if @list_selection_model.nil?
+      #raise "ListSelectionModel not yet created!" if @list_selection_model.nil?
+
       if val.empty?
-        @list_selection_model.selection_mode
+        if @list_selection_model
+          return @list_selection_model.selection_mode
+        else
+          return @tmp_selection_mode
+        end
       else
-        @list_selection_model.selection_mode = val[0] 
+        if @list_selection_model.nil?
+          @tmp_selection_mode = val[0] 
+        else
+          @list_selection_model.selection_mode = val[0].to_sym
+        end
       end
     end
     def row_count
+      return 0 if @list.nil?
       @list.length
     end
     # added 2009-01-07 13:05 so new scrollable can use
     def scrollatrow
-      #@height - 2
-      @height - 3 # 2010-01-04 15:30 BUFFERED HEIGHT
+      if @suppress_borders
+        return @height - 1
+      else
+        return @height - 3
+      end
     end
-    def list alist=nil
-      return @list if alist.nil?
-      @list = RubyCurses::ListDataModel.new(alist)
+    # provide data to List in the form of an Array or Variable or
+    # ListDataModel. This will create a default ListSelectionModel.
+    #
+    # CHANGE as on 2010-09-21 12:53:
+    # If explicit nil passed then dummy datamodel and selection model created
+    # From now on, constructor will call this, so this can always
+    # happen.
+    #
+    # NOTE: sometimes this can be added much after its painted.
+    # Do not expect this to be called from constructor, although that
+    # is the usual case. it can be dependent on some other list or tree.
+    # @param [Array, Variable, ListDataModel] data to populate list with
+    # @return [ListDataModel] just created or assigned
+    
+    def list *val
+      return @list if val.empty?
+      clear_selection if @list # clear previous selections if any
+      @default_values = nil if @list # clear previous selections if any
+      alist = val[0]
+      case alist
+      when Array
+        if @list
+          @list.remove_all
+          @list.insert 0, *alist
+          @current_index = 0
+        else
+          @list = RubyCurses::ListDataModel.new(alist)
+        end
+      when NilClass
+        if @list
+          @list.remove_all
+        else
+          @list = RubyCurses::ListDataModel.new(alist)
+        end
+      when Variable
+        @list = RubyCurses::ListDataModel.new(alist.value)
+      when RubyCurses::ListDataModel
+        @list = alist
+      else
+        raise ArgumentError, "Listbox list(): do not know how to handle #{alist.class} " 
+      end
       # added on 2009-01-13 23:19 since updates are not automatic now
       @list.bind(:LIST_DATA_EVENT) { |e| list_data_changed() }
       create_default_list_selection_model
+      @list_selection_model.selection_mode = @tmp_selection_mode if @tmp_selection_mode
+      @repaint_required = true
+      @list
     end
+    # populate using a Variable which should contain a list
+    # NOTE: This explicilty overwrites any existing datamodel such as the
+    # default one. You may lose any events you have bound to the listbox
+    # prior to this call.
     def list_variable alist=nil
       return @list if alist.nil?
       @list = RubyCurses::ListDataModel.new(alist.value)
@@ -505,6 +602,11 @@ module RubyCurses
       @list.bind(:LIST_DATA_EVENT) { |e| list_data_changed() }
       create_default_list_selection_model
     end
+    # populate using a custom data model
+    # NOTE: This explicilty overwrites any existing datamodel such as the
+    # default one. You may lose any events you have bound to the listbox
+    # prior to this call. 
+    
     def list_data_model ldm=nil
       return @list if ldm.nil?
       raise "Expecting list_data_model" unless ldm.is_a? RubyCurses::ListDataModel
@@ -513,12 +615,41 @@ module RubyCurses
       @list.bind(:LIST_DATA_EVENT) { |e| list_data_changed() }
       create_default_list_selection_model
     end
+    # 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
+    # added 2010-09-15 00:11 to make life easier
+    def_delegators :@list, :insert, :remove_all, :delete_at, :include?
+    # get element at
+    # @param [Fixnum] index for element
+    # @return [Object] element
+    # @since 1.2.0  2010-09-06 14:33 making life easier for others.
+    def [](off0)
+      @list[off0]
+    end
+    # return object under cursor
+    # Note: this should not be confused with selected row/s. User may not have selected this.
+    # This is only useful since in some demos we like to change a status bar as a user scrolls down
+    # @since 1.2.0  2010-09-06 14:33 making life easier for others.
+    def current_value
+      @list[@current_index]
+    end
+    # avoid using "row", i'd rather stick with "index" and "value".
+    alias :current_row :current_value
+    alias :text :current_value  # thanks to shoes, not sure how this will impact since widget has text.
 
+    # XXX can this not be done at repaint
     def select_default_values
       return if @default_values.nil?
       @default_values.each do |val|
         row = @list.index val
-        #do_select(row) unless row.nil?
         add_row_selection_interval row, row unless row.nil?
       end
     end
@@ -529,17 +660,22 @@ module RubyCurses
       startcol = @col 
       startrow = @row 
       @color_pair = get_color($datacolor)
-      #$log.debug "rlistb:  window.print_border #{startrow}, #{startcol} , #{height} , #{width} , @color_pair, @attr "
-      window.print_border startrow, startcol, height, width, @color_pair, @attr
+      bordercolor = @border_color || $datacolor
+      borderatt = @border_attrib || Ncurses::A_NORMAL
+
+      #$log.debug "rlistb #{name}: window.print_border #{startrow}, #{startcol} , h:#{height}, w:#{width} , @color_pair, @attr "
+      window.print_border startrow, startcol, height, width, bordercolor, borderatt
       print_title
     end
     def print_title
-      #printstring(@graphic, @row, @col+(@width-@title.length)/2, @title, @color_pair, @title_attrib) unless @title.nil?
-      # 2010-01-04 15:53 BUFFERED
-      # I notice that the old version would print a title that was longer than width,
-      #+ but the new version won't print anything if it exceeds width.
-      # TODO check title.length and truncate if exceeds width
-      @graphic.printstring( @row, @col+(@width-@title.length)/2, @title, @color_pair, @title_attrib) unless @title.nil?
+      @color_pair ||= get_color($datacolor)
+      # check title.length and truncate if exceeds width
+      return unless @title
+      _title = @title
+      if @title.length > @width - 2
+        _title = @title[0..@width-2]
+      end
+      @graphic.printstring( @row, @col+(@width-_title.length)/2, _title, @color_pair, @title_attrib) unless @title.nil?
     end
     ### START FOR scrollable ###
     def get_content
@@ -551,24 +687,26 @@ module RubyCurses
     end
     ### END FOR scrollable ###
     # override widgets text
+    # returns indices of selected rows
     def getvalue
       selected_rows
     end
     # Listbox
     def handle_key(ch)
+      map_keys unless @keys_mapped
       @current_index ||= 0
       @toprow ||= 0
       h = scrollatrow()
       rc = row_count
-      $log.debug " listbxo got ch #{ch}"
+      $log.debug " listbox got ch #{ch}"
       #$log.debug " when kps #{@KEY_PREV_SELECTION}  "
       case ch
       when KEY_UP  # show previous value
-        previous_row
+        return previous_row
       when KEY_DOWN  # show previous value
-        next_row
+        return next_row
       when @KEY_ROW_SELECTOR # 32
-        return if is_popup and @selection_mode == 'single' # not allowing select this way since there will be a difference 
+        return if is_popup && @selection_mode != :multiple # not allowing select this way since there will be a difference 
         toggle_row_selection @current_index #, @current_index
         @repaint_required = true
       when @KEY_SCROLL_FORWARD # ?\C-n
@@ -583,15 +721,15 @@ module RubyCurses
       when @KEY_NEXT_SELECTION # ?'
         $log.debug "insdie next selection"
         @oldrow = @current_index
-        do_next_selection #if @select_mode == 'multiple'
+        do_next_selection 
         bounds_check
       when @KEY_PREV_SELECTION # ?"
         @oldrow = @current_index
         $log.debug "insdie prev selection"
-        do_prev_selection #if @select_mode == 'multiple'
+        do_prev_selection 
         bounds_check
       when @KEY_CLEAR_SELECTION
-        clear_selection #if @select_mode == 'multiple'
+        clear_selection 
         @repaint_required = true
       when 27, ?\C-c.getbyte(0)
         editing_canceled @current_index if @cell_editing_allowed
@@ -632,9 +770,11 @@ module RubyCurses
           end
         end
         if ret == :UNHANDLED
+          # beware one-key eats up numbers. we'll be wondering why
           if @one_key_selection
             case ch
-            when ?A.getbyte(0)..?Z.getbyte(0), ?a.getbyte(0)..?z.getbyte(0), ?0.getbyte(0)..?9.getbyte(0)
+            #when ?A.getbyte(0)..?Z.getbyte(0), ?a.getbyte(0)..?z.getbyte(0), ?0.getbyte(0)..?9.getbyte(0)
+            when ?A.getbyte(0)..?Z.getbyte(0), ?a.getbyte(0)..?z.getbyte(0)
               # simple motion, key press defines motion
               ret = set_selection_for_char ch.chr
             else
@@ -651,13 +791,24 @@ module RubyCurses
               return 0
             end
             ret = process_key ch, self
-            $multiplier = 0
             return :UNHANDLED if ret == :UNHANDLED
           end
         end
       end
       $multiplier = 0
     end
+    # fire handler when user presses ENTER/RETURN
+    # @since 1.2.0
+    # listbox now traps ENTER key and fires action event
+    # to trap please bind :PRESS
+    #
+    def fire_action_event
+      # this does not select the row ???? FIXME ??
+      require 'rbcurse/ractionevent'
+      # should have been callled :ACTION_EVENT !!!
+      fire_handler :PRESS, ActionEvent.new(self, :PRESS, text)
+    end
+    # get a keystroke from user and go to first item starting with that key
     def ask_selection_for_char
       ch = @graphic.getch
       if ch < 0 || ch > 255
@@ -685,40 +836,26 @@ module RubyCurses
         set_focus_on(ix)
       end
     end
-    ## listbox find_prev
-    def OLDfind_prev
-        ix = @list.find_prev
-        regex = @last_regex 
-        if ix.nil?
-          alert("No previous matching data for: #{regex}")
-        else
-          @oldrow = @current_index
-          @current_index = ix
-          bounds_check
-        end
-    end
-    # table find_next
-    def OLDfind_next
-        ix = @list.find_next
-        regex = @last_regex 
-        if ix.nil?
-          alert("No more matching data for: #{regex}")
-        else
-          set_focus_on(ix) unless ix.nil?
-        end
-    end
+    # please check for error before proceeding
+    # @return [Boolean] false if no data
     def on_enter
+      if @list.nil? || @list.size == 0
+        Ncurses.beep
+        return :UNHANDLED
+      end
       on_enter_row @current_index
       set_form_row # added 2009-01-11 23:41 
       #$log.debug " ONE ENTER LIST #{@current_index}, #{@form.row}"
       @repaint_required = true
-      fire_handler :ENTER, self
+      super
+      #fire_handler :ENTER, self
+      true
     end
     def on_enter_row arow
       #$log.debug " Listbox #{self} ENTER_ROW with curr #{@current_index}. row: #{arow} H: #{@handler.keys}"
       #fire_handler :ENTER_ROW, arow
       fire_handler :ENTER_ROW, self
-      @list.on_enter_row self
+      @list.on_enter_row self  ## XXX WHY THIS ???
       edit_row_at arow
       @repaint_required = true
     end
@@ -787,7 +924,7 @@ module RubyCurses
       end
     end
     def create_default_cell_editor
-      return RubyCurses::CellEditor.new RubyCurses::Field.new nil, {"focusable"=>false, "visible"=>false, "display_length"=> @width-2-@left_margin}
+      return RubyCurses::CellEditor.new RubyCurses::Field.new nil, {"focusable"=>false, "visible"=>false, "display_length"=> @width-@internal_width-@left_margin}
     end
     ##
     # getter and setter for cell_renderer
@@ -799,7 +936,7 @@ module RubyCurses
       end
     end
     def create_default_cell_renderer
-      return RubyCurses::ListCellRenderer.new "", {"color"=>@color, "bgcolor"=>@bgcolor, "parent" => self, "display_length"=> @width-2-@left_margin}
+      return RubyCurses::ListCellRenderer.new "", {"color"=>@color, "bgcolor"=>@bgcolor, "parent" => self, "display_length"=> @width-@internal_width-@left_margin}
     end
     ##
     # this method chops the data to length before giving it to the
@@ -812,42 +949,41 @@ module RubyCurses
       # not sure where to put this, once for all or repeat 2010-02-17 23:07 RFED16
       my_win = @form ? @form.window : @target_window
       @graphic = my_win unless @graphic
-      #$log.warn "neither form not target window given!!! TV paint 368" unless my_win
-      raise " #{@name} neither form, nor target window given TV paint " unless my_win
-      raise " #{@name} NO GRAPHIC set as yet                 TV paint " unless @graphic
+      raise " #{@name} neither form, nor target window given LB paint " unless my_win
+      raise " #{@name} NO GRAPHIC set as yet                 LB paint " unless @graphic
       @win_left = my_win.left
       @win_top = my_win.top
 
-      $log.debug " rlistbox repaint graphic #{@graphic} "
-      print_borders if @to_print_borders == 1 # do this once only, unless everything changes
-      rc = row_count
-      maxlen = @maxlen ||= @width-2
+      #$log.debug "rlistbox repaint  #{@name} r,c, #{@row} #{@col} , width: #{@width}  "
+      print_borders unless @suppress_borders # do this once only, unless everything changes
+      #maxlen = @maxlen || @width-@internal_width
+      renderer = cell_renderer()
+      renderer.display_length(@width-@internal_width-@left_margin) # just in case resizing of listbox
       tm = list()
-      tr = @toprow
-      acolor = get_color $datacolor
-      h = scrollatrow()
-      r,c = rowcol
-      0.upto(h) do |hh|
-        crow = tr+hh
-        if crow < rc
-            focussed = @current_index == crow ? true : false 
+      rc = row_count
+      @longest_line = @width
+      $log.debug " rlistbox #{row_count} "
+      if rc > 0     # just added in case no data passed
+        tr = @toprow
+        acolor = get_color $datacolor
+        h = scrollatrow()
+        r,c = rowcol
+        0.upto(h) do |hh|
+          crow = tr+hh
+          if crow < rc
+            _focussed = @current_index == crow ? true : false  # row focussed ?
+            focus_type = _focussed 
+            # added 2010-09-02 14:39 so inactive fields don't show a bright focussed line
+            #focussed = false if focussed && !@focussed
+            focus_type = :SOFT_FOCUS if _focussed && !@focussed
             selected = is_row_selected crow
             content = tm[crow]   # 2009-01-17 18:37 chomp giving error in some cases says frozen
+            content = convert_value_to_text content, crow # 2010-09-23 20:12 
+            # by now it has to be a String
             if content.is_a? String
               content = content.dup
-              content.chomp!
-              content.gsub!(/\t/, '  ') # don't display tab
-              content.gsub!(/[^[:print:]]/, '')  # don't display non print characters
-              if !content.nil? 
-                if content.length > maxlen # only show maxlen
-                  content = content[@pcol..@pcol+maxlen-1] 
-                else
-                  content = content[@pcol..-1]
-                end
-              end
-            elsif content.is_a? TrueClass or content.is_a? FalseClass
-            else
-              content = content.to_s
+              sanitize content if @sanitization_required
+              truncate content
             end
             ## set the selector symbol if requested
             selection_symbol = ''
@@ -860,38 +996,83 @@ module RubyCurses
               @graphic.printstring r+hh, c, selection_symbol, acolor,@attr
             end
             #renderer = get_default_cell_renderer_for_class content.class.to_s
-            renderer = cell_renderer()
-            #renderer.show_selector @show_selector
-            #renderer.row_selected_symbol @row_selected_symbol
-            #renderer.left_margin @left_margin
-            #renderer.repaint @graphic, r+hh, c+(colix*11), content, focussed, selected
-            ## added crow on 2009-02-06 23:03 
-            # since data is being truncated and renderer may need index
-            renderer.repaint @graphic, r+hh, c+@left_margin, crow, content, focussed, selected
-        else
-          # clear rows
-          @graphic.printstring r+hh, c, " " * (@width-2), acolor,@attr
+            renderer.repaint @graphic, r+hh, c+@left_margin, crow, content, focus_type, selected
+          else
+            # clear rows
+            @graphic.printstring r+hh, c, " " * (@width-@internal_width), acolor,@attr
+          end
         end
-      end
-      if @cell_editing_allowed
-        @cell_editor.component.repaint unless @cell_editor.nil? or @cell_editor.component.form.nil?
-      end
-      @table_changed = false
+        if @cell_editing_allowed
+          @cell_editor.component.repaint unless @cell_editor.nil? or @cell_editor.component.form.nil?
+        end
+      end # rc == 0
+      #@table_changed = false
       @repaint_required = false
       @buffer_modified = true # required by form to call buffer_to_screen BUFFERED
       buffer_to_window # RFED16 2010-02-17 23:16 
     end
+    # the idea here is to allow users who subclass Listbox to easily override parts of the cumbersome repaint
+    # method. This assumes your List has some data, but you print a lot more. Now you don't need to
+    # change the data in the renderer, or keep formatted data in the list itself.
+    # e.g. @list contains file names, or File objects, and this converts to a long listing.
+    # If the renderer did that, the truncation would be on wrong data.
+    # @since 1.2.0
+    def convert_value_to_text value, crow
+      case value
+      when TrueClass, FalseClass
+        value
+      else
+        value.to_s if value
+      end
+    end
+    # takes a block, this way anyone extending this class can just pass a block to do his job
+    # This modifies the string
+    def sanitize content
+      if content.is_a? String
+        content.chomp!
+        content.gsub!(/\t/, '  ') # don't display tab
+        content.gsub!(/[^[:print:]]/, '')  # don't display non print characters
+      else
+        content
+      end
+    end
+    # returns only the visible portion of string taking into account display length
+    # and horizontal scrolling. MODIFIES STRING
+    # if you;ve truncated the data, it could stay truncated even if lb is increased. be careful
+    def truncate content
+      _maxlen = @maxlen || @width-@internal_width
+      _maxlen = @width-@internal_width if _maxlen > @width-@internal_width
+      #$log.debug "TRUNCATE: listbox maxlen #{@maxlen}, #{_maxlen} width #{@width}: #{content} "
+      if !content.nil? 
+        if content.length > _maxlen # only show maxlen
+          @longest_line = content.length if content.length > @longest_line
+          #content = content[@pcol..@pcol+maxlen-1] 
+          content.replace content[@pcol..@pcol+_maxlen-1] 
+        else
+          # can this be avoided if pcol is 0 XXX
+          content.replace content[@pcol..-1] if @pcol > 0
+        end
+      end
+      #$log.debug " content: #{content}" 
+      content
+    end
+
     def list_data_changed
       if row_count == 0 # added on 2009-02-02 17:13 so cursor not hanging on last row which could be empty
         init_vars
         @current_index = 0
-        set_form_row
+        # I had placed this at some time to get cursor correct. But if this listbox is updated
+        # during entry in another field, then this steals the row. e.g. test1.rb 5
+        #set_form_row
       end
       @repaint_required = true
     end
+    # set cursor column position
+    # if i set col1 to @curpos, i can move around left right if key mapped
     def set_form_col col1=0
       # TODO BUFFERED use setrowcol @form.row, col
       # TODO BUFFERED use cols_panned
+      #col1 ||= 0
       @cols_panned ||= 0 # RFED16 2010-02-17 23:40 
       # editable listboxes will involve changing cursor and the form issue
       ## added win_col on 2010-01-04 23:28 for embedded forms BUFFERED TRYING OUT