-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
****************************************************************************
- * Copyright (c) 1998-2000,2003 Free Software Foundation, Inc. *
+ * Copyright (c) 1998-2020,2015 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: panel.3x,v 1.11 2003/05/17 22:44:09 jmc Exp @
+ * @Id: panel.3x,v 1.18 2015/04/11 10:23:49 tom Exp @
-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
+<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
<TITLE>panel 3x</TITLE>
<link rev=made href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
-<H1>panel 3x</H1>
-<HR>
+<H1 class="no-header">panel 3x</H1>
<PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
-<STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG> <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG>
+<STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG> <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG>
</PRE>
-<H2>NAME</H2><PRE>
+<H2><a name="h2-NAME">NAME</a></H2><PRE>
panel - panel stack extension for curses
</PRE>
-<H2>SYNOPSIS</H2><PRE>
+<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
<STRONG>#include</STRONG> <STRONG><panel.h></STRONG>
<STRONG>cc</STRONG> <STRONG>[flags]</STRONG> <STRONG>sourcefiles</STRONG> <STRONG>-lpanel</STRONG> <STRONG>-lncurses</STRONG>
</PRE>
-<H2>DESCRIPTION</H2><PRE>
+<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
Panels are <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> windows with the added feature of
depth. Panel functions allow the use of stacked windows
and ensure the proper portions of each window and the
</PRE>
-<H2>FUNCTIONS</H2><PRE>
+<H2><a name="h2-FUNCTIONS">FUNCTIONS</a></H2><PRE>
<STRONG>new_panel(win)</STRONG>
allocates a <STRONG>PANEL</STRONG> structure, associates it with
<STRONG>win</STRONG>, places the panel on the top of the stack
(causes it to be displayed above any other
panel) and returns a pointer to the new panel.
- <STRONG>void</STRONG> <STRONG>update_panels()</STRONG>
+ <STRONG>update_panels()</STRONG>
refreshes the virtual screen to reflect the rela-
tions between the panels in the stack, but does not
call doupdate() to refresh the physical screen.
- Use this function and not wrefresh or wnoutrefresh.
- update_panels() may be called more than once before
- a call to doupdate(), but doupdate() is the func-
- tion responsible for updating the physical screen.
+ Use this function and not <STRONG>wrefresh</STRONG> or <STRONG>wnoutrefresh</STRONG>.
+ <STRONG>update_panels</STRONG> may be called more than once before a
+ call to doupdate(), but doupdate() is the function
+ responsible for updating the physical screen.
<STRONG>del_panel(pan)</STRONG>
removes the given panel from the stack and deallo-
- cates the <STRONG>PANEL</STRONG> structure (but not its associated
+ cates the <STRONG>PANEL</STRONG> structure (but not its associated
window).
<STRONG>hide_panel(pan)</STRONG>
- removes the given panel from the panel stack and
+ removes the given panel from the panel stack and
thus hides it from view. The <STRONG>PANEL</STRONG> structure is not
lost, merely removed from the stack.
+ <STRONG>panel_hidden(pan)</STRONG>
+ returns <STRONG>TRUE</STRONG> if the panel is in the panel stack,
+ <STRONG>FALSE</STRONG> if it is not. If the panel is a null
+ pointer, return ERR.
+
<STRONG>show_panel(pan)</STRONG>
- makes a hidden panel visible by placing it on top
+ makes a hidden panel visible by placing it on top
of the panels in the panel stack. See COMPATIBILITY
below.
<STRONG>top_panel(pan)</STRONG>
- puts the given visible panel on top of all panels
+ puts the given visible panel on top of all panels
in the stack. See COMPATIBILITY below.
<STRONG>bottom_panel(pan)</STRONG>
<STRONG>move_panel(pan,starty,startx)</STRONG>
moves the given panel window so that its upper-left
- corner is at <STRONG>starty</STRONG>, <STRONG>startx</STRONG>. It does not change
+ corner is at <STRONG>starty</STRONG>, <STRONG>startx</STRONG>. It does not change
the position of the panel in the stack. Be sure to
- use this function, not <STRONG>mvwin()</STRONG>, to move a panel
+ use this function, not <STRONG>mvwin()</STRONG>, to move a panel
window.
<STRONG>replace_panel(pan,window)</STRONG>
- replaces the current window of panel with <STRONG>window</STRONG>
+ replaces the current window of panel with <STRONG>window</STRONG>
(useful, for example if you want to resize a panel;
if you're using <STRONG>ncurses</STRONG>, you can call <STRONG>replace_panel</STRONG>
- on the output of <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>). It does not change
+ on the output of <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>). It does not change
the position of the panel in the stack.
<STRONG>panel_above(pan)</STRONG>
- returns a pointer to the panel above pan. If the
- panel argument is <STRONG>(PANEL</STRONG> <STRONG>*)0</STRONG>, it returns a pointer
+ returns a pointer to the panel above pan. If the
+ panel argument is <STRONG>(PANEL</STRONG> <STRONG>*)0</STRONG>, it returns a pointer
to the bottom panel in the stack.
<STRONG>panel_below(pan)</STRONG>
- returns a pointer to the panel just below pan. If
- the panel argument is <STRONG>(PANEL</STRONG> <STRONG>*)0</STRONG>, it returns a
+ returns a pointer to the panel just below pan. If
+ the panel argument is <STRONG>(PANEL</STRONG> <STRONG>*)0</STRONG>, it returns a
pointer to the top panel in the stack.
<STRONG>set_panel_userptr(pan,ptr)</STRONG>
</PRE>
-<H2>DIAGNOSTICS</H2><PRE>
+<H2><a name="h2-DIAGNOSTICS">DIAGNOSTICS</a></H2><PRE>
Each routine that returns a pointer returns <STRONG>NULL</STRONG> if an
error occurs. Each routine that returns an int value
returns <STRONG>OK</STRONG> if it executes successfully and <STRONG>ERR</STRONG> if not.
</PRE>
-<H2>COMPATIBILITY</H2><PRE>
+<H2><a name="h2-COMPATIBILITY">COMPATIBILITY</a></H2><PRE>
Reasonable care has been taken to ensure compatibility
with the native panel facility introduced in SVr3.2
(inspection of the SVr4 manual pages suggests the program-
</PRE>
-<H2>NOTE</H2><PRE>
+<H2><a name="h2-NOTE">NOTE</a></H2><PRE>
In your library list, libpanel.a should be before libn-
curses.a; that is, you want to say `-lpanel -lncurses',
- not the other way around (which would give you a link
- error using GNU <STRONG><A HREF="ld.1.html">ld(1)</A></STRONG> and some other linkers).
+ not the other way around (which would usually give a link-
+ error).
</PRE>
-<H2>FILES</H2><PRE>
+<H2><a name="h2-FILES">FILES</a></H2><PRE>
panel.h interface for the panels library
libpanel.a the panels library itself
</PRE>
-<H2>SEE ALSO</H2><PRE>
- <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
+<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+ <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>,
+
+ This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20150523).
</PRE>
-<H2>AUTHOR</H2><PRE>
+<H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
Originally written by Warren Tucker <wht@n4hgf.mt-
park.ga.us>, primarily to assist in porting u386mon to
systems without a native panels library. Repackaged for
- <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG>
+ <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG>
</PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
+<li><a href="#h2-FUNCTIONS">FUNCTIONS</a></li>
+<li><a href="#h2-DIAGNOSTICS">DIAGNOSTICS</a></li>
+<li><a href="#h2-COMPATIBILITY">COMPATIBILITY</a></li>
+<li><a href="#h2-NOTE">NOTE</a></li>
+<li><a href="#h2-FILES">FILES</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
+<li><a href="#h2-AUTHOR">AUTHOR</a></li>
+</ul>
+</div>
</BODY>
</HTML>