mirror of
https://git.FreeBSD.org/src.git
synced 2024-12-21 11:13:30 +00:00
3e6427f35f
old 1M, 3X and 3S section numbers) and make some minor formatting changes to silence manck.
75 lines
3.8 KiB
Groff
75 lines
3.8 KiB
Groff
.TH curs_pad 3 ""
|
|
.SH NAME
|
|
\fBnewpad\fR, \fBsubpad\fR, \fBprefresh\fR,
|
|
\fBpnoutrefresh\fR, \fBpechochar\fR - create and display \fBncurses\fR pads
|
|
.SH SYNOPSIS
|
|
\fB#include <ncurses.h>\fR
|
|
|
|
\fBWINDOW *newpad(int nlines, int ncols);\fR
|
|
.br
|
|
\fBWINDOW *subpad(WINDOW *orig, int nlines, int ncols,
|
|
int begin_y, int begin_x);\fR
|
|
\fBint prefresh(WINDOW *pad, int pminrow, int pmincol,
|
|
int sminrow, int smincol, int smaxrow, int smaxcol);\fR
|
|
\fBint pnoutrefresh(WINDOW *pad, int pminrow, int pmincol,
|
|
int sminrow, int smincol, int smaxrow, int smaxcol);\fR
|
|
\fBint pechochar(WINDOW *pad, chtype ch);\fR
|
|
.SH DESCRIPTION
|
|
The \fBnewpad\fR routine creates and returns a pointer to a new pad data
|
|
structure with the given number of lines, \fInlines\fR, and columns,
|
|
\fIncols\fR. A pad is like a window, except that it is not restricted by the
|
|
screen size, and is not necessarily associated with a particular part of the
|
|
screen. Pads can be used when a large window is needed, and only a part of the
|
|
window will be on the screen at one time. Automatic refreshes of pads
|
|
(\fIe\fR.\fIg\fR., from scrolling or echoing of input) do not occur. It is not
|
|
legal to call \fBwrefresh\fR with a \fIpad\fR as an argument; the routines
|
|
\fBprefresh\fR or \fBpnoutrefresh\fR should be called instead. Note that these
|
|
routines require additional parameters to specify the part of the pad to be
|
|
displayed and the location on the screen to be used for the display.
|
|
|
|
The \fBsubpad\fR routine creates and returns a pointer to a subwindow within a
|
|
pad with the given number of lines, \fInlines\fR, and columns, \fIncols\fR.
|
|
Unlike \fBsubwin\fR, which uses screen coordinates, the window is at position
|
|
(\fIbegin\fR_\fIx\fR\fB,\fR \fIbegin\fR_\fIy\fR) on the pad. The window is
|
|
made in the middle of the window \fIorig\fR, so that changes made to one window
|
|
affect both windows. During the use of this routine, it will often be
|
|
necessary to call \fBtouchwin\fR or \fBtouchline\fR on \fIorig\fR before
|
|
calling \fBprefresh\fR.
|
|
|
|
The \fBprefresh\fR and \fBpnoutrefresh\fR routines are analogous to
|
|
\fBwrefresh\fR and \fBwnoutrefresh\fR 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. \fIpminrow\fR and \fIpmincol\fR specify the upper
|
|
left-hand corner of the rectangle to be displayed in the pad. \fIsminrow\fR,
|
|
\fIsmincol\fR, \fIsmaxrow\fR, and \fIsmaxcol\fR 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 coordinates,
|
|
since the rectangles must be the same size. Both rectangles must be entirely
|
|
contained within their respective structures. Negative values of
|
|
\fIpminrow\fR, \fIpmincol\fR, \fIsminrow\fR, or \fIsmincol\fR are treated as if
|
|
they were zero.
|
|
|
|
The \fBpechochar\fR routine is functionally equivalent to a call to \fBaddch\fR
|
|
followed by a call to \fBrefresh\fR, a call to \fBwaddch\fR followed by a call
|
|
to \fBwrefresh\fR, or a call to \fBwaddch\fR followed by a call to
|
|
\fBprefresh.\fR The knowledge that only a single character is being output is
|
|
taken into consideration and, for non-control characters, a considerable
|
|
performance gain might be seen by using these routines instead of their
|
|
equivalents. In the case of \fBpechochar\fR, the last location of the pad on
|
|
the screen is reused for the arguments to \fBprefresh\fR.
|
|
.SH RETURN VALUE
|
|
Routines that return an integer return \fBERR\fR upon failure and an integer
|
|
value other than \fBERR\fR upon successful completion.
|
|
|
|
Routines that return pointers return \fBNULL\fR on error.
|
|
.SH NOTES
|
|
Note that \fBpechochar\fR may be a macro.
|
|
.SH SEE ALSO
|
|
\fBncurses\fR(3), \fBcurs_refresh\fR(3), \fBcurs_touch\fR(3), \fBcurs_addch\fR(3).
|
|
.\"#
|
|
.\"# The following sets edit modes for GNU EMACS
|
|
.\"# Local Variables:
|
|
.\"# mode:nroff
|
|
.\"# fill-column:79
|
|
.\"# End:
|