rbcurse 0.1.3 → 1.1.1

data/CHANGELOG

@@ -1,3 +1,129 @@
+**2010-03-01 00:00** 
+## Overhaul of tabbedpane
+
+Simplified, and it more or less completely makes sense now.
+A component may be added directly without creating a form
+which allows the TP to set row, col, and height width.
+
+At this moment, it no longer creates a form automatically, you have to call
+tp.form(tab) to get a form associated with the tab. Check code for latest on
+this. Or check samples: testtpane.rb and testtpane2.rb.
+
+**2010-02-18 22:58** 
+## RFED16 new simplified buffering
+
+Major changes. Most widgets redone (buffer part).
+Containers majorly done. Table and TabbedPane still pending.
+
+**2009-11-03 23:30**
+## tabbedpanes ##
+
+Now on first click of tabbed button, form is painted.
+A form.repaint for the lower form was required.
+
+frmincr200911032330.tgz
+* * *
+**2009-11-03 00:19**
+## some progress on tabbedpanes ##
+
+Ugly hacking and I really haven't a clue what's happening
+since there's internal forms working.
+Anyhow, its now showing up, can see form cursor moving.
+Does not show up immediately, have to press key several times for form to display.
+
+frmincr200911030018.tgz
+* * *
+**2009-11-02 13:15**
+## before rtabbedpane ##
+
+After all the changes, the new tabbedpane is not printing the form fields.
+Working on that now.
+
+frmincr200911021314.tgz
+* * *
+**2009-11-02 12:13**
+## splitpane and scrollpane working ##
+
+Both are working. Changes to copywin had caused issues. And printborder.
+Decreasing comp width does not reduce pad size, but pad keeps printing larger size.
+So in Splitpane it was overwriting. Now in Pad we maintain sheight as comp's height.
+Major change in pad, but hope it works and doesn't bomb out somewhere.
+
+frmincr200911021212.tgz
+* * *
+**2009-11-02 01:03**
+## SplitPane retouching ##
+
+began majorly misprinting after changes to printborder and copywin().
+ALmost corrected. Still some issues in copywin which are making separator and border
+to get eaten up.
+
+frmincr200911020102.tgz
+* * *
+**2009-11-01 22:28**
+## scrollbars in scrollpane ##
+
+Added scrollbars in scrollpane. Sized and positioned nicely.
+
+frmincr200911012228.tgz
+* * *
+**2009-11-01 01:05**
+## scrollpane WIP ##
+
+scrollpane with viewport and child object
+i can see the child within. have to test scrolling now.
+Issue is largely with copywin which gives errors.
+
+frmincr200911010104.tgz
+* * *
+**2009-10-31 22:07**
+## scrollpane WIP ##
+
+,,,
+
+frmincr200910312206.tgz
+* * *
+**2009-10-30 23:32**
+## more testing with SplitPane and 2 splitpanes in it ##
+
+vertical and horizontal
+check against min sizes
+
+frmincr200910302331.tgz
+* * *
+**2009-10-30 17:47**
+## buffering ##
+
+major change is buffering added (using pad)
+height and width added to Widget
+Splitpane added (midway)
+
+frmincr200910301746.tgz
+* * *
+**2009-10-07 10:14**
+## Prior to change in next_column ##
+
+Currently, after last visible column tab goes to next row.
+We want to scroll if more columns.
+At present, table will not print if a col goes out of bounds. but this does not impact
+first or last column to print variables.
+
+frmincr200910071012.tgz
+* * *
+** 2009-10-05 11:00 **
+## Horizontal scrolling in tables - some cleaning ##
+
+When increasing the size of a column, other cols could write
+outside the table. Fixed.
+
+* * *
+** 2009-10-05 00:00 **
+## Making changes for 1.9 and testing ##
+
+Mostly key related changes.
+However, there could be some string index change lurking around
+
+* * *
 ** 2009-02-22 20:48 **
 
 ## Released 0.1.2 ##

data/Manifest.txt

@@ -1,25 +1,8 @@
 CHANGELOG
 History.txt
 Manifest.txt
-README.txt
+README.markdown
 Rakefile
-examples/qdfilechooser.rb
-examples/rfe.rb
-examples/rfe_renderer.rb
-examples/sqlc.rb
-examples/test1.rb
-examples/test2.rb
-examples/testcombo.rb
-examples/testd.db
-examples/testkeypress.rb
-examples/testmenu.rb
-examples/testtable.rb
-examples/testtabp.rb
-examples/testtodo.rb
-examples/todocsv.csv
-examples/viewtodo.rb
-lib/rbcurse.rb
-lib/rbcurse.rb
 lib/rbcurse/action.rb
 lib/rbcurse/applicationheader.rb
 lib/rbcurse/celleditor.rb
@@ -27,32 +10,82 @@ lib/rbcurse/checkboxcellrenderer.rb
 lib/rbcurse/colormap.rb
 lib/rbcurse/comboboxcellrenderer.rb
 lib/rbcurse/defaultlistselectionmodel.rb
+lib/rbcurse/io.rb
 lib/rbcurse/keylabelprinter.rb
 lib/rbcurse/listcellrenderer.rb
+lib/rbcurse/listeditable.rb
 lib/rbcurse/listkeys.rb
 lib/rbcurse/listscrollable.rb
 lib/rbcurse/listselectable.rb
 lib/rbcurse/mapper.rb
 lib/rbcurse/orderedhash.rb
+lib/rbcurse/rchangeevent.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/rmulticontainer.rb
+lib/rbcurse/rmultitextview.rb
 lib/rbcurse/rpopupmenu.rb
+lib/rbcurse/rscrollform.rb
+lib/rbcurse/rscrollpane.rb
+lib/rbcurse/rsplitpane.rb
 lib/rbcurse/rtabbedpane.rb
+lib/rbcurse/rtabbedwindow.rb
 lib/rbcurse/rtable.rb
 lib/rbcurse/rtextarea.rb
 lib/rbcurse/rtextview.rb
+lib/rbcurse/rviewport.rb
 lib/rbcurse/rwidget.rb
 lib/rbcurse/scrollable.rb
 lib/rbcurse/selectable.rb
 lib/rbcurse/table/tablecellrenderer.rb
 lib/rbcurse/table/tabledatecellrenderer.rb
+lib/rbcurse/undomanager.rb
+lib/rbcurse/vieditable.rb
+lib/rbcurse.rb
 lib/ver/keyboard.rb
 lib/ver/keyboard2.rb
 lib/ver/ncurses.rb
 lib/ver/window.rb
-test/test_rbcurse.rb
-
+examples/keytest.rb
+examples/mpad2.rb
+examples/newtesttabp.rb
+examples/qdfilechooser.rb
+examples/rfe.rb
+examples/rfe_renderer.rb
+examples/rvimsplit.rb
+examples/sqlc.rb
+examples/sqlm.rb
+examples/test1.rb
+examples/test2.rb
+examples/testchars.rb
+examples/testcombo.rb
+examples/testkeypress.rb
+examples/testmenu.rb
+examples/testmulticomp.rb
+examples/testscroller.rb
+examples/testscrolllb.rb
+examples/testscrollp.rb
+examples/testscrollta.rb
+examples/testscrolltable.rb
+examples/testsplit.rb
+examples/testsplit2.rb
+examples/testsplit3.rb
+examples/testsplit3_1.rb
+examples/testsplit3a.rb
+examples/testsplit3b.rb
+examples/testsplitta.rb
+examples/testsplittv.rb
+examples/testsplittvv.rb
+examples/testtable.rb
+examples/testtabp.rb
+examples/testtestw.rb
+examples/testtodo.rb
+examples/testtpane.rb
+examples/testtpane2.rb
+examples/testtpanetable.rb
+examples/viewtodo.rb

data/README.markdown

@@ -0,0 +1,423 @@
+# rbcurse (for ruby 1.9.1)
+
+* Version to work with ruby 1.9 (backward compatible with 1.8.7)
+
+This branch - RFED19 - contains major rework on the buffering approach. It only affect
+programs that have used buffers such as splitpanes, scrollpanes and tabbedpanes.
+All are fixed.
+
+Check downloads at <http://github.com/rkumar/rbcurse/downloads>
+
+Some of the samples mentioned below may **not** work. test2.rb works - i always give it a quick run after making changes. All the testsplit* and testscroll* examples are working.
+
+* <http://totalrecall.wordpress.com>  - always has some status posted.
+
+* Notes on rbcurse - very frequent updates <http://rbcurse.tumblr.com/>
+
+* rbcurse on rubyforge: <http://rbcurse.rubyforge.org/> - Not updated.
+
+* See changes on (not updated often)
+ <http://github.com/rkumar/rbcurse/tree/master/CHANGELOG>
+
+* Many working demos in examples folder, such as:
+
+  * test2.rb (exit with F1, Or Cancel button/Alt-C) contains various
+    widgets. F2 for menubar toggling
+
+  * rfe.rb is a ruby file explorer demo.
+
+  * sqlc.rb is a ruby sql client _demo_ (using testd.db at
+     <http://www.benegal.org/files/screen/testd.db>)
+    (requires gem sqlite3-ruby)
+    sqlc.rb: uses tabbedpanes - each query opens a new tab
+    sqlm.rb: uses a multi-container - each query opens a new table in the multicontainer
+
+  * testtodo.rb is a test TODO application (now using fastercsv)
+    (needs retesting - may not work at all)
+
+* Screenshots on 
+  <http://www.benegal.org/files/screen/?M=D>   (new)
+  and on blog, <http://totalrecall.wordpress.com>   
+  and http://github.com/rkumar/rbcurse/wikis/screenshots (old)
+
+* Todo (for 0.1.2):
+ <http://rubyforge.org/pm/task.php?group_id=7775&group_project_id=13812&func=browse>
+
+  See [TODO2.txt](http://github.com/rkumar/rbcurse/blob/rbcurse19/TODO2.txt) (created and maintained by [todoapp.sh](http://github.com/rkumar/todoapp), also hosted here)
+
+* Next Major Release:
+ <http://rubyforge.org/pm/task.php?group_project_id=13813&group_id=7775&func=browse>
+
+## DESCRIPTION:
+
+A small but comprehensive widget library written in ruby for creating ncurses
+applications.
+
+## FEATURES
+
+* Field : text/entry fields in pure ruby (not ncurses)
+* scrollable list box (also editable lists with Field, checkbox and combos)
+* Textarea : 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)
+* Table: multi-column table - with cell selection and editing, horizontal and
+  vertical scrolling
+* Scrollpanes which can contain textviews, textareas, listboxes.
+* Splitpanes which can contain scrollpanes, textviews/areas, listboxes *or splitpanes* ...
+* MultiContainer = add any number of objects to it (such as tables or text objects) and cycle through them
+  (saves screen estate)
+* MultiTextView - have multiple files open for viewing in one component. Since these are readonly files, one can map a lot of single-keys as in vim for operating and cycling through buffers.
+* Textview - editable option using vim like keys.
+* PromptMenu - A simple interactive menu like the `most` application. Saves on allocating keybindings and memorizing them.
+* multiple key bindings for Procs, block and symbols (as in vim and emacs: `C-x C-f` or `15dd`)
+* Kill-ring concept of emacs for cut-paste operations
+* Unlimited undo and redo in TextArea (needs to be switched on at present on instance basis)
+* Numeric arguments. (vim: 25dd etc. Or in an editable box, emacs's C-u or Alt-1..9)
+* Various others, too
+
+Above may be created using DSL like syntax, or hashes, and modified at
+runtime. Very flexible unlike ncurses forms and fields.
+
+## Current work
+
+I've just added vi and emacs key bindings to some classes, multiple object containers such as MultiContainer
+and MultiTextView. Emacs like kill-ring in TextArea and TextView. Tabbedpane can have unlimited tabs, we can scroll the tabs. Bunch of other stuff. Multiple keys can be bound to a Proc or symbol as in emacs and vim (dd or C-x C-f).
+
+I've made a demo using ScrollForm (testscroller.rb)- a form that takes more fields/objects than
+can be viewed at a go. Meta keys scroll the form.
+Then onto testing what's there, before making a stable
+release.
+
+## Sample programs:
+
+*  test2.rb  most widgets (including menus)
+*  sqlc.rb is a ruby sql client demo (using sqlite3-ruby)
+*  rfe : file explorer or Finder like app
+*  testcombo.rb  combos with various insert policies and vertical
+   alignments
+*  testtodo.rb  : a todo app based on a yaml file (now csv)
+*  testmenu.rb  : popup menu with multiple levels
+*  testtabp.rb  tabbed pane
+*  test1.rb  various kinds of messageboxes (input, list, custom)
+   pass 1,2,3,4, or 5 as argument on command line
+   ruby test1.rb 1
+   ruby test1.rb 2
+*  test2.rb  most widgets (including menus)
+   - partially tested, many widgets, needs thorough testing.
+
+*  testscroll*.rb - various demos of scrollpanes with listboxes, text areas, tables etc
+
+*  testsplit*.rb - various splitpanes with scrollpanes and other objects placed inside
+   See screenshots on blog.
+
+*  testtpane.rb  - tabbedpane sample with a scrollpane and a textobject. 
+
+## PROBLEMS, ISSUES
+
+
+## General terminal related issues.
+
+The following are issues with terminals (or with ncurses-ruby in some cases) not with rbcurse.
+
+* 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 10.5.8 PPC.
+
+## SYNOPSIS:
+
+See lib/rbcurse/rwidgets.rb.
+For test programs, see test1, test2, testcombo etc in examples 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.**
+
+THE following samples are only demonstrative of how widgets are built. See samples in examples folder for initialization of ncurses etc which is necessary before the following code can be run. The following samples may be slightly obsolete.
+
+### 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 
+
+        texta = TextArea.new @form do
+          name   "mytext" 
+          row  1 
+          col  52 
+          width 40
+          height 20
+        end
+        texta << "hello there" << "Some text to go into textarea."
+        texta << "HELLO ruby" << "Some text to go into textarea."
+
+### 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.markdown","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.9.1 (I believe it is working on 1.8.7 as well).
+
+* ncurses-ruby (1.2.4)
+
+(Note: 1.8.6 users: pls report any issues and suggest a fix or alternative if you encounter a method_missing)
+
+
+## INSTALL:
+
+STEP 1.
+
+   `sudo gem install ncurses-ruby`
+
+If the above fails, then do as follows:
+
+Somehow at the time of writing the above installs a version that does
+not work with 1.9. So you have to download ncurses-ruby (1.2.4) tgz from
+<http://ncurses-ruby.berlios.de/> as follows:
+
+1. Download <http://prdownload.berlios.de/ncurses-ruby/ncurses-ruby-1.2.4.tar.bz2>
+2. unzip the file, cd into dir
+2. run install commands as per README (`ruby extconf.rb && make`)
+3. Create a gemspec ... use this file <http://gist.github.com/201877>
+   Save it as ncurses.gemspec 
+4. `sudo gem build ncurses.gemspec`
+5. `sudo gem install --local ncurses-1.2.4.gem`
+6. **uninstall** any previous ncurses or ncurses-ruby version otherwise
+errors will persist at runtime.
+7. check with `gem list --local` and you should see ncurses (1.2.4). The
+ examples in the ncurses-ruby/examples folder should work. (Check the
+first line regarding interpreter first).
+8. As a last resort, I've put up a copy of the gem [here](http://www.benegal.org/files/ncurses-1.2.4.gem).
+
+(edit: I am told that step 2 installs ncurses-ruby locally, so you don't need to create a gem)
+
+STEP 2.
+
+   `sudo gem install rbcurse`
+
+ Now go to the the `examples` folder and execute some examples.
+
+    cd examples 
+    ruby test2.rb
+
+
+Note: Please use gem version 1.1.1 or higher. I have just created this gem, so let me know if there are missing files.
+
+### Installing ncurses on Mac OS X Snow Leopard
+
+STEP 1.
+
+ncurses-ruby 1.2.4 is not installing, errors in `make`. I have not found a working solution. Finally, I used ncurses-0.9.1 and made some changes and it is working. Needs to be tested out. I am not sure how I got ncurses-0.9.1 in my gems folder, possible I had done a `sudo port install ncurses`.
+
+http://trickyco.de/tag/ncurses has a similar procedure. I made the changes based on my working copy of 1.2.4 from my OS X PPC Machine. Will upload the gem and code.
+
+trickyco's procedure is as follows:
+
+    gem fetch ncurses
+    gem unpack ncurses-0.9.1.gem 
+    ruby extconf.rb 
+    patch -p1 < ~/ncurses_ruby_1.9.patch
+    make
+    sudo make install
+
+See the patch file from http://trickyco.de/tag/ncurses . See other steps as above. 
+
+## LICENSE:
+
+Copyright (c) 2008 -2010 rkumar
+
+Same as ruby license.