1*ed8dd388Swiz.\" $NetBSD: panel.3,v 1.3 2015/10/28 10:22:40 wiz Exp $ 2ab1c44cbSuwe.\" 3ab1c44cbSuwe.\" Copyright (c) 2015 Valery Ushakov 4ab1c44cbSuwe.\" All rights reserved. 5ab1c44cbSuwe.\" 6ab1c44cbSuwe.\" Redistribution and use in source and binary forms, with or without 7ab1c44cbSuwe.\" modification, are permitted provided that the following conditions 8ab1c44cbSuwe.\" are met: 9ab1c44cbSuwe.\" 1. Redistributions of source code must retain the above copyright 10ab1c44cbSuwe.\" notice, this list of conditions and the following disclaimer. 11ab1c44cbSuwe.\" 2. Redistributions in binary form must reproduce the above copyright 12ab1c44cbSuwe.\" notice, this list of conditions and the following disclaimer in the 13ab1c44cbSuwe.\" documentation and/or other materials provided with the distribution. 14ab1c44cbSuwe.\" 15ab1c44cbSuwe.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16ab1c44cbSuwe.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17ab1c44cbSuwe.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18ab1c44cbSuwe.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19ab1c44cbSuwe.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20ab1c44cbSuwe.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21ab1c44cbSuwe.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22ab1c44cbSuwe.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23ab1c44cbSuwe.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24ab1c44cbSuwe.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25ab1c44cbSuwe.\" 26ab1c44cbSuwe.Dd October 28, 2015 27ab1c44cbSuwe.Dt PANEL 3 28ab1c44cbSuwe.Os 29ab1c44cbSuwe.Sh NAME 30ab1c44cbSuwe.Nm panel 31ab1c44cbSuwe.Nd z-order for curses windows 32ab1c44cbSuwe.Sh LIBRARY 33ab1c44cbSuwe.Lb libpanel 34ab1c44cbSuwe.Sh SYNOPSIS 35ab1c44cbSuwe.In panel.h 36ab1c44cbSuwe.Sh DESCRIPTION 37ab1c44cbSuweOverlapping curses windows have no notion of z-order, 38ab1c44cbSuwewhat you see on the screen depends on the order of updates. 39*ed8dd388SwizThe 40ab1c44cbSuwe.Nm 41ab1c44cbSuwelibrary is an extension built on top of 428249bf06Swiz.Xr curses 3 43ab1c44cbSuwethat adds z-order to curses windows. 44ab1c44cbSuwe.Pp 45ab1c44cbSuweEach panel has an associated curses window. 46ab1c44cbSuweAll currently visible panels form a 47ab1c44cbSuwe.Dq deck . 48ab1c44cbSuwePanels have z-order only relative to other panels in the deck and to 498249bf06Swiz.\".Xr stdscr 3 . 508249bf06Swizstdscr. 51ab1c44cbSuweThe latter doesn't have a panel of its own but implicitly lies below 52ab1c44cbSuweall other panels in the deck. 53*ed8dd388SwizIf you mix plain curses windows and panels, the visual results are 54*ed8dd388Swizundefined since the panel library is not aware of windows that are not 55ab1c44cbSuweassociated with panels. 56ab1c44cbSuwe.Bl -column ".Xr set_panel_userptr 3" 57ab1c44cbSuwe.It Sy "Function" Ta Sy "Summary" 58ab1c44cbSuwe.It Xr bottom_panel 3 Ta move the panel to the bottom of the deck 59ab1c44cbSuwe.It Xr del_panel 3 Ta delete the panel 60ab1c44cbSuwe.It Xr hide_panel 3 Ta hide the panel, removing it from deck 61ab1c44cbSuwe.It Xr move_panel 3 Ta move the panel to a new position on screen 62ab1c44cbSuwe.It Xr new_panel 3 Ta create new panel 63ab1c44cbSuwe.It Xr panel_above 3 Ta a panel above the given panel 64ab1c44cbSuwe.It Xr panel_below 3 Ta a panel below the given panel 65ab1c44cbSuwe.It Xr panel_hidden 3 Ta check if the panel is hidden 66ab1c44cbSuwe.It Xr panel_userptr 3 Ta user data associated with the panel 67ab1c44cbSuwe.It Xr panel_window 3 Ta curses window associated with the panel 68ab1c44cbSuwe.It Xr replace_panel 3 Ta associate a different window with the panel 69ab1c44cbSuwe.It Xr set_panel_userptr 3 Ta associate arbitrary user data with the panel 70ab1c44cbSuwe.It Xr show_panel 3 Ta show hidden panel at the top of the deck 71ab1c44cbSuwe.It Xr top_panel 3 Ta move the panel to the top of the deck 72ab1c44cbSuwe.It Xr update_panels 3 Ta update terminal display 73ab1c44cbSuwe.El 74ab1c44cbSuwe.Sh SEE ALSO 758249bf06Swiz.Xr curses 3 76