'\"!  tbl | mmdoc
'\"macro stdmacro
.if n .pH g3x.panels @(#)panels	40.4 of 12/15/89
.\" Copyright 1989 AT&T
.\" ident	"@(#)svid_ti:ti_env/panels	1.6"
.ds S ETI
.nr X
.if \nX=0 .ds x} panels 3X "" "\&"
.if \nX=1 .ds x} panels 3X ""
.if \nX=2 .ds x} panels 3X "" "\&"
.if \nX=3 .ds x} panels "" "" "\&"
.TH \*(x}
.SH NAME
\f4panels\fP \- character based panels package
.SH SYNOPSIS
\f4#include <panel.h>\f1
.SH DESCRIPTION
The \f4panel\fP library is built using the \f4curses\fP
library, and any program using \f4panels\fP routines must
call one of the \f4curses\fP initialization routines such as \f4initscr\f1.
A program using these routines must be compiled with
\f4\-lpanel\f1 and \f4\-lcurses\f1 on the \f4cc\f1 command line.
.PP
The \f4panels\fP package gives the applications programmer a way
to have depth relationships between \f4curses\fP windows;
a \f4curses\fP window is associated with every panel.
The \f4panels\fP routines allow \f4curses\fP windows to overlap
without making visible the overlapped portions
of underlying windows.
The initial \f4curses\fP window, \f4stdscr\f1, lies beneath all panels.
The set of currently visible panels is the \f2deck\f1 of panels.
.PP
The \f4panels\fP package allows the applications programmer to create panels,
fetch and set their associated windows, shuffle panels in
the deck, and manipulate panels in other ways.
.SS Routine Name Index
The following table lists each \f4panels\fP routine and the name of the
manual page on which it is described.
.TS H
lfHB lfHB
lfCWw(2i) lw(2i).
\f4panels\fP Routine Name	Manual Page Name
.sp 0.5
_
.TH
bottom_panel	panel_top(3X)
del_panel	panel_new(3X)
hide_panel	panel_show(3X)
move_panel	panel_move(3X)
new_panel	panel_new(3X)
panel_above	panel_above(3X)
panel_below	panel_above(3X)
panel_hidden	panel_show(3X)
panel_userptr	panel_userptr(3X)
panel_window	panel_window(3X)
replace_panel	panel_window(3X)
set_panel_userptr	panel_userptr(3X)
show_panel	panel_show(3X)
top_panel	panel_top(3X)
update_panels	panel_update(3X)
.TE
.SH RETURN VALUE
Each \f4panels\fP routine that returns a pointer
to an object returns \f4NULL\fP if an error occurs.
Each panel routine that returns an integer, returns \f4OK\fP
if it executes successfully and \f4ERR\fP if it does not.
.br
.ne 1i
.SH NOTES
.PP
The header file \f4<panel.h>\f1 automatically includes the header file
\f4<curses.h>\f1.
.SH SEE ALSO
\f4curses\fP(3X),
and 3X pages whose names begin "panel_," for detailed routine
descriptions.
