NetBSD/lib/libpanel/panel.3

.\"	$NetBSD: panel.3,v 1.3 2015/10/28 10:22:40 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 PANEL 3
.Os
.Sh NAME
.Nm panel
.Nd z-order for curses windows
.Sh LIBRARY
.Lb libpanel
.Sh SYNOPSIS
.In panel.h
.Sh DESCRIPTION
Overlapping curses windows have no notion of z-order,
what you see on the screen depends on the order of updates.
The
.Nm
library is an extension built on top of
.Xr curses 3
that adds z-order to curses windows.
.Pp
Each panel has an associated curses window.
All currently visible panels form a
.Dq deck .
Panels have z-order only relative to other panels in the deck and to
.\".Xr stdscr 3 .
stdscr.
The latter doesn't have a panel of its own but implicitly lies below
all other panels in the deck.
If you mix plain curses windows and panels, the visual results are
undefined since the panel library is not aware of windows that are not
associated with panels.
.Bl -column ".Xr set_panel_userptr 3"
.It Sy "Function"          Ta Sy "Summary"
.It Xr bottom_panel 3      Ta move the panel to the bottom of the deck
.It Xr del_panel 3         Ta delete the panel
.It Xr hide_panel 3        Ta hide the panel, removing it from deck
.It Xr move_panel 3        Ta move the panel to a new position on screen
.It Xr new_panel 3         Ta create new panel
.It Xr panel_above 3       Ta a panel above the given panel
.It Xr panel_below 3       Ta a panel below the given panel
.It Xr panel_hidden 3      Ta check if the panel is hidden
.It Xr panel_userptr 3     Ta user data associated with the panel
.It Xr panel_window 3      Ta curses window associated with the panel
.It Xr replace_panel 3     Ta associate a different window with the panel
.It Xr set_panel_userptr 3 Ta associate arbitrary user data with the panel
.It Xr show_panel 3        Ta show hidden panel at the top of the deck
.It Xr top_panel 3         Ta move the panel to the top of the deck
.It Xr update_panels 3     Ta update terminal display
.El
.Sh SEE ALSO
.Xr curses 3