rbcurse 1.4.0 → 1.4.1.pre2

data/lib/rbcurse/extras/listselectable.rb

@@ -23,6 +23,7 @@ module RubyCurses
       @repaint_required = true
       case @selection_mode 
       when :multiple
+        @widget_scrolled = true # FIXME we need a better name
         if @selected_indices.include? crow
           @selected_indices.delete crow
           lse = ListSelectionEvent.new(crow, crow, self, :DELETE)
@@ -34,10 +35,12 @@ module RubyCurses
         end
       else
         if @selected_index == crow 
+          @old_selected_index = @selected_index # 2011-10-15 so we can unhighlight
           @selected_index = nil
           lse = ListSelectionEvent.new(crow, crow, self, :DELETE)
           fire_handler :LIST_SELECTION_EVENT, lse
         else
+          @old_selected_index = @selected_index # 2011-10-15 so we can unhighlight
           @selected_index = crow 
           lse = ListSelectionEvent.new(crow, crow, self, :INSERT)
           fire_handler :LIST_SELECTION_EVENT, lse
@@ -57,6 +60,7 @@ module RubyCurses
       max = [@last_clicked, crow].max
       case @selection_mode 
       when :multiple
+        @widget_scrolled = true # FIXME we need a better name
         if @selected_indices.include? crow
           # delete from last_clicked until this one in any direction
           min.upto(max){ |i| @selected_indices.delete i }
@@ -79,11 +83,13 @@ module RubyCurses
       return if @selected_indices.nil? || @selected_indices.empty?
       @selected_indices = []
       @selected_index = nil
+      @old_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
+      @widget_scrolled = true # FIXME we need a better name
     end
     def is_row_selected crow=@current_index-@_header_adjustment
       case @selection_mode 
@@ -114,6 +120,7 @@ module RubyCurses
     # should only be used if multiple selection interval
     def add_selection_interval ix0, ix1
       return if @selection_mode != :multiple
+      @widget_scrolled = true # FIXME we need a better name
       @anchor_selection_index = ix0
       @lead_selection_index = ix1
       ix0.upto(ix1) {|i| @selected_indices  << i unless @selected_indices.include? i }
@@ -212,6 +219,7 @@ module RubyCurses
     def list_init_vars
       @selected_indices = []
       @selected_index = nil
+      @old_selected_index = nil
       #@row_selected_symbol = ''
       if @show_selector
         @row_selected_symbol ||= '*'

data/lib/rbcurse/extras/multiform.rb

@@ -0,0 +1,330 @@
+=begin
+  * Name: Multiform.rb
+  * Description   View (cycle) multiple forms
+  * Author: rkumar (arunachalesha)
+  * file created  2011-10-17 8:18 PM 
+  --------
+  * License:
+    Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+
+=end
+require 'rbcurse'
+
+include RubyCurses
+module RubyCurses
+  extend self
+
+  # Trying to implement TabbedPanes using a multiform approach, but no more windows
+  # or pads. Try to keep it as simple as possible
+  class MultiForm < Widget
+    dsl_accessor :title
+
+
+    def initialize form = nil, config={}, &block
+      @focusable = true
+      @window = form.window
+      @row_offset = @col_offset = 1
+      @bmanager = BufferManager.new self
+      @forms = []
+      super
+      init_vars
+
+    end
+    def init_vars
+      super
+      # the following allows us to navigate buffers with :bn :bp etc (with Alt pressed)
+      bind_key(?\M-:, :buffer_menu)
+      bind_key(?\M-;, :buffer_menu)
+      # bind_key([?\C-x, ?f], :file_edit)
+      bind_key([?\C-x, ?k], :delete_component)
+      bind_key([?\C-x, ?\C-b], :list_components)
+      bind_key(?\M-n, :goto_next_component)
+      bind_key(?\M-p, :goto_prev_component)
+      bind_key(?\M-1, :goto_first_component)
+      # easily cycle using p. n is used for next search.
+      #bind_key(?p, :buffer_previous)
+      @suppress_borders = false 
+      @repaint_all = true 
+      @name ||= "multiform"
+    end
+    ## returns current buffer
+    # @return  [RBuffer] current buffer
+    def current_component
+      @bmanager.current
+    end
+    ## 
+    # multi-container
+    def handle_key ch  #:nodoc:
+      @current_component.repaint
+      @current_component.window.wrefresh
+      $log.debug " MULTI handle_key #{ch}, #{@current_component}"
+      ret = :UNHANDLED
+      return :UNHANDLED unless @current_component
+      ret = @current_component.handle_key(ch)
+      $log.debug " MULTI comp #{@current_component} returned #{ret} "
+      if ret == :UNHANDLED
+        # check for bindings, these cannot override above keys since placed at end
+        begin
+          ret = process_key ch, self
+          $log.debug " MULTI = process_key returned #{ret} "
+          if ch > 177 && ch < 187
+            n = ch - 177
+            component_at(n)
+            # go to component n
+          end
+        rescue => err
+#          $error_message = err # changed 2010 dts  
+          $error_message.value = err.to_s
+          #@form.window.print_error_message PLEASE CREATE LABEL
+          $log.error " Multicomponent process_key #{err} "
+          $log.debug(err.backtrace.join("\n"))
+          alert err.to_s
+        end
+        return :UNHANDLED if ret == :UNHANDLED
+      end
+      @current_component.repaint
+      @current_component.window.wrefresh
+      FFI::NCurses.update_panels
+
+      # check for any keys not handled and check our own ones
+      return ret # 
+    end
+    def repaint
+      print_border if (@suppress_borders == false && @repaint_all) # do this once only, unless everything changes
+      return unless @current_component
+      $log.debug " MULTIFORM REPAINT "
+      ret = @current_component.repaint
+    end
+    def print_border  #:nodoc:
+      $log.debug " #{@name} print_borders,  #{@graphic.name} "
+      color = $datacolor
+      @graphic.print_border_only @row, @col, @height-1, @width, color #, Ncurses::A_REVERSE
+      print_title
+    end
+    def print_title  #:nodoc:
+      $log.debug " print_title #{@row}, #{@col}, #{@width} #{@title} "
+      @graphic.printstring( @row, @col+(@width-@title.length)/2, @title, $datacolor, @title_attrib) unless @title.nil?
+    end
+    # this is just a test of the simple "most" menu
+    # can use this for next, prev, first, last, new, delete, overwrite etc
+    def buffer_menu
+      menu = PromptMenu.new self 
+      menu.add(menu.create_mitem( 'l', "list buffers", "list buffers ", :list_components ))
+      item = menu.create_mitem( 'b', "Buffer Options", "Buffer Options" )
+      menu1 = PromptMenu.new( self, "Buffer Options")
+      menu1.add(menu1.create_mitem( 'n', "Next", "Switched to next buffer", :goto_next_component ))
+      menu1.add(menu1.create_mitem( 'p', "Prev", "Switched to previous buffer", :goto_prev_component ))
+      menu1.add(menu1.create_mitem( 'f', "First", "Switched to first buffer", :goto_first_component ))
+      menu1.add(menu1.create_mitem( 'l', "Last", "Switched to last buffer", :goto_last_component ))
+      menu1.add(menu1.create_mitem( 'd', "Delete", "Deleted buffer", :delete_component ))
+      item.action = menu1
+      menu.add(item)
+      # how do i know what's available. the application or window should know where to place
+      menu.display @form.window, $error_message_row, $error_message_col, $datacolor #, menu
+    end
+
+
+    def goto_next_component
+      perror "No other buffer" and return if @bmanager.size < 2
+
+      @current_component = @bmanager.next
+      set_current_component
+      # set_form_row and shit
+    end
+
+    def goto_prev_component
+      perror "No other buffer" and return if @bmanager.size < 2
+
+      @current_component = @bmanager.previous
+      $log.debug " buffer_prev got #{@current_component} "
+      set_current_component
+    end
+    def goto_first_component
+      @current_component = @bmanager.first
+      $log.debug " buffer_first got #{@current_component} "
+      set_current_component
+    end
+    def goto_last_component
+      @current_component = @bmanager.last
+      $log.debug " buffer_last got #{@current_component} "
+      set_current_component
+    end
+    def delete_component
+      if @bmanager.size > 1
+        @bmanager.delete_at
+        @current_component = @bmanager.previous
+        set_current_component
+      else
+        perror "Only one buffer. Cannot delete."
+      end
+    end
+
+    def component_at index
+      cc = @bmanager.element_at index
+      return unless cc 
+      @current_component = cc 
+      #$log.debug " buffer_last got #{@current_component} "
+      set_current_component
+    end
+    def add_form title, config={}, &blk
+      $log.debug "XXX: add_form window coords were hwtl #{@height} , #{@width} , #{@top} , #{@left} "
+      #w = VER::Window.new 16, 30, 2, 2 #@height-1, @width-1, @top, @left
+      w = VER::Window.new @height-2, @width-2, @row+1, @col+1
+      #w.box(0,0)
+      frm = Form.new w
+      @forms << frm
+      frm.parent_form = @form
+      frm.add_cols=@col+@col_offset
+      frm.add_rows=@row+@row_offset
+      @current_component = @bmanager.add frm, title
+      set_current_component
+      yield frm if block_given?
+      return @current_component # not a form but a Rcomponent containing component and title
+    end
+    def _add_to(index, component)
+      raise ArgumentError, "index out of bounds" unless @forms[index]
+      component.set_form(@forms[index])
+      $log.debug "XXX: comp r c #{component.row} #{component.col} "
+      component.row += @row
+      component.col += @col
+      $log.debug "XXX: after comp r c #{component.row} #{component.col} "
+    end
+    ##
+    # Add a component with a title
+    # @param [Widget] component
+    # @param [String] title
+    def add component, title
+      component.row = @row+@row_offset+0 # FFI changed 1 to 0 2011-09-12 
+      component.col = @col+@col_offset+0 # FFI changed 1 to 0 2011-09-12 
+      component.width = @width-2
+      component.height = @height-2
+      component.form = @form
+      component.override_graphic(@graphic)
+      @current_component = @bmanager.add component, title
+      set_current_component
+      set_form_row ## FFI added 2011-09-12 to get cursor at start when adding
+      $log.debug " ADD got cb : #{@current_component} "
+    end
+    def set_current_component
+      @title = @current_component.title
+      @current_component = @current_component.component
+      @current_component.repaint #2011-10-17 need to set all comps to repaint XXX
+      @current_component.window.wrefresh
+      @current_component.window.show
+      FFI::NCurses.update_panels
+      set_form_row
+      #@current_title = @current_component.title
+      #@current_component.repaint_all true 2011-10-17 need to set all comps to repaint XXX
+    end
+    def perror errmess
+      alert errmess
+      #@form.window.print_error_message errmess
+    end
+    def list_components
+      $log.debug " TODO buffers_list: #{@bmanager.size}  "
+      menu = PromptMenu.new self 
+      @bmanager.each_with_index{ |b, ix|
+        aproc = Proc.new { component_at(ix) }
+        name = b.title
+        num = ix + 1
+        menu.add(menu.create_mitem( num.to_s, name, "Switched to buffer #{ix}", aproc ))
+      }
+      menu.display @form.window, $error_message_row, $error_message_col, $datacolor
+    end
+    # required otherwise some components may not get correct cursor position on entry
+    # e.g. table
+    def on_enter
+      set_form_row # 2011-10-17 
+    end
+    # nothing happening, the cursor goes to 1,1 and does not move
+    # alhough the fields can be edited XXX
+    def set_form_row  #:nodoc:
+      if !@current_component.nil?
+        #$log.debug " #{@name} set_form_row calling sfr for #{@current_component.name} "
+        #fc = @current_component.widgets[0]
+        fc = @current_component.get_current_field
+        fc ||= @current_component.widgets[0]
+        fc.set_form_row  if fc
+        #fc.set_form_col 
+      end
+    end
+    # ADD HERE
+  end # class multicontainer
+  ##
+  # Handles multiple buffers, navigation, maintenance etc
+  # Instantiated at startup of 
+  #
+  class BufferManager
+    include Enumerable
+    def initialize source
+      @source = source
+      @buffers = [] # contains RBuffer
+      @counter = 0
+      # for each buffer i need to store data, current_index (row), curpos (col offset) and title (filename).
+    end
+    def element_at index
+      @buffers[index]
+    end
+    def each
+      @buffers.each {|k| yield(k)}
+    end
+
+    ##
+    # @return [RBuffer] current buffer/file
+    ##
+    def current
+      @buffers[@counter]
+    end
+    ##
+    # Would have liked to just return next buffer and not get lost in details of caller
+    #
+    # @return [RBuffer] next buffer/file
+    ##
+    def next
+      @counter += 1
+      @counter = 0 if @counter >= @buffers.size
+      @buffers[@counter]
+    end
+    ##
+    # @return [RBuffer] previous buffer/file
+    ##
+    def previous
+      $log.debug " previous bs: #{@buffers.size}, #{@counter}  "
+      @counter -= 1
+      return last() if @counter < 0
+      $log.debug " previous ctr  #{@counter} "
+      @buffers[@counter]
+    end
+    def first
+      @counter = 0
+      @buffers[@counter]
+    end
+    def last
+      @counter = @buffers.size - 1
+      @buffers[@counter]
+    end
+    ##
+    def delete_at index=@counter
+      @buffers.delete_at index
+    end
+    def delete_by_name name
+      @buffers.delete_if {|b| b.filename == name }
+    end
+    def insert component, position, title=nil
+      anew = RComponents.new(component, title)
+      @buffers.insert position, anew
+      @counter = position
+      return anew
+    end
+    def add component, title=nil
+      #$log.debug " ADD H: #{component.height} C: #{component.width} "
+      insert component, @buffers.size, title
+    end
+    def size
+      @buffers.size
+    end
+    alias :count :size
+  end
+  RComponents = Struct.new(:component, :title)
+
+end # modul

data/lib/rbcurse/extras/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