rndk 0.2.0 → 1.0.0

data/demos/clock.rb

@@ -11,19 +11,24 @@ require 'rndk/label'
 
 begin
   # Set up RNDK
-  rndkscreen = RNDK::Screen.new
+  screen = RNDK::Screen.new
   RNDK::Color.init
 
   # Initial time string
   mesg = ['</1/B>HH:MM:SS']
 
   # Declare the labels.
-  label = RNDK::Label.new(rndkscreen, RNDK::CENTER, RNDK::CENTER, mesg, true, true)
+  label = RNDK::Label.new(screen, {
+                            :x => RNDK::CENTER,
+                            :y => RNDK::CENTER,
+                            :text => mesg,
+                            :shadow => true
+                          })
 
   # Woops, something bad happened
   if label.nil?
-    rndkscreen.destroy
-    RNDK::Screen.end_rndk
+    screen.destroy
+    RNDK::Screen.finish
 
     puts "Cannot create the label. Is the window too small?"
     exit 1
@@ -47,18 +52,18 @@ begin
     mesg = [str]
 
     # Set the label contents
-    label.set(mesg, label.box)
+    label.set(:text => mesg)
 
     # Draw the label and sleep
-    label.draw(label.box)
+    label.draw
     Ncurses.napms(500)
   end
 
-  RNDK::Screen.end_rndk
+  RNDK::Screen.finish
 
 # In case something goes wrong
 rescue Exception => e
-  RNDK::Screen.end_rndk
+  RNDK::Screen.finish
 
   puts e
   puts e.inspect

data/demos/rss-reader.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+#
+# A simple RSS reader.
+# It receives a feed address as an argument, defaulting to the
+# Ruby Language feed if not provided.
+#
+# When an item is selected, it's content pops-up.
+#
+require 'rss'
+require 'open-uri'
+require 'rndk/label'
+require 'rndk/scroll'
+
+DEFAULT_URL = 'https://www.ruby-lang.org/en/feeds/news.rss'
+
+begin
+  # which feed
+  url = DEFAULT_URL
+  url = ARGV.first if ARGV.first
+
+  # retrieving things
+  puts 'Fetching feeds...'
+  feed = RSS::Parser.parse (open url)
+
+  # starting RNDK
+  screen = RNDK::Screen.new
+  RNDK::Color.init
+
+  # building label
+  title = ["<C></77>#{feed.channel.title}",
+           "</76>Press ESC to quit"]
+
+  label = RNDK::Label.new(screen, {
+                            :x => RNDK::CENTER,
+                            :y => RNDK::TOP,
+                            :title => "</77>#{feed.channel.title}"
+                          })
+
+  # will show the titles at scroll widget
+  titles = []
+  feed.items.each { |item| titles << item.title }
+
+  # building scroll
+  scroll = RNDK::Scroll.new(screen, {
+                              :x => RNDK::CENTER,
+                              :y => 4,
+                              :width => RNDK::Screen.width/2,
+                              :height => RNDK::Screen.height/2 - 5,
+                              :title => "<C></77>Items",
+                              :items => titles,
+                              :numbers => true,
+                              :highlight => RNDK::Color[:cyan],
+                            })
+  screen.refresh
+
+  loop do
+    scroll.activate
+
+    # Scroll exited, thus the
+    # user selected an item
+    # or pressed ESC to get out
+    if scroll.exit_type == :NORMAL
+
+      # Getting current item's content
+      index = scroll.current_item
+      raw_message = feed.items[index].description
+
+      # Removing '\n' at the end of all the lines.
+      message = []
+      raw_message.lines.each { |line| message << line.chomp }
+
+      # Show current item's content on a pop-up
+      screen.popup_label message
+
+    # user pressed ESC - wants to quit
+    elsif scroll.exit_type == :ESCAPE_HIT
+
+      # good bye!
+      RNDK::Screen.finish
+      exit
+    end
+  end
+end
+

data/examples/01-hello-world.rb

@@ -7,7 +7,7 @@ require 'rndk/label'
 
 begin
   # Startup Ncurses and RNDK
-  rndkscreen = RNDK::Screen.new
+  screen = RNDK::Screen.new
 
   # Set up RNDK colors
   RNDK::Color.init
@@ -24,32 +24,34 @@ begin
          ]
 
   # Declare the labels.
-  label = RNDK::Label.new(rndkscreen,   # screen
-                          RNDK::CENTER, # x
-                          RNDK::CENTER, # y
-                          mesg,         # message
-                          true,         # box?
-                          true)         # shadow?
+  label = RNDK::Label.new(screen, {
+                            :x => RNDK::CENTER,
+                            :y => RNDK::CENTER,
+                            :text => mesg,
+                          })
+
 
   if label.nil?
     # Clean up the memory.
-    rndkscreen.destroy
+    screen.destroy
 
     # End curses...
-    RNDK::Screen.end_rndk
+    RNDK::Screen.finish
 
     puts "Cannot create the label. Is the window too small?"
     exit 1
   end
 
   # Draw the RNDK screen and waits for space to be pressed.
-  rndkscreen.refresh
+  screen.refresh
   label.wait(' ')
 
   # Ending Ncurses and RNDK
-  RNDK::Screen.end_rndk
+  RNDK::Screen.finish
 end
 
 # Note: Unlike C's CDK, there's no need to clean up
 #       widgets/screens when finishing execution.
+#       You might need to do it when deleting widgets
+#       casually, though.
 

data/examples/02-colors.rb

@@ -11,7 +11,7 @@ begin
   RNDK::Color.init
 
   # Disabling the blinking cursor
-  Ncurses.curs_set 0
+  RNDK::blink_cursor true
 
   # Welcome to our Calendar Widget!
   #
@@ -25,30 +25,23 @@ begin
   #
   #     RNDK::Color[:foreground]
   #
-  # On the calendar, if we supply 0 as the
-  # day/month/year it'll use the current day/month/year.
-  cal = RNDK::Calendar.new(screen,
-                           RNDK::CENTER,             # x
-                           RNDK::CENTER,             # y
-                           "Colored calendar",       # title
-                           0,                        # day
-                           0,                        # month
-                           0,                        # year
-                           RNDK::Color[:red_yellow], # day attrib
-                           RNDK::Color[:cyan_white], # month attrib
-                           RNDK::Color[:black_cyan], # year attrib
-                           RNDK::Color[:red],        # highlight
-                           true,                     # has box?
-                           false)                    # has shadow?
+  cal = RNDK::Calendar.new(screen, {
+                             :x => RNDK::CENTER,
+                             :y => RNDK::CENTER,
+                             :title => "Colored calendar",
+                             :day_color => RNDK::Color[:red_yellow],
+                             :highlight => RNDK::Color[:red],
+                           })
+  # Oh yeah
   cal.activate
 
-  RNDK::Screen.end_rndk
+  RNDK::Screen.finish
 
-# Assuring we end RNDK in case something
-# bad happens.
-# You'll see this a lot on the examples.
+  # Assuring we end RNDK in case something
+  # bad happens.
+  # You'll see this a lot on the examples.
 rescue Exception => e
-  RNDK::Screen.end_rndk
+  RNDK::Screen.finish
 
   puts e
   puts e.inspect

data/examples/03-markup.rb

@@ -57,16 +57,16 @@ begin
   msg << "<C>All RNDK color pairs (press 'q' to quit)"
 
   # Show label with that huge message.
-  label = RNDK::Label.new(screen,
-                          RNDK::CENTER, # x
-                          1,            # y
-                          msg,          # message
-                          true,         # has box?
-                          true)         # has shadow?
+  label = RNDK::Label.new(screen, {
+                            :x => RNDK::CENTER,
+                            :y => 1,
+                            :text => msg,
+                            :shadow => true
+                          })
 
   screen.refresh
   label.wait('q') # wait for key to be pressed
 
-  RNDK::Screen.end_rndk
+  RNDK::Screen.finish
 end
 

data/examples/04-quick-widgets.rb

@@ -57,13 +57,13 @@ begin
   screen.popup_label ["You just said '#{value}'"]
 
   # Finally, the end!
-  RNDK::Screen.end_rndk
+  RNDK::Screen.finish
 
   puts "...and as always, thanks for watching!"
 
 # Just in case something bad happens.
 rescue Exception => e
-  RNDK::Screen.end_rndk
+  RNDK::Screen.finish
 
   puts e
   puts e.inspect

data/examples/05-position-widget.rb

@@ -33,69 +33,88 @@
 require 'rndk/entry'
 
 begin
+  title = "</77>Entry"
   label = "</U/5>Position me:<!U!5> "
 
   # Set up RNDK
   curses_win = Ncurses.initscr
-  rndkscreen = RNDK::Screen.new(curses_win)
+  screen = RNDK::Screen.new(curses_win)
 
   # Set up RNDK colors
   RNDK::Color.init
 
   # Create the entry field widget.
-  entry = RNDK::Entry.new(rndkscreen,
-                          RNDK::CENTER, # x
-                          RNDK::CENTER, # y
-                          '',
-                          label,
-                          Ncurses::A_NORMAL,
-                          '.',
-                          :MIXED,
-                          30, # w
-                          0,
-                          256,
-                          true,
-                          false)
+  entry = RNDK::Entry.new(screen, {
+                            :x => RNDK::CENTER,
+                            :y => RNDK::BOTTOM,
+                            :label => label,
+                            :title => title,
+                            :field_width => 30
+                          })
 
   if entry.nil?
-    rndkscreen.destroy
-    RNDK::Screen.end_rndk
+    screen.destroy
+    RNDK::Screen.finish
 
     puts "Cannot create the entry box. Is the window too small?"
     exit 1
   end
 
+  # Create a label explaining the keybindings
+  help = ["</77>Keybindings",
+          "Up Arrow    Moves the widget up one row.",
+
+          "Down Arrow  Moves the widget down one row.",
+          "Left Arrow  Moves the widget left one column",
+          "Right Arrow Moves the widget right one column",
+          "1           Moves the widget down one row and left one column.",
+          "2           Moves the widget down one row.",
+          "3           Moves the widget down one row and right one column.",
+          "4           Moves the widget left one column.",
+          "5           Centers the widget both vertically and horizontally.",
+          "6           Moves the widget right one column",
+          "7           Moves the widget up one row and left one column.",
+          "8           Moves the widget up one row.",
+          "9           Moves the widget up one row and right one column.",
+          "t           Moves the widget to the top of the screen.",
+          "b           Moves the widget to the bottom of the screen.",
+          "l           Moves the widget to the left of the screen.",
+          "r           Moves the widget to the right of the screen.",
+          "c           Centers the widget between the left and right of the window.",
+          "C           Centers the widget between the top and bottom of the window.",
+          "Escape      Returns the widget to its original position.",
+          "Return      Exits the function and leaves the Widget where"]
+
+  label = RNDK::Label.new(screen, :text => help)
+  label.draw
+
   # Let the user move the widget around the window.
-  entry.draw(entry.box)
+  entry.draw
   entry.position
 
   # Activate the entry field.
-  info = entry.activate('')
+  info = entry.activate
 
   # Tell them what they typed.
   if entry.exit_type == :ESCAPE_HIT
-    mesg = [
-            "<C>You hit escape. No information passed back.",
+    mesg = ["<C>You hit escape. No information passed back.",
             "",
-            "<C>Press any key to continue."
-           ]
-    rndkscreen.popup_label mesg
+            "<C>Press any key to continue."]
+    screen.popup_label mesg
 
   elsif entry.exit_type == :NORMAL
-    mesg = [
-            "<C>You typed in the following",
-            "<C>%.*s" % [236, info],  # FIXME magic number
+    mesg = ["<C>You typed in the following",
+            "<C></77>#{info}",
             "",
-            "<C>Press any key to continue."
-           ]
-    rndkscreen.popup_label mesg
+            "<C>Press any key to continue."]
+    screen.popup_label mesg
   end
 
-  RNDK::Screen.end_rndk
+  RNDK::Screen.finish
 
 # Just in case something bad happens.
 rescue Exception => e
-  RNDK::Screen.end_rndk
+  RNDK::Screen.finish
 
   puts e
   puts e.inspect

data/examples/06-callbacks.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+#
+# Shows a scrollbar with your files and keep
+# asking to interrupt scrolling.
+#
+# It means you can set custom functions to
+# execute right before and right after processing
+# input on the widget.
+#
+# To exit press ENTER or TAB.
+#
+require 'rndk/scroll'
+
+begin
+  screen = RNDK::Screen.new
+  RNDK::Color.init
+
+  # Creating scroll based on your current dir's files.
+  # Nothing should be new here
+  title = "<C></77>Your files"
+  list = `ls -l`.lines
+
+  scroll = RNDK::Scroll.new(screen, {
+                              :x => RNDK::CENTER,
+                              :y => RNDK::CENTER,
+                              :scroll_bar => RNDK::LEFT,
+                              :width => RNDK::Screen.width/2,
+                              :height => RNDK::Screen.height/2,
+                              :title => title,
+                              :items => list,
+                              :highlight => RNDK::Color[:green]
+                            })
+
+  # Here comes the good stuff.
+  # We're assigning blocks to run before and after
+  # the widget processes your input.
+  #
+  # Right before processing input, it'll create
+  # this popup dialog.
+  # Based on your answer it will stop scrolling or not.
+  #
+  # That's because a if a `before_processing` block
+  # return false, it aborts processing the current
+  # char.
+  # If it returns true, it keeps going.
+  #
+  scroll.bind_signal(:before_input) do |key|
+    message = ["</73>You just pressed </74>#{Ncurses.keyname key}",
+               "</73>Skip current action?"]
+    buttons = ["Yes", "No"]
+
+    choice  = screen.popup_dialog(message, buttons)
+
+    if choice == 0 then false else true end
+  end
+
+  # This is run after the widget processes your
+  # input.
+  # It's commented to avoid annoyance.
+  # Uncomment for awesomeness
+
+  #scroll.bind_signal(:after_input) { screen.popup_label "</75>You did it!" }
+
+
+  # Finally, we activate the widget!
+  scroll.activate
+
+  RNDK::Screen.finish
+
+# Just in case something bad happens.
+rescue Exception => e
+  RNDK::Screen.finish
+  puts e
+  puts e.inspect
+  puts e.backtrace
+end
+