X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fpanel.3x.html;h=0228e00282fed6e96b36ac999ce117a1d3b51773;hp=52e1f68b14c8cff659ce90a87cb251c155605b6d;hb=c3b21f65a2687f3894a0d3217006c23f162c893a;hpb=02f02dcd4464143580e783ae32c822d8eb8cdcbf
diff --git a/doc/html/man/panel.3x.html b/doc/html/man/panel.3x.html
index 52e1f68b..0228e002 100644
--- a/doc/html/man/panel.3x.html
+++ b/doc/html/man/panel.3x.html
@@ -1,6 +1,6 @@
@@ -45,36 +45,33 @@
-
-
+
panel - panel stack extension for curses
-
-
+
#include <panel.h>
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();
- 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);
+
+
+
Panels are curses(3x) 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
@@ -94,21 +91,20 @@
minfo curses does.
-
-
+
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()
+ update_panels
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.
+ 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
+ call to doupdate, but doupdate is the function
responsible for updating the physical screen.
del_panel(pan)
@@ -142,8 +138,8 @@
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.
+ use this function, not mvwin, to move a panel win-
+ dow.
replace_panel(pan,window)
replaces the current window of panel with window
@@ -172,15 +168,13 @@
returns a pointer to the window of the given panel.
-
-
+
Each routine that returns a pointer returns NULL if an
error occurs. Each routine that returns an int value
returns OK if it executes successfully and ERR if not.
-
-
+
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-
@@ -188,44 +182,39 @@
are merely similar. The programmer is cautioned not to
directly use PANEL fields.
- The functions show_panel() and top_panel() are identical
- in this implementation, and work equally well with dis-
- played or hidden panels. In the native System V implemen-
- tation, show_panel() is intended for making a hidden panel
- visible (at the top of the stack) and top_panel() 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 compatibility with native panel
- libraries.
+ The functions show_panel and top_panel are identical in
+ this implementation, and work equally well with displayed
+ or hidden panels. In the native System V implementation,
+ show_panel is intended for making a hidden panel visible
+ (at the top of the stack) and top_panel 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 compatibility with native panel libraries.
-
-
- In your library list, libpanel.a should be before libn-
- curses.a; that is, you want to say `-lpanel -lncurses',
+
+ 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 usually give a link-
error).
-
-
+
panel.h interface for the panels library
libpanel.a the panels library itself
-
-
+
curses(3x), curs_variables(3x),
- This describes ncurses version 6.0 (patch 20150808).
+ This describes ncurses version 6.0 (patch 20161015).
-
-
- 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
+
+ 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
ncurses by Zeyd ben-Halim.