usr/src/man/man3curses/panel_show.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 PANEL_SHOW 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 panel_show, show_panel, hide_panel, panel_hidden \- panels deck manipulation
  10 routines
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lpanel\fR \fB -lcurses \fR [ \fIlibrary\fR .. ]
  15 #include <panel.h>
  16
  17
  18
  19 \fBint\fR \fBshow_panel\fR(\fBPANEL *\fR\fIpanel\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBhide_panel\fR(\fBPANEL *\fR\fIpanel\fR);
  25 .fi
  26
  27 .LP
  28 .nf
  29 \fBint\fR \fBpanel_hidden\fR(\fBPANEL *\fR\fIpanel\fR);
  30 .fi
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 \fBshow_panel()\fR makes \fIpanel\fR, previously hidden, visible and places it
  36 on top of the deck of panels.
  37 .sp
  38 .LP
  39 \fBhide_panel()\fR removes \fIpanel\fR from the panel deck and, thus, hides it
  40 from view. The internal data structure of the panel is retained.
  41 .sp
  42 .LP
  43 \fBpanel_hidden()\fR returns \fBTRUE\fR \fB(1)\fR \fBor\fR \fBFALSE\fR
  44 \fB(0)\fR indicating whether or not \fIpanel\fR is in the deck of panels.
  45 .SH RETURN VALUES
  46 .sp
  47 .LP
  48 \fBshow_panel()\fR and \fBhide_panel()\fR return the integer \fBOK\fR upon
  49 successful completion or \fBERR\fR upon error.
  50 .SH ATTRIBUTES
  51 .sp
  52 .LP
  53 See \fBattributes\fR(5) for descriptions of the following attributes:
  54 .sp
  55
  56 .sp
  57 .TS
  58 box;
  59 c | c
  60 l | l .
  61 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  62 _
  63 MT-Level        Unsafe
  64 .TE
  65
  66 .SH SEE ALSO
  67 .sp
  68 .LP
  69 \fBcurses\fR(3CURSES), \fBpanel_update\fR(3CURSES), \fBpanels\fR(3CURSES),
  70 \fBattributes\fR(5)
  71 .SH NOTES
  72 .sp
  73 .LP
  74 The header \fB<panel.h>\fR automatically includes the header
  75 \fB<curses.h>\fR\&.