rndk 0.1.0 → 0.2.0

data/lib/rndk/fselect.rb

@@ -1,7 +1,7 @@
 require 'rndk'
 
 module RNDK
-  class FSELECT < RNDK::Widget
+  class FSELECT < Widget
     attr_reader :scroll_field, :entry_field
     attr_reader :dir_attribute, :file_attribute, :link_attribute, :highlight
     attr_reader :sock_attribute, :field_attribute, :filler_character
@@ -83,7 +83,7 @@ module RNDK
                    then RNDK::FULL
                    else box_width - 2 - label_len
                    end
-      @entry_field = RNDK::ENTRY.new(rndkscreen, Ncurses.getbegx(@win), Ncurses.getbegy(@win),
+      @entry_field = RNDK::Entry.new(rndkscreen, Ncurses.getbegx(@win), Ncurses.getbegy(@win),
           title, label, field_attribute, filler_char, :MIXED, temp_width,
           0, 512, box, false)
 
@@ -148,7 +148,7 @@ module RNDK
         ]
 
         # Create the pop up label.
-        info_label = RNDK::LABEL.new(entry.screen, RNDK::CENTER, RNDK::CENTER,
+        info_label = RNDK::Label.new(entry.screen, RNDK::CENTER, RNDK::CENTER,
             mesg, 9, true, false)
         info_label.draw(true)
         info_label.getch([])
@@ -351,12 +351,12 @@ module RNDK
       end
 
       # Define the callbacks for the entry field.
-      @entry_field.bind(:ENTRY, Ncurses::KEY_UP, adjust_scroll_cb, self)
-      @entry_field.bind(:ENTRY, Ncurses::KEY_PPAGE, adjust_scroll_cb, self)
-      @entry_field.bind(:ENTRY, Ncurses::KEY_DOWN, adjust_scroll_cb, self)
-      @entry_field.bind(:ENTRY, Ncurses::KEY_NPAGE, adjust_scroll_cb, self)
-      @entry_field.bind(:ENTRY, RNDK::KEY_TAB, complete_filename_cb, self)
-      @entry_field.bind(:ENTRY, RNDK.CTRL('^'), display_file_info_cb, self)
+      @entry_field.bind(:entry, Ncurses::KEY_UP, adjust_scroll_cb, self)
+      @entry_field.bind(:entry, Ncurses::KEY_PPAGE, adjust_scroll_cb, self)
+      @entry_field.bind(:entry, Ncurses::KEY_DOWN, adjust_scroll_cb, self)
+      @entry_field.bind(:entry, Ncurses::KEY_NPAGE, adjust_scroll_cb, self)
+      @entry_field.bind(:entry, RNDK::KEY_TAB, complete_filename_cb, self)
+      @entry_field.bind(:entry, RNDK.CTRL('^'), display_file_info_cb, self)
 
       # Put the current working directory in the entry field.
       @entry_field.setValue(@pwd)
@@ -367,7 +367,7 @@ module RNDK
                    then RNDK::FULL
                    else box_width - 1
                    end
-      @scroll_field = RNDK::SCROLL.new(rndkscreen,
+      @scroll_field = RNDK::Scroll.new(rndkscreen,
           Ncurses.getbegx(@win), Ncurses.getbegy(@win) + temp_height, RNDK::RIGHT,
           box_height - temp_height, temp_width, '', @dir_contents,
           @file_counter, false, @highlight, box, false)
@@ -608,11 +608,9 @@ module RNDK
       dir_list = []
 
       # Get the directory contents
-      file_count = RNDK.getDirectoryContents(@pwd, dir_list)
-      if file_count <= 0
-        # We couldn't read the directory. Return.
-        return false
-      end
+      dir_list = RNDK.get_directory_contents @pwd
+
+      return false if dir_list.size <= 0
 
       @dir_contents = dir_list
       @file_counter = file_count

data/lib/rndk/fslider.rb

@@ -1,7 +1,7 @@
 require 'rndk/slider'
 
 module RNDK
-  class FSLIDER < RNDK::SLIDER
+  class FSLIDER < Slider
     def initialize(rndkscreen,
                    xplace,
                    yplace,

data/lib/rndk/graph.rb

@@ -1,7 +1,7 @@
 require 'rndk'
 
 module RNDK
-  class GRAPH < RNDK::Widget
+  class GRAPH < Widget
     def initialize(rndkscreen,
                    xplace,
                    yplace,

data/lib/rndk/histogram.rb

@@ -1,7 +1,7 @@
 require 'rndk'
 
 module RNDK
-  class HISTOGRAM < RNDK::Widget
+  class HISTOGRAM < Widget
     def initialize(rndkscreen, xplace, yplace, height, width, orient,
         title, box, shadow)
       super()

data/lib/rndk/itemlist.rb

@@ -1,7 +1,7 @@
 require 'rndk'
 
 module RNDK
-  class ITEMLIST < RNDK::Widget
+  class ITEMLIST < Widget
     def initialize(rndkscreen, xplace, yplace, title, label, item, count,
         default_item, box, shadow)
       super()

data/lib/rndk/label.rb

@@ -2,9 +2,9 @@ require 'rndk'
 
 module RNDK
 
-  # Pop-up Label window.
+  # Customizable text on the screen.
   #
-  class LABEL < RNDK::Widget
+  class Label < Widget
 
     # Raw Ncurses window.
     attr_accessor :win
@@ -105,7 +105,7 @@ module RNDK
       end
 
       # Register this
-      rndkscreen.register(:LABEL, self)
+      rndkscreen.register(:label, self)
     end
 
     # Obsolete entrypoint which calls Label#draw.
@@ -162,7 +162,7 @@ module RNDK
     end
 
     def object_type
-      :LABEL
+      :label
     end
 
     def position
@@ -211,9 +211,9 @@ module RNDK
       RNDK.window_delete @shadow_win
       RNDK.window_delete @win
 
-      self.clean_bindings :LABEL
+      self.clean_bindings :label
 
-      RNDK::Screen.unregister(:LABEL, self)
+      RNDK::Screen.unregister(:label, self)
     end
 
     # Waits for the user to press a key.
@@ -237,3 +237,4 @@ module RNDK
 
   end
 end
+

data/lib/rndk/marquee.rb

@@ -1,7 +1,7 @@
 require 'rndk'
 
 module RNDK
-  class MARQUEE < RNDK::Widget
+  class MARQUEE < Widget
     def initialize(rndkscreen, xpos, ypos, width, box, shadow)
       super()
 

data/lib/rndk/matrix.rb

@@ -1,7 +1,7 @@
 require 'rndk'
 
 module RNDK
-  class MATRIX < RNDK::Widget
+  class MATRIX < Widget
     attr_accessor :info
     attr_reader :colvalues, :row, :col, :colwidths, :filler
     attr_reader :crow, :ccol

data/lib/rndk/mentry.rb

@@ -1,7 +1,7 @@
 require 'rndk'
 
 module RNDK
-  class MENTRY < RNDK::Widget
+  class MEntry < Widget
     attr_accessor :info, :current_col, :current_row, :top_row
     attr_reader :disp_type, :field_width, :rows, :field_win
 
@@ -158,7 +158,7 @@ module RNDK
       end
 
       # Register
-      rndkscreen.register(:MENTRY, self)
+      rndkscreen.register(:MEntry, self)
     end
 
     # This actually activates the mentry widget...
@@ -249,14 +249,14 @@ module RNDK
       # Check if there is a pre-process function to be called.
       unless @pre_process_func.nil?
         # Call the pre-process function
-        pp_return = @pre_process_func.call(:MENTRY, self,
+        pp_return = @pre_process_func.call(:MEntry, self,
             @pre_process_data, input)
       end
 
       # Should we continue?
       if pp_return != 0
         # Check for a key binding...
-        if self.checkBind(:MENTRY, input)
+        if self.checkBind(:MEntry, input)
           complete = true
         else
           moved = false
@@ -419,7 +419,7 @@ module RNDK
 
         # Should we do a post-process?
         if !complete && !(@post_process_func.nil?)
-          @post_process_func.call(:MENTRY, self, @post_process_data, input)
+          @post_process_func.call(:MEntry, self, @post_process_data, input)
         end
       end
 
@@ -519,10 +519,10 @@ module RNDK
       RNDK.window_delete(@win)
 
       # Clean the key bindings.
-      self.clean_bindings(:MENTRY)
+      self.clean_bindings(:MEntry)
 
       # Unregister this object.
-      RNDK::Screen.unregister(:MENTRY, self)
+      RNDK::Screen.unregister(:MEntry, self)
     end
 
     # This sets multiple attributes of the widget.
@@ -613,7 +613,7 @@ module RNDK
     end
 
     def object_type
-      :MENTRY
+      :MEntry
     end
   end
 end

data/lib/rndk/menu.rb

@@ -1,7 +1,7 @@
 require 'rndk'
 
 module RNDK
-  class MENU < RNDK::Widget
+  class MENU < Widget
     TITLELINES = 1
     MAX_MENU_ITEMS = 30
     MAX_SUB_ITEMS = 98

data/lib/rndk/radio.rb

@@ -1,7 +1,7 @@
 require 'rndk/scroller'
 
 module RNDK
-  class RADIO < RNDK::SCROLLER
+  class RADIO < SCROLLER
     def initialize(rndkscreen, xplace, yplace, splace, height, width, title,
         list, list_size, choice_char, def_item, highlight, box, shadow)
       super()

data/lib/rndk/scale.rb

@@ -1,7 +1,7 @@
 require 'rndk'
 
 module RNDK
-  class SCALE < RNDK::Widget
+  class SCALE < Widget
     def initialize(rndkscreen, xplace, yplace, title, label, field_attr,
         field_width, start, low, high, inc, fast_inc, box, shadow)
       super()

data/lib/rndk/scroll.rb

@@ -1,30 +1,100 @@
 require 'rndk/scroller'
 
 module RNDK
-  class SCROLL < RNDK::SCROLLER
+
+  # A scrolling list of text.
+  #
+  # ## Keybindings
+  #
+  # Left Arrow::  Shift the list left one column.
+  # Right Arrow:: Shift the list right one column.
+  # Up Arrow::    Select the previous item in the list.
+  # Down Arrow::  Select the next item in the list.
+  # Prev Page::   Scroll one page backward.
+  # Ctrl-B::      Scroll one page backward.
+  # Next Page::   Scroll one page forward.
+  # Ctrl-F::      Scroll one page forward.
+  # 1::           Move to the first element in the list.
+  # <::           Move to the first element in the list.
+  # g::           Move to the first element in the list.
+  # Home::        Move to the first element in the list.
+  # >::           Move to the last element in the list.
+  # G::           Move to the last element in the list.
+  # End::         Move to the last element in the list.
+  # $::           Shift the list to the far right.
+  # |::           Shift the list to the far left.
+  # Return::      Exit  the  widget and return the index
+  #               of the selected item. Also  set  the
+  #               widget `exit_type` to `:NORMAL`.
+  # Tab::         Exit  the  widget and return the index
+  #               of the selected item.   Also  set  the
+  #               widget `exit_type` to `:NORMAL`.
+  # Escape::      Exit the  widget and return -1.  Also
+  #               set the widget `exit_type` `:ESCAPE_HIT`.
+  # Ctrl-L::      Refreshes the screen.
+  #
+  class Scroll < SCROLLER
     attr_reader :item, :list_size, :current_item, :highlight
 
-    def initialize (rndkscreen, xplace, yplace, splace, height, width, title,
-        list, list_size, numbers, highlight, box, shadow)
+    # Creates a Scroll Widget.
+    #
+    # * `xplace` is the x position - can be an integer or
+    #   `RNDK::LEFT`, `RNDK::RIGHT`, `RNDK::CENTER`.
+    # * `yplace` is the y position - can be an integer or
+    #   `RNDK::TOP`, `RNDK::BOTTOM`, `RNDK::CENTER`.
+    # * `splace` is where the scrollbar will be placed.
+    #   It can be only `RNDK::LEFT`, `RNDK::RIGHT` or
+    #   `RNDK::NONE`, for no scrollbar.
+    # * `width`/`height` are integers - if either are 0, Widget
+    #   will be created with full width/height of the screen.
+    #   If it's a negative value, will create with full width/height
+    #   minus the value.
+    # * `title` can be more than one line - just split them
+    #   with `\n`s.
+    # * `list` is an Array of Strings to be shown on the Widget.
+    # * `numbers` is a flag to turn on/off line numbering at
+    #   the front of the list items.
+    # * `highlight` is the attribute/color of the currently selected
+    #   item at the list.
+    # * `box` if the Widget is drawn with a box outside it.
+    # * `shadow` turns on/off the shadow around the Widget.
+    #
+    def initialize (rndkscreen,
+                    xplace,
+                    yplace,
+                    splace,
+                    width,
+                    height,
+                    title,
+                    list,
+                    numbers,
+                    highlight,
+                    box,
+                    shadow)
       super()
-      parent_width = Ncurses.getmaxx(rndkscreen.window)
-      parent_height = Ncurses.getmaxy(rndkscreen.window)
-      box_width = width
+
+      parent_width  = Ncurses.getmaxx rndkscreen.window
+      parent_height = Ncurses.getmaxy rndkscreen.window
+
+      box_width  = width
       box_height = height
+
       xpos = xplace
       ypos = yplace
+
       scroll_adjust = 0
+
       bindings = {
         RNDK::BACKCHAR => Ncurses::KEY_PPAGE,
         RNDK::FORCHAR  => Ncurses::KEY_NPAGE,
-        'g'           => Ncurses::KEY_HOME,
-        '1'           => Ncurses::KEY_HOME,
-        'G'           => Ncurses::KEY_END,
-        '<'           => Ncurses::KEY_HOME,
-        '>'           => Ncurses::KEY_END
+        'g'            => Ncurses::KEY_HOME,
+        '1'            => Ncurses::KEY_HOME,
+        'G'            => Ncurses::KEY_END,
+        '<'            => Ncurses::KEY_HOME,
+        '>'            => Ncurses::KEY_END
       }
 
-      self.set_box(box)
+      self.set_box box
 
       # If the height is a negative value, the height will be ROWS-height,
       # otherwise the height will be the given height
@@ -38,7 +108,7 @@ module RNDK
 
       # Set the box height.
       if @title_lines > box_height
-        box_height = @title_lines + [list_size, 8].min + 2 * @border_size
+        box_height = @title_lines + [list.size, 8].min + 2 * @border_size
       end
 
       # Adjust the box width if there is a scroll bar
@@ -59,7 +129,7 @@ module RNDK
                     else box_height
                     end
 
-      self.setViewSize(list_size)
+      self.setViewSize(list.size)
 
       # Rejustify the x and y positions if we need to.
       xtmp = [xpos]
@@ -81,20 +151,27 @@ module RNDK
 
       # Create the scrollbar window.
       if splace == RNDK::RIGHT
-        @scrollbar_win = Ncurses.subwin(@win, self.maxViewSize, 1,
-            self.Screen_YPOS(ypos), xpos + box_width - @border_size - 1)
+        @scrollbar_win = Ncurses.subwin(@win,
+                                        self.maxViewSize,
+                                        1,
+                                        self.Screen_YPOS(ypos),
+                                        xpos + box_width - @border_size - 1)
       elsif splace == RNDK::LEFT
-        @scrollbar_win = Ncurses.subwin(@win, self.maxViewSize, 1,
-            self.Screen_YPOS(ypos), self.Screen_XPOS(xpos))
+        @scrollbar_win = Ncurses.subwin(@win,
+                                        self.maxViewSize,
+                                        1,
+                                        self.Screen_YPOS(ypos),
+                                        self.Screen_XPOS(xpos))
       else
         @scrollbar_win = nil
       end
 
       # create the list window
-      @list_win = Ncurses.subwin(@win, self.maxViewSize,
-          box_width - (2 * @border_size) - scroll_adjust,
-          self.Screen_YPOS(ypos),
-          self.Screen_XPOS(xpos) + (if splace == RNDK::LEFT then 1 else 0 end))
+      @list_win = Ncurses.subwin(@win,
+                                 self.maxViewSize,
+                                 box_width - (2 * @border_size) - scroll_adjust,
+                                 self.Screen_YPOS(ypos),
+                                 self.Screen_XPOS(xpos) + (if splace == RNDK::LEFT then 1 else 0 end))
 
       # Set the rest of the variables
       @screen = rndkscreen
@@ -112,33 +189,36 @@ module RNDK
       self.setPosition(0);
 
       # Create the scrolling list item list and needed variables.
-      if self.createItemList(numbers, list, list_size) <= 0
+      if self.createItemList(numbers, list, list.size) <= 0
         return nil
       end
 
       # Do we need to create a shadow?
       if shadow
-        @shadow_win = Ncurses.newwin(@box_height, box_width,
-            ypos + 1, xpos + 1)
+        @shadow_win = Ncurses.newwin(@box_height,
+                                     box_width,
+                                     ypos + 1,
+                                     xpos + 1)
       end
 
       # Set up the key bindings.
       bindings.each do |from, to|
-        #self.bind(:SCROLL, from, getc_lambda, to)
-        self.bind(:SCROLL, from, :getc, to)
+        #self.bind(:scroll, from, getc_lambda, to)
+        self.bind(:scroll, from, :getc, to)
       end
 
-      rndkscreen.register(:SCROLL, self);
+      rndkscreen.register(:scroll, self);
 
       return self
     end
 
     def object_type
-      :SCROLL
+      :scroll
     end
 
+    # @see Widget#position
     def position
-      super(@win)
+      super @win
     end
 
     # Put the cursor on the currently-selected item's row.
@@ -151,29 +231,31 @@ module RNDK
       Ncurses.wrefresh(@input_window)
     end
 
-    # This actually does all the 'real' work of managing the scrolling list.
-    def activate(actions)
+    # Activates the Widget, letting the user interact with it.
+    #
+    # `actions` is an Array of characters. If it's non-null,
+    # will #inject each char on it into the Widget.
+    #
+    def activate(actions=[])
       # Draw the scrolling list
       self.draw(@box)
 
       if actions.nil? || actions.size == 0
-        while true
+        loop do
           self.fixCursorPosition
           input = self.getch([])
 
           # Inject the character into the widget.
-          ret = self.inject(input)
-          if @exit_type != :EARLY_EXIT
-            return ret
-          end
+          ret = self.inject input
+
+          return ret if @exit_type != :EARLY_EXIT
         end
       else
         # Inject each character one at a time.
         actions.each do |action|
-          ret = self.inject(action)
-          if @exit_type != :EARLY_EXIT
-            return ret
-          end
+          ret = self.inject action
+
+          return ret if @exit_type != :EARLY_EXIT
         end
       end
 
@@ -182,8 +264,8 @@ module RNDK
       return -1
     end
 
-    # This injects a single character into the widget.
-    def inject(input)
+    # @see Widget#inject
+    def inject input
       pp_return = 1
       ret = -1
       complete = false
@@ -196,14 +278,14 @@ module RNDK
 
       #Check if there is a pre-process function to be called.
       unless @pre_process_func.nil?
-        pp_return = @pre_process_func.call(:SCROLL, self,
+        pp_return = @pre_process_func.call(:scroll, self,
             @pre_process_data, input)
       end
 
       # Should we continue?
       if pp_return != 0
         # Check for a predefined key binding.
-        if self.checkBind(:SCROLL, input) != false
+        if self.checkBind(:scroll, input) != false
           #self.checkEarlyExit
           complete = true
         else
@@ -245,7 +327,7 @@ module RNDK
         end
 
         if !complete && !(@post_process_func.nil?)
-          @post_process_func.call(:SCROLL, self, @post_process_data, input)
+          @post_process_func.call(:scroll, self, @post_process_data, input)
         end
       end
 
@@ -279,8 +361,8 @@ module RNDK
     # This moves the scroll field to the given location.
     def move(xplace, yplace, relative, refresh_flag)
       windows = [@win, @list_win, @shadow_win, @scrollbar_win]
-      self.move_specific(xplace, yplace, relative, refresh_flag,
-          windows, [])
+
+      self.move_specific(xplace, yplace, relative, refresh_flag, windows, [])
     end
 
     # This function draws the scrolling list widget.
@@ -311,7 +393,7 @@ module RNDK
           @item_len[@current_item])
     end
 
-    def drawList(box)
+    def drawList box
       # If the list is empty, don't draw anything.
       if @list_size > 0
         # Redraw the list
@@ -390,10 +472,10 @@ module RNDK
       RNDK.window_delete(@win)
 
       # Clean the key bindings.
-      self.clean_bindings(:SCROLL)
+      self.clean_bindings(:scroll)
 
       # Unregister this object
-      RNDK::Screen.unregister(:SCROLL, self)
+      RNDK::Screen.unregister(:scroll, self)
     end
 
     # This function erases the scrolling list from the screen.
@@ -592,12 +674,10 @@ module RNDK
 
         self.setViewSize(@list_size - 1)
 
-        if @list_size > 0
-          self.resequence
-        end
+        self.resequence if @list_size > 0
 
         if @list_size < self.maxViewSize
-          @win.werase  # force the next redraw to be complete
+          Ncurses.werase @win  # force the next redraw to be complete
         end
 
         # do this to update the view size, etc
@@ -629,5 +709,8 @@ module RNDK
     def WidestItem
       @max_left_char + self.AvailableWidth
     end
+
+    private
+
   end
 end

data/lib/rndk/scroller.rb

@@ -2,7 +2,13 @@ require 'rndk'
 
 module RNDK
 
-  class SCROLLER < RNDK::Widget
+  # Common actions and functionality between
+  # scrolling Widgets.
+  #
+  # @note Do **not** instantiate this class!
+  #       Use it's subclasses.
+  class SCROLLER < Widget
+
     def initialize
       super()
     end
@@ -181,5 +187,7 @@ module RNDK
     def setCurrentItem(item)
       self.setPosition(item);
     end
+
   end
 end
+

data/lib/rndk/selection.rb

@@ -2,7 +2,7 @@ require 'rndk/scroller'
 
 module RNDK
   # TODO This Widget's very buggy! Somehow improve it later!
-  class SELECTION < RNDK::SCROLLER
+  class SELECTION < SCROLLER
     attr_reader :selections
 
     def initialize(rndkscreen, xplace, yplace, splace, height, width, title,