rbcurse 0.1.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-10-26
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,54 @@
+History.txt
+Manifest.txt
+README.txt
+CHANGELOG
+Rakefile
+lib/rbcurse.rb
+test/test_rbcurse.rb
+lib/rbcurse/action.rb
+lib/rbcurse/applicationheader.rb
+lib/rbcurse/celleditor.rb
+lib/rbcurse/checkboxcellrenderer.rb
+lib/rbcurse/colormap.rb
+lib/rbcurse/comboboxcellrenderer.rb
+lib/rbcurse/defaultlistselectionmodel.rb
+lib/rbcurse/keylabelprinter.rb
+lib/rbcurse/listcellrenderer.rb
+lib/rbcurse/listkeys.rb
+lib/rbcurse/listscrollable.rb
+lib/rbcurse/listselectable.rb
+lib/rbcurse/mapper.rb
+lib/rbcurse/orderedhash.rb
+lib/rbcurse/rcombo.rb
+lib/rbcurse/rdialogs.rb
+lib/rbcurse/rform.rb
+lib/rbcurse/rinputdataevent.rb
+lib/rbcurse/rlistbox.rb
+lib/rbcurse/rmenu.rb
+lib/rbcurse/rmessagebox.rb
+lib/rbcurse/rpopupmenu.rb
+lib/rbcurse/rtabbedpane.rb
+lib/rbcurse/rtable.rb
+lib/rbcurse/rtextarea.rb
+lib/rbcurse/rtextview.rb
+lib/rbcurse/rwidget.rb
+lib/rbcurse/scrollable.rb
+lib/rbcurse/selectable.rb
+lib/rbcurse/table/tablecellrenderer.rb
+lib/rbcurse/table/tabledatecellrenderer.rb
+lib/ver/keyboard.rb
+lib/ver/keyboard2.rb
+lib/ver/ncurses.rb
+lib/ver/window.rb
+examples/qdfilechooser.rb
+examples/rfe.rb
+examples/rfe_renderer.rb
+examples/test1.rb
+examples/test2.rb
+examples/testcombo.rb
+examples/testkeypress.rb
+examples/testmenu.rb
+examples/testtable.rb
+examples/testtabp.rb
+examples/testtodo.rb
+examples/viewtodo.rb

data/README.txt

@@ -0,0 +1,304 @@
+= rbcurse
+
+* http://totalrecall.wordpress.com   << CORRECTED !!!
+
+* See latest changes on http://github.com/rkumar/rbcurse/tree/master/CHANGELOG
+
+* For a working example, execute test2.rb (exit with F1, Or Cancel
+  button/Alt-C).
+
+* Screenshots on http://github.com/rkumar/rbcurse/wikis/screenshots
+  and http://www.benegal.org/files/screen/
+
+  Full screen sample: http://www.benegal.org/files/screen/nc_ss_full.png
+
+== DESCRIPTION:
+
+A small widget library written in ruby for creating ncurses
+applications.
+See lib/rbcurse/rwidgets.rb and lib/rbcurse/rform.rb.
+Test programs are in base dir: test1.rb, test2.rb, testtabp.rb
+
+== FEATURES
+
+* entry fields in ruby 
+* scrollable list box (new, editable with Field, checkbox and combos)
+* multi-line editable area
+* togglebutton, radio and check buttons (with mnemonics)
+* message box
+* menubar - with submenu and CheckBoxMenuItem
+* popup list
+* tabbedpane (multiple forms using tabbed metaphor)
+* combobox
+* labels with mnemonics (hotkeys)
+* multi-column table - with cell selection and editing
+
+Above may be created using DSL like syntax, or hashes.
+
+== Sample programs:
+
+*  test2.rb  most widgets (including menus)
+   http://github.com/rkumar/rbcurse/tree/master/test2.rb
+*  test1.rb  various kinds of messageboxes (input, list, custom)
+   http://github.com/rkumar/rbcurse/tree/master/test1.rb
+*  testtabp.rb  tabbed pane
+   http://github.com/rkumar/rbcurse/tree/master/testtabp.rb
+*  testcombo.rb  combos with various insert policies and vertical
+   alignments
+
+== PROBLEMS, ISSUES
+TextArea not bug free. Some situations wrapping errors could exist. 
+
+== Terminal related issues.
+
+* Some terminals may not show underlines (e.g screen).
+
+* Some terminals (xterm-color) do not process Function keys, avoid declaring F1 etc if
+  unsure of client terminals. I have put in fixes for xterm-color F1 and
+  backtab.
+
+* To use ALT/META keys on a Mac OS X, in Terminal preferences, under
+  Keyboard, select
+  "use Option as Meta key". All hotkeys are automatically, ALT combinations.
+
+* Some screens do not display window background color under spaces.
+  This is okay under "screen" and "xterm-color" but not under "xterm". You will notice
+  this in the message box samples.
+
+I am developing and testing under "screen" under OS X Leopard.
+
+== SYNOPSIS:
+
+See lib/rbcurse/rwidgets.rb.
+For test programs, see test1, test2, testcombo etc in root folder.
+
+This depends only on "window" provided by ncurses. Does not use forms
+and fields. Minor changes and improvements may have happened to sample
+code below. See test programs for latest, working code.
+
+=== create a window and a form based on window
+
+      @layout = { :height => 0, :width => 0, :top => 0, :left => 0 } 
+      @win = VER::Window.new(@layout)
+
+      @form = Form.new @win
+
+
+=== create a bunch of fields with dependent labels
+
+      r = 1; c = 22;
+      %w[ name age company].each do |w|
+        field = Field.new @form do
+          name   w 
+          row  r 
+          col  c 
+          display_length  30
+          set_buffer "abcd #{w}" 
+          set_label Label.new @form, {'text' => w}
+        end
+        r += 1
+      end
+
+=== create a variable (like TkVariable) and tie a label to it.
+
+      $results = Variable.new
+      $results.value = "A variable"
+      var = RubyCurses::Label.new @form, {'text_variable' => $results, "row" => r, "col" => 22}
+        r += 1
+
+=== create a list and a list box based on the list.
+
+        mylist = []
+        0.upto(100) { |v| mylist << "#{v} scrollable data" }
+
+        field = Listbox.new @form do
+          name   "mylist" 
+          row  r 
+          col  1 
+          width 40
+          height 10
+          list mylist
+        end
+        field.insert 5, "hello ruby", "so long python", "farewell java", "RIP .Net"
+
+=== create a textarea for entry (this can be buggy at present)
+
+        texta = TextArea.new @form do
+          name   "mytext" 
+          row  1 
+          col  52 
+          width 40
+          height 20
+        end
+        texta << "hello there" << "we are testing deletes in this application"
+        texta << "HELLO there" << "WE ARE testing deletes in this application"
+
+=== create a check box, updates a Variable
+
+      checkbutton = CheckBox.new @form do
+        text_variable $results
+        #value = true
+        onvalue "selected cb"
+        offvalue "UNselected cb"
+        text "Please click me"
+        row 17
+        col 22
+      end
+
+=== change field properties at any time by referring to them by name
+
+      @form.by_name["age"].display_length = 3
+      @form.by_name["age"].maxlen = 3
+      @form.by_name["age"].set_buffer  "24"
+      @form.by_name["name"].set_buffer  "Not focusable"
+      @form.by_name["age"].chars_allowed = /\d/
+      @form.by_name["company"].type(:ALPHA)
+      @form.by_name["name"].set_focusable(false)
+
+      @form.by_name["password"].color 'red'
+      @form.by_name["password"].bgcolor 'blue'
+
+      # restrict entry to some values
+      password.values(%w[ scotty tiger secret qwerty])
+
+      # validation using ruby's regular expressions
+
+      field.valid_regex(/^[A-Z]\d+/)
+
+=== bind events to forms, and fields
+
+      @form.bind(:ENTER) { |f|   f.label.bgcolor = $promptcolor if f.instance_of? RubyCurses::Field}
+      @form.bind(:LEAVE) { |f|  f.label.bgcolor = $datacolor  if f.instance_of? RubyCurses::Field}
+
+=== create buttons
+
+      ok_button = Button.new @form do
+        text "OK"
+        name "OK"
+        row 18
+        col 22
+      end
+      ok_button.command { |form| $results.value = "OK PRESS:";form.printstr(@window, 23,45, "OK CALLED") }
+        #text "Cancel"
+      cancel_button = Button.new @form do
+        text_variable $results
+        row 18
+        col 28
+      end
+      cancel_button.command { |form| form.printstr(@window, 23,45, "Cancel CALLED"); throw(:close); }
+
+=== create radio buttons
+
+      colorlabel = Label.new @form, {'text' => "Select a color:", "row" => 20,
+          "col" => 22, "color"=> "cyan"}
+      $radio = Variable.new
+      radio1 = RadioButton.new @form do
+        text_variable $radio
+        text "red"
+        value "red"
+        color "red"
+        row 21
+        col 22
+      end
+      radio2 = RadioButton.new @form do
+        text_variable $radio
+        text  "green"
+        value  "green"
+        color "green"
+        row 22
+        col 22
+      end
+
+=== create a messagebox 
+
+      @mb = RubyCurses::MessageBox.new do
+        title "Enter your name"
+        message "Enter your name"
+        type :input
+        default_value "rahul"
+        default_button 0
+      end
+        #title "Color selector"
+        #type :custom
+        #buttons %w[red green blue yellow]
+        #underlines [0,0,0,0]
+      
+     $log.debug "MBOX : #{@mb.selected_index} "
+     $log.debug "MBOX : #{@mb.input_value} "
+
+=== create a read-only scrollable view of data
+ 
+        @textview = TextView.new @form do
+          name   "myView" 
+          row  16 
+          col  52 
+          width 40
+          height 7
+        end
+        content = File.open("../../README.txt","r").readlines
+        @textview.set_content content
+
+        ## set it to point to row 21
+        @textview.top_row 21
+
+
+        # lets scroll the text view as we scroll the listbox
+
+        listb.bind(:ENTER_ROW, @textview) { |arow, tview| tview.top_row arow }
+        
+        # lets scroll the text view to the line you enter in the numeric
+        # field
+        @form.by_name["line"].bind(:LEAVE, @textview) { |fld, tv| tv.top_row(fld.getvalue.to_i) }
+
+        # lets scroll the text view to the first match of the regex you
+        # enter
+        @form.by_name["regex"].bind(:LEAVE, @textview) { |fld, tv| tv.top_row(tv.find_first_match(fld.getvalue)) }
+
+        # change the value of colorlabel to the selected radiobutton
+        # (red or green)
+
+        $radio.update_command(colorlabel) {|tv, label|  label.color tv.value}
+
+        # change the attribute of colorlabel to bold or normal
+
+        $results.update_command(colorlabel,checkbutton) {|tv, label, cb| 
+            attrs =  cb.value ? 'bold' : nil; label.attrs(attrs)}
+
+      # during menu creation, create a checkboxmenuitem
+
+      item = RubyCurses::CheckBoxMenuItem.new "CheckMe"
+
+      # when selected, make colorlabel attribute reverse.
+
+      item.command(colorlabel){|it, label| att = it.getvalue ? 'reverse' :
+          nil; label.attrs(att); label.repaint}
+
+== REQUIREMENTS:
+
+* ruby 1.8.7    (not compatible with 1.9)
+
+* ncurses-ruby
+
+(following is provided with source)
+
+* uses the window class created by "manveru" (michael) - this can be
+  removed if not needed. (lib/ver/window)
+  It is provided with this package, and has some alterations from the
+  original. I have added a method getchar() which traps and returns
+  ALT/META, META+CTRL, META+SHIFT+CONTROL, ALT+Fn etc. 
+
+  So basically do not remove it unless you have very different
+  requirements.
+
+== INSTALL:
+
+* currently, just unzip/untar in a folder. Please change the path in
+  the top line of the test programs.
+
+(Please advice me how i can improve installation procedure)
+
+== LICENSE:
+
+Copyright (c) 2008 rkumar
+
+Same as ruby license.

data/Rakefile

@@ -0,0 +1,28 @@
+# -*- ruby -*-
+
+
+#
+require 'rubygems'
+require 'hoe'
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require 'rbcurse'
+#require './lib/rbcurse.rb'
+
+Hoe.new('rbcurse', Rbcurse::VERSION) do |p|
+  p.name = "rbcurse"
+  p.author = "Rahul Kumar"
+  p.description = "Ruby curses widgets for easy application development"
+  p.email = 'sentinel.2001@gmx.com'
+  p.summary = "Ruby curses widgets."
+  p.url = "http://rbcurse.rubyforge.org/"
+  p.clean_globs = ['test/actual'] # Remove this directory on "rake clean"
+  p.remote_rdoc_dir = '' # Release to root
+  p.changes = p.paragraphs_of('CHANGELOG', 0..1).join("\n\n")
+  # * extra_deps - An array of rubygem dependencies.
+end
+
+
+desc "Release and publish documentation"
+task :repubdoc => [:release, :publish_docs]
+
+# vim: syntax=Ruby

data/examples/qdfilechooser.rb

@@ -0,0 +1,68 @@
+# this is a test program, tests out messageboxes. type F1 to exit
+# a quick dirty file chooser in 2 lines of code.
+#$LOAD_PATH << "/Users/rahul/work/projects/rbcurse/"
+require 'rubygems'
+require 'ncurses'
+require 'logger'
+require 'ver/ncurses'
+require 'ver/window'
+require 'rbcurse/rwidget'
+
+##
+# a quick dirty file chooser - only temporary till we make something better.
+class QDFileChooser
+  attr_accessor :show_folders   # bool
+  attr_accessor :traverse_folders   # bool
+  attr_accessor :default_pattern  # e.g. "*.*"
+  attr_accessor :dialog_title    # File Chooser
+  def initialize
+
+  end
+  def show_open_dialog
+        @form = RubyCurses::Form.new nil
+        label = RubyCurses::Label.new @form, {'text' => 'File', 'row'=>3, 'col'=>4, 'color'=>'black', 'bgcolor'=>'white', 'mnemonic'=>'F'}
+        field = RubyCurses::Field.new @form do
+          name   "file" 
+          row  3 
+          col  10
+          display_length  40
+          set_label label
+        end
+        default_pattern ||= "*.*"
+        flist = Dir.glob(default_pattern)
+        @listb = RubyCurses::Listbox.new @form do
+          name   "mylist" 
+          row  5 
+          col  10 
+          width 40
+          height 10
+          list flist
+          title "File list"
+          title_attrib 'bold'
+        end
+        #@listb.list.bind(:ENTER_ROW) { field.set_buffer @listb.selected_item }
+        listb = @listb
+        field.bind(:CHANGE) do |f|   
+          flist = Dir.glob(f.getvalue+"*")
+          l = listb.list
+          l.remove_all
+          l.insert 0, *flist
+        end
+        atitle = @dialog_title || "Quick Dirty(TM) File Chooser"
+        @mb = RubyCurses::MessageBox.new @form do
+          title atitle
+          type :override
+          height 20
+          width 60
+          top 5
+          left 20
+          default_button 0
+          button_type :ok_cancel
+        end
+        return @mb.selected_index == 0 ? :OK : :CANCEL
+        $log.debug "MBOX :selected #{@listb.selected_item}"
+  end 
+  def get_selected_file
+    return @mb.selected_index == 0 ? @listb.selected_item : nil
+  end
+end