<!--
****************************************************************************
- * Copyright (c) 1998-2016,2017 Free Software Foundation, Inc. *
+ * Copyright (c) 1998-2018,2019 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.21 2017/02/18 16:53:23 tom Exp @
+ * @Id: panel.3x,v 1.27 2019/03/23 19:23:01 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">
+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
<TITLE>panel 3x</TITLE>
-<link rev=made href="mailto:bug-ncurses@gnu.org">
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
<STRONG>int</STRONG> <STRONG>bottom_panel(PANEL</STRONG> <STRONG>*pan);</STRONG>
<STRONG>int</STRONG> <STRONG>top_panel(PANEL</STRONG> <STRONG>*pan);</STRONG>
<STRONG>int</STRONG> <STRONG>show_panel(PANEL</STRONG> <STRONG>*pan);</STRONG>
- <STRONG>void</STRONG> <STRONG>update_panels();</STRONG>
+ <STRONG>void</STRONG> <STRONG>update_panels(void);</STRONG>
<STRONG>int</STRONG> <STRONG>hide_panel(PANEL</STRONG> <STRONG>*pan);</STRONG>
<STRONG>WINDOW</STRONG> <STRONG>*panel_window(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan);</STRONG>
<STRONG>int</STRONG> <STRONG>replace_panel(PANEL</STRONG> <STRONG>*pan,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*window);</STRONG>
currently visible panels is the stack of panels. The <STRONG>stdscr</STRONG> window is
beneath all panels, and is not considered part of the stack.
- A window is associated with every panel. The panel routines enable you
+ A window is associated with every panel. The panel routines enable you
to create, move, hide, and show panels, as well as position a panel at
any desired location in the stack.
above any other panel) and returns a pointer to the new panel.
<STRONG>update_panels</STRONG>
- refreshes the virtual screen to reflect the relations between
+ refreshes the <EM>virtual</EM> <EM>screen</EM> to reflect the relations between
the panels in the stack, but does not call <STRONG>doupdate</STRONG> to refresh
- the physical screen. Use this function and not <STRONG>wrefresh</STRONG> or
+ the <EM>physical</EM> <EM>screen</EM>. 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 <STRONG>doupdate</STRONG>, but <STRONG>doupdate</STRONG> is the function responsible for
- updating the physical screen.
+ updating the <EM>physical</EM> <EM>screen</EM>.
<STRONG>del_panel(pan)</STRONG>
removes the given panel from the stack and deallocates the
<STRONG>hide_panel(pan)</STRONG>
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
+ 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.
+ not. If the panel is a null pointer, return <STRONG>ERR</STRONG>.
<STRONG>show_panel(pan)</STRONG>
makes a hidden panel visible by placing it on top of the panels
- in the panel stack. See COMPATIBILITY below.
+ in the panel stack. See COMPATIBILITY below.
<STRONG>top_panel(pan)</STRONG>
puts the given visible panel on top of all panels in the stack.
</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
+ native panel facility introduced in System V (inspection of the SVr4
manual pages suggests the programming interface is unchanged). The
- <STRONG>PANEL</STRONG> data structures are merely similar. The programmer is cautioned
- not to directly use <STRONG>PANEL</STRONG> fields.
+ <STRONG>PANEL</STRONG> data structures are merely similar. The programmer is cau-
+ tioned not to directly use <STRONG>PANEL</STRONG> fields.
The functions <STRONG>show_panel</STRONG> and <STRONG>top_panel</STRONG> are identical in this implemen-
tation, and work equally well with displayed or hidden panels. In the
native System V implementation, <STRONG>show_panel</STRONG> is intended for making a
hidden panel visible (at the top of the stack) and <STRONG>top_panel</STRONG> is
intended for making an already-visible panel move to the top of the
- stack. You are cautioned to use the correct function to ensure compati-
- bility with native panel libraries.
+ stack. You are cautioned to use the correct function to ensure compat-
+ ibility with native panel libraries.
</PRE><H2><a name="h2-NOTE">NOTE</a></H2><PRE>
would give a link-error with static libraries).
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+ The panel facility was documented in SVr4.2 in <EM>Character</EM> <EM>User</EM> <EM>Interface</EM>
+ <EM>Programming</EM> <EM>(UNIX</EM> <EM>SVR4.2)</EM>.
+
+ It is not part of X/Open Curses.
+
+ Aside from ncurses, only systems based on SVr4 source code, e.g.,
+ Solaris provide this library.
+
+
</PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
panel.h interface for the panels library
</PRE><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 6.0 (patch 20170603).
+ This describes <STRONG>ncurses</STRONG> version 6.1 (patch 20190615).
</PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
<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-PORTABILITY">PORTABILITY</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>
projects / ncurses.git / blobdiff