panel(3X) panel(3X)
NAME
panel - panel stack extension for curses
SYNOPSIS
##include <>
cc [flags] sourcefiles -lpanel -lncurses
PANEL **newpanel(WINDOW **win)
int bottompanel(PANEL **pan)
int toppanel(PANEL **pan)
int showpanel(PANEL **pan)
void updatepanels();;
int hidepanel(PANEL **pan)
WINDOW **panelwindow(const PANEL **pan)
int replacepanel(PANEL **pan,, WINDOW **window)
int movepanel(PANEL **pan,, int starty,, int startx)
int panelhidden(const PANEL **pan)
PANEL **panelabove(const PANEL **pan)
PANEL **panelbelow(const PANEL **pan)
int setpaneluserptr(PANEL **pan,, const void **ptr)
const void **paneluserptr(const PANEL **pan)
int delpanel(PANEL **pan)
DESCRIPTION
Panels are curses(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 stdscr 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 stdscr 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 curses(3X), make only
high-level curses calls, and work anywhere terminfo curses does.
FUNCTIONS
newpanel(win)
allocates a PANEL structure, associates it with win, 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.
void updatepanels()
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.
delpanel(pan)
removes the given panel from the stack and deallocates the
PANEL structure (but not its associated window).
hidepanel(pan)
removes the given panel from the panel stack and thus hides it
from view. The PANEL structure is not lost, merely removed from
the stack.
showpanel(pan)
makes a hidden panel visible by placing it on top of the panels
in the panel stack. See COMPATIBILITY below.
toppanel(pan)
puts the given visible panel on top of all panels in the stack.
See COMPATIBILITY below.
bottompanel(pan)
puts panel at the bottom of all panels.
movepanel(pan,,starty,,startx)
moves the given panel window so that its upper-left corner is at
starty, startx. It does not change the position of the panel in
the stack. Be sure to use this function, not mvwin(), to move a
panel window.
replacepanel(pan,,window)
replaces the current window of panel with window (useful, for
example if you want to resize a panel; if you're using ncurses,
you can call replacepanel on the output of wresize(3X)). It
does not change the position of the panel in the stack.
panelabove(pan)
returns a pointer to the panel above pan. If the panel argument
is (PANEL **)00, it returns a pointer to the bottom panel in the
stack.
panelbelow(pan)
returns a pointer to the panel just below pan. If the panel
argument is (PANEL **)00, it returns a pointer to the top panel in
the stack.
setpaneluserptr(pan,,ptr)
sets the panel's user pointer.
paneluserptr(pan)
returns the user pointer for a given panel.
panelwindow(pan)
returns a pointer to the window of the given panel.
DIAGNOSTICS
Each routine that returns a pointer returns NUL if an error occurs.
Each routine that returns an int value returns OK if it executes suc-
cessfully and ER if not.
COMPATIBILITY
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
PANEL data structures are merely similar. The programmer is cautioned
not to directly use PANEL fields.
The functions showpanel() and toppanel() are identical in this imple-
mentation, and work equally well with displayed or hidden panels. In
the native System V implementation, showpanel() is intended for making
a hidden panel visible (at the top of the stack) and toppanel() 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.
NOTE
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 ld(1) and some other link-
ers).
FILES
panel.h interface for the panels library
libpanel.a the panels library itself
SEE ALSO
curses(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)
|
