rbcurse 1.3.0 → 1.4.0

data/lib/rbcurse/extras/directorylist.rb

@@ -46,6 +46,8 @@ module RubyCurses
       bind_key(?+, :ask_select)
       bind_key(?-, :ask_unselect)
       bind_key(?I) { @hide_dot_files = !@hide_dot_files; prune_entries; }
+      #bind_key(?v, :view_current)  # does not respond to ??? XXX
+      bind_key(?v) {view_current} 
       super
     end
     # changing the current path, refreshes files
@@ -83,10 +85,8 @@ module RubyCurses
       list @entries
       @list.insert 0, @_header
       @title = @current_path
-      #@current_index = @_first_data_index
-      # this next line will keep the cursor on header after sorting
-      # earlier cursor would appear in header but selection would be data row
-      @current_index = @_header_row_index # FFI 2011-09-16 keeping cursor synched with selection
+      @current_index = @_first_data_index
+      set_form_row
     end
     # called by parent's repaint
     def convert_value_to_text file, crow
@@ -227,7 +227,11 @@ module RubyCurses
           @reverse = false
         end
         sort_by header.strip, @reverse
+        # this next line will keep the cursor on header after sorting
+        # earlier cursor would appear in header but selection would be data row
+        @current_index = @_header_row_index # FFI 2011-09-16 keeping cursor synched with selection
         @_last_header_sorted = header
+        set_form_row
         return
       end
       value = current_value
@@ -399,6 +403,12 @@ module RubyCurses
     populate @current_path
     set_form_row
   end
+  def view_current
+    file = self.current_value
+    require 'rbcurse/extras/viewer.rb'
+    RubyCurses::Viewer.view("#{current_path}/#{file}", :close_key => KEY_RETURN, :title => "<Enter> to close, M-l M-h to scroll")
+  end
+    # ADD HERE 
     ##
   end # class
 
@@ -452,7 +462,6 @@ module RubyCurses
         graphic.printstring r, c, "%-*s" % [len, value], @color_pair,@attr
       end
     end
-    # ADD HERE 
   end
 end # module
 # set filetype=ruby

data/lib/rbcurse/extras/divider.rb

@@ -44,7 +44,7 @@ module RubyCurses
     dsl_property :parent
     # which row is focussed, current_index of listbox, required.
     # how many total rows of data does the list have, same as @list.length, required.
-    dsl_accessor :next
+    dsl_accessor :next_component  # 'next' bombing in dsl_accessor 2011-10-2 PLS CHANGE ELSEWHERE
 
     # TODO: if parent passed, we shold bind to ON_ENTER and get current_index, so no extra work is required.
 

data/lib/rbcurse/extras/listselectable.rb

@@ -5,6 +5,7 @@
 # the original gets into models and has complicated operation as well
 # as difficult to remember method names. This attempts to be a simple plugin.
 # Currently being used by rbasiclistbox and now tabularwidget.
+# NOTE: pls define @_header_adjustment to 0 if you don't use it or know what it means.
 # TODO: of course we need to fire events so user can do something.
 module RubyCurses
   module NewListSelectable
@@ -24,16 +25,22 @@ module RubyCurses
       when :multiple
         if @selected_indices.include? crow
           @selected_indices.delete crow
+          lse = ListSelectionEvent.new(crow, crow, self, :DELETE)
+          fire_handler :LIST_SELECTION_EVENT, lse
         else
-          #clear_selection
-          #@selected_indices[0] = crow 
           @selected_indices << crow
+          lse = ListSelectionEvent.new(crow, crow, self, :INSERT)
+          fire_handler :LIST_SELECTION_EVENT, lse
         end
       else
         if @selected_index == crow 
           @selected_index = nil
+          lse = ListSelectionEvent.new(crow, crow, self, :DELETE)
+          fire_handler :LIST_SELECTION_EVENT, lse
         else
           @selected_index = crow 
+          lse = ListSelectionEvent.new(crow, crow, self, :INSERT)
+          fire_handler :LIST_SELECTION_EVENT, lse
         end
       end
     end
@@ -53,19 +60,29 @@ module RubyCurses
         if @selected_indices.include? crow
           # delete from last_clicked until this one in any direction
           min.upto(max){ |i| @selected_indices.delete i }
+          lse = ListSelectionEvent.new(min, max, self, :DELETE)
+          fire_handler :LIST_SELECTION_EVENT, lse
         else
           # add to selection from last_clicked until this one in any direction
           min.upto(max){ |i| @selected_indices << i unless @selected_indices.include?(i) }
+          lse = ListSelectionEvent.new(min, max, self, :INSERT)
+          fire_handler :LIST_SELECTION_EVENT, lse
         end
       else
       end
       @repaint_required = true
+      self
     end
     # clears selected indices, typically called when multiple select
     # Key binding is application specific
     def clear_selection
+      return if @selected_indices.nil? || @selected_indices.empty?
       @selected_indices = []
       @selected_index = nil
+      # Not sure what event type I should give, DELETE or a new one, user should
+      #  understand that selection has been cleared, and ignore first two params
+      lse = ListSelectionEvent.new(0, @list.size, self, :CLEAR)
+      fire_handler :LIST_SELECTION_EVENT, lse
       @repaint_required = true
     end
     def is_row_selected crow=@current_index-@_header_adjustment
@@ -100,8 +117,8 @@ module RubyCurses
       @anchor_selection_index = ix0
       @lead_selection_index = ix1
       ix0.upto(ix1) {|i| @selected_indices  << i unless @selected_indices.include? i }
-      #lse = ListSelectionEvent.new(ix0, ix1, @parent, :INSERT)
-      #fire_handler :LIST_SELECTION_EVENT, lse
+      lse = ListSelectionEvent.new(ix0, ix1, self, :INSERT)
+      fire_handler :LIST_SELECTION_EVENT, lse
       #$log.debug " DLSM firing LIST_SELECTION EVENT #{lse}"
     end
     alias :add_row_selection_interval :add_selection_interval
@@ -109,8 +126,8 @@ module RubyCurses
       @anchor_selection_index = ix0
       @lead_selection_index = ix1
       @selected_indices.delete_if {|x| x >= ix0 and x <= ix1}
-      #lse = ListSelectionEvent.new(ix0, ix1, @parent, :DELETE)
-      #fire_handler :LIST_SELECTION_EVENT, lse
+      lse = ListSelectionEvent.new(ix0, ix1, self, :DELETE)
+      fire_handler :LIST_SELECTION_EVENT, lse
     end
     alias :remove_row_selection_interval :remove_selection_interval
     # convenience method to select next len rows
@@ -122,13 +139,13 @@ module RubyCurses
     # select all rows, you may specify starting row.
     # if header row, then 1 else should be 0. Actually we should have a way to determine
     # this, and the default should be zero.
-    def select_all start_row=0
+    def select_all start_row=0 #+@_header_adjustment
       @repaint_required = true
       # don't select header row - need to make sure this works for all cases. we may 
       # need a variable instead of hardoded value
       add_row_selection_interval start_row, row_count()
     end
-    def invert_selection start_row=1
+    def invert_selection start_row=0 #+@_header_adjustment
       start_row.upto(row_count()){|i| invert_row_selection i }
     end
      
@@ -189,6 +206,8 @@ module RubyCurses
       bind_key(?a, :select_all)
       bind_key(?*, :invert_selection)
       bind_key(?u, :clear_selection)
+      @_header_adjustment ||= 0 #  incase caller does not use
+      @_events << :LIST_SELECTION_EVENT unless @_events.include? :LIST_SELECTION_EVENT
     end
     def list_init_vars
       @selected_indices = []
@@ -219,4 +238,19 @@ module RubyCurses
       @selected_indices
     end
   end # mod
+  class ListSelectionEvent
+    attr_accessor :firstrow, :lastrow, :source, :type
+    def initialize firstrow, lastrow, source, type
+      @firstrow = firstrow
+      @lastrow = lastrow
+      @source = source
+      @type = type
+    end
+    def to_s
+      "#{@type.to_s}, firstrow: #{@firstrow}, lastrow: #{@lastrow}, source: #{@source}"
+    end
+    def inspect
+      to_s
+    end
+  end
 end # mod

data/lib/rbcurse/extras/masterdetail.rb

@@ -28,7 +28,7 @@ class MasterDetail < Widget
     if @first_time
       @first_time = nil
       [@vim, @left, @right1, @right2].each { |e|  
-        e.set_buffering(:target_window => @target_window || @form.window, :form => @form)
+        e.set_buffering(:target_window => @target_window || @form.window, :form => @form) # removed on 2011-09-29 
       }
     end
     @vim.repaint
@@ -61,7 +61,7 @@ class MasterDetail < Widget
     # what if user gives in wrong order !!
     @gb = @vim.add :divider, :SECOND, 0
     @right2 = @vim.add comp, :SECOND, weight
-    @gb.next(@right2)
+    @gb.next_component(@right2)
     _add_component comp
     @right2
   end

data/lib/rbcurse/extras/scrollbar.rb

@@ -42,6 +42,7 @@ module RubyCurses
       super
       @color_pair = get_color $datacolor, @color, @bgcolor
       @scroll_pair = get_color $bottomcolor, :green, :white
+      #$log.debug "SCROLLBAR COLOR cp #{@color_pair} sp #{@scroll_pair} " if $log.debug? 
       @window = form.window
       @editable = false
       @focusable = false
@@ -55,6 +56,11 @@ module RubyCurses
           @repaint_required = true  #requred otherwise at end when same value sent, prop handler
           # will not be fired (due to optimization).
         end
+        # in some cases, on leaving a listbox or other component redraws itself to reduce
+        # selected or highlighted object, so the scrollbar gets overwritten. We need to repaint it.
+        @parent.bind :LEAVE do |p|
+          @repaint_required = true  
+        end
       end
     end
 
@@ -82,10 +88,11 @@ module RubyCurses
       bc = $datacolor
       bordercolor = @border_color || bc
       borderatt = @border_attrib || Ncurses::A_REVERSE
+      #$log.debug "SCROLL bordercolor #{bordercolor} , #{borderatt} " if $log.debug? 
 
 
       @graphic.attron(Ncurses.COLOR_PAIR(bordercolor) | borderatt)
-      $log.debug " XXX SCROLL #{@row} #{@col} #{@length} "
+      #$log.debug " XXX SCROLL #{@row} #{@col} #{@length} "
       @graphic.mvvline(@row+0, @col, 1, @length-0)
       @graphic.attroff(Ncurses.COLOR_PAIR(bordercolor) | borderatt)
 
@@ -95,14 +102,16 @@ module RubyCurses
       @current_index = 0 if @current_index < 0
       @current_index = listlen-1 if @current_index >= listlen
       sclen = (pht/listlen)* @length
+      sclen = 1 if sclen < 1 # sometimes 0.7 for large lists 100 items 2011-10-1 
       scloc = (@current_index/listlen)* @length
       scloc = (@length - sclen) if scloc > @length - sclen # don't exceed end
       if @current_index == @list_length - 1
-        scloc = @length - sclen + 1
+        scloc = @length - sclen + 0 # earlier 1, but removed since sclen min 1 2011-10-1 
       end
       @graphic.attron(Ncurses.COLOR_PAIR(@scroll_pair) | borderatt)
       r = @row + scloc
       c = @col + 0
+      #$log.debug " XXX SCROLLBAR #{r} #{c} #{sclen} "
       @graphic.mvvline(r, c, 1, sclen)
       @graphic.attroff(Ncurses.COLOR_PAIR(@scroll_pair) | borderatt)
       @repaint_required = false

data/lib/rbcurse/extras/statusline.rb

@@ -0,0 +1,56 @@
+require 'rbcurse'
+
+module RubyCurses
+
+  #
+  # A vim-like application status bar that can display time and various other statuses
+  #  at the bottom, typically above the dock (3rd line from last).
+  #
+  class StatusLine < Widget
+
+    def initialize form, config={}, &block
+      @row = Ncurses.LINES-3
+      @col = 0
+      super
+      @focusable = false
+      @editable  = false
+      @command = nil
+      @repaint_required = true
+      bind(:PROPERTY_CHANGE) {  |e| @color_pair = nil ; }
+    end
+    #
+    # command that returns a string that populates the status line.
+    # See dbdemo.rb
+    # e.g. 
+    #   @l.command { "%-20s [DB: %-s | %-s ]" % [ Time.now, $current_db || "None", $current_table || "----"] }  
+    #
+    def command *args, &blk
+      @command = blk
+      @args = args
+    end
+
+    # NOTE: I have not put a check of repaint_required, so this will print on each key-stroke OR
+    #   rather whenever form.repaint is called.
+    def repaint
+      @color_pair ||= get_color($datacolor, @color, @bgcolor) 
+
+      # first print dashes through
+      @form.window.printstring @row, @col, "%s" % "-" * Ncurses.COLS, @color_pair, Ncurses::A_REVERSE
+
+      # now call the block to get current values
+      if @command
+        ftext = @command.call(self, @args) if @command
+      else
+        status = $status_message ? $status_message.value : ""
+        ftext = " %-20s | %s" % [Time.now, status] # should we print a default value just in case user doesn't
+      end
+      @form.window.printstring @row, @col, ftext, $datacolor, Ncurses::A_REVERSE
+
+      @repaint_required = false
+    end
+    def handle_keys ch
+      return :UNHANDLED
+    end
+    
+  end # class
+end # module

data/lib/rbcurse/extras/stdscrwindow.rb

@@ -12,6 +12,12 @@ module RubyCurses
   # FFI: 2011-09-9 The change to FFI has affected this a lot since I do not get window
   # methods in rbcurse for stdscr whereas suprisingly if i run the samples, i get them
   # all.
+  #
+  #   NOTE:
+  #   WARNING: Pls do not use this class. This was just experimentation. Using stdscr
+  #   mucks up the display and overwrites objects on the screen. I will remove this class
+  #   at some time.
+  #
   class StdscrWindow 
     attr_reader :width, :height, :top, :left
 
@@ -264,7 +270,9 @@ module RubyCurses
     #  2010-09-13 00:22 WE should not use these any longer.
     #  Application should create a label and map a Variable named
     #  $errormessage to it. We should only update the Variable
+    # CLEANUP DEPRECATED
     def print_error_message text=$error_message
+      raise "DEPRECATED CLEANUP use global method of same name"
       r = $error_message_row || Ncurses.LINES-1
       c = $error_message_col || (Ncurses.COLS-text.length)/2 
 
@@ -274,7 +282,9 @@ module RubyCurses
       $error_message_clear_pending = true
     end
     # added by rk 2008-11-29 19:01 
+    # CLEANUP DEPRECATED
     def print_status_message text=$status_message
+      raise "DEPRECATED CLEANUP use global method of same name"
       r = $status_message_row || Ncurses.LINES-1
       clear_error r, $datacolor
       # print it in centre
@@ -284,6 +294,7 @@ module RubyCurses
     # I am not only clearing if something was printed. This is since
     # certain small forms like TabbedForm top form throw an error on printstring.
     # 
+      #raise "DEPRECATED CLEANUP use global method of same name"
     def clear_error r = $error_message_row, color = $datacolor
       return unless $error_message_clear_pending
       c = $error_message_col || (Ncurses.COLS-text.length)/2 

data/lib/rbcurse/extras/tabular.rb

@@ -26,6 +26,7 @@
 module RubyCurses
 
   class Tabular
+    GUESSCOLUMNS = 20
 
   def yield_or_eval &block
     return unless block
@@ -187,7 +188,7 @@ module RubyCurses
     private
     def _guess_col_widths  #:nodoc:
       @list.each_with_index { |r, i| 
-        break if i > 10
+        break if i > GUESSCOLUMNS
         next if r == :separator
         r.each_with_index { |c, j|
           x = c.to_s.length

data/lib/rbcurse/extras/tabularwidget.rb

@@ -156,6 +156,11 @@ module RubyCurses
       bind_key(?b, :previous_column)
       list_bindings
     end
+
+    #
+    # set column names
+    # @param [Array] column names or headings
+    #
     def columns=(array)
       @_header_adjustment = 1
       @columns = array
@@ -168,7 +173,7 @@ module RubyCurses
     end
     alias :headings= :columns=
     ## 
-    # send in a list
+    # send in a list of data
     # 
     # @param [Array / Tabular] data to be displayed
     def set_content list
@@ -325,17 +330,11 @@ module RubyCurses
     end
 
     def repaint # Tabularwidget :nodoc:
-      if @screen_buffer.nil?
-        safe_create_buffer
-        @screen_buffer.name = "Pad::TABW_PAD_#{@name}" unless @screen_buffer.nil?
-        $log.debug " tabularwid creates pad #{@screen_buffer} #{@name}"
-      end
 
       #return unless @repaint_required # 2010-02-12 19:08  TRYING - won't let footer print for col move
       paint if @repaint_required
       #  raise "TV 175 graphic nil " unless @graphic
       print_foot if @print_footer && @repaint_footer_required
-      buffer_to_window
     end
     def getvalue
       @list
@@ -367,10 +366,12 @@ module RubyCurses
       when KEY_UP, ?k.getbyte(0)
         #select_prev_row
         ret = up
+        get_window.ungetch(KEY_BTAB) if ret == :NO_PREVIOUS_ROW
         check_curpos
         
       when KEY_DOWN, ?j.getbyte(0)
         ret = down
+        get_window.ungetch(KEY_TAB) if ret == :NO_NEXT_ROW
         check_curpos
       when KEY_LEFT, ?h.getbyte(0)
         cursor_backward
@@ -390,9 +391,9 @@ module RubyCurses
         blen = @buffer.rstrip.length
         set_form_col blen
         # search related 
-      when @KEY_ASK_FIND
+      when @KEY_ASK_FIND  # FIXME
         ask_search
-      when @KEY_FIND_MORE
+      when @KEY_FIND_MORE  # FIXME
         find_more
       when 10, 13, KEY_ENTER
         #fire_handler :PRESS, self
@@ -428,8 +429,9 @@ module RubyCurses
         begin
           ret = process_key ch, self
         rescue => err
-          $error_message = err
-          @form.window.print_error_message
+          $error_message.value = err.to_s
+#          @form.window.print_error_message # changed 2011 dts  
+          alert err.to_s
           $log.error " Tabularwidget ERROR #{err} "
           $log.debug(err.backtrace.join("\n"))
           # XXX caller app has no idea error occurred so can't do anything !
@@ -570,16 +572,16 @@ module RubyCurses
       @graphic = my_win unless @graphic
       @win_left = my_win.left
       @win_top = my_win.top
-      #_guess_col_widths
       tm = get_content
+      rc = tm.length
+      _estimate_column_widths if rc > 0  # will set preferred_width 2011-10-4 
       @left_margin ||= @row_selected_symbol.length
       @width ||= @preferred_width
+
       @height ||= [tm.length+3, 10].min
       _prepare_format
 
       print_borders if (@suppress_borders == false && @repaint_all) # do this once only, unless everything changes
-      rc = tm.length
-      _estimate_column_widths if rc > 0
       _maxlen = @maxlen || @width-@internal_width
       $log.debug " #{@name} Tabularwidget repaint width is #{@width}, height is #{@height} , maxlen #{maxlen}/ #{@maxlen}, #{@graphic.name} roff #{@row_offset} coff #{@col_offset}" 
       tr = @toprow
@@ -621,7 +623,6 @@ module RubyCurses
       end
       @repaint_required        = false
       @repaint_footer_required = true
-      @buffer_modified         = true # required by form to call buffer_to_screen
       @repaint_all             = false
 
     end
@@ -630,12 +631,33 @@ module RubyCurses
     def print_data_row r, c, len, value, color, attr
       @graphic.printstring  r, c, "%-*s" % [len,value], color, attr
     end
+    #
+    # Truncates data to fit into display area.
+    #  Copied from listscrollable since we need to take care of left_margin
+    #  2011-10-6 This may need to be reflected in listbox and others FIXME
+    def truncate content  #:nodoc:
+      #maxlen = @maxlen || @width-2
+      _maxlen = @maxlen || @width-@internal_width
+      _maxlen = @width-@internal_width if _maxlen > @width-@internal_width
+      _maxlen -= @left_margin
+      if !content.nil? 
+        if content.length > _maxlen # only show maxlen
+          @longest_line = content.length if content.length > @longest_line
+          #content = content[@pcol..@pcol+_maxlen-1] 
+          content.replace content[@pcol..@pcol+_maxlen-1] 
+        else
+          # can this be avoided if pcol is 0 XXX
+          content.replace content[@pcol..-1] if @pcol > 0
+        end
+      end
+      content
+    end
 
     # print header row
     #  allows user to override
     def print_header_row r, c, len, value, color, attr
       #acolor = $promptcolor
-      @graphic.printstring  r, c, "%-*s" % [len ,value], color, attr
+      @graphic.printstring  r, c+@left_margin, "%-*s" % [len-@left_margin ,value], color, attr
     end
     def separator
       #return @separ if @separ
@@ -843,6 +865,8 @@ module RubyCurses
     # FIXME we can create this once and reuse
     #++
     def fire_action_event
+      return unless @list
+      return unless @table_row_sorter
       require 'rbcurse/ractionevent'
       # the header event must only be used if columns passed
       if header_row?
@@ -1023,6 +1047,25 @@ module RubyCurses
         @current_index == @max_index
       end
     end
+    # for some compatibility with Table
+    def set_data data, colnames_array
+      set_content data
+      columns = colnames_array
+    end
+    def get_column_name index
+      @columns[index]
+    end
+    alias :column_name :get_column_name
+    alias :column :get_column
+    def method_missing(name, *args)
+      name = name.to_s
+      case name 
+      when 'cell_editing_allowed', 'editing_policy'
+        # silently ignore to keep compatible with Table
+      else
+        raise NoMethodError, "Undefined method #{name} for TabularWidget"
+      end
+    end
 
   end # class tabluarw
 
@@ -1044,7 +1087,7 @@ App.new do
     b << ["russia","europe","a hot country" ] 
     #b.column_width 2, 30
   end
-  s = TabularWidget.new @form , :row => 12, :col => 32 do |b|
+  s = TabularWidget.new @form , :row => 12, :col => 32  do |b|
     b.columns = %w{ place continent text }
     b << ["india","asia","a warm country" ] 
     b << ["japan","asia","a cool country" ]