ncurses 6.0 - patch 20151024
[ncurses.git] / doc / html / man / curs_pad.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2010,2015 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.18 2015/07/21 08:58:44 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>
49 <H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>newpad</STRONG>, <STRONG>subpad</STRONG>, <STRONG>prefresh</STRONG>, <STRONG>pnoutrefresh</STRONG>, <STRONG>pechochar</STRONG>,
51        <STRONG>pecho_wchar</STRONG> - create and display <STRONG>curses</STRONG> pads
52
53
54 </PRE>
55 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58        <STRONG>WINDOW</STRONG> <STRONG>*newpad(int</STRONG> <EM>nlines</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>ncols</EM><STRONG>);</STRONG>
59        <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>
60              <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>
61        <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>
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>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>
64              <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>
65        <STRONG>int</STRONG> <STRONG>pechochar(WINDOW</STRONG> <STRONG>*</STRONG><EM>pad</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>ch</EM><STRONG>);</STRONG>
66        <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>
67
68
69 </PRE>
70 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
71
72 </PRE>
73 <H3><a name="h3-newpad">newpad</a></H3><PRE>
74        The <STRONG>newpad</STRONG> routine creates and returns a pointer to a  new
75        pad data structure with the given number of lines, <EM>nlines</EM>,
76        and columns, <EM>ncols</EM>.  A pad is like a window,  except  that
77        it is not restricted by the screen size, and is not neces-
78        sarily associated with a particular part  of  the  screen.
79        Pads can be used when a large window is needed, and only a
80        part of the window will be on the screen at one time.  Au-
81        tomatic refreshes of pads (e.g., from scrolling or echoing
82        of input) do not occur.  It is not legal to call  <STRONG>wrefresh</STRONG>
83        with  a  <EM>pad</EM>  as  an  argument;  the  routines <STRONG>prefresh</STRONG> or
84        <STRONG>pnoutrefresh</STRONG> should be called instead.   Note  that  these
85        routines require additional parameters to specify the part
86        of the pad to be displayed and the location on the  screen
87        to be used for the display.
88
89
90 </PRE>
91 <H3><a name="h3-subpad">subpad</a></H3><PRE>
92        The <STRONG>subpad</STRONG> routine creates and returns a pointer to a sub-
93        window within a  pad  with  the  given  number  of  lines,
94        <EM>nlines</EM>,  and  columns,  <EM>ncols</EM>.   Unlike <STRONG>subwin</STRONG>, which uses
95        screen coordinates, the window is  at  position  (<EM>begin</EM>_<EM>x</EM><STRONG>,</STRONG>
96        <EM>begin</EM>_<EM>y</EM>)  on the pad.  The window is made in the middle of
97        the window <EM>orig</EM>, so that changes made to one window affect
98        both windows.  During the use of this routine, it will of-
99        ten be necessary to call <STRONG>touchwin</STRONG> or <STRONG>touchline</STRONG> on <EM>orig</EM> be-
100        fore calling <STRONG>prefresh</STRONG>.
101
102
103 </PRE>
104 <H3><a name="h3-prefresh_-pnoutrefresh">prefresh, pnoutrefresh</a></H3><PRE>
105        The  <STRONG>prefresh</STRONG>  and  <STRONG>pnoutrefresh</STRONG> routines are analogous to
106        <STRONG>wrefresh</STRONG> and <STRONG>wnoutrefresh</STRONG> except that they relate to  pads
107        instead  of windows.  The additional parameters are needed
108        to indicate what part of the pad and screen are  involved.
109        The <EM>pminrow</EM> and <EM>pmincol</EM> parameters specify the upper left-
110        hand corner of the rectangle to be displayed in  the  pad.
111        The  <EM>sminrow</EM>,  <EM>smincol</EM>,  <EM>smaxrow</EM>,  and  <EM>smaxcol</EM> parameters
112        specify the edges of the rectangle to be displayed on  the
113        screen.   The  lower right-hand corner of the rectangle to
114        be displayed in the pad is calculated from the screen  co-
115        ordinates,  since  the  rectangles  must be the same size.
116        Both rectangles must be entirely  contained  within  their
117        respective  structures.  Negative values of <EM>pminrow</EM>, <EM>pmin-</EM>
118        <EM>col</EM>, <EM>sminrow</EM>, or <EM>smincol</EM> are treated as if they were zero.
119
120
121 </PRE>
122 <H3><a name="h3-pechochar">pechochar</a></H3><PRE>
123        The <STRONG>pechochar</STRONG> routine is functionally equivalent to a call
124        to  <STRONG>addch</STRONG>  followed by a call to <STRONG>refresh</STRONG>, a call to <STRONG>waddch</STRONG>
125        followed by a call to <STRONG>wrefresh</STRONG>, or a call to  <STRONG>waddch</STRONG>  fol-
126        lowed  by  a  call to <STRONG>prefresh</STRONG>.  The knowledge that only a
127        single character is being output is taken into  considera-
128        tion  and, for non-control characters, a considerable per-
129        formance gain might be seen by using  these  routines  in-
130        stead of their equivalents.  In the case of <STRONG>pechochar</STRONG>, the
131        last location of the pad on the screen is reused  for  the
132        arguments to <STRONG>prefresh</STRONG>.
133
134
135 </PRE>
136 <H3><a name="h3-pecho_wchar">pecho_wchar</a></H3><PRE>
137        The  <STRONG>pecho_wchar</STRONG>  function is the analogous wide-character
138        form of <STRONG>pechochar</STRONG>.  It outputs one character to a pad  and
139        immediately  refreshes the pad.  It does this by a call to
140        <STRONG>wadd_wch</STRONG> followed by a call to <STRONG>prefresh</STRONG>.
141
142
143 </PRE>
144 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
145        Routines that return an integer return  <STRONG>ERR</STRONG>  upon  failure
146        and  <STRONG>OK</STRONG>  (SVr4 only specifies "an integer value other than
147        <STRONG>ERR</STRONG>") upon successful completion.
148
149        Routines that return pointers return <STRONG>NULL</STRONG>  on  error,  and
150        set <STRONG>errno</STRONG> to <STRONG>ENOMEM</STRONG>.
151
152        X/Open  does not define any error conditions.  In this im-
153        plementation
154
155           <STRONG>prefresh</STRONG> and <STRONG>pnoutrefresh</STRONG>
156                return an error if the window pointer is null,  or
157                if  the  window is not really a pad or if the area
158                to refresh extends off-screen or  if  the  minimum
159                coordinates are greater than the maximum.
160
161           <STRONG>pechochar</STRONG>
162                returns  an  error  if  the window is not really a
163                pad, and the associated call to <STRONG>wechochar</STRONG>  returns
164                an error.
165
166           <STRONG>pecho_wchar</STRONG>
167                returns  an  error  if  the window is not really a
168                pad, and the associated call  to  <STRONG>wecho_wchar</STRONG>  re-
169                turns an error.
170
171
172 </PRE>
173 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
174        Note that <STRONG>pechochar</STRONG> may be a macro.
175
176
177 </PRE>
178 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
179        The  XSI  Curses  standard,  Issue 4 describes these func-
180        tions.
181
182
183 </PRE>
184 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
185        <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>curs_add-</STRONG>
186        <STRONG><A HREF="curs_addch.3x.html">ch(3x)</A></STRONG>.
187
188
189
190                                                            <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG>
191 </PRE>
192 <div class="nav">
193 <ul>
194 <li><a href="#h2-NAME">NAME</a></li>
195 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
196 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
197 <ul>
198 <li><a href="#h3-newpad">newpad</a></li>
199 <li><a href="#h3-subpad">subpad</a></li>
200 <li><a href="#h3-prefresh_-pnoutrefresh">prefresh, pnoutrefresh</a></li>
201 <li><a href="#h3-pechochar">pechochar</a></li>
202 <li><a href="#h3-pecho_wchar">pecho_wchar</a></li>
203 </ul>
204 </li>
205 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
206 <li><a href="#h2-NOTES">NOTES</a></li>
207 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
208 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
209 </ul>
210 </div>
211 </BODY>
212 </HTML>