4db08dcf440b48a7db89bb5d338bd96ceec4d1d6
[ncurses.git] / man / curs_pad.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2003,2004 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: curs_pad.3x,v 1.12 2004/01/04 01:36:49 tom Exp $
30 .TH curs_pad 3X ""
31 .SH NAME
32 \fBnewpad\fR, \fBsubpad\fR, \fBprefresh\fR,
33 \fBpnoutrefresh\fR,
34 \fBpechochar\fR, \fBpecho_wchar\fR - create and display \fBcurses\fR pads
35 .SH SYNOPSIS
36 \fB#include <curses.h>\fR
37 .sp
38 \fBWINDOW *newpad(int nlines, int ncols);\fR
39 .br
40 \fBWINDOW *subpad(WINDOW *orig, int nlines, int ncols,\fR
41       \fBint begin_y, int begin_x);\fR
42 .br
43 \fBint prefresh(WINDOW *pad, int pminrow, int pmincol,\fR
44       \fBint sminrow, int smincol, int smaxrow, int smaxcol);\fR
45 .br
46 \fBint pnoutrefresh(WINDOW *pad, int pminrow, int pmincol,\fR
47       \fBint sminrow, int smincol, int smaxrow, int smaxcol);\fR
48 .br
49 \fBint pechochar(WINDOW *pad, chtype ch);\fR
50 .br
51 \fBint pecho_wchar(WINDOW *pad, const cchar_t *wch);\fR
52 .SH DESCRIPTION
53 The \fBnewpad\fR routine creates and returns a pointer to a new pad data
54 structure with the given number of lines, \fInlines\fR, and columns,
55 \fIncols\fR.
56 A pad is like a window, except that it is not restricted by the
57 screen size, and is not necessarily associated with a particular part of the
58 screen.
59 Pads can be used when a large window is needed, and only a part of the
60 window will be on the screen at one time.
61 Automatic refreshes of pads
62 (e.g., from scrolling or echoing of input) do not occur.
63 It is not
64 legal to call \fBwrefresh\fR with a \fIpad\fR as an argument; the routines
65 \fBprefresh\fR or \fBpnoutrefresh\fR should be called instead.
66 Note that these
67 routines require additional parameters to specify the part of the pad to be
68 displayed and the location on the screen to be used for the display.
69 .PP
70 The \fBsubpad\fR routine creates and returns a pointer to a subwindow within a
71 pad with the given number of lines, \fInlines\fR, and columns, \fIncols\fR.
72 Unlike \fBsubwin\fR, which uses screen coordinates, the window is at position
73 (\fIbegin\fR_\fIx\fR\fB,\fR \fIbegin\fR_\fIy\fR) on the pad.
74 The window is
75 made in the middle of the window \fIorig\fR, so that changes made to one window
76 affect both windows.
77 During the use of this routine, it will often be
78 necessary to call \fBtouchwin\fR or \fBtouchline\fR on \fIorig\fR before
79 calling \fBprefresh\fR.
80 .PP
81 The \fBprefresh\fR and \fBpnoutrefresh\fR routines are analogous to
82 \fBwrefresh\fR and \fBwnoutrefresh\fR except that they relate to pads instead
83 of windows.
84 The additional parameters are needed to indicate what part of the
85 pad and screen are involved.
86 \fIpminrow\fR and \fIpmincol\fR specify the upper
87 left-hand corner of the rectangle to be displayed in the pad.
88 \fIsminrow\fR,
89 \fIsmincol\fR, \fIsmaxrow\fR, and \fIsmaxcol\fR specify the edges of the
90 rectangle to be displayed on the screen.
91 The lower right-hand corner of the
92 rectangle to be displayed in the pad is calculated from the screen coordinates,
93 since the rectangles must be the same size.
94 Both rectangles must be entirely
95 contained within their respective structures.
96 Negative values of
97 \fIpminrow\fR, \fIpmincol\fR, \fIsminrow\fR, or \fIsmincol\fR are treated as if
98 they were zero.
99 .PP
100 The \fBpechochar\fR routine is functionally equivalent to a call to \fBaddch\fR
101 followed by a call to \fBrefresh\fR, a call to \fBwaddch\fR followed by a call
102 to \fBwrefresh\fR, or a call to \fBwaddch\fR followed by a call to
103 \fBprefresh\fR.
104 The knowledge that only a single character is being output is
105 taken into consideration and, for non-control characters, a considerable
106 performance gain might be seen by using these routines instead of their
107 equivalents.
108 In the case of \fBpechochar\fR, the last location of the pad on
109 the screen is reused for the arguments to \fBprefresh\fR.
110 .PP
111 The \fBpecho_wchar\fR function is the analogous wide-character
112 form of \fBpechochar\fR.
113 It outputs one character to a pad and immediately refreshes the pad.
114 It does this by a call to \fBwadd_wch\fR followed by a call to \fBprefresh\fR.
115 .SH RETURN VALUE
116 Routines that return an integer return \fBERR\fR upon failure and \fBOK\fR
117 (SVr4 only specifies "an integer value other than \fBERR\fR") upon successful
118 completion.
119 .PP
120 Routines that return pointers return \fBNULL\fR on error, and set \fBerrno\fR
121 to \fBENOMEM\fR.
122 .SH NOTES
123 Note that \fBpechochar\fR may be a macro.
124 .SH PORTABILITY
125 The XSI Curses standard, Issue 4 describes these functions.
126 .SH SEE ALSO
127 \fBcurses\fR(3X), \fBcurs_refresh\fR(3X), \fBcurs_touch\fR(3X), \fBcurs_addch\fR(3X).
128 .\"#
129 .\"# The following sets edit modes for GNU EMACS
130 .\"# Local Variables:
131 .\"# mode:nroff
132 .\"# fill-column:79
133 .\"# End: