Go to main content

man pages section 3: Curses Library Functions

Exit Print View

Updated: Thursday, June 13, 2019
 
 

panels(3CURSES)

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
bottom_panel
del_panel
hide_panel
move_panel
new_panel
panel_above
panel_below
panel_hidden
panel_userptr
panel_window
replace_panel
set_panel_userptr
show_panel
top_panel
update_panels

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.

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
MT-Level
Unsafe

See Also

curses(3CURSES), attributes(7) and 3X pages whose names begin “panel_” for detailed routine descriptions.

Notes

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