rbcurse-extras 0.0.0

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

@@ -0,0 +1,40 @@
+# Provides extended abilities to a table
+# so user does not need to code it into his app.
+# At the same time, i don't want to weigh down Table with too much functionality/
+# I am putting in some stuff, so that table columns can be resized, using multipliers.
+# That allows us to redistribute the space taken or released across rows.
+# Other options: dd, C, . (repeat) and how about range operations
+#
+module TableExtended
+
+  ##
+  # increase the focused column
+  # If no size passed, then use numeric multiplier, else 1
+  # Typically, one would bind a key such as + to this method
+  # e.g. atable.bind_key(?+) { atable.increase_column ; }
+  # See examples/viewtodo.rb for usage
+  def increase_column num=(($multiplier.nil? or $multiplier == 0) ? 1 : $multiplier)
+
+    acolumn = column focussed_col()
+    #num = $multiplier || 1
+    $multiplier = 0
+    w = acolumn.width + num
+    acolumn.width w
+    #atable.table_structure_changed
+  end
+  # decrease the focused column
+  # If no size passed, then use numeric multiplier, else 1
+  # Typically, one would bind a key such as - to this method
+  def decrease_column num=(($multiplier.nil? or $multiplier == 0) ? 1 : $multiplier)
+    acolumn = column focussed_col()
+    w = acolumn.width - num
+    $multiplier = 0
+    if w > 3
+      acolumn.width w
+      #atable.table_structure_changed
+    end
+  end
+
+
+
+end

data/lib/rbcurse/extras/widgets/horizlist.rb

@@ -0,0 +1,203 @@
+require 'rbcurse'
+
+# This is a horizontal scroller, to scroll a list of options much like
+# vim often does on the statusline. I'd like to use it for scrolling
+# menus or buttons like on TabbedPanes to avoid another Form.
+
+# You may bind to the ENTER_ROW event to chagne some data elsewhere,
+# or the PRESS event. In this case, PRESS will refer to pressing the
+# space bar or ENTER. There is <em>no</em> LIST_SELECTION event for that.
+
+
+
+module RubyCurses
+
+  # Horizontal list scrolling and selection.
+  #
+  #    == Example
+  #    require 'rbcurse/extras/widgets/horizlist'
+  #    require 'fileutils'
+  #    l = HorizList.new @form, :row => 5, :col => 5, :width => 80 
+  #    list = Dir.glob("*")
+  #    l.list(list)
+
+  class HorizList < Widget
+
+    def initialize form, config={}, &block
+      super
+      @_events.push(*[:ENTER_ROW, :LEAVE_ROW, :PRESS])
+      @focusable = true
+      init_vars
+      @list = []
+      @toprow = 0
+
+      # last printed index
+      @last_index = 0
+
+      # item on which cursor is
+      @current_index = 0
+    end
+    def init_vars
+    end
+    # alias :text :getvalue # NEXT VERSION
+
+    def map_keys
+      @keys_mapped = true
+      bind_keys([KEY_RIGHT, ?l, ?.], :next_item)
+      bind_keys([KEY_LEFT, ?h,?,], :previous_item)
+      bind_keys([10,13,32]){ fire_action_event }
+      bind_keys([?\M-l,?>, KEY_DOWN], :scroll_right)
+      bind_keys([?\M-h,?<, KEY_UP], :scroll_left)
+    end
+    def list(strings)
+      @list = strings
+    end
+    def add item
+      @list << item
+    end
+    def repaint
+      return unless @repaint_required
+      @window ||= @form.window
+      $log.debug "XXX:HORIZ REPAINT Ci #{@current_index}, TR #{@toprow} "
+      $status_message.value = " #{@current_index}, TR #{@toprow} "
+      @window.printstring @row, @col, " "* @width, @color_pair || $reversecolor
+      c = @col + 1
+      t = @toprow
+      @list.each_with_index { |e, i| 
+        next if i < t # sucks for large lists
+        break if c + e.length >= @width + @col
+        att = @attrib || FFI::NCurses::A_NORMAL
+        if i == @current_index
+          att = FFI::NCurses::A_REVERSE if i == @current_index
+          acolor = @focussed_color_pair ||  get_color($datacolor,'green', 'white') 
+        else
+          acolor = @color_pair
+        end
+        @window.printstring @row, c, e, acolor  || $reversecolor, att
+        c += e.length + 2
+        @last_index = i
+        break if c >= @width + @col
+      }
+      @repaint_required = false
+    end
+    def handle_key ch
+      map_keys unless @keys_mapped
+      ret = process_key ch, self
+      @multiplier = 0
+      return :UNHANDLED if ret == :UNHANDLED
+    end
+    def previous_item num=(($multiplier.nil? or $multiplier == 0) ? 1 : $multiplier)
+    
+      return :NO_PREVIOUS_ROW if @current_index == 0 
+      @old_toprow = @toprow
+      @oldrow = @current_index
+      @current_index -= num
+      @current_index = 0 if @current_index < 0
+      bounds_check
+      $multiplier = 0
+      if @current_index < @toprow
+        @toprow = @current_index
+      end
+      @toprow = 0 if @toprow < 0
+      @repaint_required = true
+    end
+    def next_item num=(($multiplier.nil? or $multiplier == 0) ? 1 : $multiplier)
+      rc = row_count
+      return :NO_NEXT_ROW if @current_index == rc-1  # changed 2011-10-5 so process can do something
+      @old_toprow = @toprow
+      @oldrow = @current_index
+      @current_index += num 
+      @current_index = rc - 1 if @current_index >= rc
+      @toprow = @current_index if @current_index > @last_index
+      bounds_check
+      $multiplier = 0
+      @repaint_required = true
+    end
+    def scroll_right
+      rc = row_count
+      return :NO_NEXT_ROW if @current_index == rc-1  # changed 2011-10-5 so process can do something
+      @old_toprow = @toprow
+      @oldrow = @current_index
+
+      @current_index = @last_index + 1
+
+      @current_index = rc - 1 if @current_index >= rc
+      @toprow = @current_index if @current_index > @last_index
+      bounds_check
+      $multiplier = 0
+      @repaint_required = true
+    end
+    def scroll_left
+      return :NO_PREVIOUS_ROW if @current_index == 0 
+      @old_toprow = @toprow
+      @oldrow = @current_index
+      @current_index = @toprow - 4
+      @current_index = 0 if @current_index < 0
+      bounds_check
+      $multiplier = 0
+      if @current_index < @toprow
+        @toprow = @current_index
+      end
+      @toprow = 0 if @toprow < 0
+      @repaint_required = true
+    end
+    def row_count; @list.size; end
+    def bounds_check
+      @row_changed = false
+      if @oldrow != @current_index
+        on_leave_row @oldrow if respond_to? :on_leave_row     # to be defined by widget that has included this
+        on_enter_row @current_index   if respond_to? :on_enter_row  # to be defined by widget that has included this
+        set_form_row
+        @row_changed = true
+      end
+      if @old_toprow != @toprow # only if scrolling has happened should we repaint
+        @repaint_required = true 
+        @widget_scrolled = true
+      end
+    end
+    def on_enter
+      if @list.nil? || @list.size == 0
+        Ncurses.beep
+        return :UNHANDLED
+      end
+      super  
+      on_enter_row @current_index
+      set_form_row
+      true
+    end
+    def on_enter_row arow
+      fire_handler :ENTER_ROW, self
+      @repaint_required = true
+    end
+    def on_leave_row arow
+      fire_handler :LEAVE_ROW, self
+    end
+    def fire_action_event
+      require 'rbcurse/core/include/ractionevent'
+      fire_handler :PRESS, ActionEvent.new(self, :PRESS, text)
+    end
+    def current_value
+      @list[@current_index]
+    end
+    alias :text :current_value
+    ##
+  end # class
+end # module
+if __FILE__ == $PROGRAM_NAME
+  require 'rbcurse/core/util/app'
+
+  App.new do
+    require 'rbcurse/extras/widgets/horizlist'
+    require 'fileutils'
+    l = HorizList.new @form, :row => 5, :col => 5, :width => 80 
+    list = Dir.glob("*")
+    l.list(list)
+    l.bind(:PRESS){ |eve| alert "You pressed #{eve.text} " }
+    sl = status_line
+    sl.command do
+      " Status:  #{$status_message} "
+    end
+  end
+
+  
+end

data/lib/rbcurse/extras/widgets/menutree.rb

@@ -0,0 +1,63 @@
+module RubyCurses
+  # Create a simple tree-ish structure.
+  # Each node is not a tree, only submenus are trees
+  # Others contain a hash with menu character and code
+  # Typically the code is not a method symbol, it is to be 
+  # used to decode a description or method symbol from anoterh hash
+  # @usage
+  #    menu = MenuTree.new "Main", { c: :goprev, d: :gonext, e: :gonext, s: :submenu }
+  #    menu.submenu :s, "submenu", {a: :next1, b: :next2, f: :next3 }
+  #    puts menu.hash
+  #    puts "each ..."
+  #    menu.each { |e|  puts e }
+  #    menu.each_pair { |e, v|  puts "#{e} #{v}" }
+  #    puts " -- :c -- "
+  #    puts menu[:c]
+  #    puts " -- :s -- "
+  #    puts menu[:s].children
+  class MenuTree
+    attr_reader :value
+    def initialize value, hash = {}
+      @value = [value, hash]
+    end
+    def << kv
+      @value[1][kv[0]] = kv[1]
+    end
+    def hash
+      @value[1]
+    end
+    alias :children :hash
+    def push hsh
+      hash().merge hsh
+    end
+    def [](x)
+      hash()[x]
+    end
+    def []=(x,y)
+      hash()[x] = y
+    end
+    def submenu key, value, hash = {}
+      m = MenuTree.new value, hash
+      #hash()[key] = [value, hash]
+      hash()[key] = m
+    end
+    def each
+      hash().keys.each { |e| yield e }
+    end
+    def each_pair
+      hash().each_pair { |name, val| yield name, val  }
+    end
+  end
+end
+if __FILE__ == $PROGRAM_NAME
+  menu = RubyCurses::MenuTree.new "Main", { c: :goprev, d: :gonext, e: :gonext, s: :submenu }
+  menu.submenu :s, "submenu", {a: :next1, b: :next2, f: :next3 }
+  puts menu.hash
+  puts "each ..."
+  menu.each { |e|  puts e }
+  menu.each_pair { |e, v|  puts "#{e} #{v}" }
+  puts " -- :c -- "
+  puts menu[:c]
+  puts " -- :s -- "
+  puts menu[:s].children
+end

data/lib/rbcurse/extras/widgets/multilinelabel.rb

@@ -0,0 +1,142 @@
+# ----------------------------------------------------------------------------- #
+#         File: multilinelabel.rb
+#  Description: Prints a label on the screen.
+#               This is the original label that was present in rwidgets.rb
+#               It allowed for multiple lines. I am simplifying that to a simple
+#               single line label. 
+#               I am basically moving multiline labels out of hte core package
+#       Author: rkumar http://github.com/rkumar/rbcurse/
+#         Date: 2011-11-12 - 12:04
+#      License: Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+#  Last update: 2011-11-12 - 12:05
+# ----------------------------------------------------------------------------- #
+#
+module RubyCurses
+  
+  # print static text on a form, allowing for text to be wrapped.
+  #
+  class MultiLineLabel < Widget
+    dsl_accessor :mnemonic       # keyboard focus is passed to buddy based on this key (ALT mask)
+
+    # justify required a display length, esp if center.
+    dsl_property :justify        #:right, :left, :center
+    dsl_property :display_length #please give this to ensure the we only print this much
+    #dsl_property :height         #if you want a multiline label. already added to widget
+    # for consistency with others 2011-11-5 
+    alias :width :display_length
+    alias :width= :display_length=
+
+    def initialize form, config={}, &block
+  
+      # this crap was used in position_label, find another way. where is it used ?
+      #@row = config.fetch("row",-1)  # why on earth this monstrosity ? 2011-11-5 
+      #@col = config.fetch("col",-1) 
+      #@bgcolor = config.fetch("bgcolor", $def_bg_color)
+      #@color = config.fetch("color", $def_fg_color)
+      @text = config.fetch("text", "NOTFOUND")
+      @editable = false
+      @focusable = false
+      super
+      @justify ||= :left
+      @name ||= @text
+      @repaint_required = true
+    end
+    #
+    # get the value for the label
+    def getvalue
+      @text_variable && @text_variable.value || @text
+    end
+    def label_for field
+      @label_for = field
+      #$log.debug " label for: #{@label_for}"
+      if @form
+        bind_hotkey 
+      else
+        @when_form ||= []
+        @when_form << lambda { bind_hotkey }
+      end
+    end
+
+    ##
+    # for a button, fire it when label invoked without changing focus
+    # for other widgets, attempt to change focus to that field
+    def bind_hotkey
+      if !@mnemonic.nil?
+        ch = @mnemonic.downcase()[0].ord   ##  1.9 DONE 
+        # meta key 
+        mch = ?\M-a.getbyte(0) + (ch - ?a.getbyte(0))  ## 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
+          $log.debug " bind_hotkey label for: #{@label_for}"
+          @form.bind_key(mch, @label_for) { |_form, _field| _field.focus }
+        end
+      end
+    end
+
+    ##
+    # XXX need to move wrapping etc up and done once. 
+    def repaint
+      return unless @repaint_required
+      raise "Label row or col nil #{@row} , #{@col}, #{@text} " if @row.nil? || @col.nil?
+      r,c = rowcol
+
+      @bgcolor ||= $def_bg_color
+      @color   ||= $def_fg_color
+      # value often nil so putting blank, but usually some application error
+      value = getvalue_for_paint || ""
+      lablist = []
+      # trying out array values 2011-10-16 more for messageboxes.
+      if value.is_a? Array
+        lablist = text
+        @height = text.size
+      elsif @height && @height > 1
+        lablist = wrap_text(value, @display_length).split("\n")
+      else
+        # ensure we do not exceed
+        if !@display_length.nil?
+          if value.length > @display_length
+            value = value[0..@display_length-1]
+          end
+        end
+        lablist << value
+      end
+      len = @display_length || value.length
+      acolor = get_color $datacolor
+      $log.debug "label :#{@text}, #{value}, r #{r}, c #{c} col= #{@color}, #{@bgcolor} acolor  #{acolor} j:#{@justify} dlL: #{@display_length} "
+      firstrow = r
+      _height = @height || 1
+      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
+    
+      @graphic = @form.window if @graphic.nil? ## HACK messagebox givig this in repaint, 423 not working ??
+      0.upto(_height-1) { |i| 
+        @graphic.printstring r+i, c, " " * len , acolor,@attr
+      }
+      lablist.each_with_index do |_value, ix|
+        break if ix >= _height
+        if @justify.to_sym == :center
+          padding = (@display_length - _value.length)/2
+          _value = " "*padding + _value + " "*padding # so its cleared if we change it midway
+        end
+        @graphic.printstring r, c, str % [len, _value], acolor,@attr
+        r += 1
+      end
+      if !@mnemonic.nil?
+        ulindex = value.index(@mnemonic) || value.index(@mnemonic.swapcase)
+        @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
+    end
+    # Added 2011-10-22 to prevent some naive components from putting focus here.
+    def on_enter
+      raise "Cannot enter Label"
+    end
+    def on_leave
+      raise "Cannot leave Label"
+    end
+  # ADD HERE LABEL
+  end # class
+end # module