rndk 0.0.1 → 0.1.0

data/examples/calendar.rb

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+#
+# Shows off the Calendar Widget, binding some keys to actions.
+#
+# Note: This example is quite complex.
+#       See file '02-colors.rb' for a better introduction
+#       to the calendar widget.
+#
+require 'rndk/calendar'
+
+begin
+  # Start RNDK and Colors
+  rndkscreen = RNDK::Screen.new
+  RNDK::Color.init
+
+  title = "<C></U>RNDK Calendar Widget\n<C>Demo"
+
+  # Declare the calendar widget.
+  calendar = RNDK::Calendar.new(rndkscreen,
+                                RNDK::CENTER, # x
+                                RNDK::CENTER, # y
+                                title,
+                                0, 0, 0, # current date
+                                RNDK::Color[:red_black] | Ncurses::A_BOLD,
+                                RNDK::Color[:green_black] | Ncurses::A_BOLD,
+                                RNDK::Color[:yellow_black] | Ncurses::A_BOLD,
+                                RNDK::Color[:blue_black] | Ncurses::A_REVERSE,
+                                true,
+                                false)
+
+  if calendar.nil?
+    RNDK::Screen.end_rndk
+
+    puts 'Cannot create the calendar. Is the window too small?'
+    exit 1
+  end
+
+  # Here we define the functions that will be
+  # executed when the user presses a key.
+  #
+  # They must be lambdas.
+
+  # This adds a marker ot the calendar.
+  create_calendar_mark = lambda do |object_type, calendar, client_data, key|
+    calendar.setMarker(calendar.day, calendar.month, calendar.year)
+    calendar.draw(calendar.box)
+    return false
+  end
+
+  # This removes a marker from the calendar.
+  remove_calendar_mark = lambda do |object_type, calendar, client_data, key|
+    calendar.removeMarker(calendar.day, calendar.month, calendar.year)
+    calendar.draw(calendar.box)
+    return false
+  end
+
+  # Here we bind the keys to the actions.
+  #
+  # They must be lambdas.
+
+  calendar.bind(:calendar, 'm', create_calendar_mark, calendar)
+  calendar.bind(:calendar, 'M', create_calendar_mark, calendar)
+  calendar.bind(:calendar, 'r', remove_calendar_mark, calendar)
+  calendar.bind(:calendar, 'R', remove_calendar_mark, calendar)
+
+  calendar.week_base = 0
+
+  # Let the user play with the widget.
+  ret_val = calendar.activate([])
+
+  # Check which day they selected.
+  if calendar.exit_type == :ESCAPE_HIT
+    mesg = [
+            '<C>You hit escape. No date selected.',
+            '',
+            '<C>Press any key to continue.'
+           ]
+    rndkscreen.popup_label mesg
+
+  elsif calendar.exit_type == :NORMAL
+    mesg = [
+            'You selected the following date',
+            '<C></B/16>%02d/%02d/%d (dd/mm/yyyy)' % [
+                                                     calendar.day, calendar.month, calendar.year],
+            '<C>Press any key to continue.'
+           ]
+    rndkscreen.popup_label mesg
+  end
+
+  # Finishing up and printing message
+  RNDK::Screen.end_rndk
+
+  puts 'Selected Time: %s' % ret_val.ctime unless ret_val.nil?
+
+# Just in case something bad happens.
+rescue Exception => e
+  RNDK::Screen.end_rndk
+
+  puts e
+  puts e.inspect
+  puts e.backtrace
+  exit 1
+end
+

data/examples/scroll.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/env ruby
+#
+# Displays a Scroll list with the current
+# directory's files.
+#
+# You can also modify it at runtime with the keys:
+#
+# * 'a' adds item
+# * 'i' inserts item
+# * 'd' deletes item
+#
+require 'rndk/scroll'
+
+# It creates new labels to add to the Scroll List.
+#
+# Ignore this for now, read the rest first.
+$count = 0
+def new_label(prefix)
+  result = "%s%d" % [prefix, $count]
+  $count += 1
+  return result
+end
+
+begin
+  # Set up RNDK and colors
+  rndkscreen = RNDK::Screen.new
+  RNDK::Draw.initRNDKColor
+
+  # Use the current directory list to fill the radio list
+  item  = []
+  count = RNDK.getDirectoryContents(".", item)
+
+  # Create the scrolling list.
+  scroll_list = RNDK::SCROLL.new(rndkscreen,
+                                 RNDK::CENTER, # x
+                                 RNDK::CENTER, # y
+                                 RNDK::RIGHT,  # scrollbar position
+                                 10,           # height
+                                 50,           # width
+                                 "<C></5>Pick a file", # title
+                                 item,
+                                 count,
+                                 true,
+                                 Ncurses::A_REVERSE,
+                                 true,         # box
+                                 false)        # shadow
+
+  if scroll_list.nil?
+    RNDK::Screen.end_rndk
+
+    puts "Cannot make scrolling list.  Is the window too small?"
+    exit 1
+  end
+
+  # These are the functions that will modify the
+  # Scroll List at runtime.
+
+  addItemCB = lambda do |type, widget, client_data, input|
+    widget.addItem(ScrollExample.newLabel("add"))
+    widget.screen.refresh
+    return true
+  end
+
+  insItemCB = lambda do |type, widget, client_data, input|
+    widget.insertItem(ScrollExample.newLabel("insert"))
+    widget.screen.refresh
+    return true
+  end
+
+  delItemCB = lambda do |type, widget, client_data, input|
+    widget.deleteItem(widget.getCurrentItem)
+    widget.screen.refresh
+    return true
+  end
+
+  # And this is how we bind keys to actions.
+  #
+  # It only accepts lambdas.
+
+  scroll_list.bind(:SCROLL, 'a', addItemCB, nil)
+  scroll_list.bind(:SCROLL, 'i', insItemCB, nil);
+  scroll_list.bind(:SCROLL, 'd', delItemCB, nil);
+
+  # Activate the scrolling list.
+  selection = scroll_list.activate('')
+
+  # Determine how the widget was exited
+  msg = []
+  if scroll_list.exit_type == :ESCAPE_HIT
+    msg = ['<C>You hit escape. No file selected',
+           '',
+           '<C>Press any key to continue.']
+
+  elsif scroll_list.exit_type == :NORMAL
+    the_item = RNDK.chtype2Char scroll_list.item[selection]
+
+    msg = ['<C>You selected the following file',
+           "<C>%.*s" % [236, the_item],  # FIXME magic number
+           "<C>Press any key to continue."]
+  end
+  rndkscreen.popup_label msg
+
+  # Exit
+  RNDK::Screen.end_rndk
+end
+

data/lib/rndk/alphalist.rb

@@ -22,7 +22,7 @@ module RNDK
         return nil
       end
 
-      self.setBox(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.
@@ -206,7 +206,7 @@ module RNDK
 
         if alphalist.isBind(:ALPHALIST, input)
           result = 1  # Don't try to use this key in editing
-        elsif (RNDK.isChar(input) &&
+        elsif (RNDK.is_char?(input) &&
             input.chr.match(/^[[:alnum:][:punct:]]$/)) ||
             [Ncurses::KEY_BACKSPACE, Ncurses::KEY_DC].include?(input)
           index = 0
@@ -290,12 +290,12 @@ module RNDK
 
     # This erases the alphalist from the screen.
     def erase
-      if self.validRNDKObject
+      if self.valid_widget?
         @scroll_field.erase
         @entry_field.erase
 
-        RNDK.eraseCursesWindow(@shadow_win)
-        RNDK.eraseCursesWindow(@win)
+        RNDK.window_erase(@shadow_win)
+        RNDK.window_erase(@win)
       end
     end
 
@@ -392,8 +392,8 @@ module RNDK
     def set(list, list_size, filler_char, highlight, box)
       self.setContents(list, list_size)
       self.setFillerChar(filler_char)
-      self.setHighlight(highlight)
-      self.setBox(box)
+      self.set_highlight(highlight)
+      self.set_box(box)
     end
 
     # This function sets the information inside the alphalist.
@@ -444,7 +444,7 @@ module RNDK
     end
 
     # This sets the highlgith bar attributes
-    def setHighlight(highlight)
+    def set_highlight(highlight)
       @highlight = highlight
     end
 
@@ -485,9 +485,9 @@ module RNDK
     end
 
     # This sets the background attribute of the widget.
-    def setBKattr(attrib)
-      @entry_field.setBKattr(attrib)
-      @scroll_field.setBKattr(attrib)
+    def set_bg_attrib(attrib)
+      @entry_field.set_bg_attrib(attrib)
+      @scroll_field.set_bg_attrib(attrib)
     end
 
     def destroyInfo
@@ -500,14 +500,14 @@ module RNDK
       self.destroyInfo
 
       # Clean the key bindings.
-      self.cleanBindings(:ALPHALIST)
+      self.clean_bindings(:ALPHALIST)
 
       @entry_field.destroy
       @scroll_field.destroy
 
       # Free up the window pointers.
-      RNDK.deleteCursesWindow(@shadow_win)
-      RNDK.deleteCursesWindow(@win)
+      RNDK.window_delete(@shadow_win)
+      RNDK.window_delete(@win)
 
       # Unregister the object.
       RNDK::Screen.unregister(:ALPHALIST, self)

data/lib/rndk/button.rb

@@ -10,7 +10,7 @@ module RNDK
       xpos = xplace
       ypos = yplace
 
-      self.setBox(box)
+      self.set_box(box)
       box_height = 1 + 2 * @border_size
 
       # Translate the string to a chtype array.
@@ -100,18 +100,18 @@ module RNDK
       end
 
       # Set the exit type and exit
-      self.setExitType(0)
+      self.set_exit_type(0)
       return -1
     end
 
     # This sets multiple attributes of the widget.
     def set(mesg, box)
-      self.setMessage(mesg)
-      self.setBox(box)
+      self.set_message(mesg)
+      self.set_box(box)
     end
 
     # This sets the information within the button.
-    def setMessage(info)
+    def set_message(info)
       info_len = []
       info_pos = []
       @info = RNDK.char2Chtype(info, info_len, info_pos)
@@ -124,12 +124,12 @@ module RNDK
       self.draw(box)
     end
 
-    def getMessage
+    def get_message
       return @info
     end
 
     # This sets the background attribute of the widget.
-    def setBKattr(attrib)
+    def set_bg_attrib(attrib)
       Ncurses.wbkgd(@win, attrib)
     end
 
@@ -171,9 +171,9 @@ module RNDK
 
     # This erases the button 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
 
@@ -203,11 +203,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)
 
       # Thouch the windows so they 'move'.
-      RNDK::Screen.refresh_window(@screen.window)
+      RNDK.window_refresh(@screen.window)
 
       # Redraw the window, if they asked for it.
       if refresh_flag
@@ -304,10 +304,10 @@ module RNDK
 
     # This destroys the button object pointer.
     def destroy
-      RNDK.deleteCursesWindow(@shadow_win)
-      RNDK.deleteCursesWindow(@win)
+      RNDK.window_delete(@shadow_win)
+      RNDK.window_delete(@win)
 
-      self.cleanBindings(:BUTTON)
+      self.clean_bindings(:BUTTON)
 
       RNDK::Screen.unregister(:BUTTON, self)
     end
@@ -317,7 +317,7 @@ module RNDK
       ret = -1
       complete = false
 
-      self.setExitType(0)
+      self.set_exit_type(0)
 
       # Check a predefined binding.
       if self.checkBind(:BUTTON, input)
@@ -325,16 +325,16 @@ module RNDK
       else
         case input
         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 ' '.ord, RNDK::KEY_RETURN, Ncurses::KEY_ENTER
           unless @callback.nil?
             @callback.call(self)
           end
-          self.setExitType(Ncurses::KEY_ENTER)
+          self.set_exit_type(Ncurses::KEY_ENTER)
           ret = 0
           complete = true
         when RNDK::REFRESH
@@ -346,7 +346,7 @@ module RNDK
       end
 
       unless complete
-        self.setExitType(0)
+        self.set_exit_type(0)
       end
 
       @result_data = ret

data/lib/rndk/buttonbox.rb

@@ -21,7 +21,7 @@ module RNDK
         return nil
       end
 
-      self.setBox(box)
+      self.set_box(box)
 
       # Set some default values for the widget.
       @row_adjust = 0
@@ -35,7 +35,7 @@ module RNDK
       # COLS-width, otherwise the width will be the given width.
       box_width = RNDK.setWidgetDimension(parent_width, width, 0)
 
-      box_width = self.setTitle(title, box_width)
+      box_width = self.set_title(title, box_width)
 
       # Translate the buttons string to a chtype array
       (0...button_count).each do |x|
@@ -143,7 +143,7 @@ module RNDK
       end
 
       # Set the exit type and exit
-      self.setExitType(0)
+      self.set_exit_type(0)
       return -1
     end
 
@@ -156,7 +156,7 @@ module RNDK
       complete = false
 
       # Set the exit type
-      self.setExitType(0)
+      self.set_exit_type(0)
 
       unless @pre_process_func.nil?
         pp_return = @pre_process_func.call(:BUTTONBOX, self,
@@ -198,13 +198,13 @@ module RNDK
             @screen.erase
             @screen.refresh
           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_RETURN, Ncurses::KEY_ENTER
-            self.setExitType(input)
+            self.set_exit_type(input)
             ret = @current_button
             complete = true
           end
@@ -219,7 +219,7 @@ module RNDK
 
       unless complete
         self.drawButtons
-        self.setExitType(0)
+        self.set_exit_type(0)
       end
 
       @result_data = ret
@@ -228,12 +228,12 @@ module RNDK
 
     # This sets multiple attributes of the widget.
     def set(highlight, box)
-      self.setHighlight(highlight)
-      self.setBox(box)
+      self.set_highlight(highlight)
+      self.set_box(box)
     end
 
     # This sets the highlight attribute for the buttonboxes
-    def setHighlight(highlight)
+    def set_highlight(highlight)
       @highlight = highlight
     end
 
@@ -242,7 +242,7 @@ module RNDK
     end
 
     # This sets th background attribute of the widget.
-    def setBKattr(attrib)
+    def set_bg_attrib(attrib)
       Ncurses.wbkgd(@win, attrib)
     end
 
@@ -308,9 +308,9 @@ module RNDK
 
     # This erases the buttonbox box 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
 
@@ -318,10 +318,10 @@ module RNDK
     def destroy
       self.cleanTitle
 
-      RNDK.deleteCursesWindow @shadow_win
-      RNDK.deleteCursesWindow @win
+      RNDK.window_delete @shadow_win
+      RNDK.window_delete @win
 
-      self.cleanBindings(:BUTTONBOX)
+      self.clean_bindings(:BUTTONBOX)
 
       RNDK::Screen.unregister(:BUTTONBOX, self)
     end