panels(3ocurses)

panels -- character based panels package

Synopsis

cc [flag . . .] file -lpanel -locurses [library . . .]

#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 -locurses 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 panel_top(3ocurses)

del_panel panel_new(3ocurses)

hide_panel panel_show(3ocurses)

move_panel panel_move(3ocurses)

new_panel panel_new(3ocurses)

panel_above panel_above(3ocurses)

panel_below panel_above(3ocurses)

panel_hidden panel_show(3ocurses)

panel_userptr panel_userptr(3ocurses)

panel_window panel_window(3ocurses)

replace_panel panel_window(3ocurses)

set_panel_userptr panel_userptr(3ocurses)

show_panel panel_show(3ocurses)

top_panel panel_top(3ocurses)

update_panels panel_update(3ocurses)

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

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

Notices

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

References

curses(3ocurses), panels(3ocurses)