X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_pad.3x.html;h=f59a9451acb5bc28549448addedda5d5968bbc61;hp=329a63c3610465889d73d4105f3135b6cfcc7014;hb=f344f8539c1543f8cd65a5bb142dbaf23b9421d2;hpb=027d0c57c4c4d6690e8d8727888d3282dbe9aa86
diff --git a/doc/html/man/curs_pad.3x.html b/doc/html/man/curs_pad.3x.html
index 329a63c3..f59a9451 100644
--- a/doc/html/man/curs_pad.3x.html
+++ b/doc/html/man/curs_pad.3x.html
@@ -1,6 +1,6 @@
@@ -45,29 +45,28 @@
-
-
+
newpad, subpad, prefresh, pnoutrefresh, pechochar,
pecho_wchar - create and display curses pads
-
-
+
#include <curses.h>
- WINDOW *newpad(int nlines, int ncols);
- WINDOW *subpad(WINDOW *orig, int nlines, int ncols,
- int begin_y, int begin_x);
- int prefresh(WINDOW *pad, int pminrow, int pmincol,
- int sminrow, int smincol, int smaxrow, int smaxcol);
- int pnoutrefresh(WINDOW *pad, int pminrow, int pmincol,
- int sminrow, int smincol, int smaxrow, int smaxcol);
- int pechochar(WINDOW *pad, chtype ch);
- int pecho_wchar(WINDOW *pad, const cchar_t *wch);
+ WINDOW *newpad(int nlines, int ncols);
+ WINDOW *subpad(WINDOW *orig, int nlines, int ncols,
+ int begin_y, int begin_x);
+ int prefresh(WINDOW *pad, int pminrow, int pmincol,
+ int sminrow, int smincol, int smaxrow, int smaxcol);
+ int pnoutrefresh(WINDOW *pad, int pminrow, int pmincol,
+ int sminrow, int smincol, int smaxrow, int smaxcol);
+ int pechochar(WINDOW *pad, chtype ch);
+ int pecho_wchar(WINDOW *pad, const cchar_t *wch);
-
-
+
+
+
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,6 +94,8 @@
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
@@ -108,10 +111,12 @@
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.
-
-
+
Note that pechochar may be a macro.
-
-
- The XSI Curses standard, Issue 4 describes these func-
+
+ The XSI Curses standard, Issue 4 describes these func-
tions.
-
-
+
curses(3x), curs_refresh(3x), curs_touch(3x), curs_add-
ch(3x).
@@ -179,7 +181,15 @@