X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_touch.3x;h=8b0ca87e621e3d3561569c9292af813958c45525;hb=8f487e9f47505e8cf31ea1b5e3075b2a43ce9302;hp=8d4a88cb0cfb7c1b4c7ae3867dedd98ea24dd0af;hpb=8d3ea9021573747ecd129228ba7782a03243f62c;p=ncurses.git diff --git a/man/curs_touch.3x b/man/curs_touch.3x index 8d4a88cb..8b0ca87e 100644 --- a/man/curs_touch.3x +++ b/man/curs_touch.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2015,2017 Free Software Foundation, Inc. * +.\" Copyright 2018-2020,2021 Thomas E. Dickey * +.\" Copyright 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 +27,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_touch.3x,v 1.20 2017/11/25 16:19:42 tom Exp $ +.\" $Id: curs_touch.3x,v 1.24 2021/06/17 21:26:02 tom Exp $ .TH curs_touch 3X "" .na .hy 0 @@ -41,26 +42,28 @@ .hy .SH SYNOPSIS \fB#include \fR +.sp +\fBint touchline(WINDOW *\fP\fIwin\fP\fB, int \fP\fIstart\fP\fB, int \fP\fIcount\fP\fB);\fR +.sp +\fBint touchwin(WINDOW *\fP\fIwin\fP\fB);\fR .br -\fBint touchwin(WINDOW *win);\fR +\fBint wtouchln(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIn\fP\fB, int \fP\fIchanged\fP\fB);\fR +.sp +\fBint untouchwin(WINDOW *\fP\fIwin\fP\fB);\fR +.sp +\fBbool is_linetouched(WINDOW *\fP\fIwin\fP\fB, int \fP\fIline\fP\fB);\fR .br -\fBint touchline(WINDOW *win, int start, int count);\fR -.br -\fBint untouchwin(WINDOW *win);\fR -.br -\fBint wtouchln(WINDOW *win, int y, int n, int changed);\fR -.br -\fBbool is_linetouched(WINDOW *win, int line);\fR -.br -\fBbool is_wintouched(WINDOW *win);\fR +\fBbool is_wintouched(WINDOW *\fP\fIwin\fP\fB);\fR .br .SH DESCRIPTION The \fBtouchwin\fR and \fBtouchline\fR routines throw away all optimization information about which parts of the window have been -touched, by pretending that the entire window has been drawn on. This +touched, by pretending that the entire window has been drawn on. +This is sometimes necessary when using overlapping windows, since a change 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 +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 @@ -87,7 +90,7 @@ In this implementation .RS 3 .TP 5 \fBis_linetouched\fP -returns an error +returns an error if the window pointer is null, or if the line number is outside the window. .IP @@ -102,7 +105,7 @@ the \fBERR\fP is provided by a macro named \fBis_linetouched\fP. The actual function returns \fBFALSE\fP when it detects an error. .TP 5 \fBwtouchln\fP -returns an error +returns an error if the window pointer is null, or if the line number is outside the window. .RE