DOC HOME SITE MAP MAN PAGES GNU INFO SEARCH PRINT BOOK
 

panels(S-osr5)


panels -- character based panels package

Syntax

cc ... -lpanel -lcurses

#include <panel.h>

Description

The panels(S-osr5) library is built using the curses(S-osr5) library, and any program using panels routines must call one of the curses initialization routines such as initscr(S-osr5).

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 let curses windows 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
bottom_panel panel_top(S-osr5)
del_panel panel_new(S-osr5)
hide_panel panel_show(S-osr5)
move_panel panel_move(S-osr5)
new_panel panel_new(S-osr5)
panel_above panel_above(S-osr5)
panel_below panel_above(S-osr5)
panel_hidden panel_show(S-osr5)
panel_userptr panel_userptr(S-osr5)
panel_window panel_window(S-osr5)
replace_panel panel_window(S-osr5)
set_panel_userptr panel_userptr(S-osr5)
show_panel panel_show(S-osr5)
top_panel panel_top(S-osr5)
update_panels panel_update(S-osr5)

 panels
 Routine Name           Manual Page Name
 bottom_panel            panel_top(S-osr5)
 del_panel               panel_new(S-osr5)
 hide_panel              panel_show(S-osr5)
 move_panel              panel_move(S-osr5)
 new_panel               panel_new(S-osr5)
 panel_above             panel_above(S-osr5)
 panel_below             panel_above(S-osr5)
 panel_hidden            panel_show(S-osr5)
 panel_userptr           panel_userptr(S-osr5)
 panel_window            panel_window(S-osr5)
 replace_panel           panel_window(S-osr5)
 set_panel_userptr       panel_userptr(S-osr5)
 show_panel              panel_show(S-osr5)
 top_panel               panel_top(S-osr5)
 update_panels           panel_update(S-osr5)

Return values

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.

Warning

The header file panel.h automatically includes the header file curses.h.

Files


/usr/lib/libpanel.a
the library

See also

curses(S-osr5) and S man pages whose names begin with ``panel_'' for detailed routine descriptions.

Standards conformance

panels(S-osr5) are not part of any currently supported standard; they were developed by UNIX System Laboratories, Inc. and are maintained by The SCO Group.
© 2005 The SCO Group, Inc. All rights reserved.
SCO OpenServer Release 6.0.0 -- 02 June 2005