<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
****************************************************************************
- * Copyright (c) 1998,2000 Free Software Foundation, Inc. *
+ * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_pad.3x,v 1.9 2000/07/04 22:38:13 tom Exp @
+ * @Id: curs_pad.3x,v 1.16 2010/07/31 14:43:29 tom Exp @
-->
<HTML>
<HEAD>
<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG> <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG>
+
+
+
</PRE>
<H2>NAME</H2><PRE>
- <STRONG>newpad</STRONG>, <STRONG>subpad</STRONG>, <STRONG>prefresh</STRONG>, <STRONG>pnoutrefresh</STRONG>, <STRONG>pechochar</STRONG> - create
- and display <STRONG>curses</STRONG> pads
+ <STRONG>newpad</STRONG>, <STRONG>subpad</STRONG>, <STRONG>prefresh</STRONG>, <STRONG>pnoutrefresh</STRONG>, <STRONG>pechochar</STRONG>,
+ <STRONG>pecho_wchar</STRONG> - create and display <STRONG>curses</STRONG> pads
</PRE>
<STRONG>int</STRONG> <STRONG>pnoutrefresh(WINDOW</STRONG> <STRONG>*pad,</STRONG> <STRONG>int</STRONG> <STRONG>pminrow,</STRONG> <STRONG>int</STRONG> <STRONG>pmincol,</STRONG>
<STRONG>int</STRONG> <STRONG>sminrow,</STRONG> <STRONG>int</STRONG> <STRONG>smincol,</STRONG> <STRONG>int</STRONG> <STRONG>smaxrow,</STRONG> <STRONG>int</STRONG> <STRONG>smaxcol);</STRONG>
<STRONG>int</STRONG> <STRONG>pechochar(WINDOW</STRONG> <STRONG>*pad,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
+ <STRONG>int</STRONG> <STRONG>pecho_wchar(WINDOW</STRONG> <STRONG>*pad,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*wch);</STRONG>
</PRE>
it is not restricted by the screen size, and is not neces-
sarily 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 (<EM>e</EM>.<EM>g</EM>., from scrolling or echo-
- ing of input) do not occur. It is not legal to call <STRONG>wre-</STRONG>
- <STRONG>fresh</STRONG> with a <EM>pad</EM> as an argument; the routines <STRONG>prefresh</STRONG> or
+ part of the window will be on the screen at one time. Au-
+ tomatic refreshes of pads (e.g., from scrolling or echoing
+ of input) do not occur. It is not legal to call <STRONG>wrefresh</STRONG>
+ with a <EM>pad</EM> as an argument; the routines <STRONG>prefresh</STRONG> or
<STRONG>pnoutrefresh</STRONG> 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
screen coordinates, the window is at position (<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 window <EM>orig</EM>, so that changes made to one window affect
- both windows. During the use of this routine, it will
- often be necessary to call <STRONG>touchwin</STRONG> or <STRONG>touchline</STRONG> on <EM>orig</EM>
- before calling <STRONG>prefresh</STRONG>.
+ both windows. During the use of this routine, it will of-
+ ten be necessary to call <STRONG>touchwin</STRONG> or <STRONG>touchline</STRONG> on <EM>orig</EM> be-
+ fore calling <STRONG>prefresh</STRONG>.
The <STRONG>prefresh</STRONG> and <STRONG>pnoutrefresh</STRONG> routines are analogous to
<STRONG>wrefresh</STRONG> and <STRONG>wnoutrefresh</STRONG> 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.
- <EM>pminrow</EM> and <EM>pmincol</EM> specify the upper left-hand corner of
- the rectangle to be displayed in the pad. <EM>sminrow</EM>, <EM>smin-</EM>
- <EM>col</EM>, <EM>smaxrow</EM>, and <EM>smaxcol</EM> specify the edges of the rectan-
- gle to be displayed on the screen. The lower right-hand
- corner of the rectangle to be displayed in the pad is cal-
- culated 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 <EM>pminrow</EM>, <EM>pmincol</EM>, <EM>sminrow</EM>, or <EM>smincol</EM> are
- treated as if they were zero.
+ The <EM>pminrow</EM> and <EM>pmincol</EM> parameters specify the upper left-
+ hand corner of the rectangle to be displayed in the pad.
+ The <EM>sminrow</EM>, <EM>smincol</EM>, <EM>smaxrow</EM>, and <EM>smaxcol</EM> parameters
+ 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 co-
+ ordinates, since the rectangles must be the same size.
+ Both rectangles must be entirely contained within their
+ respective structures. Negative values of <EM>pminrow</EM>, <EM>pmin-</EM>
+ <EM>col</EM>, <EM>sminrow</EM>, or <EM>smincol</EM> are treated as if they were zero.
The <STRONG>pechochar</STRONG> routine is functionally equivalent to a call
to <STRONG>addch</STRONG> followed by a call to <STRONG>refresh</STRONG>, a call to <STRONG>waddch</STRONG>
followed by a call to <STRONG>wrefresh</STRONG>, or a call to <STRONG>waddch</STRONG> fol-
- lowed by a call to <STRONG>prefresh.</STRONG> The knowledge that only a
+ lowed by a call to <STRONG>prefresh</STRONG>. The knowledge that only a
single character is being output is taken into considera-
tion and, for non-control characters, a considerable per-
- formance gain might be seen by using these routines
- instead of their equivalents. In the case of <STRONG>pechochar</STRONG>,
- the last location of the pad on the screen is reused for
- the arguments to <STRONG>prefresh</STRONG>.
+ formance gain might be seen by using these routines in-
+ stead of their equivalents. In the case of <STRONG>pechochar</STRONG>, the
+ last location of the pad on the screen is reused for the
+ arguments to <STRONG>prefresh</STRONG>.
+
+ The <STRONG>pecho_wchar</STRONG> function is the analogous wide-character
+ form of <STRONG>pechochar</STRONG>. It outputs one character to a pad and
+ immediately refreshes the pad. It does this by a call to
+ <STRONG>wadd_wch</STRONG> followed by a call to <STRONG>prefresh</STRONG>.
</PRE>
<H2>RETURN VALUE</H2><PRE>
- Routines that return an integer return <STRONG>ERR</STRONG> upon failure
- and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than
+ Routines that return an integer return <STRONG>ERR</STRONG> upon failure
+ and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than
<STRONG>ERR</STRONG>") upon successful completion.
- Routines that return pointers return <STRONG>NULL</STRONG> on error, and
+ Routines that return pointers return <STRONG>NULL</STRONG> on error, and
set <STRONG>errno</STRONG> to <STRONG>ENOMEM</STRONG>.
+ X/Open does not define any error conditions. In this im-
+ plementation
+
+ <STRONG>prefresh</STRONG> and <STRONG>pnoutrefresh</STRONG>
+ return an error if the window pointer is null,
+ or if the window is not really a pad or if the
+ area to refresh extends off-screen or if the
+ minimum coordinates are greater than the maxi-
+ mum.
+
+ <STRONG>pechochar</STRONG>
+ returns an error if the window is not really a
+ pad, and the associated call to <STRONG>wechochar</STRONG> re-
+ turns an error.
+
+ <STRONG>pecho_wchar</STRONG>
+ returns an error if the window is not really a
+ pad, and the associated call to <STRONG>wecho_wchar</STRONG>
+ returns an error.
+
</PRE>
<H2>NOTES</H2><PRE>
</PRE>
<H2>SEE ALSO</H2><PRE>
- <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>.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+ <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>
+ <STRONG><A HREF="curs_addch.3x.html">ch(3x)</A></STRONG>.
+ <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG>
</PRE>
<HR>
<ADDRESS>
projects / ncurses.git / blobdiff