rndk 0.0.1 → 0.1.0

data/lib/rndk/graph.rb

@@ -14,11 +14,11 @@ module RNDK
       parent_width = Ncurses.getmaxx rndkscreen.window
       parent_height = Ncurses.getmaxy rndkscreen.window
 
-      self.setBox(false)
+      self.set_box(false)
 
       box_height = RNDK.setWidgetDimension(parent_height, height, 3)
       box_width = RNDK.setWidgetDimension(parent_width, width, 0)
-      box_width = self.setTitle(title, box_width)
+      box_width = self.set_title(title, box_width)
       box_height += @title_lines
       box_width = [parent_width, box_width].min
       box_height = [parent_height, box_height].min
@@ -236,7 +236,7 @@ module RNDK
     end
 
     # Set the background attribute of the widget.
-    def setBKattr(attrib)
+    def set_bg_attrib(attrib)
       Ncurses.wbkgd(@win, attrib)
     end
 
@@ -266,11 +266,11 @@ module RNDK
       ydiff = current_y - ypos
 
       # Move the window to the new location.
-      RNDK.moveCursesWindow(@win, -xdiff, -ydiff)
-      RNDK.moveCursesWindow(@shadow_win, -xdiff, -ydiff)
+      RNDK.window_move(@win, -xdiff, -ydiff)
+      RNDK.window_move(@shadow_win, -xdiff, -ydiff)
 
       # Touch the windows so they 'move'.
-      RNDK::Screen.refresh_window(@screen.window)
+      RNDK.window_refresh(@screen.window)
 
       # Reraw the windowk if they asked for it
       if refresh_flag
@@ -378,14 +378,14 @@ module RNDK
 
     def destroy
       self.cleanTitle
-      self.cleanBindings(:GRAPH)
+      self.clean_bindings(:GRAPH)
       RNDK::Screen.unregister(:GRAPH, self)
-      RNDK.deleteCursesWindow(@win)
+      RNDK.window_delete(@win)
     end
 
     def erase
-      if self.validRNDKObject
-        RNDK.eraseCursesWindow(@win)
+      if self.valid_widget?
+        RNDK.window_erase(@win)
       end
     end
 

data/lib/rndk/histogram.rb

@@ -8,7 +8,7 @@ module RNDK
       parent_width = Ncurses.getmaxx(rndkscreen.window)
       parent_height = Ncurses.getmaxy(rndkscreen.window)
 
-      self.setBox(box)
+      self.set_box(box)
 
       box_height = RNDK.setWidgetDimension(parent_height, height, 2)
       old_height = box_height
@@ -16,7 +16,7 @@ module RNDK
       box_width = RNDK.setWidgetDimension(parent_width, width, 0)
       old_width = box_width
 
-      box_width = self.setTitle(title, -(box_width + 1))
+      box_width = self.set_title(title, -(box_width + 1))
 
       # Increment the height by number of lines in in the title
       box_height += @title_lines
@@ -99,7 +99,7 @@ module RNDK
       self.setValue(low, high, value)
       self.setFillerChar(filler)
       self.setStatsAttr(stats_attr)
-      self.setBox(box)
+      self.set_box(box)
     end
 
     # Set the values for the widget.
@@ -308,7 +308,7 @@ module RNDK
     end
 
     # Set the background attribute of the widget.
-    def setBKattr(attrib)
+    def set_bg_attrib(attrib)
       Ncurses.wbkgd(@win, attrib)
     end
 
@@ -387,11 +387,11 @@ module RNDK
       self.cleanTitle
 
       # Clean up the windows.
-      RNDK.deleteCursesWindow(@shadow_win)
-      RNDK.deleteCursesWindow(@win)
+      RNDK.window_delete(@shadow_win)
+      RNDK.window_delete(@win)
 
       # Clean the key bindings.
-      self.cleanBindings(:HISTOGRAM)
+      self.clean_bindings(:HISTOGRAM)
 
       # Unregister this object.
       RNDK::Screen.unregister(:HISTOGRAM, self)
@@ -399,9 +399,9 @@ module RNDK
 
     # Erase the widget from the screen.
     def erase
-      if self.validRNDKObject
-        RNDK.eraseCursesWindow(@win)
-        RNDK.eraseCursesWindow(@shadow_win)
+      if self.valid_widget?
+        RNDK.window_erase(@win)
+        RNDK.window_erase(@shadow_win)
       end
     end
 

data/lib/rndk/itemlist.rb

@@ -14,7 +14,7 @@ module RNDK
         return nil
       end
 
-      self.setBox(box)
+      self.set_box(box)
       box_height = (@border_size * 2) + 1
 
       # Set some basic values of the item list
@@ -32,7 +32,7 @@ module RNDK
       # Set the box width. Allow an extra char in field width for cursor
       field_width = self.maximumFieldWidth + 1
       box_width = field_width + @label_len + 2 * @border_size
-      box_width = self.setTitle(title, box_width)
+      box_width = self.set_title(title, box_width)
       box_height += @title_lines
 
       # Make sure we didn't extend beyond the dimensions of the window
@@ -137,7 +137,7 @@ module RNDK
       end
 
       # Set the exit type and exit.
-      self.setExitType(0)
+      self.set_exit_type(0)
       return ret
     end
 
@@ -148,7 +148,7 @@ module RNDK
       complete = false
 
       # Set the exit type.
-      self.setExitType(0)
+      self.set_exit_type(0)
 
       # Draw the widget field
       self.drawField(true)
@@ -185,13 +185,13 @@ module RNDK
           when '$'.ord
             @current_item = @list_size - 1
           when RNDK::KEY_ESC
-            self.setExitType(input)
+            self.set_exit_type(input)
             complete = true
           when Ncurses::ERR
-            self.setExitType(input)
+            self.set_exit_type(input)
             complete = true
           when RNDK::KEY_TAB, RNDK::KEY_RETURN, Ncurses::KEY_ENTER
-            self.setExitType(input)
+            self.set_exit_type(input)
             ret = @current_item
             complete = true
           when RNDK::REFRESH
@@ -210,7 +210,7 @@ module RNDK
 
       if !complete
         self.drawField(true)
-        self.setExitType(0)
+        self.set_exit_type(0)
       end
 
       @result_data = ret
@@ -251,7 +251,7 @@ module RNDK
     end
 
     # This sets the background attribute of the widget
-    def setBKattr(attrib)
+    def set_bg_attrib(attrib)
       Ncurses.wbkgd(@win, attrib)
       Ncurses.wbkgd(@field_win, attrib)
       Ncurses.wbkgd(@label_win, attrib) unless @label_win.nil?
@@ -285,11 +285,11 @@ module RNDK
 
     # This function removes the widget from the screen.
     def erase
-      if self.validRNDKObject
-        RNDK.eraseCursesWindow(@field_win)
-        RNDK.eraseCursesWindow(@label_win)
-        RNDK.eraseCursesWindow(@win)
-        RNDK.eraseCursesWindow(@shadow_win)
+      if self.valid_widget?
+        RNDK.window_erase(@field_win)
+        RNDK.window_erase(@label_win)
+        RNDK.window_erase(@win)
+        RNDK.window_erase(@shadow_win)
       end
     end
 
@@ -304,13 +304,13 @@ module RNDK
       self.destroyInfo
 
       # Delete the windows
-      RNDK.deleteCursesWindow(@field_win)
-      RNDK.deleteCursesWindow(@label_win)
-      RNDK.deleteCursesWindow(@shadow_win)
-      RNDK.deleteCursesWindow(@win)
+      RNDK.window_delete(@field_win)
+      RNDK.window_delete(@label_win)
+      RNDK.window_delete(@shadow_win)
+      RNDK.window_delete(@win)
 
       # Clean the key bindings.
-      self.cleanBindings(:ITEMLIST)
+      self.clean_bindings(:ITEMLIST)
 
       RNDK::Screen.unregister(:ITEMLIST, self)
     end
@@ -318,7 +318,7 @@ module RNDK
     # This sets multiple attributes of the widget.
     def set(list, count, current, box)
       self.setValues(list, count, current)
-      self.setBox(box)
+      self.set_box(box)
     end
 
     # This function sets the contents of the list

data/lib/rndk/label.rb

@@ -2,26 +2,41 @@ require 'rndk'
 
 module RNDK
 
+  # Pop-up Label window.
+  #
   class LABEL < RNDK::Widget
 
     # Raw Ncurses window.
     attr_accessor :win
 
-    def initialize(rndkscreen, xplace, yplace, mesg, rows, box, shadow)
+    # Creates a Label 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`.
+    # * `message` is an Array of Strings with all the lines you'd want
+    #   to show. RNDK markup applies (see RNDK#Markup).
+    # * `box` if the Widget is drawn with a box outside it.
+    # * `shadow` turns on/off the shadow around the Widget.
+    #
+    # If the Widget cannot be created, returns `nil`.
+    def initialize(rndkscreen, xplace, yplace, mesg, box, shadow)
+      return nil if mesg.class != Array or mesg.empty?
+
       super()
+      rows = mesg.size
 
-      parent_width  = Ncurses.getmaxx(rndkscreen.window)
-      parent_height = Ncurses.getmaxy(rndkscreen.window)
+      parent_width  = Ncurses.getmaxx rndkscreen.window
+      parent_height = Ncurses.getmaxy rndkscreen.window
       box_width  = -2**30  # -INFINITY
       box_height = 0
       xpos = [xplace]
       ypos = [yplace]
       x = 0
 
-      return nil if rows <= 0
-
-      self.setBox box
-      box_height = rows + 2 * @border_size
+      self.set_box box
+      box_height = rows + 2*@border_size
 
       @info = []
       @info_len = []
@@ -43,7 +58,7 @@ module RNDK
 
       # Create the string alignments.
       (0...rows).each do |x|
-        @info_pos[x] = RNDK.justifyString(box_width - 2 * @border_size,
+        @info_pos[x] = RNDK.justifyString(box_width - 2*@border_size,
                                           @info_len[x],
                                           @info_pos[x])
       end
@@ -93,20 +108,25 @@ module RNDK
       rndkscreen.register(:LABEL, self)
     end
 
-    # This was added for the builder.
-    def activate(actions)
-      self.draw(@box)
+    # Obsolete entrypoint which calls Label#draw.
+    def activate(actions=[])
+      self.draw @box
     end
 
-    # This sets multiple attributes of the widget
-    def set(mesg, lines, box)
-      self.setMessage(mesg, lines)
-      self.setBox(box)
+    # Sets multiple attributes of the Widget.
+    #
+    # See Label#initialize.
+    def set(mesg, box)
+      self.set_message mesg
+      self.set_box box
     end
 
-    # This sets the information within the label.
-    def setMessage(info, info_size)
+    # Sets the contents of the Label Widget.
+    # @note `info` is an Array of Strings.
+    def set_message info
+      return if info.class != Array or info.empty?
 
+      info_size = info.size
       # Clean out the old message.
       (0...@rows).each do |x|
         @info[x]     = ''
@@ -132,10 +152,11 @@ module RNDK
 
       # Redraw the label widget.
       self.erase
-      self.draw(@box)
+      self.draw @box
     end
 
-    def getMessage(size)
+    # Returns current contents of the Widget.
+    def get_message(size)
       size << @rows
       return @info
     end
@@ -148,13 +169,15 @@ module RNDK
       super(@win)
     end
 
-    # This sets the background attribute of the widget.
-    def setBKattr(attrib)
+    # Sets the background attribute/color of the widget.
+    def set_bg_attrib attrib
       Ncurses.wbkgd(@win, attrib)
     end
 
-    # This draws the label widget.
-    def draw(box)
+    # Draws the Label Widget on the Screen.
+    #
+    # If `box` is `true`, the Widget is drawn with a box.
+    def draw(box=false)
 
       # Is there a shadow?
       Draw.drawShadow(@shadow_win) unless @shadow_win.nil?
@@ -178,38 +201,36 @@ module RNDK
 
     # This erases the label widget
     def erase
-      RNDK.eraseCursesWindow(@win)
-      RNDK.eraseCursesWindow(@shadow_win)
+      RNDK.window_erase @win
+      RNDK.window_erase @shadow_win
     end
 
-    # This moves the label field to the given location
-    # Inherited
-    # def move(xplace, yplace, relative, refresh_flag)
-    # end
-
-    # This destroys the label object pointer.
+    # Removes the Widget from the Screen, deleting it's
+    # internal windows.
     def destroy
-      RNDK.deleteCursesWindow(@shadow_win)
-      RNDK.deleteCursesWindow(@win)
+      RNDK.window_delete @shadow_win
+      RNDK.window_delete @win
 
-      self.cleanBindings(:LABEL)
+      self.clean_bindings :LABEL
 
       RNDK::Screen.unregister(:LABEL, self)
     end
 
-    # This pauses until a user hits a key...
-    def wait(key)
-      function_key = []
+    # Waits for the user to press a key.
+    #
+    # If no key is provided, waits for a
+    # single keypress of any key.
+    def wait(key=0)
 
       if key.ord == 0
-        code = self.getch(function_key)
-
-      else
-        # Only exit when a specific key is hit
-        while true
-          code = self.getch(function_key)
-          break if code == key.ord
-        end
+        code = self.getch
+        return code
+      end
+
+      # Only exit when a specific key is hit
+      loop do
+        code = self.getch
+        break if code == key.ord
       end
       code
     end

data/lib/rndk/marquee.rb

@@ -12,7 +12,7 @@ module RNDK
       @width = width
       @shadow = shadow
 
-      self.setBox(box)
+      self.set_box(box)
       if @win.nil?
         self.destroy
         # return (0);
@@ -37,7 +37,7 @@ module RNDK
       end
 
       # Keep the box info, setting BorderOf()
-      self.setBox(box)
+      self.set_box(box)
 
       padding = if mesg[-1] == ' ' then 0 else 1 end
 
@@ -158,11 +158,11 @@ module RNDK
     # This destroys the widget.
     def destroy
       # Clean up the windows.
-      RNDK.deleteCursesWindow(@shadow_win)
-      RNDK.deleteCursesWindow(@win)
+      RNDK.window_delete(@shadow_win)
+      RNDK.window_delete(@win)
 
       # Clean the key bindings.
-      self.cleanBindings(:MARQUEE)
+      self.clean_bindings(:MARQUEE)
 
       # Unregister this object.
       RNDK::Screen.unregister(:MARQUEE, self)
@@ -170,14 +170,14 @@ module RNDK
 
     # This erases the widget.
     def erase
-      if self.validRNDKObject
-        RNDK.eraseCursesWindow(@win)
-        RNDK.eraseCursesWindow(@shadow_win)
+      if self.valid_widget?
+        RNDK.window_erase(@win)
+        RNDK.window_erase(@shadow_win)
       end
     end
 
     # This sets the widgets box attribute.
-    def setBox(box)
+    def set_box(box)
       xpos = if @win.nil? then 0 else Ncurses.getbegx(@win) end
       ypos = if @win.nil? then 0 else Ncurses.getbegy(@win) end
 
@@ -195,7 +195,7 @@ module RNDK
     end
 
     # This sets the background attribute of the widget.
-    def setBKattr(attrib)
+    def set_bg_attrib(attrib)
       Ncurses.wbkgd(@win, attrib)
     end
 

data/lib/rndk/matrix.rb

@@ -31,7 +31,7 @@ module RNDK
           RNDK::BACKCHAR => Ncurses::KEY_PPAGE,
       }
 
-      self.setBox(box)
+      self.set_box(box)
       borderw = if @box then 1 else 0 end
 
       # Make sure that the number of rows/cols/vrows/vcols is not zero.
@@ -108,7 +108,7 @@ module RNDK
       end
       max_width -= (col_space - 1)
       box_width = [max_width, box_width].max
-      box_width = self.setTitle(title, box_width)
+      box_width = self.set_title(title, box_width)
 
       # Make sure the dimensions of the window didn't extend
       # beyond the dimensions of the parent window
@@ -228,7 +228,7 @@ module RNDK
       @shadow_win = nil
       @callbackfn = lambda do |matrix, input|
         disptype = matrix.colvanlues[matrix.col]
-        plainchar = Display.filterByDisplayType(disptype, input)
+        plainchar = Display.filter_by_display_type(disptype, input)
         charcount = matrix.info[matrix.row][matrix.col].size
 
         if plainchar == Ncurses::ERR
@@ -241,7 +241,7 @@ module RNDK
                         1,
                         matrix.info[matrix.row][matrix.col].size + 1)
           Ncurses.waddch(matrix.CurMatrixCell,
-                         if Display.isHiddenDisplayType(disptype)
+                         if Display.is_hidden_display_type(disptype)
                          then matrix.filler
                          else plainchar
                          end)
@@ -307,7 +307,7 @@ module RNDK
       end
 
       # Set the exit type and exit.
-      self.setExitType(0)
+      self.set_exit_type(0)
       return -1
     end
 
@@ -321,7 +321,7 @@ module RNDK
       complete = false
 
       # Set the exit type.
-      self.setExitType(0)
+      self.set_exit_type(0)
 
       # Move the cursor to the correct position within the cell.
       if @colwidths[@ccol] == 1
@@ -542,11 +542,11 @@ module RNDK
               self.drawOldCell
             end
             Ncurses.wrefresh self.CurMatrixCell
-            self.setExitType(input)
+            self.set_exit_type(input)
             ret = 1
             complete = true
           when Ncurses::ERR
-            self.setExitType(input)
+            self.set_exit_type(input)
             complete = true
           when RNDK::KEY_ESC
             if !@box_cell
@@ -556,7 +556,7 @@ module RNDK
               self.drawOldCell
             end
             Ncurses.wrefresh self.CurMatrixCell
-            self.setExitType(input)
+            self.set_exit_type(input)
             complete = true
           when RNDK::REFRESH
             @screen.erase
@@ -612,7 +612,7 @@ module RNDK
         @oldvcol = @col
 
         # Set the exit type and exit.
-        self.setExitType(0)
+        self.set_exit_type(0)
       end
 
       @result_data = ret
@@ -635,7 +635,7 @@ module RNDK
 
       # If the column is only one char.
       (1..@colwidths[@ccol]).each do |x|
-        ch = if x <= infolen && !Display.isHiddenDisplayType(disptype)
+        ch = if x <= infolen && !Display.is_hidden_display_type(disptype)
              then RNDK.CharOf(@info[@row][@col][x - 1])
              else @filler
              end
@@ -677,7 +677,7 @@ module RNDK
 
       # Draw in the cell info.
       (1..@colwidths[col]).each do |x|
-        ch = if x <= infolen && !Display.isHiddenDisplayType(disptype)
+        ch = if x <= infolen && !Display.is_hidden_display_type(disptype)
              then RNDK.CharOf(@info[vrow][vcol][x-1]).ord | highlight
              else @filler
              end
@@ -878,21 +878,21 @@ module RNDK
       self.cleanTitle
 
       # Clear the matrix windows.
-      RNDK.deleteCursesWindow(@cell[0][0])
-      (1..@vrows).each { |x| RNDK.deleteCursesWindow @cell[x][0] }
-      (1..@vcols).each { |x| RNDK.deleteCursesWindow @cell[0][x] }
+      RNDK.window_delete(@cell[0][0])
+      (1..@vrows).each { |x| RNDK.window_delete @cell[x][0] }
+      (1..@vcols).each { |x| RNDK.window_delete @cell[0][x] }
 
       (1..@vrows).each do |x|
         (1..@vcols).each do |y|
-          RNDK.deleteCursesWindow @cell[x][y]
+          RNDK.window_delete @cell[x][y]
         end
       end
 
-      RNDK.deleteCursesWindow @shadow_win
-      RNDK.deleteCursesWindow @win
+      RNDK.window_delete @shadow_win
+      RNDK.window_delete @win
 
       # Clean the key bindings.
-      self.cleanBindings(:MATRIX)
+      self.clean_bindings(:MATRIX)
 
       # Unregister this object.
       RNDK::Screen.unregister(:MATRIX, self)
@@ -900,21 +900,21 @@ module RNDK
 
     # This function erases the matrix widget from the screen.
     def erase
-      if self.validRNDKObject
+      if self.valid_widget?
         # Clear the matrix cells.
-        RNDK.eraseCursesWindow @cell[0][0]
+        RNDK.window_erase @cell[0][0]
 
-        (1..@vrows).each { |x| RNDK.eraseCursesWindow @cell[x][0] }
-        (1..@vcols).each { |x| RNDK.eraseCursesWindow @cell[0][x] }
+        (1..@vrows).each { |x| RNDK.window_erase @cell[x][0] }
+        (1..@vcols).each { |x| RNDK.window_erase @cell[0][x] }
 
         (1..@vrows).each do |x|
           (1..@vcols).each do |y|
-            RNDK.eraseCursesWindow @cell[x][y]
+            RNDK.window_erase @cell[x][y]
           end
         end
 
-        RNDK.eraseCursesWindow @shadow_win
-        RNDK.eraseCursesWindow @win
+        RNDK.window_erase @shadow_win
+        RNDK.window_erase @win
       end
     end
 
@@ -1159,7 +1159,7 @@ module RNDK
     end
 
     # This sets the background attribute of the widget.
-    def setBKattr(attrib)
+    def set_bg_attrib(attrib)
       Ncurses.wbkgd(@win, attrib)
 
       # TODO what the hell?