xref: /netbsd-src/lib/libpanel/update_panels.3 (revision f0f2f50bf3bc4b67ef88870ff457d12da126a42e)
1.\"	$NetBSD: update_panels.3,v 1.3 2015/10/29 06:57:34 wiz Exp $
2.\"
3.\" Copyright (c) 2015 Valery Ushakov
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.Dd October 28, 2015
27.Dt UPDATE_PANELS 3
28.Os
29.Sh NAME
30.Nm update_panels
31.Nd update terminal display
32.Sh LIBRARY
33.Lb libpanel
34.Sh SYNOPSIS
35.In panel.h
36.\"
37.Ft void
38.Fn update_panels "void"
39.\"
40.Sh DESCRIPTION
41The
42.Fn update_panels
43function performs the internal processing required by the panel
44library to determine what changes need to be made to synchronise
45the curses internal screen buffer and the terminal but does not
46modify the terminal display.
47.Pp
48This function will internally perform the required calls to
49.Xr touchoverlap 3
50and
51.Xr wnoutrefresh 3
52in the correct order.
53You should never directly call curses functions like
54.Xr wnoutrefresh 3
55on panel windows yourself.
56Remember, that
57.Dv stdscr
58is below all panels and any changes to it also require calling
59.Fn update_panels .
60.Pp
61Finally, call the curses function
62.Xr doupdate 3
63to update the terminal display.
64.Sh SEE ALSO
65.Xr doupdate 3 ,
66.Xr panel 3
67