Home
Search all pages
Subjects
By activity
Professions, Sciences, Humanities, Business, ...
User Interface
Text-based, GUI, Audio, Video, Keyboards, Mouse, Images,...
Text Strings
Conversions, tests, processing, manipulation,...
Math
Integer, Floating point, Matrix, Statistics, Boolean, ...
Processing
Algorithms, Memory, Process control, Debugging, ...
Stored Data
Data storage, Integrity, Encryption, Compression, ...
Communications
Networks, protocols, Interprocess, Remote, Client Server, ...
Hard World Timing, Calendar and Clock, Audio, Video, Printer, Controls...
File System
Management, Filtering, File & Directory access, Viewers, ...
|
|
|
RocketLink!--> Man page versions:
OpenBSD
FreeBSD
Others
curs_pad(3) curs_pad(3)
NAME
newpad, subpad, prefresh, pnoutrefresh, pechochar - create
and display curses pads
SYNOPSIS
#include <curses.h>
WINDOW *newpad(int nlines, int ncols);
WINDOW *subpad(WINDOW *orig, int nlines, int ncols,
int begin_y, int begin_x);
int prefresh(WINDOW *pad, int pminrow, int pmincol,
int sminrow, int smincol, int smaxrow, int smaxcol);
int pnoutrefresh(WINDOW *pad, int pminrow, int pmincol,
int sminrow, int smincol, int smaxrow, int smaxcol);
int pechochar(WINDOW *pad, chtype ch);
DESCRIPTION
The newpad routine creates and returns a pointer to a new
pad data structure with the given number of lines, nlines,
and columns, ncols. A pad is like a window, except that
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 (e.g., from scrolling or echo-
ing of input) do not occur. It is not legal to call wre-
fresh with a pad as an argument; the routines prefresh or
pnoutrefresh 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
to be used for the display.
The subpad routine creates and returns a pointer to a sub-
window within a pad with the given number of lines,
nlines, and columns, ncols. Unlike subwin, which uses
screen coordinates, the window is at position (begin_x,
begin_y) on the pad. The window is made in the middle of
the window orig, so that changes made to one window affect
both windows. During the use of this routine, it will
often be necessary to call touchwin or touchline on orig
before calling prefresh.
The prefresh and pnoutrefresh routines are analogous to
wrefresh and wnoutrefresh 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.
pminrow and pmincol specify the upper left-hand corner of
the rectangle to be displayed in the pad. sminrow, smin-
col, smaxrow, and smaxcol 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
1
curs_pad(3) curs_pad(3)
values of pminrow, pmincol, sminrow, or smincol are
treated as if they were zero.
The pechochar routine is functionally equivalent to a call
to addch followed by a call to refresh, a call to waddch
followed by a call to wrefresh, or a call to waddch fol-
lowed by a call to prefresh. 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 pechochar,
the last location of the pad on the screen is reused for
the arguments to prefresh.
RETURN VALUE
Routines that return an integer return ERR upon failure
and OK (SVr4 only specifies "an integer value other than
ERR") upon successful completion.
Routines that return pointers return NULL on error, and
set errno to ENOMEM.
NOTES
Note that pechochar may be a macro.
PORTABILITY
The XSI Curses standard, Issue 4 describes these func-
tions.
SEE ALSO
curses(3), curs_refresh(3), curs_touch(3), curs_addch(3).
2
Source: OpenBSD 2.6 man pages. Copyright: Portions are copyrighted by BERKELEY SOFTWARE DESIGN, INC., The Regents of the University of California, Massachusetts Institute of Technology, Free Software Foundation, FreeBSD Inc., and others. |
(Corrections, notes, and links courtesy of RocketAware.com)
FreeBSD Sources for curs_pad(3) functions OpenBSD sources for curs_pad(3)
Up to: Curses - Curses (Library for text display interfaces)
RocketLink!--> Man page versions:
OpenBSD
FreeBSD
Others
Rapid-Links:
Search | About | Comments | Submit Path: RocketAware > man pages >
curs_pad.3/
RocketAware.com is a service of Mib Software Copyright 1999, Forrest J. Cavalier III. All Rights Reserved. We welcome submissions and comments
|