ncurses 5.0
[ncurses.git] / c++ / README-first
index b0c38fad0c10330cfddff96bc9d62d5187490d16..eb37ac6702476abbd81fd399c30d6df9ba47b425 100644 (file)
@@ -1,7 +1,7 @@
                   C++ interface to ncurses routines
 -----------------------------------------------------------------------
 
-This directory contains the source code for three C++ classes which
+This directory contains the source code for several C++ classes which
 ease the use of writing ncurses-based programs.  The code is derived
 from the libg++ CursesWindow class but enhanced for ncurses.
 
@@ -15,23 +15,21 @@ the curses.h file.  This is a steady cause of trouble because many
 common identifiers are used.  Instead now all #defines are inline
 functions which also allows strict type checking of arguments.
 
-The next enhancement is color support, which is provided by a derived
-class.  The implementation chosen here is directed to unrestricted use
-of mixes of color and monochrome windows.  This is done through virtual
-functions and means that you can write all of your code as if a color
-window is the destination.  If the destination window is monochrome these
-functions calls have no effect.
-
-       NOTE: This implementation of the color support was topic of
-       some discussion.  The introduction of virtual functions
-       introduced some overhead.  Please let us know what you think
-       about this: is it worth being able to write color supporting
-       functions.
-
-The last point to mention is the support of another package Zeyd
-distributes with his ncurses package: the panels library.  This support
-is provided by the NCursesPanel class, which is also derived from the
-NCursesWindow class.  This allows building interfaces with windows.
+The next enhancement is color support. It was originally provided by a 
+derived class. This caused some trouble if you think about Panels or
+Menus and Forms with colors. We decided to put color support into the
+base class so that any derived class may use color support also.
+The implementation chosen here is directed to unrestricted use
+of mixes of color and monochrome windows. The original NCursesColorWindow
+class is maintained for compatibility reasons.
+
+The last point to mention is the support of other packages that are
+distributed with the ncurses package: the panels library, the menu library
+and the form library. This support is provided by the NCursesPanel class, 
+which is also derived from the NCursesWindow class and the NCursesMenu
+and NCursesForm classes which are derived from NCursesPanel. This allows 
+building interfaces with windows.
+
 Please see the example program for a quick introduction.
 
 Note that at this point, there is no documentation for these classes.
@@ -52,6 +50,9 @@ welcome.  Please let us know which functionality you miss.
 Original author:
      Eric Newton         <newton@rocky.oswego.edu> for FSF's libg++
 
-Authors of this release:
+Authors of first ncurses based release (NCursesWindow, NCursesPanel):
      Ulrich Drepper      <drepper@ira.uka.de>
  and Anatoly Ivasyuk     <anatoly@nick.csh.rit.edu>
+
+Author of this release:
+     Juergen Pfeifer     <juergen.pfeifer@gmx.net>