rndk 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5b6103e3b2539bf72321942974536d2688cdf41
-  data.tar.gz: 5890e72b066792bf7c11e0810aa6fec292c287d8
+  metadata.gz: c8f9ad279e8103fa755fa296a6ce77f841d44447
+  data.tar.gz: 645cac649bc64fc804541c71868800aa28b172e4
 SHA512:
-  metadata.gz: 4236e304d133df93247638b65dba122a1b434f6934f6635e4de784aa169696e773c874efdcb2835713390ee10e7c683b53a71594d9d1eb8b8f01d26d5a3d5af5
-  data.tar.gz: 18585b599021f220cc26fb9e2127b04727ef7d757b965be78b8e33d66ea27e3ef11f83a0f8013d53cd01b733eb7bc88925a9a40539ffbccf6b7647a946d0e5ec
+  metadata.gz: 66e6a0f5bdda584d982e13ecb89643c09f0acc07061c9de05912ecdaff70abf22163d87eba05fd4405d5fbff2672e75188cf07d37a7a22d121a65386612f5a12
+  data.tar.gz: 6ab7a46f6aa062a58d3b79a7620665eae38e1b0f6bfbeff64eaa4fd31a78d5dd700b5c9845789b12fda15c7ca77a27e8e8a2976338e1ebf1ee6f3d319b46f457

data/demos/appointment.rb

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
 #
+# Note: This is not for beginners! Check out the examples/
+#       before adventuring into the demos/ realm!
+#
 # Shows a book where you can create appointments of different
 # kinds, save and restore them on a file.
 #
@@ -40,8 +43,8 @@ class Appointment
     lines = []
 
     # Read the appointment file.
-    lines_read = RNDK.readFile(filename, lines)
-    if lines_read == -1
+    lines_read = RNDK.read_file(filename, lines)
+    if lines_read == nil
       app_info.count = 0
       return
     end
@@ -114,14 +117,13 @@ class Appointment
     readAppointmentFile(filename, appointment_info)
 
     # Set up RNDK
-    curses_win = Ncurses.initscr
-    rndkscreen = RNDK::Screen.new(curses_win)
+    rndkscreen = RNDK::Screen.new
 
     # Set up RNDK colors
-    RNDK::Draw.initRNDKColor
+    RNDK::Color.init
 
     # Create the calendar widget.
-    calendar = RNDK::CALENDAR.new(rndkscreen,
+    calendar = RNDK::Calendar.new(rndkscreen,
                                   RNDK::CENTER,
                                   RNDK::CENTER,
                                   title, day, month, year,
@@ -130,7 +132,6 @@ class Appointment
 
     # Is the widget nil?
     if calendar.nil?
-      rndkscreen.destroy
       RNDK::Screen.end_rndk
 
       puts "Cannot create the calendar. Is the window too small?"
@@ -148,8 +149,15 @@ class Appointment
 
       # Create the itemlist widget.
       itemlist = RNDK::ITEMLIST.new(calendar.screen,
-          RNDK::CENTER, RNDK::CENTER, '', 'Select Appointment Type: ',
-          items, items.size, 0, true, false)
+                                    RNDK::CENTER,
+                                    RNDK::CENTER,
+                                    '',
+                                    'Select Appointment Type: ',
+                                    items,
+                                    items.size,
+                                    0,
+                                    true,
+                                    false)
 
       # Get the appointment type from the user.
       selection = itemlist.activate([])
@@ -167,10 +175,19 @@ class Appointment
       marker = Appointment::GPAppointmentAttributes[selection]
 
       # Create the entry field for the description.
-      entry = RNDK::ENTRY.new(calendar.screen, RNDK::CENTER, RNDK::CENTER,
-          '<C>Enter a description of the appointment.',
-          'Description: ', Ncurses::A_NORMAL, '.'.ord, :MIXED, 40, 1, 512,
-          true, false)
+      entry = RNDK::ENTRY.new(calendar.screen,
+                              RNDK::CENTER,
+                              RNDK::CENTER,
+                              '<C>Enter a description of the appointment.',
+                              'Description: ',
+                              Ncurses::A_NORMAL,
+                              '.'.ord,
+                              :MIXED,
+                              40,
+                              1,
+                              512,
+                              true,
+                              false)
 
       # Get the description.
       description = entry.activate([])
@@ -275,7 +292,7 @@ class Appointment
       end
 
       # Create the label widget
-      label = RNDK::LABEL.new(calendar.screen, RNDK::CENTER, RNDK::CENTER, mesg, mesg.size, true, false)
+      label = RNDK::LABEL.new(calendar.screen, RNDK::CENTER, RNDK::CENTER, mesg, true, false)
       label.draw(label.box)
       label.wait(' ')
       label.destroy
@@ -293,17 +310,17 @@ class Appointment
              " '?' displays appointment for selected day",
              " 'enter' or 'tab' quits"]
 
-      rndkscreen.popupLabel msg
+      rndkscreen.popup_label msg
     end
 
     # Now we bind actions to the calendar.
     # Create a key binding to mark days on the calendar.
-    calendar.bind(:CALENDAR, 'm', create_calendar_mark_cb, appointment_info)
-    calendar.bind(:CALENDAR, 'M', create_calendar_mark_cb, appointment_info)
-    calendar.bind(:CALENDAR, 'r', remove_calendar_mark_cb, appointment_info)
-    calendar.bind(:CALENDAR, 'R', remove_calendar_mark_cb, appointment_info)
-    calendar.bind(:CALENDAR, '?', display_calendar_mark_cb, appointment_info)
-    calendar.bind(:CALENDAR, 'h', show_help, nil)
+    calendar.bind(:calendar, 'm', create_calendar_mark_cb, appointment_info)
+    calendar.bind(:calendar, 'M', create_calendar_mark_cb, appointment_info)
+    calendar.bind(:calendar, 'r', remove_calendar_mark_cb, appointment_info)
+    calendar.bind(:calendar, 'R', remove_calendar_mark_cb, appointment_info)
+    calendar.bind(:calendar, '?', display_calendar_mark_cb, appointment_info)
+    calendar.bind(:calendar, 'h', show_help, nil)
 
     # Set all the appointments read from the file.
     appointment_info.appointment.each do |appointment|
@@ -316,17 +333,15 @@ class Appointment
     end
 
     # Draw the calendar widget.
-    calendar.draw(calendar.box)
+    calendar.draw calendar.box
 
     # Let the user play with the widget.
-    calendar.activate([])
+    calendar.activate
 
     # Save the appointment information.
     Appointment.saveAppointmentFile(filename, appointment_info)
 
     # Clean up.
-    calendar.destroy
-    rndkscreen.destroy
     RNDK::Screen.end_rndk
   end
 end

data/demos/clock.rb

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
 #
+# Note: This is not for beginners! Check out the examples/
+#       before adventuring into the demos/ realm!
+#
 # Shows a colored clock on the screen according to
 # current system time.
 # Press any key to exit.
@@ -8,20 +11,19 @@ require 'rndk/label'
 
 begin
   # Set up RNDK
-  curses_win = Ncurses.initscr
-  rndkscreen = RNDK::Screen.new curses_win
-  RNDK::Draw.initRNDKColor
+  rndkscreen = 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, 1, true, true)
+  label = RNDK::LABEL.new(rndkscreen, RNDK::CENTER, RNDK::CENTER, mesg, true, true)
 
   # Woops, something bad happened
   if label.nil?
     rndkscreen.destroy
-    RNDK.end_rndk
+    RNDK::Screen.end_rndk
 
     puts "Cannot create the label. Is the window too small?"
     exit 1
@@ -33,7 +35,11 @@ begin
   # Will wait 50ms before getting input
   Ncurses.wtimeout(label.screen.window, 50)
 
-  begin
+  loop do
+    # Will go on until the user presses something
+    char = Ncurses.wgetch label.screen.window
+    break unless (char == Ncurses::ERR)
+
     current_time = Time.now.getlocal
 
     # Formatting time string.
@@ -41,16 +47,21 @@ begin
     mesg = [str]
 
     # Set the label contents
-    label.set(mesg, 1, label.box)
+    label.set(mesg, label.box)
 
     # Draw the label and sleep
     label.draw(label.box)
     Ncurses.napms(500)
-  end while (Ncurses.wgetch(label.screen.window)) == Ncurses::ERR
+  end
 
-  # Clean up
-  label.destroy
-  rndkscreen.destroy
   RNDK::Screen.end_rndk
+
+# In case something goes wrong
+rescue Exception => e
+  RNDK::Screen.end_rndk
+
+  puts e
+  puts e.inspect
+  puts e.backtrace
 end
 

data/demos/fileview.rb

@@ -0,0 +1,141 @@
+#!/usr/bin/env ruby
+#
+# Note: This is not for beginners! Check out the examples/
+#       before adventuring into the demos/ realm!
+#
+# Shows a FSelect Widget, asking you to pick a file.
+# Then, a Viewer Widget, showing that file's contents.
+#
+require 'optparse'
+require 'rndk/fselect'
+
+begin
+  filename  = ''
+  directory = '.'
+
+  # Create the viewer buttons.
+  button = [
+            '</5><OK><!5>',
+            '</5><Cancel><!5>',
+           ]
+
+  # Set up RNDK and Colors
+  rndkscreen = RNDK::Screen.new
+  RNDK::Color.init
+
+  # Get the filename
+  if filename == ''
+    title = '<C>Pick a file.'
+    label = 'File: '
+    fselect = RNDK::FSELECT.new(rndkscreen,
+                                RNDK::CENTER,
+                                RNDK::CENTER,
+                                20,
+                                65,
+                                title,
+                                label,
+                                Ncurses::A_NORMAL,
+                                '_',
+                                Ncurses::A_REVERSE,
+                                '</5>', '</48>', '</N>', '</N>',
+                                true,
+                                false)
+
+    # Set the starting directory.  This is not necessary because when
+    # the file selector starts it uses the present directory as a default.
+    fselect.set(directory,
+                Ncurses::A_NORMAL,
+                '.',
+                Ncurses::A_REVERSE,
+                '</5>', '</48>',
+                '</N>', '</N>',
+                fselect.box)
+
+    # Activate the file selector.
+    filename = fselect.activate([])
+
+    # Check how the person exited from the widget.
+    if fselect.exit_type == :ESCAPE_HIT
+      # pop up a message for the user.
+      mesg = [
+              '<C>Escape hit. No file selected.',
+              '',
+              '<C>Press any key to continue.',
+             ]
+      rndkscreen.popup_label(mesg, 3)
+
+      fselect.destroy
+
+      RNDK::Screen.end_rndk
+      exit
+    end
+    fselect.destroy
+  end
+
+  # Create the file viewer to view the file selected.
+  example = RNDK::VIEWER.new(rndkscreen,
+                             RNDK::CENTER,
+                             RNDK::CENTER,
+                             20,
+                             -2,
+                             button,
+                             2,
+                             Ncurses::A_REVERSE,
+                             true,
+                             false)
+
+  # Could we create the viewer widget?
+  if example.nil?
+    RNDK::Screen.end_rndk
+
+    puts "Cannot create viewer. Is the window too small?"
+    exit 1
+  end
+
+  # Open the file and read the contents.
+
+  info = []
+  lines = RNDK.read_file(filename, info)
+  if lines == -1
+    puts "Could not open %s" % [filename]
+    exit 1
+  end
+
+  # Set up the viewer title and the contents to the widget.
+  title = '<C></B/22>%20s<!22!B> (If screen is messed up, press Ctrl+L)' % filename
+  example.set(title, info, lines, Ncurses::A_REVERSE, true, true, true)
+
+  # Activate the viewer widget.
+  selected = example.activate([])
+
+  # Check how the person exited from the widget.
+  if example.exit_type == :ESCAPE_HIT
+    mesg = [
+            '<C>Escape hit. No Button selected.',
+            '',
+            '<C>Press any key to continue.',
+           ]
+    rndkscreen.popup_label mesg
+
+  elsif example.exit_type == :NORMAL
+    mesg = [
+            '<C>You selected button %d' % [selected],
+            '',
+            '<C>Press any key to continue.',
+           ]
+    rndkscreen.popup_label mesg
+  end
+
+  # Clean up
+  RNDK::Screen.end_rndk
+
+# In case something goes wrong
+rescue Exception => e
+  RNDK::Screen.end_rndk
+
+  puts e
+  puts e.inspect
+  puts e.backtrace
+end
+
+

data/examples/01-hello-world.rb

@@ -10,7 +10,7 @@ begin
   rndkscreen = RNDK::Screen.new
 
   # Set up RNDK colors
-  RNDK::Draw.initRNDKColor
+  RNDK::Color.init
 
   # Set the labels' content.
   # (RNDK supports a "markup" string, with colors
@@ -28,7 +28,6 @@ begin
                           RNDK::CENTER, # x
                           RNDK::CENTER, # y
                           mesg,         # message
-                          4,            # lines count
                           true,         # box?
                           true)         # shadow?
 

data/examples/02-colors.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+#
+# Shows how to use colors on your daily life,
+# plus this beautiful Calendar Widget!
+#
+require 'rndk/calendar'
+
+begin
+  # Always initialize and save the scren
+  screen = RNDK::Screen.new
+  RNDK::Color.init
+
+  # Disabling the blinking cursor
+  Ncurses.curs_set 0
+
+  # Welcome to our Calendar Widget!
+  #
+  # We call Colors attributes - or attrib.
+  # We use them as:
+  #
+  #     RNDK::Color[:foreground_background]
+  #
+  # If you want to use your terminal's default
+  # background, simply do:
+  #
+  #     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.activate []
+
+  RNDK::Screen.end_rndk
+
+# 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
+
+  puts e
+  puts e.inspect
+  puts e.backtrace
+  exit 1
+end
+

data/examples/03-markup.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+#
+# Shows all the color pairs available on RNDK.
+# Also, how to use RNDK's color markup on strings.
+#
+# Colors on text are achieved by foreground/background
+# color pairs. Run the example now.
+#
+# As you just say, they go from 1 to 80, going on the
+# following order in sets of 8 and from background to
+# foreground:
+#
+# 1. white
+# 2. red
+# 3. green
+# 4. yellow
+# 5. blue
+# 6. magenta
+# 7. cyan
+# 8. black
+#
+# Which means that 4 is white on yellow, 11 is red on green
+# and 44 is magenta on yellow.
+#
+# 65 to 72 are the default terminal's foreground over
+# color backgrounds and 73 to 80 are the colors over
+# the terminal's default background.
+
+require 'rndk/label'
+
+begin
+  # Starting RNDK and Color support
+  screen = RNDK::Screen.new
+  RNDK::Color.init
+
+  # Don't get scared, we're simply showing off all 80 color
+  # pairs available.
+  #
+  # * To start a color, do `</XX>`, where XX is a color pair
+  #   from 1 to 80.
+  # * To stop it, do `<!XX>`, where XX is the same as above.
+
+  msg = []
+  msg << "</1>Pair01<!1> </2>Pair02<!2> </3>Pair03<!3> </4>Pair04<!4> </5>Pair05<!5> </6>Pair06<!6> </7>Pair07<!7> </8>Pair08<!8>"
+  msg << "</9>Pair09<!9> </10>Pair10<!10> </11>Pair11<!11> </12>Pair12<!12> </13>Pair13<!13> </14>Pair14<!14> </15>Pair15<!15> </16>Pair16<!16>"
+  msg << "</17>Pair17<!17> </18>Pair18<!18> </19>Pair19<!19> </20>Pair20<!20> </21>Pair21<!21> </22>Pair22<!22> </23>Pair23<!23> </24>Pair24<!24>"
+  msg << "</25>Pair25<!25> </26>Pair26<!26> </27>Pair27<!27> </28>Pair28<!28> </29>Pair29<!29> </30>Pair30<!30> </31>Pair31<!31> </32>Pair32<!32>"
+  msg << "</33>Pair33<!33> </34>Pair34<!34> </35>Pair35<!35> </36>Pair36<!36> </37>Pair37<!37> </38>Pair38<!38> </39>Pair39<!39> </40>Pair40<!40>"
+  msg << "</41>Pair41<!41> </42>Pair42<!42> </43>Pair43<!43> </44>Pair44<!44> </45>Pair45<!45> </46>Pair46<!46> </47>Pair47<!47> </48>Pair48<!48>"
+  msg << "</49>Pair49<!49> </50>Pair50<!50> </51>Pair51<!51> </52>Pair52<!52> </53>Pair53<!53> </54>Pair54<!54> </55>Pair55<!55> </56>Pair56<!56>"
+  msg << "</57>Pair57<!57> </58>Pair58<!58> </59>Pair59<!59> </60>Pair60<!60> </61>Pair61<!61> </62>Pair62<!62> </63>Pair63<!63> </64>Pair64<!64>"
+  msg << "</65>Pair65<!65> </66>Pair66<!66> </67>Pair67<!67> </68>Pair68<!68> </69>Pair69<!69> </70>Pair70<!70> </71>Pair71<!71> </72>Pair72<!72>"
+  msg << "</73>Pair73<!73> </74>Pair74<!74> </75>Pair75<!75> </76>Pair76<!76> </77>Pair77<!77> </78>Pair78<!78> </79>Pair79<!79> </80>Pair80<!80>"
+  msg << ""
+  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,
+                          true,         # has box?
+                          true)         # has shadow?
+
+  screen.refresh
+  label.wait('q') # wait for key to be pressed
+
+  RNDK::Screen.end_rndk
+end
+

data/examples/04-quick-widgets.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+#
+# This shows you how easy it is to use the Quick Widgets --
+# temporary pre-made Widgets with a single action.
+#
+# They're automatically included within `require 'rndk'`.
+require 'rndk'
+
+begin
+  screen = RNDK::Screen.new
+
+  # Popup label
+  msg = ["Hello, there!",
+         "Lemme show you some pre-made widgets",
+         "This is the popup_label",
+         "(press any key to continue)"
+        ]
+  screen.popup_label msg
+
+  # Popup dialog
+  msg = ["Now this is the popup_dialog",
+         "It returns the index of which button",
+         "you select"
+        ]
+  buttons = ["Press me",
+             "No, press me",
+             "No, me"
+            ]
+  choice = screen.popup_dialog(msg, buttons)
+
+  screen.popup_label ["You selected button no #{choice}"]
+
+  # View file
+  title = "view_file (If something bad happens, press Ctrl+L)"
+  buttons = ["I'm impressed",
+             "Maybe impressed",
+             "Not impressed"
+             ]
+  screen.view_file(title, __FILE__, buttons)
+
+  # Get list index
+  title = "get_list_index example"
+  msg = ["Apples",
+         "Oranges",
+         "Avocados",
+         "Watermelons"]
+
+  screen.get_list_index(title, msg, true)
+
+  # Get string
+  title = "get_string example"
+  msg = "Finally, the last example! What did you thing of it? "
+
+  value = screen.get_string(title, msg, "great")
+
+  screen.popup_label ["You just said '#{value}'"]
+
+  # Finally, the end!
+  RNDK::Screen.end_rndk
+
+  puts "...and as always, thanks for watching!"
+
+# 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/05-position-widget.rb

@@ -40,7 +40,7 @@ begin
   rndkscreen = RNDK::Screen.new(curses_win)
 
   # Set up RNDK colors
-  RNDK::Draw.initRNDKColor
+  RNDK::Color.init
 
   # Create the entry field widget.
   entry = RNDK::ENTRY.new(rndkscreen,
@@ -79,7 +79,7 @@ begin
             "",
             "<C>Press any key to continue."
            ]
-    rndkscreen.popupLabel mesg
+    rndkscreen.popup_label mesg
 
   elsif entry.exit_type == :NORMAL
     mesg = [
@@ -88,12 +88,9 @@ begin
             "",
             "<C>Press any key to continue."
            ]
-    rndkscreen.popupLabel mesg
+    rndkscreen.popup_label mesg
   end
 
-  # Clean up
-  entry.destroy
-  rndkscreen.destroy
   RNDK::Screen.end_rndk
 
 # Just in case something bad happens.