ncurses 5.4
[ncurses.git] / c++ / README-first
1 -- $Id: README-first,v 1.7 2003/10/25 15:13:23 tom Exp $
2 -------------------------------------------------------------------------------
3                   C++ interface to ncurses routines
4 -----------------------------------------------------------------------
5
6 This directory contains the source code for several C++ classes which
7 ease the use of writing ncurses-based programs.  The code is derived
8 from the libg++ CursesWindow class but enhanced for ncurses.
9
10 The classes simplify the use of window specific functions by
11 encapsulating them in the window object.  Function overloading is
12 used in order to narrow the interface.  E.g. you don't have the
13 distinction between `printw' and `mvprintw' anymore.
14
15 A second benefit is the removal of all #defines which are included in
16 the curses.h file.  This is a steady cause of trouble because many
17 common identifiers are used.  Instead now all #defines are inline
18 functions which also allows strict type checking of arguments.
19
20 The next enhancement is color support. It was originally provided by a 
21 derived class. This caused some trouble if you think about Panels or
22 Menus and Forms with colors. We decided to put color support into the
23 base class so that any derived class may use color support also.
24 The implementation chosen here is directed to unrestricted use
25 of mixes of color and monochrome windows. The original NCursesColorWindow
26 class is maintained for compatibility reasons.
27
28 The last point to mention is the support of other packages that are
29 distributed with the ncurses package: the panels library, the menu library
30 and the form library. This support is provided by the NCursesPanel class, 
31 which is also derived from the NCursesWindow class and the NCursesMenu
32 and NCursesForm classes which are derived from NCursesPanel. This allows 
33 building interfaces with windows.
34
35 Please see the example program for a quick introduction.
36
37 Note that at this point, there is no documentation for these classes.
38 Hopefully some will be written in the not too distant future.  For now,
39 to find out how to use the classes, read the code and the example program.
40
41 Suggestions for enhancements and contributions of code (and docs) are
42 welcome.  Please let us know which functionality you miss.
43
44         ATTENTION LINUX USERS:  There is currently some discussion of
45         replacing the BSD curses in the Linux libc with ncurses.  If
46         this is done we could perhaps include these classes in the Linux
47         libg++ replacing the original CursesWindow class (and renaming it
48         to CursesWindow).  This could be done because NCursesWindow can
49         be made easily to a superset of the CursesWindow class.
50
51
52 Original author:
53      Eric Newton         <newton@rocky.oswego.edu> for FSF's libg++
54
55 Authors of first ncurses based release (NCursesWindow, NCursesPanel):
56      Ulrich Drepper      <drepper@ira.uka.de>
57  and Anatoly Ivasyuk     <anatoly@nick.csh.rit.edu>
58
59 Author of this release:
60      Juergen Pfeifer