ncurses 5.9 - patch 20131110
[ncurses.git] / man / curs_touch.3x
index e1d130d30368b49c6cf208b890884d49f479dcdc..9fa6d370b9a225f3769631ae4daed2329f155efe 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 1998-2006,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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_touch.3x,v 1.6 1998/03/11 21:12:53 juergen Exp $
+.\" $Id: curs_touch.3x,v 1.14 2010/12/04 18:38:55 tom Exp $
 .TH curs_touch 3X ""
+.na
+.hy 0
 .SH NAME
-\fBtouchwin\fR, \fBtouchline\fR, \fBuntouchwin\fR,
-\fBwtouchln\fR, \fBis_linetouched\fR, \fBis_wintouched\fR -
-\fBcurses\fR refresh control routines
+\fBtouchwin\fR,
+\fBtouchline\fR,
+\fBuntouchwin\fR,
+\fBwtouchln\fR,
+\fBis_linetouched\fR,
+\fBis_wintouched\fR \- \fBcurses\fR refresh control routines
+.ad
+.hy
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 .br
@@ -43,9 +50,9 @@
 .br
 \fBint wtouchln(WINDOW *win, int y, int n, int changed);\fR
 .br
-\fBint is_linetouched(WINDOW *win, int line);\fR
+\fBbool is_linetouched(WINDOW *win, int line);\fR
 .br
-\fBint is_wintouched(WINDOW *win);\fR
+\fBbool is_wintouched(WINDOW *win);\fR
 .br
 .SH DESCRIPTION
 The \fBtouchwin\fR and \fBtouchline\fR routines throw away all
@@ -56,15 +63,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
@@ -74,9 +81,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
@@ -84,10 +107,6 @@ ncurses.
 .SH NOTES
 Note that all routines except \fBwtouchln\fR may be macros.
 .SH SEE ALSO
-\fBcurses\fR(3X), \fBcurs_refresh\fR(3X).
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End:
+\fBcurses\fR(3X),
+\fBcurs_refresh\fR(3X),
+\fBcurs_variables\fR(3X).