usr/src/man/man3curses/panels.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH PANELS 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 panels \- character based panels package
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fB#include <panel.h>\fR
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The \fBpanel\fR library is built using the \fBcurses\fR library, and any
  20 program using \fBpanels\fR routines must call one of the \fBcurses\fR
  21 initialization routines such as \fBinitscr\fR. A program using these routines
  22 must be compiled with \fB-lpanel\fR and \fB-lcurses\fR on the \fBcc\fR command
  23 line.
  24 .sp
  25 .LP
  26 The \fBpanels\fR package gives the applications programmer a way to have depth
  27 relationships between \fBcurses\fR windows; a \fBcurses\fR window is associated
  28 with every panel. The \fBpanels\fR routines allow \fBcurses\fR windows to
  29 overlap without making visible the overlapped portions of underlying windows.
  30 The initial \fBcurses\fR window, \fBstdscr\fR, lies beneath all panels. The set
  31 of currently visible panels is the \fIdeck\fR of panels.
  32 .sp
  33 .LP
  34 The \fBpanels\fR package allows the applications programmer to create panels,
  35 fetch and set their associated windows, shuffle panels in the deck, and
  36 manipulate panels in other ways.
  37 .SS "Routine Name Index"
  38 .sp
  39 .LP
  40 The following table lists each \fBpanels\fR routine and the name of the manual
  41 page on which it is described.
  42 .sp
  43
  44 .sp
  45 .TS
  46 c c
  47 l l .
  48 panels Routine Name     Manual Page Name
  49 bottom_panel    \fBpanel_top\fR(3CURSES)
  50 del_panel       \fBpanel_new\fR(3CURSES)
  51 hide_panel      \fBpanel_show\fR(3CURSES)
  52 move_panel      \fBpanel_move\fR(3CURSES)
  53 new_panel       \fBpanel_new\fR(3CURSES)
  54 panel_above     \fBpanel_above\fR(3CURSES)
  55 panel_below     \fBpanel_above\fR(3CURSES)
  56 panel_hidden    \fBpanel_show\fR(3CURSES)
  57 panel_userptr   \fBpanel_userptr\fR(3CURSES)
  58 panel_window    \fBpanel_window\fR(3CURSES)
  59 replace_panel   \fBpanel_window\fR(3CURSES)
  60 set_panel_userptr       \fBpanel_userptr\fR(3CURSES)
  61 show_panel      \fBpanel_show\fR(3CURSES)
  62 top_panel       \fBpanel_top\fR(3CURSES)
  63 update_panels   \fBpanel_update\fR(3CURSES)
  64 .TE
  65
  66 .SH RETURN VALUES
  67 .sp
  68 .LP
  69 Each \fBpanels\fR routine that returns a pointer to an object returns
  70 \fBNULL\fR if an error occurs. Each panel routine that returns an integer,
  71 returns \fBOK\fR if it executes successfully and \fBERR\fR if it does not.
  72 .SH ATTRIBUTES
  73 .sp
  74 .LP
  75 See \fBattributes\fR(5) for descriptions of the following attributes:
  76 .sp
  77
  78 .sp
  79 .TS
  80 box;
  81 c | c
  82 l | l .
  83 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  84 _
  85 MT-Level        Unsafe
  86 .TE
  87
  88 .SH SEE ALSO
  89 .sp
  90 .LP
  91 \fBcurses\fR(3CURSES), \fBattributes\fR(5) and 3X pages whose names begin
  92 "panel_" for detailed routine descriptions.
  93 .SH NOTES
  94 .sp
  95 .LP
  96 The header \fB<panel.h>\fR automatically includes the header
  97 \fB<curses.h>\fR\&.