diff options
Diffstat (limited to 'lib/libcurses/curs_touch.3')
| -rw-r--r-- | lib/libcurses/curs_touch.3 | 34 |
1 files changed, 27 insertions, 7 deletions
diff --git a/lib/libcurses/curs_touch.3 b/lib/libcurses/curs_touch.3 index 1cd02bc1f26..e18a0bf7e42 100644 --- a/lib/libcurses/curs_touch.3 +++ b/lib/libcurses/curs_touch.3 @@ -1,7 +1,7 @@ -.\" $OpenBSD: curs_touch.3,v 1.6 2000/07/10 03:06:09 millert Exp $ +.\" $OpenBSD: curs_touch.3,v 1.7 2010/01/12 23:21:59 nicm Exp $ .\" .\"*************************************************************************** -.\" Copyright (c) 1998,2000 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2005,2006 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 * @@ -28,8 +28,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $From: curs_touch.3x,v 1.8 2000/07/08 11:07:57 tom Exp $ +.\" $Id: curs_touch.3,v 1.7 2010/01/12 23:21:59 nicm Exp $ .TH curs_touch 3 "" +.na +.hy 0 .SH NAME \fBtouchwin\fR, \fBtouchline\fR, @@ -37,6 +39,8 @@ \fBwtouchln\fR, \fBis_linetouched\fR, \fBis_wintouched\fR - \fBcurses\fR refresh control routines +.ad +.hy .SH SYNOPSIS \fB#include <curses.h>\fR .br @@ -61,15 +65,15 @@ to one window affects the other window, but the records of which lines have been changed in the other window do not reflect the change. The routine \fBtouchline\fR only pretends that \fIcount\fR lines have been changed, beginning with line \fIstart\fR. - +.PP The \fBuntouchwin\fR routine marks all lines in the window as unchanged since the last call to \fBwrefresh\fR. - +.PP The \fBwtouchln\fR routine makes \fIn\fR lines in the window, starting at line \fIy\fR, look as if they have (\fIchanged\fR\fB=1\fR) or have not (\fIchanged\fR\fB=0\fR) been changed since the last call to \fBwrefresh\fR. - +.PP The \fBis_linetouched\fR and \fBis_wintouched\fR routines return \fBTRUE\fR if the specified line/window was modified since the last call to \fBwrefresh\fR; otherwise they return \fBFALSE\fR. In @@ -79,9 +83,25 @@ valid for the given window. All routines return the integer \fBERR\fR upon failure and an integer value other than \fBERR\fR upon successful completion, unless otherwise noted in the preceding routine descriptions. +.PP +X/Open does not define any error conditions. +In this implementation +.RS +.TP 5 +\fBis_linetouched\fP +returns an error +if the window pointer is null, or +if the line number is outside the window. +Note that ERR is distinct from TRUE and FALSE, which are the normal return values of this function. +.TP 5 +\fBwtouchln\fP +returns an error +if the window pointer is null, or +if the line number is outside the window. +.RE .SH PORTABILITY The XSI Curses standard, Issue 4 describes these functions. - +.PP Some historic curses implementations had, as an undocumented feature, the ability to do the equivalent of \fBclearok(..., 1)\fR by saying \fBtouchwin(stdscr)\fR or \fBclear(stdscr)\fR. This will not work under |