panels(3X)                        SDK R4.11                       panels(3X)


NAME
       panels - character based panels package

SYNOPSIS
       #include <panel.h>

DESCRIPTION
       The panel library is built using the curses library, and any program
       using panels routines must call one of the curses initialization
       routines such as initscr.  A program using these routines must be
       compiled with -lpanel and -lcurses on the cc command line.

       The panels package gives the applications programmer a way to have
       depth relationships between curses windows; a curses window is
       associated with every panel.  The panels routines allow curses
       windows to overlap without making visible the overlapped portions of
       underlying windows.  The initial curses window, stdscr, lies beneath
       all panels.  The set of currently visible panels is the deck of
       panels.

       The panels 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.

   Routine Name Index
       The following table lists each panels routine and the name of the
       manual page on which it is described.
       panels Routine Name    Manual Page Name
       --------------------------------------------
       bottompanel           panel_top(3X)
       delpanel              panel_new(3X)
       hidepanel             panel_show(3X)
       movepanel             panel_move(3X)
       newpanel              panel_new(3X)
       panelabove            panel_above(3X)
       panelbelow            panel_above(3X)
       panelhidden           panel_show(3X)
       paneluserptr          panel_userptr(3X)
       panelwindow           panel_window(3X)
       replacepanel          panel_window(3X)
       setpaneluserptr      panel_userptr(3X)
       showpanel             panel_show(3X)
       toppanel              panel_top(3X)
       updatepanels          panel_update(3X)

RETURN VALUE
       Each panels routine that returns a pointer to an object returns NULL
       if an error occurs.  Each panel routine that returns an integer,
       returns OK if it executes successfully and ERR if it does not.

SEE ALSO
       curses(3X), and 3X pages whose names begin "panel_," for detailed
       routine descriptions.

NOTES
       The header file <panel.h> automatically includes the header file
       <curses.h>.


Licensed material--property of copyright holder(s)