X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_pad.3x;h=1b427e1002b5ca00b71e64db6f489521e8511924;hp=c7222074ebeb07dbaee49ccc4f0d32494f23c73e;hb=5eb177874dea59107a1a2ea44f5d8f5bb99550b2;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8 diff --git a/man/curs_pad.3x b/man/curs_pad.3x index c7222074..1b427e10 100644 --- a/man/curs_pad.3x +++ b/man/curs_pad.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2004,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2015,2017 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 * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_pad.3x,v 1.14 2005/05/15 16:18:43 tom Exp $ +.\" $Id: curs_pad.3x,v 1.19 2017/01/07 19:25:15 tom Exp $ .TH curs_pad 3X "" .na .hy 0 @@ -36,27 +36,28 @@ \fBprefresh\fR, \fBpnoutrefresh\fR, \fBpechochar\fR, -\fBpecho_wchar\fR - create and display \fBcurses\fR pads +\fBpecho_wchar\fR \- create and display \fBcurses\fR pads .ad .hy .SH SYNOPSIS \fB#include \fR .sp -\fBWINDOW *newpad(int nlines, int ncols);\fR +\fBWINDOW *newpad(int \fP\fInlines\fP\fB, int \fP\fIncols\fP\fB);\fR .br -\fBWINDOW *subpad(WINDOW *orig, int nlines, int ncols,\fR - \fBint begin_y, int begin_x);\fR +\fBWINDOW *subpad(WINDOW *\fP\fIorig\fP\fB, int \fP\fInlines\fP\fB, int \fP\fIncols\fP\fB,\fR + \fBint \fP\fIbegin_y\fP\fB, int \fP\fIbegin_x\fP\fB);\fR .br -\fBint prefresh(WINDOW *pad, int pminrow, int pmincol,\fR - \fBint sminrow, int smincol, int smaxrow, int smaxcol);\fR +\fBint prefresh(WINDOW *\fP\fIpad\fP\fB, int \fP\fIpminrow\fP\fB, int \fP\fIpmincol\fP\fB,\fR + \fBint \fP\fIsminrow\fP\fB, int \fP\fIsmincol\fP\fB, int \fP\fIsmaxrow\fP\fB, int \fP\fIsmaxcol\fP\fB);\fR .br -\fBint pnoutrefresh(WINDOW *pad, int pminrow, int pmincol,\fR - \fBint sminrow, int smincol, int smaxrow, int smaxcol);\fR +\fBint pnoutrefresh(WINDOW *\fP\fIpad\fP\fB, int \fP\fIpminrow\fP\fB, int \fP\fIpmincol\fP\fB,\fR + \fBint \fP\fIsminrow\fP\fB, int \fP\fIsmincol\fP\fB, int \fP\fIsmaxrow\fP\fB, int \fP\fIsmaxcol\fP\fB);\fR .br -\fBint pechochar(WINDOW *pad, chtype ch);\fR +\fBint pechochar(WINDOW *\fP\fIpad\fP\fB, chtype \fP\fIch\fP\fB);\fR .br -\fBint pecho_wchar(WINDOW *pad, const cchar_t *wch);\fR +\fBint pecho_wchar(WINDOW *\fP\fIpad\fP\fB, const cchar_t *\fP\fIwch\fP\fB);\fR .SH DESCRIPTION +.SS newpad The \fBnewpad\fR routine creates and returns a pointer to a new pad data structure with the given number of lines, \fInlines\fR, and columns, \fIncols\fR. @@ -73,6 +74,7 @@ legal to call \fBwrefresh\fR with a \fIpad\fR as an argument; the routines 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. +.SS subpad .PP The \fBsubpad\fR routine creates and returns a pointer to a subwindow within a pad with the given number of lines, \fInlines\fR, and columns, \fIncols\fR. @@ -84,16 +86,18 @@ affect both windows. During the use of this routine, it will often be necessary to call \fBtouchwin\fR or \fBtouchline\fR on \fIorig\fR before calling \fBprefresh\fR. +.SS prefresh, pnoutrefresh .PP The \fBprefresh\fR and \fBpnoutrefresh\fR routines are analogous to \fBwrefresh\fR and \fBwnoutrefresh\fR 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. -\fIpminrow\fR and \fIpmincol\fR specify the upper +The \fIpminrow\fR and \fIpmincol\fR parameters specify the upper left-hand corner of the rectangle to be displayed in the pad. -\fIsminrow\fR, -\fIsmincol\fR, \fIsmaxrow\fR, and \fIsmaxcol\fR specify the edges of the +The \fIsminrow\fR, +\fIsmincol\fR, \fIsmaxrow\fR, and \fIsmaxcol\fR +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 coordinates, @@ -103,9 +107,10 @@ contained within their respective structures. Negative values of \fIpminrow\fR, \fIpmincol\fR, \fIsminrow\fR, or \fIsmincol\fR are treated as if they were zero. +.SS pechochar .PP The \fBpechochar\fR routine is functionally equivalent to a call to \fBaddch\fR -followed by a call to \fBrefresh\fR, a call to \fBwaddch\fR followed by a call +followed by a call to \fBrefresh\fR(3X), a call to \fBwaddch\fR followed by a call to \fBwrefresh\fR, or a call to \fBwaddch\fR followed by a call to \fBprefresh\fR. The knowledge that only a single character is being output is @@ -114,6 +119,7 @@ performance gain might be seen by using these routines instead of their equivalents. In the case of \fBpechochar\fR, the last location of the pad on the screen is reused for the arguments to \fBprefresh\fR. +.SS pecho_wchar .PP The \fBpecho_wchar\fR function is the analogous wide-character form of \fBpechochar\fR. @@ -129,7 +135,7 @@ to \fBENOMEM\fR. .PP X/Open does not define any error conditions. In this implementation -.RS +.RS 3 .TP 5 \fBprefresh\fP and \fBpnoutrefresh\fP return an error @@ -154,9 +160,3 @@ Note that \fBpechochar\fR may be a macro. The XSI Curses standard, Issue 4 describes these functions. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_refresh\fR(3X), \fBcurs_touch\fR(3X), \fBcurs_addch\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: