rndk 0.1.0 → 0.2.0

data/lib/rndk/calendar.rb

@@ -24,19 +24,19 @@ module RNDK
   # Enter::       Exits the widget and returns a value of
   #               time_t   which   represents   the   day
   #               selected at 1  second  after  midnight.
-  #               This also sets the widget data exitType
-  #               to vNORMAL.
+  #               This also sets the widget data `exit_type`
+  #               to `:NORMAL`.
   # Tab::         Exits the widget and returns a value of
   #               time_t   which   represents   the   day
   #               selected at 1  second  after  midnight.
-  #               This also sets the widget data exitType
-  #               to vNORMAL.
-  # Escape::      Exits the widget and returns (time_)-1
-  #               This also sets the widget data exitType
-  #               to vESCAPE_HIT.
+  #               This also sets the widget data `exit_type`
+  #               to `:NORMAL`.
+  # Escape::      Exits the widget and returns selected date
+  #               This also sets the widget data `exit_type`
+  #               to `:ESCAPE_HIT`.
   # Ctrl-L::      Refreshes the screen.
   #
-  class Calendar < RNDK::Widget
+  class Calendar < Widget
 
     attr_reader :day, :month, :year
 
@@ -117,6 +117,10 @@ module RNDK
 
     # Creates a Calendar 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`.
     # * `day`, `month` and `year` are integers. I suggest
     #   you to use Ruby's `Time.now.gmtime`.
     # * `title` can be more than one line - just split them
@@ -274,7 +278,7 @@ module RNDK
       @marker[Calendar.calendar_index(d, m, y)]
     end
 
-    # Activates the Calendar Widget, letting the user interact with it.
+    # 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.
@@ -306,14 +310,7 @@ module RNDK
       ret
     end
 
-    # Makes the Calendar react to `char` just as if the user
-    # had pressed it.
-    #
-    # Nice to simulate batch actions on a Widget.
-    #
-    # Besides normal keybindings (arrow keys and such), see
-    # Widget#set_exit_type to see how the Widget exits.
-    #
+    # @see Widget#inject
     def inject char
       pp_return = 1
       ret       = nil
@@ -386,14 +383,14 @@ module RNDK
       return ret
     end
 
-    # This moves the calendar field to the given location.
+    # @see Widget#move
     def move(xplace, yplace, relative, refresh_flag)
       windows = [@win, @field_win, @label_win, @shadow_win]
 
       self.move_specific(xplace, yplace, relative, refresh_flag, windows, [])
     end
 
-    # Draws the Calendar Widget on the Screen.
+    # Draws the Widget on the Screen.
     #
     # If `box` is true, it is drawn with a box.
     def draw(box=false)
@@ -568,8 +565,7 @@ module RNDK
       Ncurses.wbkgd(@label_win, attrib) unless @label_win.nil?
     end
 
-    # Erases the Calendar from the Screen.
-    # @note It does not destroy the widget.
+    # @see Widget#erase
     def erase
       return unless self.valid_widget?
 
@@ -579,8 +575,7 @@ module RNDK
       RNDK.window_erase @shadow_win
     end
 
-    # Destroys all windows inside the Widget and
-    # removes it from the Screen.
+    # @see Widget#destroy
     def destroy
       self.cleanTitle
 

data/lib/rndk/core/draw.rb

@@ -2,36 +2,6 @@
 module RNDK
 
   module Draw
-    # # This sets up a basic set of color pairs.
-    # # These can be redefined if wanted
-    # def Draw.initRNDKColor
-    #   color = [Ncurses::COLOR_WHITE,
-    #            Ncurses::COLOR_RED,
-    #            Ncurses::COLOR_GREEN,
-    #            Ncurses::COLOR_YELLOW,
-    #            Ncurses::COLOR_BLUE,
-    #            Ncurses::COLOR_MAGENTA,
-    #            Ncurses::COLOR_CYAN,
-    #            Ncurses::COLOR_BLACK]
-    #   pair = 1
-
-    #   if Ncurses.has_colors
-    #     # XXX: Only checks if terminal has colours not if colours are started
-    #     Ncurses.start_color
-    #     limit = if Ncurses.COLORS < 8
-    #             then Ncurses.COLORS
-    #             else 8
-    #             end
-
-    #     # Create the color pairs
-    #     (0...limit).each do |fg|
-    #       (0...limit).each do |bg|
-    #         Ncurses.init_pair(pair, color[fg], color[bg])
-    #         pair += 1
-    #       end
-    #     end
-    #   end
-    # end
 
     # This prints out a box around a window with attributes
     def Draw.boxWindow(window, attr)

data/lib/rndk/core/quick_widgets.rb

@@ -49,7 +49,7 @@ module RNDK
       return if message.class != Array or message.empty?
 
       self.cleanly do
-        popup = RNDK::LABEL.new(self, CENTER, CENTER, message, true, false)
+        popup = RNDK::Label.new(self, CENTER, CENTER, message, true, false)
         popup.draw(true)
 
         # Wait for some input.
@@ -67,7 +67,7 @@ module RNDK
       return if message.class != Array or message.empty?
 
       self.cleanly do
-        popup = RNDK::LABEL.new(self, CENTER, CENTER, message, true, false)
+        popup = RNDK::Label.new(self, CENTER, CENTER, message, true, false)
         popup.setBackgroundAttrib attrib
         popup.draw(true)
 
@@ -254,15 +254,14 @@ module RNDK
       width = [width, title.size].max
       width += 5
 
-      scrollp = RNDK::SCROLL.new(self,
+      scrollp = RNDK::Scroll.new(self,
                                  RNDK::CENTER,
                                  RNDK::CENTER,
                                  RNDK::RIGHT,
-                                 height,
                                  width,
+                                 height,
                                  title,
                                  list,
-                                 list.size,
                                  numbers,
                                  Ncurses::A_REVERSE,
                                  true,
@@ -288,10 +287,10 @@ module RNDK
     # Pops up an Entry Widget and returns the value supplied
     # by the user.
     #
-    # `title`, `label` and `initial_value` are passed to the Widget.
-    def get_string(title, label, initial_value="")
+    # `title`, `label` and `initial_text` are passed to the Widget.
+    def get_string(title, label, initial_text="")
 
-      widget = RNDK::ENTRY.new(self,
+      widget = RNDK::Entry.new(self,
                                RNDK::CENTER,
                                RNDK::CENTER,
                                title,
@@ -305,7 +304,7 @@ module RNDK
                                true,
                                false)
 
-      widget.setValue(initial_value)
+      widget.set_text(initial_text)
 
       value = widget.activate([])
 
@@ -316,7 +315,7 @@ module RNDK
       end
 
       # Return a copy of the string typed in.
-      value = widget.getValue.clone
+      value = widget.get_text.clone
       widget.destroy
 
       value

data/lib/rndk/core/utils.rb

@@ -7,17 +7,17 @@ module RNDK
     value.to_str.size
   end
 
-  # Opens the current directory and reads the contents.
-  def RNDK.getDirectoryContents(directory, list)
-    counter = 0
+  # Returns all files from `directory` as
+  # an Array of Strings.
+  def RNDK.get_directory_contents directory
+    list = []
 
     Dir.foreach(directory) do |filename|
-      next if filename == '.'
+      next if filename == '.' or filename == '..'
       list << filename
     end
 
-    list.sort!
-    return list.size
+    list.sort
   end
 
   # This looks for a subset of a word in the given list

data/lib/rndk/core/widget.rb

@@ -57,6 +57,8 @@ module RNDK
     def draw(a)
     end
 
+    # Erases the Widget from the Screen.
+    # @note It does not destroy the Widget.
     def erase
     end
 
@@ -136,6 +138,10 @@ module RNDK
     # had pressed it.
     #
     # Nice to simulate batch actions on a Widget.
+    #
+    # Besides normal keybindings (arrow keys and such), see
+    # Widget#set_exit_type to see how the Widget exits.
+    #
     def inject char
     end
 
@@ -160,6 +166,8 @@ module RNDK
     def refreshData
     end
 
+    # Destroys all windows inside the Widget and
+    # removes it from the Screen.
     def destroy
     end
 
@@ -315,7 +323,7 @@ module RNDK
     def bindableObject(rndktype)
       if rndktype != self.object_type
         return nil
-      elsif [:FSELECT, :ALPHALIST].include?(self.object_type)
+      elsif [:FSELECT, :alphalist].include?(self.object_type)
         return @entry_field
       else
         return self

data/lib/rndk/dialog.rb

@@ -1,7 +1,7 @@
 require 'rndk'
 
 module RNDK
-  class DIALOG < RNDK::Widget
+  class DIALOG < Widget
     attr_reader :current_button
     MIN_DIALOG_WIDTH = 10
 
@@ -220,11 +220,6 @@ module RNDK
       return ret
     end
 
-    # This moves the dialog field to the given location.
-    # Inherited
-    # def move(xplace, yplace, relative, refresh_flag)
-    # end
-
     # This function draws the dialog widget.
     def draw(box)
       # Is there a shadow?

data/lib/rndk/dscale.rb

@@ -1,7 +1,7 @@
 require 'rndk/fscale'
 
 module RNDK
-  class DSCALE < RNDK::FSCALE
+  class DSCALE < FSCALE
     # The original DScale handled unsigned values.
     # Since Ruby's typing is different this is really just FSCALE
     # but is nice it's nice to have this for compatibility/completeness