Content-type: text/html Man page of panels

panels

Section: Curses Library Functions (3CURSES)
Updated: 31 Dec 1996
Index Return to Main Contents
 

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 NameManual Page Name
bottom_panelpanel_top(3CURSES)
del_panelpanel_new(3CURSES)
hide_panelpanel_show(3CURSES)
move_panelpanel_move(3CURSES)
new_panelpanel_new(3CURSES)
panel_abovepanel_above(3CURSES)
panel_belowpanel_above(3CURSES)
panel_hiddenpanel_show(3CURSES)
panel_userptrpanel_userptr(3CURSES)
panel_windowpanel_window(3CURSES)
replace_panelpanel_window(3CURSES)
set_panel_userptrpanel_userptr(3CURSES)
show_panelpanel_show(3CURSES)
top_panelpanel_top(3CURSES)
update_panelspanel_update(3CURSES)

 

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(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
MT-LevelUnsafe

 

SEE ALSO

curses(3CURSES), attributes(5) and 3X pages whose names begin "panel_" for detailed routine descriptions.  

NOTES

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


 

Index

NAME
SYNOPSIS
DESCRIPTION
Routine Name Index
RETURN VALUES
ATTRIBUTES
SEE ALSO
NOTES

This document was created by man2html, using the manual pages.
Time: 02:38:37 GMT, October 02, 2010