Calling newwin creates and returns a pointer to a new win-
dow with the given number of lines and columns. The upper
- left-hand corner of the window is at line begin_y, column
- begin_x. If either nlines or ncols is zero, they default
- to LINES-begin_y and COLS-begin_x. A new full-screen
- window is created by calling newwin(0,0,0,0).
+ left-hand corner of the window is at
+ line begin_y,
+ column begin_x
+
+ If either nlines or ncols is zero, they default to
+ LINES-begin_y and
+ COLS-begin_x.
+
+ A new full-screen window is created by calling
+ newwin(0,0,0,0).
Calling delwin deletes the named window, freeing all memo-
ry associated with it (it does not actually erase the win-
@@ -95,13 +104,11 @@
Calling subwin creates and returns a pointer to a new win-
dow with the given number of lines, nlines, and columns,
ncols. The window is at position (begin_y, begin_x) on
- the screen. (This position is relative to the screen, and
- not to the window orig.) The window is made in the middle
- of the window orig, so that changes made to one window
- will affect both windows. The subwindow shares memory
- with the window orig. When using this routine, it is nec-
- essary to call touchwin or touchline on orig before call-
- ing wrefresh on the subwindow.
+ the screen. The subwindow shares memory with the window
+ orig, so that changes made to one window will affect both
+ windows. When using this routine, it is necessary to call
+ touchwin or touchline on orig before calling wrefresh on
+ the subwindow.
Calling derwin is the same as calling subwin, except that
begin_y and begin_x are relative to the origin of the win-
@@ -133,7 +140,7 @@
Routines that return an integer return the integer ERR up-
on failure and OK (SVr4 only specifies "an integer value
other than ERR") upon successful completion.
@@ -143,34 +150,54 @@
X/Open defines no error conditions. In this implementa-
tion
- delwin
- returns an error if the window pointer is
- null, or if the window is the parent of anoth-
- er window.
+ delwin
+ returns an error if the window pointer is null, or if
+ the window is the parent of another window.
+
+ derwin
+ returns an error if the parent window pointer is
+ null, or if any of its ordinates or dimensions is
+ negative, or if the resulting window does not fit in-
+ side the parent window.
+
+ dupwin
+ returns an error if the window pointer is null.
+
+ This implementation also maintains a list of windows,
+ and checks that the pointer passed to delwin is one
+ that it created, returning an error if it was not..
+
+ mvderwin
+ returns an error if the window pointer is null, or if
+ some part of the window would be placed off-screen.
+
+ mvwin
+ returns an error if the window pointer is null, or if
+ the window is really a pad, or if some part of the
+ window would be placed off-screen.
- This implementation also maintains a list of
- windows, and checks that the pointer passed to
- delwin is one that it created, returning an
- error if it was not..
+ newwin
+ will fail if either of its beginning ordinates is
+ negative, or if either the number of lines or columns
+ is negative.
- mvderwin
- returns an error if the window pointer is
- null, or if some part of the window would be
- placed off-screen.
+ syncok
+ returns an error if the window pointer is null.
- mvwin
- returns an error if the window pointer is
- null, or if the window is really a pad, or if
- some part of the window would be placed off-
- screen.
+ subwin
+ returns an error if the parent window pointer is
+ null, or if any of its ordinates or dimensions is
+ negative, or if the resulting window does not fit in-
+ side the parent window.
- syncok
- returns an error if the window pointer is
- null.
+ The functions which return a window pointer may also fail
+ if there is insufficient memory for its data structures.
+ Any of these functions will fail if the screen has not
+ been initialized, i.e., with initscr or newterm.
The subwindow functions (subwin, derwin, mvderwin, wsyn-cup, wsyncdown, wcursyncup, syncok) are flaky, incomplete-
ly implemented, and not well tested.
@@ -193,23 +220,31 @@