NetBSD/lib/libpanel/update_panels.3

67 lines
2.3 KiB
Groff

.\" $NetBSD: update_panels.3,v 1.3 2015/10/29 06:57:34 wiz Exp $
.\"
.\" Copyright (c) 2015 Valery Ushakov
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd October 28, 2015
.Dt UPDATE_PANELS 3
.Os
.Sh NAME
.Nm update_panels
.Nd update terminal display
.Sh LIBRARY
.Lb libpanel
.Sh SYNOPSIS
.In panel.h
.\"
.Ft void
.Fn update_panels "void"
.\"
.Sh DESCRIPTION
The
.Fn update_panels
function performs the internal processing required by the panel
library to determine what changes need to be made to synchronise
the curses internal screen buffer and the terminal but does not
modify the terminal display.
.Pp
This function will internally perform the required calls to
.Xr touchoverlap 3
and
.Xr wnoutrefresh 3
in the correct order.
You should never directly call curses functions like
.Xr wnoutrefresh 3
on panel windows yourself.
Remember, that
.Dv stdscr
is below all panels and any changes to it also require calling
.Fn update_panels .
.Pp
Finally, call the curses function
.Xr doupdate 3
to update the terminal display.
.Sh SEE ALSO
.Xr doupdate 3 ,
.Xr panel 3