te
Copyright 1989 AT&T
Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
panels - character based panels package

#include <panel.h>

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.

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(3CURSES)

del_panel panel_new(3CURSES)

hide_panel panel_show(3CURSES)

move_panel panel_move(3CURSES)

new_panel panel_new(3CURSES)

panel_above panel_above(3CURSES)

panel_below panel_above(3CURSES)

panel_hidden panel_show(3CURSES)

panel_userptr panel_userptr(3CURSES)

panel_window panel_window(3CURSES)

replace_panel panel_window(3CURSES)

set_panel_userptr panel_userptr(3CURSES)

show_panel panel_show(3CURSES)

top_panel panel_top(3CURSES)

update_panels panel_update(3CURSES)

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

ATTRIBUTE TYPE ATTRIBUTE VALUE

MT-Level Unsafe

curses(3CURSES), attributes(7) and 3CURSES pages whose names begin "panel_" for detailed routine descriptions. The header <panel.h> automatically includes the header <curses.h>.