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