The newpad routine creates and returns a pointer to a new
pad data structure with the given number of lines, nlines,
and columns, ncols. A pad is like a window, except that
@@ -83,6 +82,8 @@
of the pad to be displayed and the location on the screen
to be used for the display.
+
+
The subpad routine creates and returns a pointer to a sub-
window within a pad with the given number of lines,
nlines, and columns, ncols. Unlike subwin, which uses
@@ -93,25 +94,29 @@
ten be necessary to call touchwin or touchline on orig be-
fore calling prefresh.
+
+
The prefresh and pnoutrefresh routines are analogous to
wrefresh and wnoutrefresh except that they relate to pads
instead of windows. The additional parameters are needed
to indicate what part of the pad and screen are involved.
- pminrow and pmincol specify the upper left-hand corner of
- the rectangle to be displayed in the pad. sminrow, smin-
- col, smaxrow, and smaxcol specify the edges of the rectan-
- gle to be displayed on the screen. The lower right-hand
- corner of the rectangle to be displayed in the pad is cal-
- culated from the screen coordinates, since the rectangles
- must be the same size. Both rectangles must be entirely
- contained within their respective structures. Negative
- values of pminrow, pmincol, sminrow, or smincol are treat-
- ed as if they were zero.
-
+ The pminrow and pmincol parameters specify the upper left-
+ hand corner of the rectangle to be displayed in the pad.
+ The sminrow, smincol, smaxrow, and smaxcol parameters
+ specify the edges of the rectangle to be displayed on the
+ screen. The lower right-hand corner of the rectangle to
+ be displayed in the pad is calculated from the screen co-
+ ordinates, since the rectangles must be the same size.
+ Both rectangles must be entirely contained within their
+ respective structures. Negative values of pminrow, pmin-
+ col, sminrow, or smincol are treated as if they were zero.
+
+
+
The pechochar routine is functionally equivalent to a call
- to addch followed by a call to refresh, a call to waddch
- followed by a call to wrefresh, or a call to waddch fol-
- lowed by a call to prefresh. The knowledge that only a
+ to addch followed by a call to refresh(3x), a call to wad-
+ dch followed by a call to wrefresh, or a call to waddch
+ followed by a call to prefresh. The knowledge that only a
single character is being output is taken into considera-
tion and, for non-control characters, a considerable per-
formance gain might be seen by using these routines in-
@@ -119,14 +124,15 @@
last location of the pad on the screen is reused for the
arguments to prefresh.
+
+
The pecho_wchar function is the analogous wide-character
form of pechochar. It outputs one character to a pad and
immediately refreshes the pad. It does this by a call to
wadd_wch followed by a call to prefresh.
-
Routines that return an integer return ERR upon failure
and OK (SVr4 only specifies "an integer value other than
ERR") upon successful completion.
@@ -137,37 +143,33 @@
X/Open does not define any error conditions. In this im-
plementation
- prefresh and pnoutrefresh
- return an error if the window pointer is null,
- or if the window is not really a pad or if the
- area to refresh extends off-screen or if the
- minimum coordinates are greater than the maxi-
- mum.
+ prefresh and pnoutrefresh
+ return an error if the window pointer is null, or
+ if the window is not really a pad or if the area
+ to refresh extends off-screen or if the minimum
+ coordinates are greater than the maximum.
- pechochar
- returns an error if the window is not really a
- pad, and the associated call to wechochar re-
- turns an error.
+ pechochar
+ returns an error if the window is not really a
+ pad, and the associated call to wechochar returns
+ an error.
- pecho_wchar
- returns an error if the window is not really a
- pad, and the associated call to wecho_wchar
- returns an error.
+ pecho_wchar
+ returns an error if the window is not really a
+ pad, and the associated call to wecho_wchar re-
+ turns an error.
-