X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_pad.3x;h=6ce640b7f691df531f92a43b54f42899cb70e4eb;hp=4db08dcf440b48a7db89bb5d338bd96ceec4d1d6;hb=b040313679284c778b4f02a5b34d9e775ceba697;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/man/curs_pad.3x b/man/curs_pad.3x index 4db08dcf..6ce640b7 100644 --- a/man/curs_pad.3x +++ b/man/curs_pad.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2004 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 * @@ -26,12 +26,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_pad.3x,v 1.12 2004/01/04 01:36:49 tom Exp $ +.\" $Id: curs_pad.3x,v 1.17 2010/12/04 18:41:07 tom Exp $ .TH curs_pad 3X "" +.na +.hy 0 .SH NAME -\fBnewpad\fR, \fBsubpad\fR, \fBprefresh\fR, +\fBnewpad\fR, +\fBsubpad\fR, +\fBprefresh\fR, \fBpnoutrefresh\fR, -\fBpechochar\fR, \fBpecho_wchar\fR - create and display \fBcurses\fR pads +\fBpechochar\fR, +\fBpecho_wchar\fR \- create and display \fBcurses\fR pads +.ad +.hy .SH SYNOPSIS \fB#include \fR .sp @@ -83,10 +90,11 @@ The \fBprefresh\fR and \fBpnoutrefresh\fR routines are analogous to 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, @@ -119,15 +127,31 @@ completion. .PP Routines that return pointers return \fBNULL\fR on error, and set \fBerrno\fR to \fBENOMEM\fR. +.PP +X/Open does not define any error conditions. +In this implementation +.RS +.TP 5 +\fBprefresh\fP and \fBpnoutrefresh\fP +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 maximum. +.TP 5 +\fBpechochar\fP +returns an error +if the window is not really a pad, and the associated call +to \fBwechochar\fP returns an error. +.TP 5 +\fBpecho_wchar\fP +returns an error +if the window is not really a pad, and the associated call +to \fBwecho_wchar\fP returns an error. +.RE .SH NOTES Note that \fBpechochar\fR may be a macro. .SH PORTABILITY 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: