rndk 0.2.0 → 1.0.0

data/lib/rndk/scroller.rb

@@ -7,13 +7,13 @@ module RNDK
   #
   # @note Do **not** instantiate this class!
   #       Use it's subclasses.
-  class SCROLLER < Widget
+  class Scroller < Widget
 
     def initialize
       super()
     end
 
-    def KEY_UP
+    def scroll_up
       if @list_size > 0
         if @current_item > 0
           if @current_high == 0
@@ -35,7 +35,7 @@ module RNDK
       end
     end
 
-    def KEY_DOWN
+    def scroll_down
       if @list_size > 0
         if @current_item < @list_size - 1
           if @current_high == @view_size - 1
@@ -57,7 +57,7 @@ module RNDK
       end
     end
 
-    def KEY_LEFT
+    def scroll_left
       if @list_size > 0
         if @left_char == 0
           RNDK.beep
@@ -69,7 +69,7 @@ module RNDK
       end
     end
 
-    def KEY_RIGHT
+    def scroll_right
       if @list_size > 0
         if @left_char >= @max_left_char
           RNDK.beep
@@ -81,14 +81,14 @@ module RNDK
       end
     end
 
-    def KEY_PPAGE
+    def scroll_page_up
       if @list_size > 0
         if @current_top > 0
           if @current_top >= @view_size - 1
             @current_top -= @view_size - 1
             @current_item -= @view_size - 1
           else
-            self.KEY_HOME
+            self.scroll_begin
           end
         else
           RNDK.beep
@@ -98,7 +98,7 @@ module RNDK
       end
     end
 
-    def KEY_NPAGE
+    def scroll_page_down
       if @list_size > 0
         if @current_top < @max_top_item
           if @current_top + @view_size - 1 <= @max_top_item
@@ -117,13 +117,13 @@ module RNDK
       end
     end
 
-    def KEY_HOME
+    def scroll_begin
       @current_top = 0
       @current_item = 0
       @current_high = 0
     end
 
-    def KEY_END
+    def scroll_end
       if @max_top_item == -1
         @current_top = 0
         @current_item = @last_item - 1
@@ -134,13 +134,13 @@ module RNDK
       @current_high = @view_size - 1
     end
 
-    def maxViewSize
+    def max_view_size
       return @box_height - (2 * @border_size + @title_lines)
     end
 
     # Set variables that depend upon the list_size
-    def setViewSize(list_size)
-      @view_size = self.maxViewSize
+    def set_view_size(list_size)
+      @view_size = self.max_view_size
       @list_size = list_size
       @last_item = list_size - 1
       @max_top_item = list_size - @view_size
@@ -150,9 +150,9 @@ module RNDK
         @max_top_item = 0
       end
 
-      if @list_size > 0 && self.maxViewSize > 0
-        @step = 1.0 * self.maxViewSize / @list_size
-        @toggle_size = if @list_size > self.maxViewSize
+      if @list_size > 0 && self.max_view_size > 0
+        @step = 1.0 * self.max_view_size / @list_size
+        @toggle_size = if @list_size > self.max_view_size
                        then 1
                        else @step.ceil
                        end
@@ -162,9 +162,9 @@ module RNDK
       end
     end
 
-    def setPosition(item)
+    def set_position(item)
       if item <= 0
-        self.KEY_HOME
+        self.scroll_begin
       elsif item > @list_size - 1
         @current_top = @max_top_item
         @current_item = @list_size - 1
@@ -180,12 +180,12 @@ module RNDK
     end
 
     # Get/Set the current item number of the scroller.
-    def getCurrentItem
+    def get_current_item
       @current_item
     end
 
-    def setCurrentItem(item)
-      self.setPosition(item);
+    def set_current_item(item)
+      self.set_position(item);
     end
 
   end

data/lib/rndk/slider.rb

@@ -15,18 +15,18 @@ module RNDK
   # Next Page::   Increments the field by the accelerated increment value.
   # D::           Increments the field by the accelerated increment value.
   # Ctrl-F::      Increments the field by the accelerated increment value.
-  # Home::        Sets the value to the low value.
-  # g::           Sets the value to the low value.
-  # End::         Sets the value to the high value.
-  # G::           Sets the value to the high value.
-  # $::           Sets the value to the high value.
+  # Home::        Sets the value to the minimum value.
+  # g::           Sets the value to the minimum value.
+  # End::         Sets the value to the maximum value.
+  # G::           Sets the value to the maximum value.
+  # $::           Sets the value to the maximum value.
   # Return::      Exits the widget and returns the current value. This also sets the widget data `exit_type` to `:NORMAL`.
   # Tab::         Exits the widget and returns the current value. This also sets the widget data `exit_type` to `:NORMAL`.
   # Escape::      Exits the widget and returns `nil`.  Also  sets the widget data `exit_type` to `:ESCAPE_HIT`.
   # Ctrl-L::      Refreshes the screen.
   #
   # If the cursor  is not pointing to the field's value,
-  # the following key bindings apply.
+  # the folminimuming key bindings apply.
   #
   # You may use the left/right arrows to move the cursor
   # onto the field's value and modify it by typing characters
@@ -38,15 +38,15 @@ module RNDK
   # D::           Increments the scale by the accelerated value.
   # -::           Decrements the scale by the normal value.
   # +::           Increments the scale by the normal value.
-  # 0::           Sets the scale to the low value.
+  # 0::           Sets the scale to the minimum value.
   #
   class Slider < Widget
 
     # Creates a new Slider Widget.
     #
-    # * `xplace` is the x position - can be an integer or
+    # * `x` 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
+    # * `y` is the y position - can be an integer or
     #   `RNDK::TOP`, `RNDK::BOTTOM`, `RNDK::CENTER`.
     # * `title` can be more than one line - just split them
     #   with `\n`s.
@@ -59,54 +59,63 @@ module RNDK
     #   If it's a negative value, will create with full width
     #   minus that value.
     # * `start` is the initial value of the widget.
-    # * `low`/`high` are the minimum and maximum values of
+    # * `minimum`/`maximum` are the minimum and maximum values of
     #   the slider.
     # * `inc` is the increment value.
     # * `fast_inc` is the accelerated increment value.
     # * `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,
-                   title,
-                   label,
-                   filler,
-                   field_width,
-                   start,
-                   low,
-                   high,
-                   inc,
-                   fast_inc,
-                   box,
-                   shadow)
+    def initialize(screen, config={})
       super()
+      @widget_type = :slider
+      @supported_signals += [:before_input, :after_input]
+
+      x           = 0
+      y           = 0
+      title       = "slider"
+      label       = "label"
+      filler      = ' '.ord | RNDK::Color[:reverse]
+      field_width = 0
+      start       = 0
+      minimum     = 0
+      maximum     = 100
+      increment   = 1
+      fast_increment    = 5
+      box         = true
+      shadow      = false
+
+      config.each do |key, val|
+        x           = val if key == :x
+        y           = val if key == :y
+        title       = val if key == :title
+        label       = val if key == :label
+        filler      = val if key == :filler
+        field_width = val if key == :field_width
+        start       = val if key == :start
+        minimum     = val if key == :minimum
+        maximum     = val if key == :maximum
+        increment   = val if key == :inc
+        fast_increment    = val if key == :fast_inc
+        box         = val if key == :box
+        shadow      = val if key == :shadow
+      end
 
-      parent_width  = Ncurses.getmaxx(rndkscreen.window)
-      parent_height = Ncurses.getmaxy(rndkscreen.window)
-
-      bindings = {
-          'u'           => Ncurses::KEY_UP,
-          'U'           => Ncurses::KEY_PPAGE,
-          RNDK::BACKCHAR => Ncurses::KEY_PPAGE,
-          RNDK::FORCHAR  => Ncurses::KEY_NPAGE,
-          'g'           => Ncurses::KEY_HOME,
-          '^'           => Ncurses::KEY_HOME,
-          'G'           => Ncurses::KEY_END,
-          '$'           => Ncurses::KEY_END,
-      }
-      self.set_box(box)
+      parent_width  = Ncurses.getmaxx screen.window
+      parent_height = Ncurses.getmaxy screen.window
+
+      self.set_box box
       box_height = @border_size * 2 + 1
 
       # Set some basic values of the widget's data field.
       @label = []
       @label_len = 0
       @label_win = nil
-      high_value_len = self.formattedSize(high)
+      maximum_value_len = self.formattedSize maximum
 
       # If the field_width is a negative will be COLS-field_width,
       # otherwise field_width will be the given width.
-      field_width = RNDK.setWidgetDimension(parent_width, field_width, 0)
+      field_width = RNDK.set_widget_dimension(parent_width, field_width, 0)
 
       # Translate the label string to a chtype array.
       if !(label.nil?) && label.size > 0
@@ -114,9 +123,9 @@ module RNDK
         @label = RNDK.char2Chtype(label, label_len, [])
         @label_len = label_len[0]
         box_width = @label_len + field_width +
-            high_value_len + 2 * @border_size
+            maximum_value_len + 2 * @border_size
       else
-        box_width = field_width + high_value_len + 2 * @border_size
+        box_width = field_width + maximum_value_len + 2 * @border_size
       end
 
       old_width = box_width
@@ -128,12 +137,12 @@ module RNDK
       # Make sure we didn't extend beyond the dimensions of the window.
       box_width = [box_width, parent_width].min
       box_height = [box_height, parent_height].min
-      field_width = [field_width, box_width - @label_len - high_value_len - 1].min
+      field_width = [field_width, box_width - @label_len - maximum_value_len - 1].min
 
       # Rejustify the x and y positions if we need to.
-      xtmp = [xplace]
-      ytmp = [yplace]
-      RNDK.alignxy(rndkscreen.window, xtmp, ytmp, box_width, box_height)
+      xtmp = [x]
+      ytmp = [y]
+      RNDK.alignxy(screen.window, xtmp, ytmp, box_width, box_height)
       xpos = xtmp[0]
       ypos = ytmp[0]
 
@@ -162,7 +171,7 @@ module RNDK
       # Create the widget's data field window.
       @field_win = Ncurses.subwin(@win,
                                   1,
-                                  field_width + high_value_len - 1,
+                                  field_width + maximum_value_len - 1,
                                   ypos + @title_lines + @border_size,
                                   xpos + @label_len + horizontal_adjust + @border_size)
 
@@ -174,26 +183,26 @@ module RNDK
       Ncurses.keypad(@win, true)
 
       # Create the widget's data field.
-      @screen = rndkscreen
-      @window = rndkscreen.window
+      @screen = screen
+      @window = screen.window
       @shadow_win = nil
       @box_width = box_width
       @box_height = box_height
       @field_width = field_width - 1
       @filler = filler
-      @low = low
-      @high = high
+      @minimum = minimum
+      @maximum = maximum
       @current = start
-      @inc = inc
-      @fastinc = fast_inc
+      @increment = increment
+      @fast_increment = fast_increment
       @accepts_focus = true
       @input_window = @win
       @shadow = shadow
       @field_edit = 0
 
       # Set the start value.
-      if start < low
-        @current = low
+      if start < minimum
+        @current = minimum
       end
 
       # Do we want a shadow?
@@ -209,11 +218,14 @@ module RNDK
       end
 
       # Setup the key bindings.
-      bindings.each do |from, to|
-        self.bind(:slider, from, :getc, to)
-      end
-
-      rndkscreen.register(:slider, self)
+      self.bind_key('u') { self.increment @increment      }
+      self.bind_key('U') { self.increment @fast_increment }
+      self.bind_key('g') { @current = @minimum            }
+      self.bind_key('^') { @current = @minimum            }
+      self.bind_key('G') { @current = @maximum            }
+      self.bind_key('$') { @current = @maximum            }
+
+      screen.register(@widget_type, self)
     end
 
     # Activates the Widget, letting the user interact with it.
@@ -223,11 +235,11 @@ module RNDK
     #
     # @return The current value of the slider.
     def activate(actions=[])
-      self.draw @box
+      self.draw
 
       if actions.nil? || actions.size == 0
         while true
-          input = self.getch([])
+          input = self.getch
 
           # Inject the character into the widget.
           ret = self.inject(input)
@@ -250,13 +262,13 @@ module RNDK
       return nil
     end
 
-    # Check if the value lies outside the low/high range. If so, force it in.
+    # Check if the value lies outside the minimum/maximum range. If so, force it in.
     def limitCurrentValue
-      if @current < @low
-        @current = @low
+      if @current < @minimum
+        @current = @minimum
         RNDK.beep
-      elsif @current > @high
-        @current = @high
+      elsif @current > @maximum
+        @current = @maximum
         RNDK.beep
       end
     end
@@ -278,7 +290,7 @@ module RNDK
         return false
       end
       ch = Ncurses.winch(@field_win)
-      if RNDK.CharOf(ch) != ' '
+      if RNDK.char_of(ch) != ' '
         return true
       end
       if new_position > 1
@@ -287,13 +299,13 @@ module RNDK
           return false
         end
         ch = Ncurses.winch(@field_win)
-        return RNDK.CharOf(ch) != ' '
+        return RNDK.char_of(ch) != ' '
       end
       return false
     end
 
     # Set the edit position.  Normally the cursor is one cell to the right of
-    # the editable field.  Moving it left, over the field, allows the user to
+    # the editable field.  Moving it left, over the field, alminimums the user to
     # modify cells by typing in replacement characters for the field's value.
     def setEditPosition(new_position)
       if new_position < 0
@@ -351,8 +363,8 @@ module RNDK
       end
       if modify &&
           ((value, test) = temp.scanf(self.SCAN_FMT)).size == 2 &&
-          test == ' ' && value >= @low && value <= @high
-        self.setValue(value)
+          test == ' ' && value >= @minimum && value <= @maximum
+        self.set_value(value)
         result = true
       end
       return result
@@ -376,28 +388,24 @@ module RNDK
 
     # @see Widget#inject
     def inject input
-      pp_return = 1
+      pp_return = true
       ret = nil
       complete = false
 
-      # Set the exit type.
-      self.set_exit_type(0)
+      self.set_exit_type 0
 
-      # Draw the field.
-      self.drawField
+      self.draw_field
 
       # 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(:slider, self,
-            @pre_process_data, input)
-      end
+      keep_going = self.run_signal_binding(:before_input, input)
+
+      if keep_going
 
-      # Should we continue?
-      if pp_return != 0
         # Check for a key binding.
-        if self.checkBind(:slider, input)
-          complete = true
+        if self.is_bound? input
+          self.run_key_binding input
+          #complete = true
+
         else
           case input
           when Ncurses::KEY_LEFT
@@ -405,17 +413,17 @@ module RNDK
           when Ncurses::KEY_RIGHT
             self.setEditPosition(@field_edit - 1)
           when Ncurses::KEY_DOWN
-            @current = RNDK::Slider.Decrement(@current, @inc)
+            self.decrement @increment
           when Ncurses::KEY_UP
-            @current = RNDK::Slider.Increment(@current, @inc)
-          when Ncurses::KEY_PPAGE
-            @current = RNDK::Slider.Increment(@current, @fastinc)
-          when Ncurses::KEY_NPAGE
-            @current = RNDK::Slider.Decrement(@current, @fastinc)
+            self.increment @increment
+          when Ncurses::KEY_PPAGE, RNDK::BACKCHAR
+            self.increment @fast_increment
+          when Ncurses::KEY_NPAGE, RNDK::FORCHAR
+            self.decrement @fast_increment
           when Ncurses::KEY_HOME
-            @current = @low
+            @current = @minimum
           when Ncurses::KEY_END
-            @current = @high
+            @current = @maximum
           when RNDK::KEY_TAB, RNDK::KEY_RETURN, Ncurses::KEY_ENTER
             self.set_exit_type(input)
             ret = @current
@@ -453,16 +461,12 @@ module RNDK
           end
         end
         self.limitCurrentValue
-
-        # Should we call a post-process?
-        if !complete && !(@post_process_func.nil?)
-          @post_process_func.call(:slider, self, @post_process_data, input)
-        end
+        self.run_signal_binding(:after_input) if not complete
       end
 
-      if !complete
-        self.drawField
-        self.set_exit_type(0)
+      if not complete
+        self.draw_field
+        self.set_exit_type 0
       end
 
       @return_data = 0
@@ -470,24 +474,24 @@ module RNDK
     end
 
     # @see Widget#move
-    def move(xplace, yplace, relative, refresh_flag)
+    def move(x, y, relative, refresh_flag)
       windows = [@win, @label_win, @field_win, @shadow_win]
 
-      self.move_specific(xplace, yplace, relative, refresh_flag, windows, [])
+      self.move_specific(x, y, relative, refresh_flag, windows, [])
     end
 
     # Draws the Widget on the Screen.
     #
     # If `box` is true, it is drawn with a box.
-    def draw box
+    def draw
 
       # Draw the shadow.
       Draw.drawShadow(@shadow_win) unless @shadow_win.nil?
 
       # Box the widget if asked.
-      Draw.drawObjBox(@win, self) if box
+      Draw.drawObjBox(@win, self) if @box
 
-      self.drawTitle @win
+      self.draw_title @win
 
       # Draw the label.
       unless @label_win.nil?
@@ -498,15 +502,15 @@ module RNDK
       Ncurses.wrefresh @win
 
       # Draw the field window.
-      self.drawField
+      self.draw_field
     end
 
     # This draws the widget.
-    def drawField
-      step = 1.0 * @field_width / (@high - @low)
+    def draw_field
+      step = 1.0 * @field_width / (@maximum - @minimum)
 
       # Determine how many filler characters need to be drawn.
-      filler_characters = (@current - @low) * step
+      filler_characters = (@current - @minimum) * step
 
       Ncurses.werase(@field_win)
 
@@ -517,14 +521,14 @@ module RNDK
 
       # Draw the value in the field.
       Draw.writeCharAttrib(@field_win, @field_width, 0, @current.to_s,
-          Ncurses::A_NORMAL, RNDK::HORIZONTAL, 0, @current.to_s.size)
+          RNDK::Color[:normal], RNDK::HORIZONTAL, 0, @current.to_s.size)
 
       self.moveToEditPosition(@field_edit)
       Ncurses.wrefresh(@field_win)
     end
 
     # This sets the background attribute of the widget.
-    def set_bg_attrib(attrib)
+    def set_bg_color(attrib)
       # Set the widget's background attribute.
       Ncurses.wbkgd(@win, attrib)
       Ncurses.wbkgd(@field_win, attrib)
@@ -533,7 +537,7 @@ module RNDK
 
     # @see Widget#destroy
     def destroy
-      self.cleanTitle
+      self.clean_title
       @label = []
 
       # Clean up the windows.
@@ -543,15 +547,15 @@ module RNDK
       RNDK.window_delete(@win)
 
       # Clean the key bindings.
-      self.clean_bindings(:slider)
+      self.clean_bindings
 
-      # Unregister this object.
-      RNDK::Screen.unregister(:slider, self)
+      # Unregister this widget.
+      @screen.unregister self
     end
 
     # @see Widget#erase
     def erase
-      if self.valid_widget?
+      if self.valid?
         RNDK.window_erase @label_win
         RNDK.window_erase @field_win
         RNDK.window_erase @lwin
@@ -563,52 +567,52 @@ module RNDK
       return value.to_s.size
     end
 
-    # This function sets the low/high/current values of the widget.
-    def set(low, high, value, box)
-      self.setLowHigh(low, high)
-      self.setValue(value)
+    # This function sets the minimum/maximum/current values of the widget.
+    def set(minimum, maximum, value, box)
+      self.setMinimumMaximum(minimum, maximum)
+      self.set_value(value)
       self.set_box(box)
     end
 
     # This sets the widget's value.
-    def setValue(value)
+    def set_value(value)
       @current = value
       self.limitCurrentValue
     end
 
-    def getValue
+    def get_value
       return @current
     end
 
-    # This function sets the low/high values of the widget.
-    def setLowHigh(low, high)
+    # This function sets the minimum/maximum values of the widget.
+    def setMinimumMaximum(minimum, maximum)
       # Make sure the values aren't out of bounds.
-      if low <= high
-        @low = low
-        @high = high
-      elsif low > high
-        @low = high
-        @high = low
+      if minimum <= maximum
+        @minimum = minimum
+        @maximum = maximum
+      elsif minimum > maximum
+        @minimum = maximum
+        @maximum = minimum
       end
 
       # Make sure the user hasn't done something silly.
       self.limitCurrentValue
     end
 
-    def getLowValue
-      return @low
+    def getMinimumValue
+      return @minimum
     end
 
-    def getHighValue
-      return @high
+    def getMaximumValue
+      return @maximum
     end
 
     def focus
-      self.draw(@box)
+      self.draw
     end
 
     def unfocus
-      self.draw(@box)
+      self.draw
     end
 
     def SCAN_FMT
@@ -619,8 +623,13 @@ module RNDK
       super(@win)
     end
 
-    def object_type
-      :slider
+    def decrement by
+      @current = @current - by if (@current - by) < @current
     end
+
+    def increment by
+      @current = @current + by if (@current + by) > @current
+    end
+
   end
 end