ncumbra 0.1.1 → 0.1.2

data/lib/umbra/tabular.rb

@@ -10,7 +10,7 @@
   *               :
   * Author        : jkepler
   * Date          : 
-  * Last Update   : 2018-05-20 14:24
+  * Last Update   : 2018-05-31 16:16
   * License       : MIT
 =end
 
@@ -241,7 +241,7 @@ module Umbra
       buffer << str
       #puts "-" * str.length
       buffer << separator if @use_separator
-      if @list    ## XXX why wasn't this done in _prepare_format ???? FIXME
+      if @list    ## XXX why wasn't numbering done in _prepare_format ???? FIXME
         if @numbering
           fmstr = "%#{rows}d "+ @y + fmstr
         end
@@ -268,6 +268,9 @@ module Umbra
     end
 
     ## render_row
+    ## @param [Array] row as Array
+    ## @param [String] format string
+    ## @param [Integer] row offset in data
     def convert_value_to_text r, fmstr, index
       return fmstr % r;  
     end

data/lib/umbra/textbox.rb

@@ -4,38 +4,34 @@
 #       Author: j kepler  http://github.com/mare-imbrium/canis/
 #         Date: 2018-03-24 - 12:39
 #      License: MIT
-#  Last update: 2018-05-10 11:06
+#  Last update: 2018-05-30 12:47
 # ----------------------------------------------------------------------------- #
 #  textbox.rb  Copyright (C) 2012-2018 j kepler
-##  TODO -----------------------------------
-#  improve the object sent when row change or cursor movement 
-## 2018-05-08 - extend Multiline
+##  Todo -----------------------------------
+## TODO w and b for next and previous word movement
 #
 #  ----------------------------------------
 ## CHANGELOG
-#
+# 2018-05-30 - giving self during cursor movement
 #  ----------------------------------------
 require 'umbra/multiline'
 module Umbra
 class Textbox < Multiline 
   attr_accessor :file_name            # filename passed in for reading
   #attr_accessor :cursor              # position of cursor in line ??
-=begin
-  attr_accessor :selected_mark               # row selected character
-  attr_accessor :unselected_mark             # row unselected character (usually blank)
-  attr_accessor :current_mark                # row current character (default is >)
-=end
 
   def initialize config={}, &block
     @highlight_attr     = FFI::NCurses::A_BOLD
     @row_offset         = 0
     @col_offset         = 0
     @curpos             = 0                  # current cursor position in buffer (NOT screen/window/field)
-    #register_events([:ENTER_ROW, :LEAVE_ROW, :CURSOR_MOVE]) # 
-    register_events([:CURSOR_MOVE]) # 
+
+    register_events([:CURSOR_MOVE]) # movement of cursor left or right, up down or panning.
     super
 
   end
+
+
   # set list of data to be displayed from filename.  {{{
   # NOTE this can be called again and again, so we need to take care of change in size of data
   # as well as things like current_index and selected_index or indices.
@@ -81,150 +77,15 @@ class Textbox < Multiline
       return ret
     ensure
       if @repaint_required
-        fire_handler(:CURSOR_MOVE, [@col_offset, @current_index, @curpos, @pcol, ch ])     # 2018-03-25 - improve this
-      end
-    end
-  end
-  def OLDhandle_key ch # {{{
-    return :UNHANDLED unless @list
-    #   save old positions so we know movement has happened
-    old_current_index = @current_index
-    old_pcol = @pcol
-    old_col_offset = @col_offset
-
-    begin
-        ret = super
-        return ret
-    ensure
-      @current_index = 0 if @current_index < 0
-      @current_index = @list.size-1 if @current_index >= @list.size
-      @repaint_required = true  if @current_index != old_current_index
-      if @current_index != old_current_index or @pcol != old_pcol or @col_offset != old_col_offset
-        if @current_index != old_current_index 
-          on_leave_row old_current_index
-          on_enter_row @current_index
-        end
-        @repaint_required = true 
-        fire_handler(:CURSOR_MOVE, [@col_offset, @current_index, @curpos, @pcol, ch ])     # 2018-03-25 - improve this
-      end
-    end
-  end # }}}
-  # advance col_offset (where cursor will be displayed on screen) {{{
-  # @param [Integer] advance by n (can be negative or positive)
-  # @return -1 if cannot advance
-  private def OLDadd_col_offset num
-    x = @col_offset + num
-    return -1 if x < 0
-    return -1 if x > @int_width 
-    # is it a problem that i am directly changing col_offset ??? XXX
-    @col_offset += num 
-  end
-
-  # move cursor forward one character, called with KEY_RIGHT action.
-  def OLDcursor_forward
-    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 < @width 
-        @pcol += 1 if @pcol < blen
-      end
-      @curpos += 1
-    end
-  end
-  def OLDcursor_backward
-
-    if @col_offset > 0
-      @curpos -= 1
-      add_col_offset -1
-    else
-      # cur is on the first col, then scroll left
-      if @pcol > 0
-        @pcol -= 1
-        @curpos -= 1
-      else
-        # do nothing
+        ## this could get fired even if color changed or something not related to cursor moving. FIXME
+        ## Should this fire if users scrolls but does not change cursor position
+        #fire_handler(:CURSOR_MOVE, [@col_offset, @current_index, @curpos, @panned_cols, ch ])     # 2018-03-25 - improve this
+        fire_handler(:CURSOR_MOVE, self)          ## 2018-05-30 - made this like most others yielding self
       end
     end
   end
-  # position cursor at start of field
-  def OLDcursor_home
-    @curpos = 0
-    @pcol = 0
-    set_col_offset 0
-  end
-  # goto end of line. 
-  # This should be consistent with moving the cursor to the end of the row with right arrow
-  def OLDcursor_end
-    blen = current_row().length
-    if blen < @int_width
-      set_col_offset blen # just after the last character
-      @pcol = 0
-    else
-      @pcol = blen-@int_width
-      set_col_offset blen
-    end
-    @curpos = blen # this is position in array where editing or motion is to happen regardless of what you see
-    # regardless of pcol (panning)
-  end
-  # go to start of file (first line)
-  def OLDgoto_start
-    @current_index = 0
-    @pcol = @curpos = 0
-    set_col_offset 0
-  end
-  # go to end of file (last line)
-  def OLDgoto_end
-    @current_index = @list.size-1
-  end
-  # sets the visual cursor on the window at correct place
-  # NOTE be careful of curpos - pcol being less than 0
-  # @param [Integer] position in data on the line
-  private def OLD_set_col_offset x=@curpos
-    @curpos = x || 0 # NOTE we set the index of cursor here - WHY TWO THINGS ??? XXX
-    #return -1 if x < 0
-    #return -1 if x > @width
-    if x >= @int_width
-      x = @int_width
-      @col_offset = @int_width 
-      return
-    end
-    @col_offset = x 
-    @col_offset = @int_width if @col_offset > @int_width
-    return
-  end
-  # called whenever a row entered.
-  # Call when object entered, also. 
-  def OLD_on_enter_row index
-    #fire_handler(:ENTER_ROW, [old_current_index, @current_index, ch ])     # 2018-03-26 - improve this
-    fire_handler(:ENTER_ROW, [@current_index])     # 2018-03-26 - improve this
-    # if cursor ahead of blen then fix it
-    blen = current_row().size-1
-    if @curpos > blen
-      @col_offset = blen - @pcol 
-      @curpos = blen
-      if @pcol > blen
-        @pcol = blen - @int_width
-        @pcol = 0 if @pcol < 0
-        @col_offset = blen - @pcol 
-      end
-    end
-    @col_offset = 0 if @col_offset < 0
-  end # }}}
-  ## border {{{
-  private def print_border row, col, height, width, color, att=FFI::NCurses::A_NORMAL
-    raise
-    pointer = @graphic.pointer
-    FFI::NCurses.wattron(pointer, FFI::NCurses.COLOR_PAIR(color) | att)
-    FFI::NCurses.mvwaddch pointer, row, col, FFI::NCurses::ACS_ULCORNER
-    FFI::NCurses.mvwhline( pointer, row, col+1, FFI::NCurses::ACS_HLINE, width-2)
-    FFI::NCurses.mvwaddch pointer, row, col+width-1, FFI::NCurses::ACS_URCORNER
-    FFI::NCurses.mvwvline( pointer, row+1, col, FFI::NCurses::ACS_VLINE, height-2)
 
-    FFI::NCurses.mvwaddch pointer, row+height-1, col, FFI::NCurses::ACS_LLCORNER
-    FFI::NCurses.mvwhline(pointer, row+height-1, col+1, FFI::NCurses::ACS_HLINE, width-2)
-    FFI::NCurses.mvwaddch pointer, row+height-1, col+width-1, FFI::NCurses::ACS_LRCORNER
-    FFI::NCurses.mvwvline( pointer, row+1, col+width-1, FFI::NCurses::ACS_VLINE, height-2)
-    FFI::NCurses.wattroff(pointer, FFI::NCurses.COLOR_PAIR(color) | att)
-  end # }}}
 end 
 end # module
+
+#  vim:  comments=sr\:##,mb\:##,el\:#/,\:## :

data/lib/umbra/togglebutton.rb

@@ -6,133 +6,96 @@ require 'umbra/button'
 #       Author: j kepler  http://github.com/mare-imbrium/umbra/
 #         Date: 2018-03-17 - 22:50
 #      License: MIT
-#  Last update: 2018-05-14 14:35
+#  Last update: 2018-05-27 14:21
 # ----------------------------------------------------------------------------- #
-#  togglebutton.rb Copyright (C) 2012-2018 j kepler
+#  togglebutton.rb Copyright (C) 2018 j kepler
 #
 #
 module Umbra
-  ##
-  # an event fired when an item that can be selected is toggled/selected
-  class ItemEvent  # {{{
-    # http://java.sun.com/javase/6/docs/api/java/awt/event/ItemEvent.html
-    attr_reader :state   # :SELECTED :DESELECTED
-    attr_reader :item   # the item pressed such as toggle button
-    attr_reader :item_selectable   # item originating event such as list or collection
-    attr_reader :item_first   # if from a list
-    attr_reader :item_last   # 
-    attr_reader :param_string   #  for debugging etc
-=begin
-    def initialize item, item_selectable, state, item_first=-1, item_last=-1, paramstring=nil
-      @item, @item_selectable, @state, @item_first, @item_last =
-        item, item_selectable, state, item_first, item_last 
-      @param_string = "Item event fired: #{item}, #{state}"
-    end
-=end
-    # i think only one is needed per object, so create once only
-    def initialize item, item_selectable
-      @item, @item_selectable =
-        item, item_selectable
-    end
-    def set state, item_first=-1, item_last=-1, param_string=nil
-      @state, @item_first, @item_last, @param_string =
-        state, item_first, item_last, param_string 
-      @param_string = "Item event fired: #{item}, #{state}" if param_string.nil?
-    end
-  end # }}}
-# A button that may be switched off an on. 
-# Extended by RadioButton and checkbox.
-# WARNING, pls do not override +text+ otherwise checkboxes etc will stop functioning.
-# TODO: add editable here nd prevent toggling if not so.
-class ToggleButton < Button 
-  # text for on value and off value
-  attr_accessor :onvalue, :offvalue
-  # boolean, which value to use currently, onvalue or offvalue
-  attr_accessor :value
-  # characters to use for surround, array, default square brackets
-  attr_property :surround_chars 
-  # 2018-04-02 - removing variable
-  #attr_accessor :variable    # value linked to this variable which is a boolean
-  # background to use when selected, if not set then default
-  # 2018-04-02 - unused so commenting off. color_pair is not used here or in checkbox
-  attr_property :selected_color_pair
 
-  def initialize config={}, &block
-    super
+  # A button that may be switched off an on. 
+  # Extended by RadioButton and checkbox.
+  # WARNING, pls do not override +text+ otherwise checkboxes etc will stop functioning.
+  # TODO: add editable here and prevent toggling if not so.
+  class ToggleButton < Button 
+    # text to display for on value and off value
+    attr_accessor :onvalue, :offvalue
+    # boolean, which value to use currently, onvalue or offvalue
+    attr_property :value
+    # characters to use for surround, array, default square brackets
+    #attr_property :surround_chars  already in button
+    # 2018-04-02 - removing variable
+    # background to use when selected, if not set then default
+    # 2018-04-02 - unused so commenting off. color_pair is not used here or in checkbox
+    #attr_property :selected_color_pair
 
-    #@value ||= (@variable.nil? ? false : @variable.get_value(@name)==true)
-    # TODO may need to do this when this is added to button_group 
-  end
-  def getvalue
-    @value ? @onvalue : @offvalue
-  end
+    def initialize config={}, &block
+      super
 
-  # WARNING, pls do not override +text+ otherwise checkboxes etc will stop functioning.
+    end
+    def getvalue
+      @value ? @onvalue : @offvalue
+    end
+
+    # WARNING, pls do not override +text+ otherwise checkboxes etc will stop functioning.
 
-  # added for some standardization 2010-09-07 20:28 
-  # alias :text :getvalue # NEXT VERSION
-  # change existing text to label
-  ##
-  # is the button on or off
-  # added 2008-12-09 19:05 
-  def checked?
-    @value
-  end
-  alias :selected? :checked?
+    # added for some standardization 2010-09-07 20:28 
+    # alias :text :getvalue # NEXT VERSION
+    # change existing text to label
+    ##
+    # is the button on or off
+    # added 2008-12-09 19:05 
+    def checked?
+      @value
+    end
+    alias :selected? :checked?
 
-  def getvalue_for_paint
-    # when the width is set externally then the surround chars sit outside the width
-    #unless @width
+    def getvalue_for_paint
+      # when the width is set externally then the surround chars sit outside the width
+      #unless @width
       if @onvalue && @offvalue
         @width = [ @onvalue.length, @offvalue.length ].max 
       end
-    #end
-    buttontext = getvalue().center(@width)
-    @text_offset = @surround_chars[0].length
-    @surround_chars[0] + buttontext + @surround_chars[1]
-  end
-
-  # toggle button handle key
-  # @param [int] key received
-  #
-  def handle_key ch
-    if ch == 32
-      toggle
-      @repaint_required = true # need to change the label
-    else
-      super
+      #end
+      buttontext = getvalue().center(@width)
+      @text_offset = @surround_chars[0].length
+      @surround_chars[0] + buttontext + @surround_chars[1]
     end
-  end
 
-  ##
-  # toggle the button value
-  def toggle
-    fire
-  end
-
-  # called on :PRESS event
-  # caller should check state of itemevent passed to block
-  # NOTE i have not brought ItemEvent in here.
-  def fire
-    checked(!@value)
-    @item_event = ItemEvent.new self, self if @item_event.nil?
-    @item_event.set(@value ? :SELECTED : :DESELECTED)
-    fire_handler :PRESS, @item_event # should the event itself be ITEM_EVENT
-  end
-  ##
-  # set the value to true or false
-  # user may programmatically want to check or uncheck
-  def checked tf
-    @value = tf
-=begin
-    if @variable
-      if @value 
-        @variable.set_value((@onvalue || 1), @name)
+    # toggle button handle key
+    # @param [int] key received
+    #
+    def handle_key ch
+      if ch == 32
+        toggle
+        @repaint_required = true # need to change the label
       else
-        @variable.set_value((@offvalue || 0), @name)
+        super
       end
     end
-=end
-  end
-end # class 
+
+    ##
+    # toggle the button value
+    def toggle
+      fire
+    end
+
+    # called on :PRESS event
+    def fire
+      checked(!@value)
+      #@item_event = ItemEvent.new self, self if @item_event.nil?
+      #@item_event.set(@value ? :SELECTED : :DESELECTED)
+      #fire_handler :PRESS, @item_event # should the event itself be ITEM_EVENT
+      ## 2018-05-27 - trying to use self in most cases. Above was not needed.
+      fire_handler :PRESS, self
+    end
+    ##
+    # set the value to true or false
+    # user may programmatically want to check or uncheck
+    # ## duplicate of value ??? 2018-05-26 - 
+    def checked tf
+      @value = tf
+      @repaint_required = true
+    end
+  end # class 
 end # module

data/lib/umbra/version.rb

@@ -1,3 +1,3 @@
 module Umbra
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/umbra/widget.rb

@@ -44,7 +44,7 @@ class Widget
     include KeyMappingHandler
   # common interface for text related to a field, label, textview, button etc
   attr_property :text
-  attr_property   :width, :height   ## FIXME this won't trigger repaint or property !!!
+  attr_property   :width, :height   ## width and height of widget
 
   # foreground and background colors when focussed. Currently used with buttons and field
   # Form checks and repaints on entry if these are set.
@@ -54,13 +54,12 @@ class Widget
   # NOTE: 2018-03-04 - user will have to call repaint_required if he changes color or coordinates.
   attr_accessor  :col                   # location of object
   attr_writer    :row                   # location of object
-  #attr_writer :color, :bgcolor               # normal foreground and background 2018-03-08 - now color_pair
   # moved to a method which calculates color 2011-11-12 
   attr_property  :color_pair                  # instead of colors give just color_pair
   attr_property  :attr                        # attribute bold, normal, reverse
   attr_accessor  :name                        # name to refr to or recall object by_name
   attr_accessor :curpos                       # cursor position inside object - column, not row.
-  attr_reader  :config                        # can be used for popping user objects too. NOTE unused
+  #attr_reader  :config                        # can be used for popping user objects too. NOTE unused
   #attr_accessor  :form                       # made accessor 2008-11-27 22:32 so menu can set
   attr_accessor  :graphic                     # window which should be set by form when adding 2018-03-19
   attr_accessor :state                        # normal, selected, highlighted
@@ -76,8 +75,8 @@ class Widget
 
   #attr_accessor :parent_component  # added 2010-01-12 23:28 BUFFERED - to bubble up
 
-  # NOTE state takes care of this and is set by form. boolean
-  attr_reader :focussed                    # is this widget in focus, so they may paint differently
+  # NOTE state takes care of this and is set by form. boolean 2018-05-26 - commented since unused
+  #attr_reader :focussed                    # is this widget in focus, so they may paint differently
 
   # height percent and width percent used in stacks and flows.
   #attr_accessor :height_pc, :width_pc        # may bring this back
@@ -99,9 +98,8 @@ class Widget
     # These are standard events for most widgets which will be fired by 
     # Form. In the case of CHANGED, form fires if it's editable property is set, so
     # it does not apply to all widgets.
-    # 2018-03-18 - proporty change is deprecated since we don't use dsl_property any longer
     register_events( [:ENTER, :LEAVE, :CHANGED, :PROPERTY_CHANGE])
-    @repaint_required = true # added 2018-03-20 - so all widgets get it
+    @repaint_required = true
 
     aconfig.each_pair { |k,v| variable_set(k,v) }
     #instance_eval &block if block_given?
@@ -129,25 +127,21 @@ class Widget
   def modified?
     @modified
   end
-  #def set_modified tf=true
-    #@modified = tf
-  #end
-  #alias :modified :set_modified
 
   # triggered whenever a widget is entered.
   # NOTE should we not fix cursor at this point (on_enter) ?
   def on_enter
+    ## Form has already set this, and set modified to false
     @state = :HIGHLIGHTED    # duplicating since often these are inside containers
-    @focussed = true
+    #@focussed = true
     if @handler && @handler.has_key?(:ENTER)
       fire_handler :ENTER, self
     end
   end
   ## Called when user exits a widget
-  # 2018-03-04 - Are we keeping this at all, can we avoid NOT_SURE
   def on_leave
     @state = :NORMAL    # duplicating since often these are inside containers
-    @focussed = false
+    #@focussed = false
     if @handler && @handler.has_key?(:LEAVE)
       fire_handler :LEAVE, self
     end
@@ -268,6 +262,7 @@ class Widget
     @height
   end
   def row
+    return nil unless @row
     if @row < 0
       return FFI::NCurses.LINES + @row
     end