c++/README-first

   1 -------------------------------------------------------------------------------
   2 -- Copyright (c) 1998-2003,2006 Free Software Foundation, Inc.               --
   3 --                                                                           --
   4 -- Permission is hereby granted, free of charge, to any person obtaining a   --
   5 -- copy of this software and associated documentation files (the             --
   6 -- "Software"), to deal in the Software without restriction, including       --
   7 -- without limitation the rights to use, copy, modify, merge, publish,       --
   8 -- distribute, distribute with modifications, sublicense, and/or sell copies --
   9 -- of the Software, and to permit persons to whom the Software is furnished  --
  10 -- to do so, subject to the following conditions:                            --
  11 --                                                                           --
  12 -- The above copyright notice and this permission notice shall be included   --
  13 -- in all copies or substantial portions of the Software.                    --
  14 --                                                                           --
  15 -- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS   --
  16 -- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF                --
  17 -- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN --
  18 -- NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,       --
  19 -- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR     --
  20 -- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE --
  21 -- USE OR OTHER DEALINGS IN THE SOFTWARE.                                    --
  22 --                                                                           --
  23 -- Except as contained in this notice, the name(s) of the above copyright    --
  24 -- holders shall not be used in advertising or otherwise to promote the      --
  25 -- sale, use or other dealings in this Software without prior written        --
  26 -- authorization.                                                            --
  27 -------------------------------------------------------------------------------
  28 -- $Id: README-first,v 1.8 2006/04/22 22:19:37 tom Exp $
  29 -------------------------------------------------------------------------------
  30                   C++ interface to ncurses routines
  31 -----------------------------------------------------------------------
  32
  33 This directory contains the source code for several C++ classes which
  34 ease the use of writing ncurses-based programs.  The code is derived
  35 from the libg++ CursesWindow class but enhanced for ncurses.
  36
  37 The classes simplify the use of window specific functions by
  38 encapsulating them in the window object.  Function overloading is
  39 used in order to narrow the interface.  E.g. you don't have the
  40 distinction between `printw' and `mvprintw' anymore.
  41
  42 A second benefit is the removal of all #defines which are included in
  43 the curses.h file.  This is a steady cause of trouble because many
  44 common identifiers are used.  Instead now all #defines are inline
  45 functions which also allows strict type checking of arguments.
  46
  47 The next enhancement is color support. It was originally provided by a
  48 derived class. This caused some trouble if you think about Panels or
  49 Menus and Forms with colors. We decided to put color support into the
  50 base class so that any derived class may use color support also.
  51 The implementation chosen here is directed to unrestricted use
  52 of mixes of color and monochrome windows. The original NCursesColorWindow
  53 class is maintained for compatibility reasons.
  54
  55 The last point to mention is the support of other packages that are
  56 distributed with the ncurses package: the panels library, the menu library
  57 and the form library. This support is provided by the NCursesPanel class,
  58 which is also derived from the NCursesWindow class and the NCursesMenu
  59 and NCursesForm classes which are derived from NCursesPanel. This allows
  60 building interfaces with windows.
  61
  62 Please see the example program for a quick introduction.
  63
  64 Note that at this point, there is no documentation for these classes.
  65 Hopefully some will be written in the not too distant future.  For now,
  66 to find out how to use the classes, read the code and the example program.
  67
  68 Suggestions for enhancements and contributions of code (and docs) are
  69 welcome.  Please let us know which functionality you miss.
  70
  71         ATTENTION LINUX USERS:  There is currently some discussion of
  72         replacing the BSD curses in the Linux libc with ncurses.  If
  73         this is done we could perhaps include these classes in the Linux
  74         libg++ replacing the original CursesWindow class (and renaming it
  75         to CursesWindow).  This could be done because NCursesWindow can
  76         be made easily to a superset of the CursesWindow class.
  77
  78
  79 Original author:
  80      Eric Newton         <newton@rocky.oswego.edu> for FSF's libg++
  81
  82 Authors of first ncurses based release (NCursesWindow, NCursesPanel):
  83      Ulrich Drepper      <drepper@ira.uka.de>
  84  and Anatoly Ivasyuk     <anatoly@nick.csh.rit.edu>
  85
  86 Author of this release:
  87      Juergen Pfeifer