X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fpanel.3x.html;h=2925bc1c8c2b480b30d188b203694cb12de0814d;hp=380bda9c5274136ad1dac762fbfe30a35d84b659;hb=54d0d62f0eb759e3c623a215d98ddebccca64488;hpb=a8dfaf0998c91b39c5c0a4913987cd67ca622bff
diff --git a/doc/html/man/panel.3x.html b/doc/html/man/panel.3x.html
index 380bda9c..2925bc1c 100644
--- a/doc/html/man/panel.3x.html
+++ b/doc/html/man/panel.3x.html
@@ -1,6 +1,7 @@
@@ -54,21 +72,30 @@
cc [flags] sourcefiles -lpanel -lncurses
- PANEL *new_panel(WINDOW *win);
- int bottom_panel(PANEL *pan);
- int top_panel(PANEL *pan);
- int show_panel(PANEL *pan);
+ PANEL *new_panel(WINDOW *win);
+
+ int bottom_panel(PANEL *pan);
+ int top_panel(PANEL *pan);
+ int show_panel(PANEL *pan);
void update_panels(void);
- int hide_panel(PANEL *pan);
- WINDOW *panel_window(const PANEL *pan);
- int replace_panel(PANEL *pan, WINDOW *window);
- int move_panel(PANEL *pan, int starty, int startx);
- int panel_hidden(const PANEL *pan);
- PANEL *panel_above(const PANEL *pan);
- PANEL *panel_below(const PANEL *pan);
- int set_panel_userptr(PANEL *pan, const void *ptr);
- const void *panel_userptr(const PANEL *pan);
- int del_panel(PANEL *pan);
+ int hide_panel(PANEL *pan);
+
+ WINDOW *panel_window(const PANEL *pan);
+ int replace_panel(PANEL *pan, WINDOW *window);
+ int move_panel(PANEL *pan, int starty, int startx);
+ int panel_hidden(const PANEL *pan);
+
+ PANEL *panel_above(const PANEL *pan);
+ PANEL *panel_below(const PANEL *pan);
+
+ int set_panel_userptr(PANEL *pan, const void *ptr);
+ const void *panel_userptr(const PANEL *pan);
+
+ int del_panel(PANEL *pan);
+
+ /* ncurses-extensions */
+ PANEL *ground_panel(SCREEN *sp);
+ PANEL *ceiling_panel(SCREEN *sp);
@@ -88,73 +115,100 @@
- new_panel(win)
- allocates a PANEL structure, associates it with win, 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.
-
- update_panels
- refreshes the virtual screen to reflect the relations 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 function responsible for
- updating the physical screen.
-
- del_panel(pan)
- removes the given panel from the stack and deallocates the
- PANEL structure (but not its associated window).
-
- hide_panel(pan)
- removes the given panel from the panel stack and thus hides it
- from view. The PANEL structure is not lost, merely removed from
- the stack.
-
- panel_hidden(pan)
- returns TRUE if the panel is in the panel stack, FALSE if it is
- not. If the panel is a null pointer, return ERR.
-
- show_panel(pan)
- makes a hidden panel visible by placing it on top of the panels
- in the panel stack. See COMPATIBILITY below.
-
- top_panel(pan)
- puts the given visible panel on top of all panels in the stack.
- See COMPATIBILITY below.
-
- bottom_panel(pan)
- puts panel at the bottom of all panels.
-
- move_panel(pan,starty,startx)
- moves the given panel window so that its upper-left corner is at
- starty, startx. It does not change the position of the panel in
- the stack. Be sure to use this function, not mvwin, to move a
- panel window.
-
- replace_panel(pan,window)
- replaces the current window of panel with window (useful, for
- example if you want to resize a panel; if you're using ncurses,
- you can call replace_panel on the output of wresize(3x)). It
- does not change the position of the panel in the stack.
-
- panel_above(pan)
- returns a pointer to the panel above pan. If the panel argument
- is (PANEL *)0, it returns a pointer to the bottom panel in the
- stack.
-
- panel_below(pan)
- returns a pointer to the panel just below pan. If the panel
- argument is (PANEL *)0, it returns a pointer to the top panel in
- the stack.
-
- set_panel_userptr(pan,ptr)
- sets the panel's user pointer.
-
- panel_userptr(pan)
- returns the user pointer for a given panel.
-
- panel_window(pan)
- returns a pointer to the window of the given panel.
+
+
+ bottom_panel(pan) puts panel pan at the bottom of all panels.
+
+
+
+ ceiling_panel(sp) acts like panel_below(NULL), for the given SCREEN sp.
+
+
+
+ del_panel(pan) removes the given panel pan from the stack and deallo-
+ cates the PANEL structure (but not its associated window).
+
+
+
+ ground_panel(sp) acts like panel_above(NULL), for the given SCREEN sp.
+
+
+
+ hide_panel(pan) removes the given panel pan from the panel stack and
+ thus hides it from view. The PANEL structure is not lost, merely
+ removed from the stack.
+
+
+
+ move_panel(pan,starty,startx) moves the given panel pan's window so
+ that its upper-left corner is at starty, startx. It does not change
+ the position of the panel in the stack. Be sure to use this function,
+ not mvwin(3x), to move a panel window.
+
+
+
+ new_panel(win) allocates a PANEL structure, associates it with win,
+ 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.
+
+
+
+ panel_above(pan) returns a pointer to the panel above pan. If the
+ panel argument is (PANEL *)0, it returns a pointer to the bottom panel
+ in the stack.
+
+
+
+ panel_below(pan) returns a pointer to the panel just below pan. If the
+ panel argument is (PANEL *)0, it returns a pointer to the top panel in
+ the stack.
+
+
+
+ panel_hidden(pan) returns TRUE if the panel pan is in the panel stack,
+ FALSE if it is not. If the panel is a null pointer, return ERR.
+
+
+
+ panel_userptr(pan) returns the user pointer for a given panel pan.
+
+
+
+ panel_window(pan) returns a pointer to the window of the given panel
+ pan.
+
+
+
+ replace_panel(pan,window) replaces the current window of panel pan with
+ window This is useful, for example if you want to resize a panel. In
+ ncurses, you can call replace_panel to resize a panel using a window
+ resized with wresize(3x). It does not change the position of the panel
+ in the stack.
+
+
+
+ set_panel_userptr(pan,ptr) sets the panel's user pointer.
+
+
+
+ show_panel(pan) makes a hidden panel visible by placing it on top of
+ the panels in the panel stack. See COMPATIBILITY below.
+
+
+
+ top_panel(pan) puts the given visible panel pan on top of all panels in
+ the stack. See COMPATIBILITY below.
+
+
+
+ update_panels() refreshes the virtual screen to reflect the relations
+ between the panels in the stack, but does not call doupdate(3x) to
+ refresh the physical screen. Use this function and not wrefresh(3x) or
+ wnoutrefresh(3x).
+
+ update_panels may be called more than once before a call to doupdate,
+ but doupdate is the function responsible for updating the physical
+ screen.
@@ -162,6 +216,12 @@
Each routine that returns an int value returns OK if it executes suc-
cessfully and ERR if not.
+ Except as noted, the pan and window parameters must be non-null. If
+ those are null, an error is returned.
+
+ The move_panel function uses mvwin(3x), and will return an error if
+ mvwin returns an error.
+
Reasonable care has been taken to ensure compatibility with the
@@ -191,8 +251,25 @@
It is not part of X/Open Curses.
- Aside from ncurses, only systems based on SVr4 source code, e.g.,
- Solaris provide this library.
+ A few implementations exist:
+
+ o Systems based on SVr4 source code, e.g., Solaris, provide this
+ library.
+
+ o ncurses (since version 0.6 in 1993) and PDCurses (since version 2.2
+ in 1995) provide a panel library whose common ancestor was a public
+ domain implementation by Warren Tucker published in u386mon 2.20
+ (1990).
+
+ According to Tucker, the SystemV panel library was first released
+ in SVr3.2 (1988), and his implementation helped with a port to
+ SVr3.1 (1987).
+
+ Several developers have improved each of these; they are no longer
+ the same as Tucker's implementation.
+
+ o NetBSD 8 (2018) has a panel library begun by Valery Ushakov in
+ 2015. This is based on the AT&T documentation.
@@ -204,13 +281,17 @@
curses(3x), curs_variables(3x),
- This describes ncurses version 6.1 (patch 20190720).
+ This describes ncurses version 6.2 (patch 20200516).
- Originally written by Warren Tucker <wht@n4hgf.mt-park.ga.us>, primar-
- ily to assist in porting u386mon to systems without a native panels
- library. Repackaged for ncurses by Zeyd ben-Halim.
+ Originally written by Warren Tucker <wht@n4hgf.mt-park.ga.us>, primar-
+ ily to assist in porting u386mon to systems without a native panels
+ library.
+
+ Repackaged for ncurses by Zeyd ben-Halim.
+
+ Juergen Pfeifer and Thomas E. Dickey revised/improved the library.
@@ -221,7 +302,27 @@
NAME
SYNOPSIS
DESCRIPTION
-FUNCTIONS
+FUNCTIONS
+
+
DIAGNOSTICS
COMPATIBILITY
NOTE