panel(3X) panel(3X)
NAME
panel - panel stack extension for curses
SYNOPSIS
##iinncclluuddee <>
cccc [[ffllaaggss]] ssoouurrcceeffiilleess -llppaanneell -llnnccuurrsseess
PPAANNEELL **nneewwppaanneell((WWIINNDDOOWW **wwiinn))
iinntt bboottttoommppaanneell((PPAANNEELL **ppaann))
iinntt ttooppppaanneell((PPAANNEELL **ppaann))
iinntt sshhoowwppaanneell((PPAANNEELL **ppaann))
vvooiidd uuppddaatteeppaanneellss(());;
iinntt hhiiddeeppaanneell((PPAANNEELL **ppaann))
WWIINNDDOOWW **ppaanneellwwiinnddooww((ccoonnsstt PPAANNEELL **ppaann))
iinntt rreeppllaacceeppaanneell((PPAANNEELL **ppaann,, WWIINNDDOOWW **wwiinnddooww))
iinntt mmoovveeppaanneell((PPAANNEELL **ppaann,, iinntt ssttaarrttyy,, iinntt ssttaarrttxx))
iinntt ppaanneellhhiiddddeenn((ccoonnsstt PPAANNEELL **ppaann))
PPAANNEELL **ppaanneellaabboovvee((ccoonnsstt PPAANNEELL **ppaann))
PPAANNEELL **ppaanneellbbeellooww((ccoonnsstt PPAANNEELL **ppaann))
iinntt sseettppaanneelluusseerrppttrr((PPAANNEELL **ppaann,, ccoonnsstt vvooiidd **ppttrr))
ccoonnsstt vvooiidd **ppaanneelluusseerrppttrr((ccoonnsstt PPAANNEELL **ppaann))
iinntt ddeellppaanneell((PPAANNEELL **ppaann))
DESCRIPTION
Panels are ccuurrsseess(3X) windows with the added feature of depth. Panel
functions allow the use of stacked windows and ensure the proper por-
tions of each window and the curses ssttddssccrr window are hidden or dis-
played when panels are added, moved, modified or removed. The set of
currently visible panels is the stack of panels. The ssttddssccrr window is
beneath all panels, and is not considered part of the stack.
A window is associated with every panel. The panel routines enable you
to create, move, hide, and show panels, as well as position a panel at
any desired location in the stack.
Panel routines are a functional layer added to ccuurrsseess(3X), make only
high-level curses calls, and work anywhere terminfo curses does.
FFUUNNCCTTIIOONNSS
nneewwppaanneell((wwiinn))
allocates a PPAANNEELL structure, associates it with wwiinn, places
the panel on the top of the stack (causes it to be displayed
above any other panel) and returns a pointer to the new panel.
vvooiidd uuppddaatteeppaanneellss(())
refreshes the virtual screen to reflect the relations between
the panels in the stack, but does not call doupdate() to refresh
the physical screen. Use this function and not wrefresh or
wnoutrefresh. updatepanels() may be called more than once
before a call to doupdate(), but doupdate() is the function
responsible for updating the physical screen.
ddeellppaanneell((ppaann))
removes the given panel from the stack and deallocates the
PPAANNEELL structure (but not its associated window).
hhiiddeeppaanneell((ppaann))
removes the given panel from the panel stack and thus hides it
from view. The PPAANNEELL structure is not lost, merely removed from
the stack.
sshhoowwppaanneell((ppaann))
makes a hidden panel visible by placing it on top of the panels
in the panel stack. See COMPATIBILITY below.
ttooppppaanneell((ppaann))
puts the given visible panel on top of all panels in the stack.
See COMPATIBILITY below.
bboottttoommppaanneell((ppaann))
puts panel at the bottom of all panels.
mmoovveeppaanneell((ppaann,,ssttaarrttyy,,ssttaarrttxx))
moves the given panel window so that its upper-left corner is at
ssttaarrttyy, ssttaarrttxx. It does not change the position of the panel in
the stack. Be sure to use this function, not mmvvwwiinn(()), to move a
panel window.
rreeppllaacceeppaanneell((ppaann,,wwiinnddooww))
replaces the current window of panel with wwiinnddooww (useful, for
example if you want to resize a panel; if you're using nnccuurrsseess,
you can call rreeppllaacceeppaanneell on the output of wwrreessiizzee(3X)). It
does not change the position of the panel in the stack.
ppaanneellaabboovvee((ppaann))
returns a pointer to the panel above pan. If the panel argument
is ((PPAANNEELL **))00, it returns a pointer to the bottom panel in the
stack.
ppaanneellbbeellooww((ppaann))
returns a pointer to the panel just below pan. If the panel
argument is ((PPAANNEELL **))00, it returns a pointer to the top panel in
the stack.
sseettppaanneelluusseerrppttrr((ppaann,,ppttrr))
sets the panel's user pointer.
ppaanneelluusseerrppttrr((ppaann))
returns the user pointer for a given panel.
ppaanneellwwiinnddooww((ppaann))
returns a pointer to the window of the given panel.
DIAGNOSTICS Each routine that returns a pointer returns NNUULLLL if an error occurs.
Each routine that returns an int value returns OOKK if it executes suc-
cessfully and EERRRR if not.
CCOOMMPPAATTIIBBIILLIITTYY
Reasonable care has been taken to ensure compatibility with the
native panel facility introduced in SVr3.2 (inspection of the SVr4
manual pages suggests the programming interface is unchanged). The
PPAANNEELL data structures are merely similar. The programmer is cautioned
not to directly use PPAANNEELL fields.
The functions sshhoowwppaanneell(()) and ttooppppaanneell(()) are identical in this imple-
mentation, and work equally well with displayed or hidden panels. In
the native System V implementation, sshhoowwppaanneell(()) is intended for making
a hidden panel visible (at the top of the stack) and ttooppppaanneell(()) is
intended for making an already-visible panel move to the top of the
stack. You are cautioned to use the correct function to ensure compati-
bility with native panel libraries.
NNOOTTEE
In your library list, libpanel.a should be before libncurses.a; that
is, you want to say `-lpanel -lncurses', not the other way around
(which would give you a link error using GNU lldd(1) and some other link-
ers).
FILES panel.h interface for the panels library
libpanel.a the panels library itself
SEE ALSO
ccuurrsseess(3X)
AUTHOR Originally written by Warren Tucker , primar-
ily to assist in porting u386mon to systems without a native panels
library. Repackaged for ncurses by Zeyd ben-Halim.
panel(3X)