ncurses 6.0 - patch 20171118
[ncurses.git] / doc / html / man / curs_pad.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2015,2017 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: curs_pad.3x,v 1.23 2017/11/19 01:29:46 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_pad 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">curs_pad 3x</H1>
42 <PRE>
43 <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG>                                                      <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG>
44
45
46
47
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49        <STRONG>newpad</STRONG>, <STRONG>subpad</STRONG>, <STRONG>prefresh</STRONG>, <STRONG>pnoutrefresh</STRONG>, <STRONG>pechochar</STRONG>, <STRONG>pecho_wchar</STRONG> - create
50        and display <STRONG>curses</STRONG> pads
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
55
56        <STRONG>WINDOW</STRONG> <STRONG>*newpad(int</STRONG> <EM>nlines</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>ncols</EM><STRONG>);</STRONG>
57        <STRONG>WINDOW</STRONG> <STRONG>*subpad(WINDOW</STRONG> <STRONG>*</STRONG><EM>orig</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>nlines</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>ncols</EM><STRONG>,</STRONG>
58              <STRONG>int</STRONG> <EM>begin</EM><STRONG>_</STRONG><EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>begin</EM><STRONG>_</STRONG><EM>x</EM><STRONG>);</STRONG>
59        <STRONG>int</STRONG> <STRONG>prefresh(WINDOW</STRONG> <STRONG>*</STRONG><EM>pad</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>pminrow</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>pmincol</EM><STRONG>,</STRONG>
60              <STRONG>int</STRONG> <EM>sminrow</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>smincol</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>smaxrow</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>smaxcol</EM><STRONG>);</STRONG>
61        <STRONG>int</STRONG> <STRONG>pnoutrefresh(WINDOW</STRONG> <STRONG>*</STRONG><EM>pad</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>pminrow</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>pmincol</EM><STRONG>,</STRONG>
62              <STRONG>int</STRONG> <EM>sminrow</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>smincol</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>smaxrow</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>smaxcol</EM><STRONG>);</STRONG>
63        <STRONG>int</STRONG> <STRONG>pechochar(WINDOW</STRONG> <STRONG>*</STRONG><EM>pad</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>ch</EM><STRONG>);</STRONG>
64        <STRONG>int</STRONG> <STRONG>pecho_wchar(WINDOW</STRONG> <STRONG>*</STRONG><EM>pad</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
65
66
67 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
68
69 </PRE><H3><a name="h3-newpad">newpad</a></H3><PRE>
70        The <STRONG>newpad</STRONG> routine creates and returns a pointer  to  a  new  pad  data
71        structure  with  the given number of lines, <EM>nlines</EM>, and columns, <EM>ncols</EM>.
72        A pad is like a window, except that it is not restricted by the  screen
73        size,  and  is not necessarily associated with a particular part of the
74        screen.  Pads can be used when a large window is  needed,  and  only  a
75        part  of  the  window will be on the screen at one time.  Automatic re-
76        freshes of pads (e.g., from scrolling or echoing of input) do  not  oc-
77        cur.
78
79        It  is  not  legal to call <STRONG>wrefresh</STRONG> with a <EM>pad</EM> as an argument; the rou-
80        tines <STRONG>prefresh</STRONG> or <STRONG>pnoutrefresh</STRONG> should be  called  instead.   Note  that
81        these routines require additional parameters to specify the part of the
82        pad to be displayed and the location on the screen to be used  for  the
83        display.
84
85
86 </PRE><H3><a name="h3-subpad">subpad</a></H3><PRE>
87        The  <STRONG>subpad</STRONG> routine creates and returns a pointer to a subwindow within
88        a pad with the given number of lines, <EM>nlines</EM>, and columns, <EM>ncols</EM>.   Un-
89        like  <STRONG>subwin</STRONG>,  which uses screen coordinates, the window is at position
90        (<EM>begin</EM>_<EM>x</EM><STRONG>,</STRONG> <EM>begin</EM>_<EM>y</EM>) on the pad.  The window is made in the middle of the
91        window  <EM>orig</EM>,  so  that changes made to one window affect both windows.
92        During the use of this routine, it will  often  be  necessary  to  call
93        <STRONG>touchwin</STRONG> or <STRONG>touchline</STRONG> on <EM>orig</EM> before calling <STRONG>prefresh</STRONG>.
94
95
96 </PRE><H3><a name="h3-prefresh_-pnoutrefresh">prefresh, pnoutrefresh</a></H3><PRE>
97        The  <STRONG>prefresh</STRONG>  and  <STRONG>pnoutrefresh</STRONG> routines are analogous to <STRONG>wrefresh</STRONG> and
98        <STRONG>wnoutrefresh</STRONG> except that they relate to pads instead of  windows.   The
99        additional  parameters  are needed to indicate what part of the pad and
100        screen are involved.
101
102        <STRONG>o</STRONG>   The <EM>pminrow</EM> and <EM>pmincol</EM> parameters specify the upper left-hand cor-
103            ner of the rectangle to be displayed in the pad.
104
105        <STRONG>o</STRONG>   The  <EM>sminrow</EM>,  <EM>smincol</EM>, <EM>smaxrow</EM>, and <EM>smaxcol</EM> parameters specify the
106            edges of the rectangle to be displayed on the screen.
107
108        The lower right-hand corner of the rectangle to be displayed in the pad
109        is calculated from the screen coordinates, since the rectangles must be
110        the same size.  Both rectangles must be entirely contained within their
111        respective  structures.   Negative values of <EM>pminrow</EM>, <EM>pmincol</EM>, <EM>sminrow</EM>,
112        or <EM>smincol</EM> are treated as if they were zero.
113
114
115 </PRE><H3><a name="h3-pechochar">pechochar</a></H3><PRE>
116        The <STRONG>pechochar</STRONG> routine is functionally equivalent to  a  call  to  <STRONG>addch</STRONG>
117        followed  by a call to <STRONG><A HREF="curs_refresh.3x.html">refresh(3x)</A></STRONG>, a call to <STRONG>waddch</STRONG> followed by a call
118        to <STRONG>wrefresh</STRONG>, or a call to <STRONG>waddch</STRONG> followed by a call to  <STRONG>prefresh</STRONG>.   The
119        knowledge  that  only  a single character is being output is taken into
120        consideration and, for non-control characters, a  considerable  perfor-
121        mance  gain  might  be  seen  by  using these routines instead of their
122        equivalents.  In the case of <STRONG>pechochar</STRONG>, the last location of the pad on
123        the screen is reused for the arguments to <STRONG>prefresh</STRONG>.
124
125
126 </PRE><H3><a name="h3-pecho_wchar">pecho_wchar</a></H3><PRE>
127        The  <STRONG>pecho_wchar</STRONG>  function  is the analogous wide-character form of <STRONG>pe-</STRONG>
128        <STRONG>chochar</STRONG>.  It outputs one character to a pad and  immediately  refreshes
129        the pad.  It does this by a call to <STRONG>wadd_wch</STRONG> followed by a call to <STRONG>pre-</STRONG>
130        <STRONG>fresh</STRONG>.
131
132
133 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
134        Routines that return an integer return <STRONG>ERR</STRONG> upon failure  and  <STRONG>OK</STRONG>  (SVr4
135        only  specifies "an integer value other than <STRONG>ERR</STRONG>") upon successful com-
136        pletion.
137
138        Routines that return pointers return <STRONG>NULL</STRONG> on error, and  set  <STRONG>errno</STRONG>  to
139        <STRONG>ENOMEM</STRONG>.
140
141        X/Open does not define any error conditions.  In this implementation
142
143           <STRONG>prefresh</STRONG> and <STRONG>pnoutrefresh</STRONG>
144                return an error if the window pointer is null, or if the window
145                is not really a pad or if the  area  to  refresh  extends  off-
146                screen or if the minimum coordinates are greater than the maxi-
147                mum.
148
149           <STRONG>pechochar</STRONG>
150                returns an error if the window is not really a pad, and the as-
151                sociated call to <STRONG>wechochar</STRONG> returns an error.
152
153           <STRONG>pecho_wchar</STRONG>
154                returns an error if the window is not really a pad, and the as-
155                sociated call to <STRONG>wecho_wchar</STRONG> returns an error.
156
157
158 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
159        Note that <STRONG>pechochar</STRONG> may be a macro.
160
161
162 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
163        BSD curses has no <EM>pad</EM> feature.
164
165        SVr2 curses (1986) provided the <STRONG>newpad</STRONG> and related functions, document-
166        ing  them  in  a single line each.  SVr3 (1987) provided more extensive
167        documentation.
168
169        The documentation does not explain the term <EM>pad</EM>.  However,  the  Apollo
170        <EM>Aegis</EM> workstation operating system supported a graphical <EM>pad</EM> feature:
171
172        <STRONG>o</STRONG>   These  graphical pads could be much larger than the computer's dis-
173            play.
174
175        <STRONG>o</STRONG>   The read-only output from a command could be scrolled back  to  in-
176            spect, and select text from the pad.
177
178        The two uses may be related.
179
180        The  XSI  Curses  standard,  Issue 4 describes these functions, without
181        significant change from the SVr3 documentation.  It describes no  error
182        conditions.   The  behavior of <STRONG>subpad</STRONG> if the parent window is not a pad
183        is undocumented, and is not checked by the vendor Unix implementations:
184
185        <STRONG>o</STRONG>   SVr4 curses sets a flag in the <STRONG>WINDOW</STRONG>  structure  in  <STRONG>newpad</STRONG>  which
186            tells if the window is a <EM>pad</EM>.
187
188            However, it uses this information only in <STRONG>wscrl</STRONG>, and does not check
189            in <STRONG>wrefresh</STRONG> to ensure that the pad is refreshed properly.
190
191        <STRONG>o</STRONG>   Solaris X/Open Curses checks if a window is a pad in  <STRONG>wnoutrefresh</STRONG>,
192            returning <STRONG>ERR</STRONG> in that case.
193
194            However,  it only sets the flag for subwindows if the parent window
195            is a pad.  Its <STRONG>newpad</STRONG> function does not set this information.  Con-
196            sequently, the check will never fail.
197
198            It  makes no comparable check in <STRONG>pnoutrefresh</STRONG>, though interestingly
199            enough, a comment in the source code states  that  the  lack  of  a
200            check was an MKS extension.
201
202        <STRONG>o</STRONG>   NetBSD  7 curses sets a flag in the <STRONG>WINDOW</STRONG> structure for <STRONG>newpad</STRONG> and
203            <STRONG>subpad</STRONG>, using this to help with the  distinction  between  <STRONG>wnoutre-</STRONG>
204            <STRONG>fresh</STRONG> and <STRONG>pnoutrefresh</STRONG>.
205
206            It  does  not  check for the case where a subwindow is created in a
207            pad using <STRONG>subwin</STRONG> or <STRONG>derwin</STRONG>.
208
209            The <STRONG>dupwin</STRONG> function returns a regular  window  when  duplicating  a
210            pad.   Likewise,  <STRONG>getwin</STRONG> always returns a window, even if the saved
211            data was from a pad.
212
213        This implementation
214
215        <STRONG>o</STRONG>   sets a flag in the <STRONG>WINDOW</STRONG> structure for <STRONG>newpad</STRONG> and <STRONG>subpad</STRONG>,
216
217        <STRONG>o</STRONG>   allows a <STRONG>subwin</STRONG> or <STRONG>derwin</STRONG> call to succeed having a  pad  parent  by
218            forcing the subwindow to be a pad,
219
220        <STRONG>o</STRONG>   checks  in  both  <STRONG>wnoutrefresh</STRONG> and <STRONG>pnoutrefresh</STRONG> to ensure that pads
221            and windows are handled distinctly, and
222
223        <STRONG>o</STRONG>   ensures that <STRONG>dupwin</STRONG> and <STRONG>getwin</STRONG> treat pads  versus  windows  consis-
224            tently.
225
226
227 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
228        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG>, <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>.
229
230
231
232                                                                   <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG>
233 </PRE>
234 <div class="nav">
235 <ul>
236 <li><a href="#h2-NAME">NAME</a></li>
237 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
238 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
239 <ul>
240 <li><a href="#h3-newpad">newpad</a></li>
241 <li><a href="#h3-subpad">subpad</a></li>
242 <li><a href="#h3-prefresh_-pnoutrefresh">prefresh, pnoutrefresh</a></li>
243 <li><a href="#h3-pechochar">pechochar</a></li>
244 <li><a href="#h3-pecho_wchar">pecho_wchar</a></li>
245 </ul>
246 </li>
247 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
248 <li><a href="#h2-NOTES">NOTES</a></li>
249 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
250 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
251 </ul>
252 </div>
253 </BODY>
254 </HTML>