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