mirror of
https://github.com/freebsd/freebsd-src.git
synced 2024-12-02 15:03:41 +00:00
3e6427f35f
old 1M, 3X and 3S section numbers) and make some minor formatting changes to silence manck.
58 lines
2.1 KiB
Groff
58 lines
2.1 KiB
Groff
.TH curs_touch 3 ""
|
|
.SH NAME
|
|
\fBtouchwin\fR, \fBtouchline\fR, \fBuntouchwin\fR,
|
|
\fBwtouchln\fR, \fBis_linetouched\fR,
|
|
\fBis_wintouched\fR - \fBncurses\fR refresh control routines
|
|
.SH SYNOPSIS
|
|
\fB#include <ncurses.h>\fR
|
|
.br
|
|
\fBint touchwin(WINDOW *win);\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
|
|
\fBint is_linetouched(WINDOW *win, int line);\fR
|
|
.br
|
|
\fBint is_wintouched(WINDOW *win);\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
|
|
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
|
|
routine \fBtouchline\fR only pretends that \fIcount\fR lines have been
|
|
changed, beginning with line \fIstart\fR.
|
|
|
|
The \fBuntouchwin\fR routine marks all lines in the window as unchanged since
|
|
the last call to \fBwrefresh\fR.
|
|
|
|
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.
|
|
|
|
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
|
|
addition, \fBis_linetouched\fR returns \fBERR\fR if \fIline\fR is not
|
|
valid for the given window.
|
|
.SH RETURN VALUE
|
|
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.
|
|
.SH NOTES
|
|
Note that all routines except \fBwtouchln\fR may be macros.
|
|
.SH SEE ALSO
|
|
\fBncurses\fR(3), \fBcurs_refresh\fR(3).
|
|
.\"#
|
|
.\"# The following sets edit modes for GNU EMACS
|
|
.\"# Local Variables:
|
|
.\"# mode:nroff
|
|
.\"# fill-column:79
|
|
.\"# End:
|