PANEL(3X) INTERACTIVE UNIX System PANEL(3X)
NAME
panel - PANEL library routines
SYNOPSIS
#include <panel.h>
cc [ flags ] files -lpanel -lcurses [ libraries ]
PANEL *new_panel(win)
WINDOW *win;
WINDOW *panel_window(panel)
PANEL *panel;
int replace_panel(panel, window)
PANEL *panel;
WINDOW *window;
int move_panel(panel, starty, startx)
PANEL *panel;
int starty, startx;
int bottom_panel(panel)
PANEL *panel;
int top_panel(panel)
PANEL *panel;
void update_panels()
int hide_panel(panel)
PANEL *panel;
int panel_hidden(panel)
PANEL *panel;
int show_panel(panel)
PANEL *panel;
PANEL *panel_above(panel)
PANEL *panel;
PANEL *panel_below(panel)
PANEL *panel;
int *set_panel_userptr(panel,ptr)
PANEL *panel;
char *ptr;
char *panel_userptr(panel)
PANEL *panel;
int del_panel(panel)
PANEL *panel;
DESCRIPTION
Panels are rectangles of text with depth. They enable your
windows to overlap without having hidden portions of under-
lying windows be mistakenly visible. stdscr lies beneath
all panels. The set of currently visible panels is the deck
of panels.
A window is associated with every panel. The panel routines
enable you to create panels, fetch their associated windows,
shuffle panels in the deck, and manipulate panels in other
ways.
PANEL routines run on the AT&T processor line using any
Rev. Extended Terminal Interface Page 1
PANEL(3X) INTERACTIVE UNIX System PANEL(3X)
terminal supported by curses(3X), the low-level Extended
Terminal Interface (ETI) library. Once you compile your ETI
program #includeing the PANEL header file panel.h, you
should link it with the panel and curses library routines.
FUNCTIONS
For a complete description of each panel routine, see the
UNIX System V ETI Programmer's Guide.
new_panel(win) returns a pointer to a new panel associated
with win. The new panel is placed on top of the panel deck.
panel_window(panel) returns a pointer to the window of
panel.
replace_panel(panel, window) replaces the current window of
panel with window.
move_panel(panel, starty, startx) moves the given panel win-
dow so that its upper-left corner is at starty, startx. Be
sure to use this function, not mvwin(), to move a panel win-
dow.
bottom_panel(panel) puts panel at the bottom of all panels.
It leaves the size and contents of its associated window,
and its relations to other panels, wholly intact.
top_panel(panel) puts the given visible panel on top of all
panels in the deck.
void update_panels() refreshes the virtual screen to reflect
the relations between the panels in the deck, but does not
call doupdate() to refresh the physical screen.
hide_panel(panel) removes the panel from the panel deck and
thus hides it from view. The panel's internal data struc-
ture, however, is retained.
panel_hidden(panel) returns a boolean value indicating
whether or not the given panel has been removed from the
panel deck.
show_panel(panel) makes a hidden panel visible by placing it
on top of the panels in the panel deck.
panel_above(panel) returns a pointer to the panel just above
panel. If the panel argument is NULL, i.e., (panel *) 0, it
returns a pointer to the bottom panel in the deck.
panel_below(panel) returns a pointer to the panel just below
panel. If the panel argument is NULL, it returns a pointer
to the top panel in the deck.
Rev. Extended Terminal Interface Page 2
PANEL(3X) INTERACTIVE UNIX System PANEL(3X)
set_panel_userptr(panel,ptr) sets the panel's user pointer.
panel_userptr(panel) returns the user pointer for a given
panel.
del_panel(panel) deletes the panel, but not its associated
window.
SEE ALSO
curses(3X), field(3X), fieldtype(3X), form(3X), item(3X),
menu(3X), tam(3X).
The UNIX System V ETI Programmer's Guide.
DIAGNOSTICS
Each panel routine that returns a pointer to an object
returns NULL if an error occurs. Each panel routine that
returns an int value returns OK if it executes successfully
and ERR if not.
Rev. Extended Terminal Interface Page 3