rbcurse 0.1.3 → 1.1.1

data/lib/rbcurse/rviewport.rb

@@ -0,0 +1,203 @@
+=begin
+  * Name: Viewport
+  * $Id$
+  * Description: a viewport thru which you see an underlying form or widget. Scrolling
+    the viewport reveals new sections of the underlying object.
+  * Author: rkumar arunachala
+TODO 
+  * file created  2009-10-27 18:05 
+Major change 2010-02-11 23:32 
+  * removed buffering, was totally unnecessary
+  * FIXME avoid repaint and handle_keys totally, let scrollpane talk to child.
+    Do we really need this ?
+    If we do strip it down to its major function - nothign extraneous. Currently its a huge layer in between.
+  --------
+  * License:
+    Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+
+=end
+#require 'rubygems'
+require 'ncurses'
+require 'logger'
+require 'rbcurse'
+require 'rbcurse/rchangeevent'
+
+include Ncurses
+include RubyCurses
+module RubyCurses
+  extend self
+
+  ##
+  # A viewport or porthole throgh which one can see portions of underlying object
+  # such as textarea, table or a form, usually the underlying data is larger
+  # than what can be displayed and thus must be seen through a viewport.
+  # TODO - 
+  
+  class Viewport < Widget
+    # row and col also present int widget
+    dsl_accessor :child  # component that is being viewed
+    attr_accessor :cascade_changes
+    #attr_reader :top_margin, :left_margin
+
+    def initialize form, config={}, &block
+      @focusable = false
+      @editable = false
+      #@top_margin = @left_margin = 1 # 2010-02-06 23:27  reduce in scrollpane
+      @row = 1 # 1 # 0 2010-02-06 22:46 so we don't write on scrollpanes border
+      @col = 1 # 1 #  0 2010-02-06 22:47 
+      super
+      #@row_offset = @col_offset = 1
+      #@orig_col = @col
+      init_vars
+    end
+    def init_vars
+      #@curpos = @pcol = @toprow = @current_index = 0
+      should_create_buffer = true
+      @border_width = 2
+    end
+    # set the component to be viewed
+    def set_view ch
+      @child = ch
+    end
+    def set_view_size h,w
+      # calling the property shoudl uniformally trigger fire_property_change
+      $log.debug " setting viewport to h #{h} , w #{w} "
+      height(h)
+      width(w)
+      fire_state_changed
+      #fire_handler :PROPERTY_CHANGE, self # XXX should it be an event STATE_CHANGED with details
+    end
+    ##
+    # Set the row and col of the child, that the viewport starts displaying.
+    # Used to initialize the view, and later if scrolling.
+    # Initially would be set to 0,0. 
+    #
+    def set_view_position r,c
+      return false if r < 0 or c < 0
+      # 2010-02-04 19:29 TRYING -2 for borders
+      $log.debug " set_view if #{r} +1+ #{@height} - #{@border_width} )} >=#{@child.height} "
+      # 2010-02-12 15:33 XXX made > into >= and added +1 since -1 in set_buffering
+      # testscrollp was crashing out when child height exceeded
+      if r+ (@height+1-@border_width) >= @child.height
+      # basically r + (:bottom - :screen_top) < @child.height
+      #if r+ (@height) >= @child.height
+        $log.debug " set_view_position : trying to exceed ht #{r} + #{@height} > #{@child.height}  returned false"
+        return false
+      end
+      # testscrollp was printing junk on right end. Why the 1? 
+      if c+ (@width+1-@border_width) >=@child.width
+      #if c+ (@width) >=@child.width
+        $log.debug " set_view_position : trying to exceed width #{c} + #{@width} . returned false"
+        return false
+      end
+      $log.debug " VP row #{@row} col #{@col}, now will be #{r} , #{c} "
+      row(r) # commnting off 2010-02-06 22:47 
+      col(c) # commnting off 2010-02-06 22:47 
+      # next call sets pminrow and pmincol 
+      $log.debug " VP setting child buffer pmin to #{r} #{c} "
+      @child.get_buffer().set_pad_top_left(r, c)
+      # replaced this on 2010-02-26 11:49 HOPE IT WORKS XXX
+      #@child.fire_property_change("row", r, r) # XXX quick dirty, this should happen
+      @child.repaint_required(true)
+      @repaint_required = true
+      #fire_handler :PROPERTY_CHANGE, self
+      fire_state_changed
+      return true
+    end
+    # instead of using row and col to increment, try using this, since this is what's actually incremented.
+    def get_pad_top_left
+        p = @child.get_buffer()
+        return p.pminrow, p.pmincol
+    end
+    def repaint # viewport
+      return unless @repaint_required
+      # should call child's repaint onto pad
+      # then this should return clipped pad
+       $log.debug "VP calling child #{@child.name}  repaint"
+     #x  @graphic.wclear # required otherwise bottom of scrollpane had old rows still repeated. 2010-01-17 22:51 
+      @child.repaint_all
+      @child.repaint
+      paint
+    end
+    def getvalue
+      # TODO ???
+    end
+    ## most likely should just return an unhandled and not try being intelligent
+    # should viewport handle keys or should parent do so directly to child
+    def handle_key ch
+      # if this gets key it should just hand it to child
+      if @child != nil
+        ret = @child.handle_key ch
+        # 2010-01-19 19:26 commenting off repaint to see.
+        return :UNHANDLED if ret == :UNHANDLED
+        # moved below return so only if table handles
+        @repaint_required=true # added 2009-12-27 22:25 BUFFERED WHY ??
+      else
+        return :UNHANDLED
+      end
+      return 0
+      #$log.debug "TV after loop : curpos #{@curpos} blen: #{@buffer.length}"
+    end
+    def paint
+      @repaint_required = false
+      @repaint_all = false
+    end
+    # set height
+    # a container must pass down changes in size to it's children
+    #+ 2010-02-04 18:06 - i am not sure about this. When viewport is set then it passes down 
+    #+ changes to child which user did not intend. Maybe in splitpane it is okay but other cases?
+    #+ Perhaps its okay if scrollpane gets larger than child, not otherwise.
+    # added 2010-01-16 23:55 
+      def height(*val)
+          return @height if val.empty?
+          oldvalue = @height || 0
+          super
+          @height = val[0]
+          return if @child == nil
+          delta = @height - oldvalue
+          return if delta == 0
+          @repaint_required = true
+          if @child.height.nil?
+             @child.height = @height
+             $log.warn " viewport setting child #{@child.name} to default h of #{@height} -- child is usually larger. "
+          else
+              if @cascade_changes
+                  $log.debug "warn!! viewport adding #{delta} to child ht #{child.height} "
+                  @child.height += delta
+              end
+          end
+      end
+    # set width
+    # a container must pass down changes in size to it's children
+    # added 2010-01-16 23:55 
+      def width(*val)
+          return @width if val.empty?
+          oldvalue = @width || 0
+          super
+          @width = val[0]
+          return if @child == nil
+          delta = @width - oldvalue
+          return if delta == 0
+          @repaint_required = true
+          # another safeguard if user did not enter. usesomething sensible 2010-01-17 15:23 
+          if @child.width.nil?
+             @child.width = @width
+             $log.warn " viewport setting child #{@child.name} to default w of #{@width}. Usually child is larger. "
+          else
+              ## sometime we are needless increasing. this happens when we set viewport and
+              ##+ child has been set. Or may do only if scrollpane is getting larger than child
+              ##+ largely a situation with splitpanes.
+              if @cascade_changes
+                  $log.debug "warn!! viewport adding #{delta} to child wt #{child.width} "
+                  @child.width += delta
+              end
+          end
+      end
+      # should this be in widget ?
+      # inform listeners that state has changed
+      def fire_state_changed
+        @sce = ChangeEvent.new(self) if @sce.nil?
+        fire_handler :STATE_CHANGE, @sce
+      end
+  end # class viewport
+end # module

data/lib/rbcurse/rwidget.rb

@@ -23,10 +23,10 @@ TODO
 require 'rubygems'
 require 'ncurses'
 require 'logger'
-require 'rbcurse/mapper'
+#require 'rbcurse/mapper'
 require 'rbcurse/colormap'
-#require 'rbcurse/rdialogs'
-#require 'rbcurse/listcellrenderer'
+require 'rbcurse/orderedhash'
+require 'rbcurse/io'
 
 module DSL
 ## others may not want this, if = sent, it creates DSL and sets
@@ -85,6 +85,18 @@ class Module
 
 end
 
+# 2009-10-04 14:13 added RK after suggestion on http://www.ruby-forum.com/topic/196618#856703
+# these are for 1.8 compatibility
+class Fixnum
+   def ord
+     self
+   end
+## mostly for control and meta characters
+   def getbyte(n)
+     self
+   end
+end unless "a"[0] == "a"
+
 include Ncurses
 module RubyCurses
   extend self
@@ -92,6 +104,14 @@ module RubyCurses
     class FieldValidationException < RuntimeError
     end
     module Utils
+      ## this is the numeric argument used to repeat and action by repeatm()
+      $multiplier = 0
+
+      # 2010-03-04 18:01 
+      ## this may come in handy for methods to know whether they are inside a batch action or not
+      # e.g. a single call of foo() may set a var, a repeated call of foo() may append to var
+      $inside_multiplier_action = true
+
       ## 
       # wraps text given max length, puts newlines in it.
       # it does not take into account existing newlines
@@ -111,19 +131,19 @@ module RubyCurses
         case keycode
         when 33..126
           return keycode.chr
-        when ?\C-a .. ?\C-z
-          return "C-" + (keycode + ?a -1).chr 
-        when ?\M-A..?\M-z
+        when ?\C-a.getbyte(0) .. ?\C-z.getbyte(0)
+          return "C-" + (keycode + ?a.getbyte(0) -1).chr 
+        when ?\M-A.getbyte(0)..?\M-z.getbyte(0)
           return "M-"+ (keycode - 128).chr
-        when ?\M-\C-A..?\M-\C-Z
+        when ?\M-\C-A.getbyte(0)..?\M-\C-Z.getbyte(0)
           return "M-C-"+ (keycode - 32).chr
-        when ?\M-0..?\M-9
-          return "M-"+ (keycode-?\M-0).to_s
-        when 32:
+        when ?\M-0.getbyte(0)..?\M-9.getbyte(0)
+          return "M-"+ (keycode-?\M-0.getbyte(0)).to_s
+        when 32
           return "Space"
-        when 27:
+        when 27
           return "Esc"
-        when ?\C-]
+        when ?\C-].getbyte(0)
           return "C-]"
         when 258
           return "down"
@@ -145,8 +165,11 @@ module RubyCurses
           return "M-S-tab"
         when 393..402
           return "M-F"+ (keycode-392).to_s
+        when 0
+          return "C-space" # i hope this is correct, just guessing
         else
           others=[?\M--,?\M-+,?\M-=,?\M-',?\M-",?\M-;,?\M-:,?\M-\,, ?\M-.,?\M-<,?\M->,?\M-?,?\M-/]
+          others.collect! {|x| x.getbyte(0)  }  ## added 2009-10-04 14:25 for 1.9
           s_others=%w[M-- M-+ M-= M-' M-"   M-;   M-:   M-, M-. M-< M-> M-? M-/ ]
           if others.include? keycode
             index =  others.index keycode
@@ -165,13 +188,91 @@ module RubyCurses
         end
         return acolor
       end
+      ## repeats the given action based on how value of universal numerica argument
+      ##+ set using the C-u key. Or in vim-mode using numeric keys
+      def repeatm
+        $inside_multiplier_action = true
+        _multiplier = ( ($multiplier.nil? || $multiplier == 0) ? 1 : $multiplier )
+        _multiplier.times { yield }
+        $multiplier = 0
+        $inside_multiplier_action = false
+      end
+ 
+    ##
+    # bind an action to a key, required if you create a button which has a hotkey
+    # or a field to be focussed on a key, or any other user defined action based on key
+    # e.g. bind_key ?\C-x, object, block 
+    # added 2009-01-06 19:13 since widgets need to handle keys properly
+    #  2010-02-24 12:43 trying to take in multiple key bindings, TODO unbind
+    #  TODO add symbol so easy to map from config file or mapping file
+    def bind_key keycode, *args, &blk
+      @key_handler ||= {}
+      if !block_given?
+        blk = args.pop
+        raise "If block not passed, last arg should be a method symbol" if !blk.is_a? Symbol
+        $log.debug " #{@name} bind_key received a symbol #{blk} "
+      end
+      case keycode
+      when String
+        keycode = keycode.getbyte(0) #if keycode.class==String ##    1.9 2009-10-05 19:40 
+        $log.debug " #{name} Widg String called bind_key BIND #{keycode}, #{keycode_tos(keycode)}  "
+        @key_handler[keycode] = blk
+      when Array
+        # for starters lets try with 2 keys only
+        a0 = keycode[0]
+        a0 = keycode[0].getbyte(0) if keycode[0].class == String
+        a1 = keycode[1]
+        a1 = keycode[1].getbyte(0) if keycode[1].class == String
+        @key_handler[a0] ||= OrderedHash.new
+        @key_handler[a0][a1] = blk
+      else
+        @key_handler[keycode] = blk
+      end
+      @key_args ||= {}
+      @key_args[keycode] = args
+    end
+    # e.g. process_key ch, self
+    # returns UNHANDLED if no block for it
+    # after form handles basic keys, it gives unhandled key to current field, if current field returns
+    # unhandled, then it checks this map.
+    # added 2009-01-06 19:13 since widgets need to handle keys properly
+    # added 2009-01-18 12:58 returns ret val of blk.call
+    # so that if block does not handle, the key can still be handled
+    # e.g. table last row, last col does not handle, so it will auto go to next field
+    #  2010-02-24 13:45 handles 2 key combinations, copied from Form, must be identical in logic
+    #  except maybe for window pointer. TODO not tested
+    def _process_key keycode, object, window
+      return :UNHANDLED if @key_handler.nil?
+      blk = @key_handler[keycode]
+      return :UNHANDLED if blk.nil?
+      if blk.is_a? OrderedHash
+          ch = window.getch
+          if ch < 0 || ch > 255
+            #next
+            return nil
+          end
+          $log.debug " process_key: got #{keycode} , #{ch} "
+          yn = ch.chr
+          blk1 = blk[ch]
+          return nil if blk1.nil?
+          $log.debug " process_key: found block for #{keycode} , #{ch} "
+          blk = blk1
+      end
+      #$log.debug "called process_key #{object}, kc: #{keycode}, args  #{@key_args[keycode]}"
+      if blk.is_a? Symbol
+        return send(blk, *@key_args[keycode])
+      else
+        return blk.call object,  *@key_args[keycode]
+      end
+      #0
+    end
     end
 
     module EventHandler
       ##
       # bind an event to a block, optional args will also be passed when calling
       def bind event, *xargs, &blk
-        #$log.debug "#{self} called EventHandler BIND #{event}, args:#{xargs} "
+       #$log.debug "#{self} called EventHandler BIND #{event}, args:#{xargs} "
         @handler ||= {}
         @event_args ||= {}
         #@handler[event] = blk
@@ -192,7 +293,7 @@ module RubyCurses
       # currently object usually contains self which is perhaps a bit of a waste,
       # could contain an event object with source, and some relevant methods or values
       def fire_handler event, object
-        #$log.debug " def fire_handler evt:#{event}, o: #{object}, #{self}, hdnler:#{@handler}"
+        $log.debug " def fire_handler evt:#{event}, o: #{object.class}, hdnler:#{@handler}"
         if !@handler.nil?
         #blk = @handler[event]
           ablk = @handler[event]
@@ -200,6 +301,7 @@ module RubyCurses
             aeve = @event_args[event]
             ablk.each_with_index do |blk, ix|
               #$log.debug "#{self} called EventHandler firehander #{@name}, #{event}, obj: #{object},args: #{aeve[ix]}"
+              $log.debug "#{self} called EventHandler firehander #{@name}, #{event}"
               blk.call object,  *aeve[ix]
             end
           end # if
@@ -207,10 +309,16 @@ module RubyCurses
       end
       ## added on 2009-01-08 00:33 
       # goes with dsl_property
-      # Need to inform listeners
+      # Need to inform listeners - done 2010-02-25 23:09 
     def fire_property_change text, oldvalue, newvalue
       #$log.debug " FPC #{self}: #{text} #{oldvalue}, #{newvalue}"
-      @repaint_required = true
+      if @pce.nil?
+        @pce = PropertyChangeEvent.new(self, text, oldvalue, newvalue)
+      else
+        @pce.set( self, text, oldvalue, newvalue)
+      end
+      fire_handler :PROPERTY_CHANGE, @pce
+      @repaint_required = true # this was a hack and shoudl go, someone wanted to set this so it would repaint (viewport line 99 fire_prop
     end
 
     end # module eventh
@@ -252,11 +360,8 @@ module RubyCurses
     include EventHandler
     include ConfigSetup
     include RubyCurses::Utils
+    include Io # added 2010-03-06 13:05 
     dsl_property :text
-    #dsl_accessor :text_variable
-    #dsl_accessor :underline                        # offset of text to underline DEPRECATED
-    dsl_property :width                # desired width of text
-    #dsl_accessor :wrap_length                      # wrap length of text, if applic UNUSED
 
     # next 3 to be checked if used or not. Copied from TK.
     dsl_property :select_foreground, :select_background  # color init_pair
@@ -270,7 +375,7 @@ module RubyCurses
     dsl_property :attr                 # attribute bold, normal, reverse
     dsl_accessor :name                 # name to refr to or recall object by_name
     attr_accessor :id #, :zorder
-    attr_accessor :curpos              # cursor position inside object
+    attr_accessor :curpos              # cursor position inside object - column, not row.
     attr_reader  :config             # COULD GET AXED SOON NOTE
     attr_accessor  :form              # made accessor 2008-11-27 22:32 so menu can set
     attr_accessor :state              # normal, selected, highlighted
@@ -278,11 +383,31 @@ module RubyCurses
     dsl_property :visible # boolean     # 2008-12-09 11:29 
     #attr_accessor :modified          # boolean, value modified or not (moved from field 2009-01-18 00:14 )
     dsl_accessor :help_text          # added 2009-01-22 17:41 can be used for status/tooltips
+
+    dsl_property :preferred_width  # added 2009-10-28 13:40 for splitpanes and better resizing
+    dsl_property :preferred_height  # added 2009-10-28 13:40 for splitpanes and better resizing
+    dsl_property :min_width  # added 2009-10-28 13:40 for splitpanes and better resizing
+    dsl_property :min_height  # added 2009-10-28 13:40 for splitpanes and better resizing
+
+    ## 2010-01-05 13:27 create buffer conditionally, if enclosing component asks. Needs to be passed down
+    ##+ to further children or editor components. Default false.
+    attr_accessor  :should_create_buffer              # added  2010-01-05 13:16 BUFFERED, trying to create buffersonly where required.
     
+    ## I think parent_form was not a good idea since i can't add parent widget offsets
+    ##+ thus we should use parent_comp and push up.
+    attr_accessor :parent_component  # added 2010-01-12 23:28 BUFFERED - to bubble up
+    # tired of getting the cursor wrong and guessing, i am now going to try to get absolute
+    # coordinates - 2010-02-07 20:17 this should be updated by parent.
+    attr_accessor :ext_col_offset, :ext_row_offset # 2010-02-07 20:16  to get abs position for cursor
+    #attr_accessor :manages_cursor # does this widget manage cursor, or should form handle it 2010-02-07 20:54 
+    attr_accessor :rows_panned # moved from form, how many rows scrolled.panned 2010-02-11 15:26 
+    attr_accessor :cols_panned # moved from form, how many cols scrolled.panned 2010-02-11 15:26 
+
     def initialize form, aconfig={}, &block
       @form = form
       @bgcolor ||=  "black" # 0
       @row_offset = @col_offset = 0
+      @ext_row_offset = @ext_col_offset = 0 # 2010-02-07 20:18 
       @state = :NORMAL
       @color ||= "white" # $datacolor
       @attr = nil
@@ -296,6 +421,8 @@ module RubyCurses
     def init_vars
       # just in case anyone does a super. Not putting anything here
       # since i don't want anyone accidentally overriding
+      @buffer_modified = false 
+      #@manages_cursor = false # form should manage it, I will pass row and col to it. XXX ?
     end
 
     # modified
@@ -330,6 +457,10 @@ module RubyCurses
     def on_leave
       fire_handler :LEAVE, self
     end
+    ## 
+    # @return row and col of a widget where painting data actually starts
+    # row and col is where a widget starts. offsets usually take into account borders.
+    # the offsets typically are where the cursor should be positioned inside, upon on_enter.
     def rowcol
     # $log.debug "widgte rowcol : #{@row+@row_offset}, #{@col+@col_offset}"
       return @row+@row_offset, @col+@col_offset
@@ -356,18 +487,19 @@ module RubyCurses
         else
           acolor = $datacolor
         end
-        @form.window.printstring r, c, "%-*s" % [len, value], acolor, @attr
+        @graphic.printstring r, c, "%-*s" % [len, value], acolor, @attr
         # next line should be in same color but only have @att so we can change att is nec
         #@form.window.mvchgat(y=r, x=c, max=len, Ncurses::A_NORMAL, @bgcolor, nil)
+        @buffer_modified = true # required for form to call buffer_to_screen
     end
 
     def destroy
-      $log.debug "DESTROY : widget"
+      $log.debug "DESTROY : widget #{@name} "
       panel = @window.panel
       Ncurses::Panel.del_panel(panel) if !panel.nil?   
       @window.delwin if !@window.nil?
     end
-    # @ deprecated pls call windows method
+    # @deprecated pls call windows method
     def printstring(win, r,c,string, color, att = Ncurses::A_NORMAL)
 
       att = Ncurses::A_NORMAL if att.nil?
@@ -399,6 +531,14 @@ module RubyCurses
       raise "Form is nil in set_form" if form.nil?
       @form = form
       @id = form.add_widget(self) if !form.nil? and form.respond_to? :add_widget
+      # 2009-10-29 15:04 use form.window, unless buffer created
+      # should not use form.window so explicitly everywhere.
+      # added 2009-12-27 20:05 BUFFERED in case child object needs a form.
+      # We don;t wish to overwrite the graphic object
+      if @graphic.nil?
+        $log.debug " setting graphic to form window for #{self.class}, #{form} "
+        @graphic = form.window unless form.nil? # use screen for writing, not buffer
+      end
     end
     # puts cursor on correct row.
     def set_form_row
@@ -407,9 +547,13 @@ module RubyCurses
       @form.row = @row + 1 
     end
     # set cursor on correct column, widget
-    def set_form_col col=@curpos
-      @curpos = col
-      @form.col = @col + @col_offset + @curpos
+    # Ideally, this should be overriden, as it is not likely to be correct.
+    def set_form_col col1=@curpos
+      @curpos = col1 || 0 # 2010-01-14 21:02 
+      #@form.col = @col + @col_offset + @curpos
+      c = @col + @col_offset + @curpos
+      $log.debug " #{@name} widget WARNING super set_form_col #{c}, #{@form} "
+      setrowcol nil, c
     end
     def hide
       @visible = false
@@ -446,11 +590,32 @@ module RubyCurses
     # or a field to be focussed on a key, or any other user defined action based on key
     # e.g. bind_key ?\C-x, object, block 
     # added 2009-01-06 19:13 since widgets need to handle keys properly
-    def bind_key keycode, *args, &blk
-      $log.debug "called bind_key BIND #{keycode} #{keycode_tos(keycode)} #{args} "
+    #  2010-02-24 12:43 trying to take in multiple key bindings, TODO unbind
+    #  TODO add symbol so easy to map from config file or mapping file
+    def OLDbind_key keycode, *args, &blk
       @key_handler ||= {}
+      if !block_given?
+        blk = args.pop
+        raise "If block not passed, last arg should be a method symbol" if !blk.is_a? Symbol
+        $log.debug " #{@name} bind_key received a symbol #{blk} "
+      end
+      case keycode
+      when String
+        $log.debug "Widg String called bind_key BIND #{keycode} #{keycode_tos(keycode)}  "
+        keycode = keycode.getbyte(0) #if keycode.class==String ##    1.9 2009-10-05 19:40 
+        @key_handler[keycode] = blk
+      when Array
+        # for starters lets try with 2 keys only
+        a0 = keycode[0]
+        a0 = keycode[0].getbyte(0) if keycode[0].class == String
+        a1 = keycode[1]
+        a1 = keycode[1].getbyte(0) if keycode[1].class == String
+        @key_handler[a0] ||= OrderedHash.new
+        @key_handler[a0][a1] = blk
+      else
+        @key_handler[keycode] = blk
+      end
       @key_args ||= {}
-      @key_handler[keycode] = blk
       @key_args[keycode] = args
     end
     ##
@@ -468,13 +633,10 @@ module RubyCurses
     # added 2009-01-18 12:58 returns ret val of blk.call
     # so that if block does not handle, the key can still be handled
     # e.g. table last row, last col does not handle, so it will auto go to next field
+    #  2010-02-24 13:45 handles 2 key combinations, copied from Form, must be identical in logic
+    #  except maybe for window pointer. TODO not tested
     def process_key keycode, object
-      return :UNHANDLED if @key_handler.nil?
-      blk = @key_handler[keycode]
-      return :UNHANDLED if blk.nil?
-      #$log.debug "called process_key #{object}, #{@key_args[keycode]}"
-      return blk.call object,  *@key_args[keycode]
-      #0
+      return _process_key keycode, object, @graphic
     end
     ## 
     # to be added at end of handle_key of widgets so instlalled actions can be checked
@@ -482,6 +644,346 @@ module RubyCurses
       ret = process_key ch, self
       return :UNHANDLED if ret == :UNHANDLED
     end
+    # @since 0.1.3
+    def get_preferred_size
+      return @preferred_height, @preferred_width
+    end
+    ## 
+    #  creates a buffer for the widget to write to.
+    #  This is typically called in the constructor. Sometimes, the constructor
+    #  does not have a height or width, since the object will be resized based on parents
+    #  size, as in splitpane
+    #  Please use this only if embedding this object in another object/s that would wish
+    #  to crop this. Otherwise, you could have many pads in your app.
+    #  Sets @graphic which can be used in place of @form.window
+    #  
+    # @return [buffer] returns pad created
+    # @since 0.1.3
+    # NOTE: 2010-01-12 11:14  there are some parent widgets that may want this w to have a larger top and left.
+    # Setting it later, means that the first repaint can be off.
+
+    def create_buffer()
+      $log.debug " #{self.class}  CB called with #{@should_create_buffer} H: #{@height} W #{@width}  "
+      if @should_create_buffer
+         @height or $log.warn " CB height is nil, setting to 1. This may not be what you want"
+        mheight = @height ||  1 # some widgets don't have height XXX
+        mwidth  = @width ||  30 # some widgets don't have width as yet
+        mrow    = @row || 0
+        mcol    = @col || 0
+        layout  = { :height => mheight, :width => mwidth, :top => mrow, :left => mcol }
+        $log.debug "  cb .. #{@name} create_buffer #{mrow} #{mcol} #{mheight} #{mwidth}"
+        @screen_buffer = VER::Pad.create_with_layout(layout)
+        @is_double_buffered = true # will be checked prior to blitting
+        @buffer_modified = true # set this in repaint 
+        @repaint_all = true # added 2010-01-08 19:02 
+      else
+        ## NOTE: if form has not been set, you could run into problems
+        ## Typically a form MUST be set by now, unless you are buffering, in which
+        ##+ case it should go in above block.
+        @screen_buffer = @form.window if @form
+      end
+
+      @graphic = @screen_buffer # use buffer for writing, not screen window
+      return @screen_buffer
+    end # create_buffer
+
+    ##
+    # checks if buffer not created already, and figures
+    # out dimensions.
+    # Preferable to use this instead of directly using create_buffer.
+    #
+    def safe_create_buffer
+      if @screen_buffer == nil
+        if @height == nil
+          @height = @preferred_height || @min_height
+        end
+        if @width == nil
+          @width = @preferred_width || @min_width
+        end
+        create_buffer
+      end
+      return @screen_buffer
+    end
+    ##
+    # Inform the system that the buffer has been modified
+    # and should be blitted over the screen or copied to parent.
+    def set_buffer_modified(tf=true)
+      @buffer_modified = tf
+    end
+
+
+    ## 
+    #  copy the buffer to the screen, or given window/pad.
+    #  Relevant only in double_buffered case since pad has to be written
+    #  to screen. Should be called only by outer form, not by widgets as a widget
+    #  could be inside another widget.
+    #  Somewhere we need to clear screen if scrolling.???
+    #  aka b2s
+    # @param [Window, #get_window, nil] screen to write to, if nil then write to phys screen
+    # @return 0 - copy success, -1 copy failure, 1 - did nothing, usually since buffer_modified false
+
+   def buffer_to_screen(screen=nil, pminrow=0, pmincol=0)
+      raise "deprecated b2s "
+      return 1 unless @is_double_buffered and @buffer_modified
+      # screen is nil when form calls this to write to physical screen
+      $log.debug " screen inside buffer_to_screen b2s :#{screen} "
+      $log.error "ERROR !I have moved away fomr this method. Your program is broken and will not be working"
+      ## 2010-01-03 19:38 i think its wrong to put the pad onto the screen
+      ##+ since wrefreshing the window will cause this to be overwriting
+      ##+ so i put current window here.
+      if screen == nil
+        #$log.debug " XXX calling graphic.wrefresh 2010-01-03 12:27 (parent_buffer was nil) "
+        $log.debug " XXX 2010-01-03 20:47 now copying pad #{@graphic} onto form.window"
+        ret = @graphic.wrefresh
+       ## 2010-01-03 20:45 rather than writing to phys screen, i write to forms window
+       ##+ so later updates to that window do not overwrite this widget.
+       ## We need to check this out with scrollpane and splitpane.
+        #ret = @graphic.copywin(@form.window.get_window, 0, 0, @row, @col, @row+@height-1, @col+@width-1,0)
+      else
+      # screen is passed when a parent object calls this to copy child buffer to itself
+        @graphic.set_backing_window(screen)
+        $log.debug "   #{@name} #{@graphic} calling copy pad to win COPY"
+        ret = @graphic.copy_pad_to_win
+      end
+      @buffer_modified = false
+      return ret
+    end # buffer_to_screen
+    ## 
+    #  returns screen_buffer or nil
+    #  
+    # @return [screen_buffer, nil] screen_buffer earlier created
+    # @since 0.1.3
+
+    def get_buffer()
+      @screen_buffer
+    end # get_buffer
+
+    ## 
+    #  destroys screen_buffer if present
+    #  
+    # @return 
+    # @since 0.1.3
+
+    def destroy_buffer()
+        if @screen_buffer != nil
+            @screen_buffer.destroy # ??? 
+        end
+    end # destroy_buffer
+
+     ## 
+     #  Does the widget buffer its output in a pad
+     #  
+     # @return [true, false] comment
+    
+     def is_double_buffered?()
+       @is_double_buffered
+     end # is_double_buffered
+
+     ##
+     # getter and setter for width - 2009-10-29 22:45 
+     # Using dsl_property style
+     #
+     # @param [val, nil] value to set
+     # @return [val] earlier value if nil param
+     # @since 0.1.3
+     #
+     def width(*val)
+       #$log.debug " inside XXX width() #{val[0]}"
+       if val.empty?
+         return @width
+       else
+         #$log.debug " inside XXX width()"
+         oldvalue = @width || 0 # is this default okay, else later nil cries
+         @width = val.size == 1 ? val[0] : val
+         newvalue = @width
+         @config["width"]=@width
+         if oldvalue != newvalue
+           fire_property_change("width", oldvalue, newvalue)
+           repaint_all(true)  # added 2010-01-08 18:51 so widgets can redraw everything.
+         end
+         if is_double_buffered? and newvalue != oldvalue
+           $log.debug " #{@name} w calling resize of screen buffer with #{newvalue}. WARNING: does not change buffering_params"
+           @screen_buffer.resize(0, newvalue)
+         end
+       end
+     end
+     def width=val
+       width(val)
+     end
+     ##
+     # getter and setter for height - 2009-10-30 12:25 
+     # Using dsl_property style
+     # SO WE've finally succumbed and added height to widget
+     # @param [val, nil] height to set
+     # @return [val] earlier height if nil param
+     # @since 0.1.3
+     #
+     def height(*val)
+       #$log.debug " inside XXX height() #{val[0]}"
+       if val.empty?
+         return @height
+       else
+         #$log.debug " inside #{@name} height()"
+         oldvalue = @height || 0 # is this default okay, else later nil cries
+         @height = val.size == 1 ? val[0] : val
+         newvalue = @height
+         @config["height"]=@height
+         if oldvalue != newvalue
+           fire_property_change("height", oldvalue, newvalue)
+           $log.debug " widget #{@name} setting repaint_all to true"
+           @repaint_all=true
+         end
+         # XXX this troubles me a lot. gets fired more than we would like
+         # XXX When both h and w change then happens 2 times.
+         if is_double_buffered? and newvalue != oldvalue
+           $log.debug " #{@name} h calling resize of screen buffer with #{newvalue}"
+           @screen_buffer.resize(newvalue, 0)
+         end
+       end
+     end
+     def height=val
+       height(val)
+     end
+    # to give simple access to other components, (eg, parent) to tell a comp to either
+    # paint its data, or to paint all - borders, headers, footers due to a big change (ht/width)
+    def repaint_required(tf=true)
+      @repaint_required = tf
+    end
+    def repaint_all(tf=true)
+      @repaint_all = tf
+      @repaint_required = tf
+    end
+
+     ## 
+     # When an enclosing component creates a pad (buffer) and the child component
+     #+ should write onto the same pad, then the enclosing component should override
+     #+ the default graphic of child. This applies mainly to editor components in
+     #+ listboxes and tables. 
+     # @param graphic graphic object to use for writing contents
+     # @see prepare_editor in rlistbox.
+     # added 2010-01-05 15:25 
+     def override_graphic gr
+       @graphic = gr
+     end
+
+     ## passing a cursor up and adding col and row offsets
+     ## Added 2010-01-13 13:27 I am checking this out.
+     ## I would rather pass the value down and store it than do this recursive call
+     ##+ for each cursor display
+     # @see Form#setrowcol
+     def setformrowcol r, c
+           @form.row = r unless r.nil?
+           @form.col = c unless c.nil?
+           # this is stupid, going through this route i was losing windows top and left
+           # And this could get repeated if there are mult objects. 
+        if !@parent_component.nil? and @parent_component != self
+           r+= @parent_component.form.window.top unless  r.nil?
+           c+= @parent_component.form.window.left unless c.nil?
+           $log.debug " (#{@name}) calling parents setformrowcol #{r}, #{c} pa: #{@parent_component.name} self: #{name}, #{self.class}, poff #{@parent_component.row_offset}, #{@parent_component.col_offset}, top:#{@form.window.left} left:#{@form.window.left} "
+           @parent_component.setformrowcol r, c
+        else
+           # no more parents, now set form
+           $log.debug " name NO MORE parents setting #{r}, #{c}    in #{@form} "
+           @form.setrowcol r, c
+        end
+     end
+     ## widget: i am putting one extra level of indirection so i can switch here
+     # between form#setrowcol and setformrowcol, since i am not convinced either
+     # are giving the accurate result. i am not sure what the issue is.
+     def setrowcol r, c
+         # 2010-02-07 21:32 is this where i should add ext_offsets
+        #$log.debug " #{@name}  w.setrowcol #{r} + #{@ext_row_offset}, #{c} + #{@ext_col_offset}  "
+        # commented off 2010-02-15 18:22 
+        #r += @ext_row_offset unless r.nil?
+        #c += @ext_col_offset unless c.nil?
+        if @form
+          @form.setrowcol r, c
+        else
+          @parent_component.setrowcol r, c
+        end
+        #setformrowcol r,c 
+     end
+
+     # move from TextView
+     # parameters relating to buffering - new 2010-02-12 12:09 RFED16
+     # I am merging so i can call multiple times
+     # WARNING NOTE : this does not set Pad's top and left since Pad may not be created yet, or at all
+     def set_buffering params
+       @buffer_params ||= {}
+       #@should_create_buffer = params[:should_create_buffer] || true
+       @target_window ||= params[:target_window]
+       # trying out, 2010-02-12 19:40 sometimes no form even with parent.
+       @form = params[:form] unless @form
+       ## XXX trying this out.
+       # what if container does not ask child to buffer, as in splitpane
+       # then graphic could be nil
+       if @graphic.nil? # and should_create_buffer not set or false XXX
+         @graphic = @target_window
+       end
+       $log.debug " set_buffering #{@name} got target window #{@target_window}, #{@graphic} - THIS DOES NOT UPDATE PAD ... sr:#{params[:screen_top]} sc:#{params[:screen_left]} top:#{params[:top]} left:#{params[:left]} bot:#{params[:bottom]} rt:#{params[:right]} "
+       # @top = params[:top]
+       # @left = params[:left]
+       # @bottom = params[:bottom]
+       # @right = params[:right]
+       # offsets ?
+       # warning, this does not touch @top and left of Pad, often pad will bot yet be created
+       @buffer_params.merge!(params)
+       if !@screen_buffer.nil?
+         # update Pad since some folks take from there such as print_border
+         @screen_buffer.top = params[:screen_top] if !params[:screen_top].nil?
+         @screen_buffer.left = params[:screen_left] if !params[:screen_left].nil?
+       end
+     end
+ 
+     # copy buffer onto window
+     # RFED16 added 2010-02-12 14:42 0 simpler buffer management
+     def buffer_to_window
+       if @is_double_buffered and @buffer_modified
+         raise " #{@name} @buffer_params not passed. Use set_buffering()" unless @buffer_params
+         # we are notchecking for TV's width exceedingg, could get -1 if TV exceeds parent/
+          $log.debug "RFED16 paint  #{@name} calling b2s #{@graphic}  "
+          # TODO need to call set_screen_row_col (top, left), set_pad_top_left (pminrow, pmaxrow), set_screen_max_row_col
+          if false
+            # boh these print the pad behind 0,0, later scroll etc cover it and show bars.
+            # adding window was giving error
+              ret = buffer_to_screen #@target_window.get_window
+              #ret = @graphic.wrefresh
+          else
+             # ext gives me parents offset. often the row would be zero, so we still need one extra
+              r1 = @ext_row_offset # XXX NO, i should use top and left 
+              c1 = @ext_col_offset  
+              r = @graphic.top # 2010-02-12 21:12 TRYING THIS.
+              c = @graphic.left
+              maxr = @buffer_params[:bottom]
+              maxc = @buffer_params[:right]
+              r = @buffer_params[:screen_top] || 0
+              c = @buffer_params[:screen_left] || 0
+              $log.debug " b2w #{r1} #{c1} , #{r} #{c} "
+              ## sadly this is bypassing the method that does this stuff in Pad. We need to assimilate it back, so not so much work here
+              pminr = @graphic.pminrow
+              pminc = @graphic.pmincol
+              border_width = 0 # 2 #XXX  2010-02-15 23:40 2 to 0
+              $log.debug " #{@name} ret = @graphic.copywin(@target_window.get_window, #{pminr}, #{pminc}, #{r}, #{c}, #{r}+#{maxr} - #{border_width}, #{c} + #{maxc} - #{border_width} ,0)"
+              # this print the view at 0,0, byt covers the scrllare, bars not shown.
+              # this can crash if textview is smaller than container dimension
+              # can crash/give -1 when panning, giong beyond pad size XXX
+              ret = @graphic.copywin(@target_window.get_window, pminr, pminc, r, c, r+maxr-border_width, c+maxc-border_width,0)
+              if ret == -1
+                $log.debug " copywin #{@name} h #{@height} w #{@width} "
+                if @height <= maxr-border_width
+                  $log.warn " h #{@height} is <= :bottom #{maxr} "
+                end
+                if @width <= maxc-border_width
+                  $log.warn " h #{@width} is <= :right #{maxc} "
+                end
+                $log.warn "ERROR !!! copywin returns -1 check Target: #{@target_window}, #{@target_window.get_window} " if ret == -1
+              end
+          end
+          $log.debug " copywin ret --> #{ret} "
+          #
+      end
+     end
+     ##
     ## ADD HERE WIDGET
   end
 
@@ -506,6 +1008,19 @@ module RubyCurses
     attr_reader :by_name   # hash containing widgets by name for retrieval
     attr_reader :menu_bar
     attr_accessor :navigation_policy  # :CYCLICAL will cycle around. Needed to move to other tabs
+    ## i need some way to move the cursor by telling the main form what the coords are
+    ##+ perhaps this will work
+    attr_accessor :parent_form  # added 2009-12-28 23:01 BUFFERED - to bubble up row col changes
+    # how many rows the component is panning embedded widget by
+    attr_accessor :rows_panned  # HACK added 2009-12-30 16:01 BUFFERED 
+    # how many cols the component is panning embedded widget by
+    attr_accessor :cols_panned  # HACK added 2009-12-30 16:01 BUFFERED 
+    ## next 2 added since tabbedpanes offset needs to be accounted by form inside it.
+    attr_accessor :add_cols # 2010-01-26 20:23 additional columns due to being placed in some container
+    attr_accessor :add_rows # 2010-01-26 20:23 additional columns due to being placed in some container
+    attr_accessor :name # for debugging 2010-02-02 20:12 
+    attr_accessor :ext_col_offset, :ext_row_offset # 2010-02-07 20:16  to get abs position for cursor
+#    attr_accessor :allow_alt_digits # catch Alt-1-9 as digit_argument
     def initialize win, &block
       @window = win
       @widgets = []
@@ -513,12 +1028,26 @@ module RubyCurses
       @active_index = -1
       @padx = @pady = 0
       @row = @col = -1
+      @ext_row_offset = @ext_col_offset = 0 # 2010-02-07 20:18 
+      @add_cols = @add_rows = 0 # 2010-01-26 20:28 
       @handler = {}
       @modified = false
       @focusable = true
       @navigation_policy ||= :CYCLICAL
       instance_eval &block if block_given?
       @firsttime = true # internal, don't touch
+      ## I need some counter so a widget knows it has been panned and can send a correct
+      ##+ cursor coordinate to system.
+      @rows_panned = @cols_panned = 0 # how many rows were panned, typically at a higher level
+      @firsttime = true; # added on 2010-01-02 19:21 to prevent scrolling crash ! 
+      @name ||= ""
+      $kill_ring ||= [] # 2010-03-09 22:42 so textarea and others can copy and paste
+      $kill_ring_pointer = 0 # needs to be incremented with each append, moved with yank-pop
+      $append_next_kill = false
+      $kill_last_pop_size = 0 # size of last pop which has to be cleared
+
+      #@allow_alt_digits = true ; # capture Alt-1-9 as digit_args. Set to false if you wish to map
+                                 # Alt-1-9 to buttons of tabs 
     end
     ##
     # set this menubar as the form's menu bar.
@@ -549,9 +1078,21 @@ module RubyCurses
         @by_name[widget.name] = widget
       end
 
+
+      $log.debug " #{self} adding a widget #{@widgets.length} .. #{widget} "
       @widgets << widget
+      # add form offsets to widget's external offsets - 2010-02-07 20:22 
+      if widget.is_a? RubyCurses::Widget
+        if @window # ext seems redundant
+          widget.ext_col_offset += @window.left # just hope window aint undef!! XXX
+          $log.debug " #{@name} add widget ( #{widget.name} ) ext_row #{widget.ext_row_offset} += #{@window.top} "
+          widget.ext_row_offset += @window.top
+        end
+      end
       return @widgets.length-1
-   end
+    end
+    alias :add :add_widget
+
     # remove a widget
     #  added 2008-12-09 12:18 
    def remove_widget widget
@@ -564,31 +1105,69 @@ module RubyCurses
    # form repaint
    # to be called at some interval, such as after each keypress.
     def repaint
+      $log.debug " form repaint:#{self}, #{@name} , r #{@row} c #{@col} "
       @widgets.each do |f|
         next if f.visible == false # added 2008-12-09 12:17 
         f.repaint
+        # added 2009-10-29 20:11 for double buffered widgets
+        # this should only happen if painting actually happened
+        #$log.debug " #{self} form repaint parent_buffer (#{@parent_buffer}) if #{f.is_double_buffered?} : #{f.name} "
+        pb = @parent_buffer #|| @window
+        # is next line used 2010-02-05 00:04 its wiping off top in scrollpane in tabbedpane
+        # RFED16 - the next line should never execute now, since no outer object is buffered
+        #+ only those within containers are.
+        # Drat - this line is happeing since components inside a TP are double_buffered
+        #x f.buffer_to_screen(pb) if f.is_double_buffered? 
       end
-      @window.clear_error
+      @window.clear_error # suddenly throwing up on a small pad 2010-03-02 15:22 TPNEW
       @window.print_status_message $status_message unless $status_message.nil?
       @window.print_error_message $error_message unless $error_message.nil?
       $error_message = $status_message = nil
       #  this can bomb if someone sets row. We need a better way!
-      if @row == -1 #or @firsttime == true
+      if @row == -1 and @firsttime == true
         #set_field_cursor 0
-       $log.debug "form repaint calling select field 0"
+        #  this part caused an endless loop on 2010-01-02 19:20 when scrollpane scrolled up
+       $log.debug "form repaint calling select field 0 SHOULD HAPPEN FIRST TIME ONLY"
         #select_field 0
         req_first_field
-        #@firsttime = false
+        @firsttime = false
       end
        setpos 
-       @window.wrefresh
+       # XXX this creates a problem if window is a pad
+       # although this does show cursor movement etc.
+       ### XXX@window.wrefresh
+       if @window.window_type == :WINDOW
+         $log.debug " formrepaint #{@name} calling window.wrefresh #{@window} "
+         @window.wrefresh
+       else
+         # UGLY HACK TO MAKE TABBEDPANES WORK !!
+         # If the form is based on a Pad, then it would come here to write the Pad onto the parent_buffer
+         # However, I've obviated the need to handle anything here by adding a display_form after handle_key
+         # in TP.
+         #x if @parent_buffer!=nil
+           #x $log.debug " formrep coming to set backing window part #{@window} , type:#{@window.window_type}, #{@parent_buffer}, #{@parent_buffer.window_type} "
+           # XXX RFED19 do we need at all 2010-02-19 15:26 
+           # this is required so that each key stroke registers on tabbedpane
+           # for this to work both have to be pads
+           #x @window.set_backing_window(@parent_buffer)
+           #x @window.copy_pad_to_win
+           #x @window.wrefresh #since the pads are writing onto window directly, i don't think we need  this
+           #x $log.debug " DO I NEED TO DO SOMETHING HERE FOR TABBEDPANES now ? WARN ?? YES, else keystrokes won't be updated "
+         #x end
+       end
     end
     ## 
     # move cursor to where the fields row and col are
     # private
     def setpos r=@row, c=@col
-     # $log.debug "setpos : #{r} #{c}"
-     @window.wmove r,c
+      # next 2 lines added, only do cursor if current field doesn't manage it.
+      #curr = get_current_field
+      #return if curr.manages_cursor
+      $log.debug "setpos : (#{self}) #{r} #{c}"
+      ## adding just in case things are going out of bounds of a parent and no cursor to be shown
+      return if r.nil? or c.nil?  # added 2009-12-29 23:28 BUFFERED
+      return if r<0 or c<0  # added 2010-01-02 18:49 stack too deep coming if goes above screen
+      @window.wmove r,c
     end
     def get_current_field
       select_next_field if @active_index == -1
@@ -628,17 +1207,23 @@ module RubyCurses
       f.on_enter if f.respond_to? :on_enter
       fire_handler :ENTER, f 
     end
+    ## is a field focusable
+    # Added a method here, so forms can extend this to avoid focussing on off-screen components
+    def focusable?(f)
+      return f.focusable
+    end
     ##
     # puts focus on the given field/widget index
     # XXX if called externally will not run a on_leave of previous field
     def select_field ix0
-      return if @widgets.nil? or @widgets.empty? or !@widgets[ix0].focusable
-#     $log.debug "insdie select  field :  #{ix0} ai #{@active_index}" 
+      #return if @widgets.nil? or @widgets.empty? or !@widgets[ix0].focusable
+      return if @widgets.nil? or @widgets.empty? or !focusable?(@widgets[ix0])
+     #$log.debug "insdie select  field :  #{ix0} ai #{@active_index}" 
       f = @widgets[ix0]
-      if f.focusable
+      if focusable?(f)
         @active_index = ix0
         @row, @col = f.rowcol
-#       $log.debug "insdie sele nxt field : ROW #{@row} COL #{@col} " 
+       #$log.debug " WMOVE insdie sele nxt field : ROW #{@row} COL #{@col} " 
         @window.wmove @row, @col
         on_enter f
         f.curpos = 0
@@ -669,7 +1254,7 @@ module RubyCurses
     # in which case returns :NO_NEXT_FIELD.
     def select_next_field
       return if @widgets.nil? or @widgets.empty?
-      #$log.debug "insdie sele nxt field :  #{@active_index} WL:#{@widgets.length}" 
+      $log.debug "insdie sele nxt field :  #{@active_index} WL:#{@widgets.length}" 
       if @active_index.nil?
         @active_index = -1 
       else
@@ -687,7 +1272,8 @@ module RubyCurses
       index = @active_index + 1
       index.upto(@widgets.length-1) do |i|
         f = @widgets[i]
-        if f.focusable
+        $log.debug "insdie sele nxt field :  i #{i}  #{index} WL:#{@widgets.length}, field #{f}" 
+        if focusable?(f)
           select_field i
           return
         end
@@ -701,12 +1287,13 @@ module RubyCurses
         #select_next_field
         0.upto(index-1) do |i|
           f = @widgets[i]
-          if f.focusable
+          if focusable?(f)
             select_field i
             return
           end
         end
       end
+      $log.debug "insdie sele nxt field : NO NEXT  #{@active_index} WL:#{@widgets.length}" 
       return :NO_NEXT_FIELD
     end
     ##
@@ -732,7 +1319,7 @@ module RubyCurses
       index = @active_index - 1
       (index).downto(0) do |i|
         f = @widgets[i]
-        if f.focusable
+        if focusable?(f)
           select_field i
           return
         end
@@ -746,7 +1333,7 @@ module RubyCurses
         total = @widgets.length-1
         total.downto(index-1) do |i|
           f = @widgets[i]
-          if f.focusable
+          if focusable?(f)
             select_field i
             return
           end
@@ -757,61 +1344,231 @@ module RubyCurses
     alias :req_next_field :select_next_field
     alias :req_prev_field :select_prev_field
     ##
-    # move cursor by num columns
+    # move cursor by num columns. Form
     def addcol num
       return if @col.nil? or @col == -1
       @col += num
       @window.wmove @row, @col
+      ## 2010-01-30 23:45 exchange calling parent with calling this forms setrow
+      # since in tabbedpane with table i am not gietting this forms offset. 
+        setrowcol nil, col
+      # added on 2010-01-05 22:26 so component widgets like scrollpane can get the cursor
+      #if !@parent_form.nil? and @parent_form != self #@form
+        #$log.debug " #{@name} addcol calling parents setrowcol #{row}, #{col}: #{@parent_form}   "
+        #@parent_form.setrowcol nil, col
+      #end
     end
     ##
     # move cursor by given rows and columns, can be negative.
+    # 2010-01-30 23:47 FIXME, if this is called we should call setrowcol like in addcol
     def addrowcol row,col
-      return if @col.nil? or @col == -1
+      return if @col.nil? or @col == -1   # contradicts comment on top
       return if @row.nil? or @row == -1
       @col += col
       @row += row
       @window.wmove @row, @col
+      # added on 2010-01-05 22:26 so component widgets like scrollpane can get the cursor
+      if !@parent_form.nil? and @parent_form != @form
+        $log.debug " #{@name} addrowcol calling parents setrowcol #{row}, #{col}  "
+        @parent_form.setrowcol row, col
+      end
+    end
+
+    ## added 2009-12-29 15:46  BUFFERED
+    # Set forms row and col, so that the cursor can be displayed at that point.
+    # Widgets should call this rather than touch row and col
+    # directly. This should percolate the row and col
+    # upwards to parent forms, after comparing to prevent 
+    # infinite recursion.
+    # This is being done for embedded objects so that the cursor
+    # can be maintained correctly.
+    def OLDsetrowcol r, c
+      @row = r unless r.nil?
+      @col = c unless c.nil?
+           r +=  @add_rows unless r.nil? # 2010-01-26 20:31 
+           c +=  @add_cols unless c.nil? # 2010-01-26 20:31 
+           $log.debug " addcols #{@add_cols} addrow #{@add_rows} : #{self}  "
+      if !@parent_form.nil? and @parent_form != self
+        $log.debug " (#{@name}) calling parents setrowcol #{r}, #{c} : pare: #{@parent_form}; self:  #{self}, #{self.class}  "
+        r += @parent_form.window.top unless  r.nil?
+        c += @parent_form.window.left unless c.nil?
+        @parent_form.setrowcol r, c
+      end
+    end
+    ## Form
+    # New attempt at setting cursor using absolute coordinates
+    # Also, trying NOT to go up. let this pad or window print cursor.
+    def setrowcol r, c
+      @row = r unless r.nil?
+      @col = c unless c.nil?
+      r +=  @add_rows unless r.nil? # 2010-01-26 20:31 
+      c +=  @add_cols unless c.nil? # 2010-01-26 20:31 
+      $log.debug " addcols #{@add_cols} addrow #{@add_rows} : #{self}  "
+      if !@parent_form.nil? and @parent_form != self
+        $log.debug " (#{@name}) calling parents setrowcol #{r}, #{c} : pare: #{@parent_form}; self:  #{self}, #{self.class}  "
+        #r += @parent_form.window.top unless  r.nil?
+        #c += @parent_form.window.left unless c.nil?
+        @parent_form.setrowcol r, c
+      end
     end
   ##
   # bind an action to a key, required if you create a button which has a hotkey
   # or a field to be focussed on a key, or any other user defined action based on key
   # e.g. bind_key ?\C-x, object, block
-  def bind_key keycode, *args, &blk
-    $log.debug "called bind_key BIND #{keycode} #{keycode_tos(keycode)} #{args} "
-    @key_handler ||= {}
-    @key_args ||= {}
-    @key_handler[keycode] = blk
-    @key_args[keycode] = args
+    # 1.9 if string passed then getbyte so user does not need to change much and
+    # less chance of error 2009-10-04 16:08 
+  def OLDbind_key keycode, *args, &blk
+      @key_handler ||= {}
+      case keycode
+      when String
+        $log.debug "FORM String called bind_key BIND #{keycode} #{keycode_tos(keycode)}  "
+        keycode = keycode.getbyte(0) #if keycode.class==String ##    1.9 2009-10-05 19:40 
+        @key_handler[keycode] = blk
+      when Array
+        # for starters lets try with 2 keys only
+        a0 = keycode[0]
+        a0 = keycode[0].getbyte(0) if keycode[0].class == String
+        a1 = keycode[1]
+        a1 = keycode[1].getbyte(0) if keycode[1].class == String
+        @key_handler[a0] ||= OrderedHash.new
+        @key_handler[a0][a1] = blk
+      else
+        @key_handler[keycode] = blk
+      end
+      @key_args ||= {}
+      @key_args[keycode] = args
   end
 
   # e.g. process_key ch, self
   # returns UNHANDLED if no block for it
   # after form handles basic keys, it gives unhandled key to current field, if current field returns
   # unhandled, then it checks this map.
+  # Please update widget with any changes here. TODO: match regexes as in mapper
   def process_key keycode, object
-    return :UNHANDLED if @key_handler.nil?
-    blk = @key_handler[keycode]
-    return :UNHANDLED if blk.nil?
-    $log.debug "called process_key #{object}, #{@key_args[keycode]}"
-    blk.call object,  *@key_args[keycode]
-    0
+    return _process_key keycode, object, @window
+  end
+      #return :UNHANDLED if @key_handler.nil?
+      #blk = @key_handler[keycode]
+      #return :UNHANDLED if blk.nil?
+      #if blk.is_a? OrderedHash
+        ## Please note that this does not wait too long, you have to press next key fast
+        ## since i have set halfdelay in ncurses.rb, test this with getchar to get more keys TODO
+          #ch = @window.getch
+          #if ch < 0 || ch > 255
+            ##next
+            #return nil
+          #end
+          #$log.debug " process_key: got #{keycode} , #{ch} "
+          #yn = ch.chr
+          #blk1 = blk[ch]
+          #return nil if blk1.nil?
+          #$log.debug " process_key: found block for #{keycode} , #{ch} "
+          #blk = blk1
+      #end
+      #$log.debug "called process_key #{object}, kc: #{keycode}, args  #{@key_args[keycode]}"
+     ## return blk.call object,  *@key_args[keycode]
+    #blk.call object,  *@key_args[keycode]
+    #0
+  #end
+  # Defines how user can give numeric args to a command even in edit mode
+  # User either presses universal_argument (C-u) which generates a series of 4 16 64.
+  # Or he presses C-u and then types some numbers. Followed by the action.
+  # @returns [0, :UNHANDLED] :UNHANDLED implies that last keystroke is still to evaluated
+  # by system. ) implies only numeric args were obtained. This method updates $multiplier
+  def universal_argument
+    $multiplier = ( ($multiplier.nil? || $multiplier == 0) ? 4 : $multiplier *= 4)
+        $log.debug " inside UNIV MULT0: #{$multiplier} "
+    # See if user enters numerics. If so discard existing varaible and take only 
+    #+ entered values
+    _m = 0
+    while true
+      ch = @window.getchar()
+      case ch
+      when -1
+        next 
+      when ?0.getbyte(0)..?9.getbyte(0)
+        _m *= 10 ; _m += (ch-48)
+        $multiplier = _m
+        $log.debug " inside UNIV MULT #{$multiplier} "
+      when ?\C-u.getbyte(0)
+        if _m == 0
+          # user is incrementally hitting C-u
+          $multiplier *= 4
+        else
+          # user is terminating some numbers so he can enter a numeric command next
+          return 0
+        end
+      else
+        $log.debug " inside UNIV MULT else got #{ch} "
+        # here is some other key that is the function key to be repeated. we must honor this
+        # and ensure it goes to the right widget
+        return ch
+        #return :UNHANDLED
+      end
+    end
+    return 0
+  end
+  def digit_argument ch
+    $multiplier = ch - ?\M-0.getbyte(0)
+    $log.debug " inside UNIV MULT 0 #{$multiplier} "
+    # See if user enters numerics. If so discard existing varaible and take only 
+    #+ entered values
+    _m = $multiplier
+    while true
+      ch = @window.getchar()
+      case ch
+      when -1
+        next 
+      when ?0.getbyte(0)..?9.getbyte(0)
+        _m *= 10 ; _m += (ch-48)
+        $multiplier = _m
+        $log.debug " inside UNIV MULT 1 #{$multiplier} "
+      when ?\M-0.getbyte(0)..?\M-9.getbyte(0)
+        _m *= 10 ; _m += (ch-?\M-0.getbyte(0))
+        $multiplier = _m
+        $log.debug " inside UNIV MULT 2 #{$multiplier} "
+      else
+        $log.debug " inside UNIV MULT else got #{ch} "
+        # here is some other key that is the function key to be repeated. we must honor this
+        # and ensure it goes to the right widget
+        return ch
+        #return :UNHANDLED
+      end
+    end
+    return 0
   end
   ## forms handle keys
   # mainly traps tab and backtab to navigate between widgets.
   # I know some widgets will want to use tab, e.g edit boxes for entering a tab
   #  or for completion.
   def handle_key(ch)
+        if ch ==  ?\C-u.getbyte(0)
+          ret = universal_argument
+          $log.debug " FORM set MULT to #{$multiplier}, ret = #{ret}  "
+          return 0 if ret == 0
+          ch = ret # unhandled char
+        elsif ch >= ?\M-1.getbyte(0) && ch <= ?\M-9.getbyte(0)
+          if $catch_alt_digits
+            ret = digit_argument ch
+            $log.debug " FORM set MULT DA to #{$multiplier}, ret = #{ret}  "
+            return 0 if ret == 0 # don't see this happening
+            ch = ret # unhandled char
+          end
+        end
+
         case ch
         when -1
           return
         else
+          keycode = keycode_tos(ch)
+          $log.debug " form HK #{ch} #{self}, #{@name}, #{keycode}  "
           field =  get_current_field
           handled = :UNHANDLED 
           handled = field.handle_key ch unless field.nil? # no field focussable
           # some widgets like textarea and list handle up and down
           if handled == :UNHANDLED or handled == -1 or field.nil?
             case ch
-            when 9, ?\M-\C-i  # tab and M-tab in case widget eats tab (such as Table)
+            when 9, ?\M-\C-i.getbyte(0)  # tab and M-tab in case widget eats tab (such as Table)
               ret = select_next_field
               return ret if ret == :NO_NEXT_FIELD
               # alt-shift-tab  or backtab (in case Table eats backtab)
@@ -822,14 +1579,31 @@ module RubyCurses
               select_prev_field
             when KEY_DOWN
               select_next_field
+            #when ?\M-L.getbyte(0)
+              ### trying out these for fuun and testing splitpane 2010-01-10 20:32 
+              #$log.debug " field #{field.name} was #{field.width} "
+              #field.width += 1
+              #$log.debug " field #{field.name} now #{field.width} "
+              #field.repaint_all
+            #when ?\M-H.getbyte(0), ?\M-<.getbyte(0)
+              #field.width -= 1
+              #$log.debug " field #{field.name} now #{field.width} "
+              #field.repaint_all
+            #when ?\M-J.getbyte(0)
+              #field.height += 1
+            #when ?\M-K.getbyte(0)
+              #field.height -= 1
             else
               ret = process_key ch, self
+              $log.debug " process_key #{ch} got ret #{ret} in #{self} "
               return :UNHANDLED if ret == :UNHANDLED
             end
           end
         end
-       $log.debug " form before repaint"
+       $log.debug " form before repaint #{self} , #{@name}, ret #{ret}"
        repaint
+       #return handled # TRYNG 2010-03-01 23:30 since TP returns NO_NEXT_FIELD sometimes
+       #$multiplier = 0
   end
   ##
   # test program to dump data onto log
@@ -854,9 +1628,36 @@ module RubyCurses
     end
     $log.debug " END DUMPING DATA "
   end
+  ##
+  # trying out for splitpane and others who have a sub-form
+  def set_parent_buffer b
+    @parent_buffer = b
+  end
+  # 2010-02-07 14:50 to aid in debugging and comparing log files.
+  def to_s; @name || self; end
 
     ## ADD HERE FORM
   end
+  ## Created and sent to all listeners whenever a property is changed
+  # @see fire_property_change
+  # @see fire_handler 
+  # @since 1.0.5 added 2010-02-25 23:06 
+  class PropertyChangeEvent
+    attr_accessor :source, :property_name, :oldvalue, :newvalue
+    def initialize source, property_name, oldvalue, newvalue
+      set source, property_name, oldvalue, newvalue
+    end
+    def set source, property_name, oldvalue, newvalue
+        @source, @property_name, @oldvalue, @newvalue =
+        source, property_name, oldvalue, newvalue
+    end
+    def to_s
+      "PROPERTY_CHANGE name: #{property_name}, oldval: #{@oldvalue}, newvalue: #{@newvalue}, source: #{@source}"
+    end
+    def inspect
+      to_s
+    end
+  end
 
   ##
   # Text edit field
@@ -887,6 +1688,7 @@ module RubyCurses
     #attr_reader :curpos              # cursor position in buffer current, in WIDGET 
     attr_accessor :datatype              # crrently set during set_buffer
     attr_reader :original_value              # value on entering field
+    attr_accessor :overwrite_mode              # true or false INSERT OVERWRITE MODE
 
     def initialize form, config={}, &block
       @form = form
@@ -931,11 +1733,17 @@ module RubyCurses
       end
     end
     def putch char
-      return -1 if !@editable or @buffer.length >= @maxlen
+      return -1 if !@editable 
+      return -1 if !@overwrite_mode and @buffer.length >= @maxlen
       if @chars_allowed != nil
         return if char.match(@chars_allowed).nil?
       end
-      @buffer.insert(@curpos, char)
+      # added insert or overwrite mode 2010-03-17 20:11 
+      if @overwrite_mode
+        @buffer[@curpos] = char
+      else
+        @buffer.insert(@curpos, char)
+      end
       @curpos += 1 if @curpos < @maxlen
       @modified = true
       $log.debug " FIELD FIRING CHANGE: #{char} at new #{@curpos}: bl:#{@buffer.length} buff:[#{@buffer}]"
@@ -997,8 +1805,13 @@ module RubyCurses
     label.col  @col-(label.name.length+1) if label.col == -1
     label.label_for(self)
   end
+
+  ## Note that some older widgets like Field repaint every time the form.repaint
+  ##+ is called, whether updated or not. I can't remember why this is, but
+  ##+ currently I've not implemented events with these widgets. 2010-01-03 15:00 
+
   def repaint
-#    $log.debug("FIELD: #{id}, #{zorder}, #{focusable}")
+    $log.debug("repaint FIELD: #{id}, #{name},  #{focusable}")
     #return if display_length <= 0 # added 2009-02-17 00:17 sometimes editor comp has 0 and that
     # becomes negative below, no because editing still happens
     @display_length = 1 if display_length == 0
@@ -1017,11 +1830,12 @@ module RubyCurses
     else
       acolor = $datacolor
     end
-    @form.window.printstring  row, col, sprintf("%-*s", display_length, printval), acolor, @attr
+    @graphic = @form.window if @graphic.nil? ## cell editor listbox hack XXX fix in correct place
+    $log.debug " Field g:#{@graphic}. r,c,displen:#{@row}, #{@col}, #{@display_length} "
+    @graphic.printstring  row, col, sprintf("%-*s", display_length, printval), acolor, @attr
   end
   def set_focusable(tf)
     @focusable = tf
- #   @form.regenerate_focusables
   end
 
   # field
@@ -1047,13 +1861,13 @@ module RubyCurses
       end
     when 330
       delete_curr_char if @editable
-    when ?\C-a
+    when ?\C-a.getbyte(0)
       cursor_home 
-    when ?\C-e
+    when ?\C-e.getbyte(0)
       cursor_end 
-    when ?\C-k
+    when ?\C-k.getbyte(0)
       delete_eol if @editable
-    when ?\C-u
+    when ?\C-_.getbyte(0) # changed on 2010-02-26 14:44 so C-u can be used as numeric arg
       @buffer.insert @curpos, @delete_buffer unless @delete_buffer.nil?
     when 32..126
       #$log.debug("FIELD: ch #{ch} ,at #{@curpos}, buffer:[#{@buffer}] bl: #{@buffer.to_s.length}")
@@ -1137,6 +1951,7 @@ module RubyCurses
       set_modified 
       addcol -1
     end
+    ## add a column to cursor position. Field
     def addcol num
       if num < 0
         if @form.col <= @col + @col_offset
@@ -1213,7 +2028,7 @@ module RubyCurses
     ##
     # install trigger to call whenever a value is updated
     def update_command *args, &block
-      $log.debug "Variable: update command set #{args}"
+      $log.debug "Variable: update command set " # #{args}"
       @update_command << block
       @args << args
     end
@@ -1327,9 +2142,9 @@ module RubyCurses
     # for other widgets, attempt to change focus to that field
     def bind_hotkey
       if !@mnemonic.nil?
-        ch = @mnemonic.downcase()[0]   ## FIXME 1.9
+        ch = @mnemonic.downcase()[0].ord   ## FIXME 1.9 DONE 
         # meta key 
-        mch = ?\M-a + (ch - ?a)
+        mch = ?\M-a.getbyte(0) + (ch - ?a.getbyte(0))  ## FIXME 1.9
         if @label_for.is_a? RubyCurses::Button and @label_for.respond_to? :fire
           @form.bind_key(mch, @label_for) { |_form, _butt| _butt.fire }
         else
@@ -1365,8 +2180,10 @@ module RubyCurses
         str = @justify.to_sym == :right ? "%*s" : "%-*s"  # added 2008-12-22 19:05 
         # loop added for labels that are wrapped.
         # TODO clear separately since value can change in status like labels
+        $log.debug " RWID 1595 #{self.class} value: #{value} form:  #{form} "
+        @graphic = @form.window if @graphic.nil? ## HACK messagebox givig this in repaint, 423 not working ??
         0.upto(_height-1) { |i| 
-          @form.window.printstring r+i, c, " " * len , acolor,@attr
+          @graphic.printstring r+i, c, " " * len , acolor,@attr
         }
         lablist.each_with_index do |_value, ix|
           break if ix >= _height
@@ -1374,12 +2191,12 @@ module RubyCurses
             padding = (@display_length - _value.length)/2
             _value = " "*padding + _value + " "*padding # so its cleared if we change it midway
           end
-          @form.window.printstring r, c, str % [len, _value], acolor,@attr
+          @graphic.printstring r, c, str % [len, _value], acolor,@attr
           r += 1
         end
         if !@mnemonic.nil?
           ulindex = value.index(@mnemonic) || value.index(@mnemonic.swapcase)
-          @form.window.mvchgat(y=firstrow, x=c+ulindex, max=1, Ncurses::A_BOLD|Ncurses::A_UNDERLINE, acolor, nil)
+          @graphic.mvchgat(y=firstrow, x=c+ulindex, max=1, Ncurses::A_BOLD|Ncurses::A_UNDERLINE, acolor, nil)
         end
         #@form.window.mvchgat(y=r, x=c, max=len, Ncurses::A_NORMAL, color, nil)
         @repaint_required = false
@@ -1396,7 +2213,6 @@ module RubyCurses
     def initialize form, config={}, &block
       @focusable = true
       @editable = false
-      #@command_block = nil
       @handler={} # event handler
       @event_args ||= {}
       super
@@ -1404,8 +2220,6 @@ module RubyCurses
       @color ||= $datacolor 
       @surround_chars ||= ['[ ', ' ]'] 
       @col_offset = @surround_chars[0].length 
-      #@text = @name if @text.nil?
-      #bind_hotkey # 2008-12-23 22:41 remarked
     end
     ##
     # set button based on Action
@@ -1433,13 +2247,15 @@ module RubyCurses
     end
     ## 
     # FIXME this will not work in messageboxes since no form available
+    # if already set mnemonic, then unbind_key, ??
+
     def mnemonic char
       $log.error " #{self} COULD NOT SET MNEMONIC since form NIL" if @form.nil?
       return if @form.nil?
       @mnemonic = char
-      ch = char.downcase()[0] ## XXX 1.9 
+      ch = char.downcase()[0].ord ## XXX 1.9 
       # meta key 
-      mch = ?\M-a + (ch - ?a)
+      mch = ?\M-a.getbyte(0) + (ch - ?a.getbyte(0))
       $log.debug " #{self} setting MNEMO to #{char} #{mch}"
       @form.bind_key(mch, self) { |_form, _butt| _butt.fire }
     end
@@ -1460,10 +2276,10 @@ module RubyCurses
       _value = @text || getvalue # hack for Togglebutton FIXME
       #_value = getvalue
       $log.debug " bind hot #{_value} #{@underline}"
-      ch = _value[@underline,1].downcase()[0] ## XXX 1.9 
+      ch = _value[@underline,1].downcase()[0].ord ## XXX 1.9  2009-10-05 18:55  TOTEST
       @mnemonic = _value[@underline,1]
       # meta key 
-      mch = ?\M-a + (ch - ?a)
+      mch = ?\M-a.getbyte(0) + (ch - ?a.getbyte(0))
       @form.bind_key(mch, self) { |_form, _butt| _butt.fire }
     end
     #    2009-01-17 01:48 removed so widgets can be called
@@ -1496,12 +2312,22 @@ module RubyCurses
         value = getvalue_for_paint
         #$log.debug("button repaint :#{self} r:#{r} c:#{c} col:#{color} bg #{bgcolor} v: #{value} ul #{@underline} mnem #{@mnemonic}")
         len = @display_length || value.length
-        @form.window.printstring r, c, "%-*s" % [len, value], color, @attr
+        @graphic = @form.window if @graphic.nil? ## cell editor listbox hack XXX fix in correct place
+        @graphic.printstring r, c, "%-*s" % [len, value], color, @attr
 #       @form.window.mvchgat(y=r, x=c, max=len, Ncurses::A_NORMAL, bgcolor, nil)
         # in toggle buttons the underline can change as the text toggles
         if !@underline.nil? or !@mnemonic.nil?
           uline = @underline && (@underline + @text_offset) ||  value.index(@mnemonic) || value.index(@mnemonic.swapcase)
-          @form.window.mvchgat(y=r, x=c+uline, max=1, Ncurses::A_BOLD|Ncurses::A_UNDERLINE, color, nil)
+          $log.debug " mvchgat UNDERLI r= #{r} - #{@graphic.top} c #{c} c+x #{c+uline}- #{@graphic.left} #{@graphic} "
+          #$log.debug " XXX HACK in next line related to UNDERLINES -graphic.top"
+          y=r #-@graphic.top
+          x=c+uline #-@graphic.left
+          if @graphic.window_type == :PAD
+            x -= @graphic.left
+            y -= @graphic.top
+          end
+          raise "button underline location error #{x} , #{y} " if x < 0 or c < 0
+          @graphic.mvchgat(y, x, max=1, Ncurses::A_BOLD|Ncurses::A_UNDERLINE, color, nil)
         end
     end
     ## command of button (invoked on press, hotkey, space)
@@ -1519,11 +2345,9 @@ module RubyCurses
     def handle_key ch
       case ch
       when KEY_LEFT, KEY_UP
-        $log.debug " from 2009-01-16 18:18 buttons return UNHANDLED on UP DOWN LEFT RIGHT"
         return :UNHANDLED
         #  @form.select_prev_field
       when KEY_RIGHT, KEY_DOWN
-        $log.debug " from 2009-01-16 18:18 buttons return UNHANDLED on UP DOWN LEFT RIGHT"
         return :UNHANDLED
         #  @form.select_next_field
       when KEY_ENTER, 10, 13, 32  # added space bar also