ncumbra 0.1.1 → 0.1.2

data/lib/umbra/listbox.rb

@@ -5,7 +5,7 @@ require 'umbra/multiline'
 #       Author: j kepler  http://github.com/mare-imbrium/umbra
 #         Date: 2018-03-19 
 #      License: MIT
-#  Last update: 2018-05-18 14:16
+#  Last update: 2018-05-30 10:08
 # ----------------------------------------------------------------------------- #
 #  listbox.rb  Copyright (C) 2012-2018 j kepler
 #  == TODO 
@@ -17,13 +17,14 @@ require 'umbra/multiline'
 module Umbra
 
   ## Display a list of items.
-  ## Adds selection capability to the Scrollable widget.
+  ## Adds selection capability to the Multiline widget.
+  ## Adds event :SELECT_ROW which fires on selection and unselection.
   #
   class Listbox < Multiline 
 
     attr_accessor :selection_allowed           # does this class allow row selection (should be class level)
     attr_accessor :selection_key               # key used to select a row
-    attr_accessor :selected_index              # row selected, may change to plural
+    attr_reader   :selected_index              # row selected, may change to plural
     attr_property :selected_color_pair         # row selected color_pair
     attr_property :selected_attr               # row selected color_pair
     attr_accessor :selected_mark               # row selected character
@@ -40,7 +41,8 @@ module Umbra
       @selected_mark      = 'x'                # row selected character
       @unselected_mark    = ' '                # row unselected character (usually blank)
       @current_mark       = '>'                # row current character (default is >)
-      register_events([:LIST_SELECTION_EVENT])
+      #register_events([:LIST_SELECTION_EVENT])
+      register_events([:SELECT_ROW])
       super
     end
 
@@ -64,14 +66,27 @@ module Umbra
     end
 
     ## Toggle current row's selection status.
-    def toggle_selection
+    def toggle_selection _row=@current_index
       @repaint_required = true  
-      if @selected_index == @current_index 
-        @selected_index = nil
+      if @selected_index == _row
+        unselect_row _row
       else
-        @selected_index = @current_index 
+        select_row _row
+      end
+    end
+
+    ## select given row
+    def select_row _row=@current_index
+      @selected_index = _row
+      fire_handler :SELECT_ROW, self   # use selected_index to know which one
+    end
+    
+    ## unselect given row
+    def unselect_row _row=@current_index
+      if _row == @selected_index
+        @selected_index = nil
+        fire_handler :SELECT_ROW, self   # use selected_index to know which one
       end
-      fire_handler :LIST_SELECTION_EVENT, self   # use selected_index to know which one
     end
 
     ## Paint the row.
@@ -142,16 +157,7 @@ module Umbra
     end
 
 
-=begin
-    def cursor_forward
-      blen = current_row().size-1
-      @pcol += 1 if @pcol < blen
-    end
-    def cursor_backward
-      @pcol -= 1 if @pcol > 0
-    end
-=end
-
 
-  end 
+  end  # class
 end # module
+#  vim:  comments=sr\:##,mb\:##,el\:#/,\:## :

data/lib/umbra/menu.rb

@@ -4,7 +4,7 @@
 #       Author: j kepler  http://github.com/mare-imbrium/canis/
 #         Date: 2018-03-13
 #      License: MIT
-#  Last update: 2018-04-16 15:20
+#  Last update: 2018-06-01 12:38
 # ----------------------------------------------------------------------------- #
 #  menu.rb  Copyright (C) 2012-2018 j kepler
 
@@ -13,7 +13,7 @@
 # menu will only accept keys or arrow keys or C-c Esc to cancel
 # returns nil if C-c or Esc pressed.
 # Otherwise returns character pressed.
-# == TODO 
+# == Todo 
 # depends on our window class which is minimal.
 # [ ] cursor should show on the row that is highlighted
 # [ ] Can we remove that dependency so this is independent

data/lib/umbra/messagebox.rb

@@ -4,7 +4,7 @@
 #       Author: j kepler  http://github.com/mare-imbrium/canis/
 #         Date: 2018-04-13 - 23:10
 #      License: MIT
-#  Last update: 2018-05-17 12:33
+#  Last update: 2018-06-01 14:37
 # ----------------------------------------------------------------------------- #
 #  messagebox.rb  Copyright (C) 2012-2018 j kepler
 #  BUGS:
@@ -152,8 +152,8 @@ module Umbra
     def run
       repaint
       @form.pack # needs window
-      @form.select_first_field      ## otherwise on_enter of first won't fire
       @form.repaint
+      @form.select_first_field      ## otherwise on_enter of first won't fire
       @window.wrefresh
       return handle_keys
     end

data/lib/umbra/multiline.rb

@@ -6,18 +6,26 @@ require 'umbra/widget'
 #       Author: j kepler  http://github.com/mare-imbrium/canis/
 #         Date: 2018-05-08 - 11:54
 #      License: MIT
-#  Last update: 2018-05-22 12:27
+#  Last update: 2018-06-01 14:36
 # ----------------------------------------------------------------------------- #
 #  multiline.rb Copyright (C) 2012-2018 j kepler
 #
 ##  TODO search through text and put cursor on next result.
+##  TODO allow setting of current_index programmatically
+##  TODO is a row visible. visible? row. and make a row visible. programmatically
+##  TODO insert delete a row (if editable)
 #/
 
 
 module Umbra
+
+  ## Base class for widgets that have multiple lines and are scrollable.
+  ## Preferably, use a concrete class such as Listbox, Table or Textbox.
+  ## This is not editable by default. To delete or insert rows, set editable to true.
   class Multiline < Widget 
 
     attr_reader   :list                        # array containing data (usually Strings)
+    attr_reader   :panned_cols                 ## How may columns has widget panned to right
 
     # index of focussed row, starting 0, index into the list supplied
     attr_reader   :current_index
@@ -27,7 +35,6 @@ module Umbra
       @editable           = false
       @pstart             = 0                  # which row does printing start from
       @current_index      = 0                  # index of row on which cursor is
-      #register_events([:LEAVE_ROW, :ENTER_ROW, :LIST_SELECTION_EVENT])
 
       ## PRESS event relates to pressing RETURN/ENTER (10)
       register_events([:LEAVE_ROW, :ENTER_ROW, :PRESS])
@@ -36,8 +43,9 @@ module Umbra
 
       map_keys
       @row_offset         = 0
-      @pcol               = 0
-      @curpos             = 0  
+      @panned_cols               = 0     ## how many columns the view has panned.
+                                  ## The name means panned_cols
+      @curpos             = 0     ## Widget defines an accessor on this.
       @repaint_required   = true
     end
 
@@ -53,7 +61,7 @@ module Umbra
       @list               = alist
       @repaint_required   = true
       @pstart = @current_index = 0
-      @pcol               = 0
+      @panned_cols               = 0
       $log.debug "  before multiline list= CHANGED "
       fire_handler(:CHANGED, self)    ## added 2018-05-08 - 
     end
@@ -88,6 +96,7 @@ module Umbra
       return unless @repaint_required
       return unless @list
       win                 = @graphic
+      raise "window nil in multiline" unless win
       r,c                 = self.row, self.col 
       _attr               = @attr || NORMAL
       _color              = @color_pair || CP_WHITE
@@ -230,15 +239,15 @@ module Umbra
       _width = self.width
       if ff
         if ff.size > _width
-          # pcol can be greater than width then we get null
-          if @pcol < ff.size
-            ff = ff[@pcol..@pcol+_width-1] 
+          # panned_cols can be greater than width then we get null
+          if @panned_cols < ff.size
+            ff = ff[@panned_cols..@panned_cols+_width-1] 
           else
             ff = ""
           end
         else
-          if @pcol < ff.size
-            ff = ff[@pcol..-1]
+          if @panned_cols < ff.size
+            ff = ff[@panned_cols..-1]
           else
             ff = ""
           end
@@ -276,7 +285,8 @@ module Umbra
       super
       on_enter_row @current_index
       # basically I need to only highlight the current index, not repaint all OPTIMIZE 
-      touch ; repaint
+      #touch ; repaint ## 2018 why was i calling repaint here ??? causing error in messagebox since window nil
+      touch 
     end
 
     # on leave of this multiline
@@ -284,7 +294,8 @@ module Umbra
       super
       on_leave_row @current_index
       # basically I need to only unhighlight the current index, not repaint all OPTIMIZE 
-      touch ; repaint
+      #touch ; repaint
+      touch ##; repaint  ## why repaint here ?? when was this necessary ?
     end
 
     ## called when user leaves a row and when object is exited.
@@ -297,13 +308,15 @@ module Umbra
       fire_handler(:ENTER_ROW, [@current_index])     # 2018-03-26 - improve this
       # if cursor ahead of blen then fix it
       blen = current_row().size-1
+      ## why -1 on above line. Empty lines will give -1
+      blen = 0 if blen < 0
       if @curpos > blen
-        @col_offset = blen - @pcol 
+        @col_offset = blen - @panned_cols 
         @curpos = blen
-        if @pcol > blen
-          @pcol = blen - self.width  ## @int_width 2018-05-22 - 
-          @pcol = 0 if @pcol < 0
-          @col_offset = blen - @pcol 
+        if @panned_cols > blen
+          @panned_cols = blen - self.width  ## @int_width 2018-05-22 - 
+          @panned_cols = 0 if @panned_cols < 0
+          @col_offset = blen - @panned_cols 
         end
       end
       @col_offset = 0 if @col_offset < 0
@@ -318,7 +331,7 @@ module Umbra
     # position cursor at start of field
     def cursor_home
       @curpos  = 0 
-      @pcol    = 0
+      @panned_cols    = 0
       set_col_offset 0
     end
     # goto end of line. 
@@ -327,13 +340,13 @@ module Umbra
       blen = current_row().length
       if blen < self.width
         set_col_offset blen # just after the last character
-        @pcol = 0
+        @panned_cols = 0
       else
-        @pcol = blen-self.width #+2  # 2 is due to mark and space XXX could be a problem with textbox
+        @panned_cols = blen-self.width #+2  # 2 is due to mark and space XXX could be a problem with textbox
         set_col_offset blen # just after the last character
       end
       @curpos = blen # this is position in array where editing or motion is to happen regardless of what you see
-      # regardless of pcol (panning)
+      # regardless of panned_cols (panning)
     end
     # returns current row as String
     # 2018-04-11 - NOTE this may not be a String so we convert it to string before returning
@@ -347,8 +360,8 @@ module Umbra
       blen = current_row().size # -1
       if @curpos < blen
         if add_col_offset(1)==-1  # go forward if you can, else scroll
-          #@pcol += 1 if @pcol < self.width 
-          @pcol += 1 if @pcol < blen
+          #@panned_cols += 1 if @panned_cols < self.width 
+          @panned_cols += 1 if @panned_cols < blen
         end
         @curpos += 1
       end
@@ -360,8 +373,8 @@ module Umbra
         add_col_offset -1
       else
         # cur is on the first col, then scroll left
-        if @pcol > 0
-          @pcol -= 1
+        if @panned_cols > 0
+          @panned_cols -= 1
           @curpos -= 1
         else
           # do nothing
@@ -379,7 +392,7 @@ module Umbra
       @col_offset += num 
     end
     # sets the visual cursor on the window at correct place
-    # NOTE be careful of curpos - pcol being less than 0
+    # NOTE be careful of curpos - panned_cols being less than 0
     # @param [Integer] position in data on the line
     private def set_col_offset x=@curpos
       @curpos = x || 0 # NOTE we set the index of cursor here - WHY TWO THINGS ??? XXX
@@ -397,21 +410,21 @@ module Umbra
     end
     def scroll_right ## cursor_forward
       blen = current_row().size-1
-      @pcol += 1 if @pcol < blen
+      @panned_cols += 1 if @panned_cols < blen
     end
     def scroll_left  ##cursor_backward
-      @pcol -= 1 if @pcol > 0
+      @panned_cols -= 1 if @panned_cols > 0
     end
     # go to start of file (first line)
     def goto_start
       @current_index = 0
-      @pcol = @curpos = 0
+      @panned_cols = @curpos = 0
       set_col_offset 0
     end
     # go to end of file (last line)
     def goto_end
       @current_index = @list.size-1
-      @pcol = @curpos = 0
+      @panned_cols = @curpos = 0
     end
     def scroll_down
       @current_index += @scroll_lines
@@ -433,7 +446,7 @@ module Umbra
     ## @param [Integer] ch: key caught by getch of window
     def handle_key ch
       old_current_index = @current_index
-      old_pcol = @pcol
+      old_panned_cols = @panned_cols
       old_col_offset = @col_offset
 
       ret = super
@@ -449,7 +462,7 @@ module Umbra
         on_enter_row @current_index
         @repaint_required = true  
       end
-      @repaint_required = true if old_pcol != @pcol or old_col_offset != @col_offset
+      @repaint_required = true if old_panned_cols != @panned_cols or old_col_offset != @col_offset
     end
 
     ## convenience method for calling most used event of a widget
@@ -471,6 +484,56 @@ module Umbra
       #fire_handler :PRESS, aev
       fire_handler :PRESS, self
     end
+
+
+##### TO TEST THE REST ############ 
+
+    ## Is the given row visible
+    ## UNTESTED
+    def is_visible? _row
+      j = _row - @pstart
+      j >= 0 && j <= (self.height - 1)
+    end
+
+    # Ensure current row is visible, if not make it first row
+    # NOTE - need to check if its at end and then reduce scroll at rows, check_prow does that
+    # 
+    # @param current_index (default if not given)
+    #
+    ## UNTESTED
+    def ensure_visible _row = @current_index
+      unless is_visible? _row
+        @pstart = _row
+      end
+    end
+
+    ## NOTE what about firing handlers when moving rows, i suppose that these will be called from a binding.
+    ## UNTESTED
+    def goto_line line
+      return if line < 0 or line >= self.row_count
+      @current_index = line
+      ensure_visible line
+    end
+
+    ## UNTESTED
+    def delete_at index
+      return unless @list
+      return unless @editable
+      @repaint_all = true
+      @list.delete_at index
+    end
+
+    ## UNTESTED
+    def insert index, line
+      return unless @list
+      return unless @editable
+      @repaint_all = true
+      @list.insert index, line
+    end
+
+    ## delegate << []= etc but we need to fire CHANGED 
+
   end  # class
 end    # module
 
+#  vim:  comments=sr\:##,mb\:##,el\:#/,\:## :

data/lib/umbra/pad.rb

@@ -7,10 +7,10 @@
   * Author:  jkepler
   * Date:    2018-03-28 14:30
   * License: MIT
-  * Last update:  2018-04-26 08:29
+  * Last update:  2018-06-01 12:40
 
   == CHANGES
-  == TODO 
+  == Todo 
   - should have option to wrap text
   - / search ?
   NOTE:
@@ -35,7 +35,7 @@ class Pad
     @config = config
     @rows = FFI::NCurses.LINES-1
     @cols = FFI::NCurses.COLS-1
-    @prow = @pcol = 0                        # show many cols we are panning
+    @prow = @pcol = 0                        # how many cols we are panning
     @startrow = 0
     @startcol = 0
     
@@ -76,6 +76,8 @@ class Pad
       self.list=(config[:list])
     end
   end
+
+
   # minimum window creator method, not using a class.
   # However, some methods do require windows width and ht etc
   def create_window h, w, t, l

data/lib/umbra/radiobutton.rb

@@ -4,7 +4,7 @@
 #       Author: j kepler  http://github.com/mare-imbrium/canis/
 #         Date: 2018-04-02 - 10:37
 #      License: MIT
-#  Last update: 2018-05-14 14:31
+#  Last update: 2018-06-01 12:31
 # ----------------------------------------------------------------------------- #
 #  radiobutton.rb  Copyright (C) 2012-2018 j kepler
 
@@ -27,7 +27,7 @@ module Umbra
     def initialize config={}, &block
       @surround_chars = ['(', ')'] if @surround_chars.nil?
       super
-      $log.warn "XXX: FIXME Please set 'value' for radiobutton. If not sure, try setting it to the same value as 'text'" unless @value
+      $log.warn "XXX: FIXMe Please set 'value' for radiobutton. If not sure, try setting it to the same value as 'text'" unless @value
       @value ||= @text
     end