VARCem/PDCurses
1
0
Fork 0
mirror of https://github.com/VARCem/PDCurses.git synced 2026-09-25 00:05:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Revised panel intro to reflect that it's not a separate library in PDCurses.

Browse Source
This commit is contained in:
William McBrine
2019-01-21 12:21:11 -05:00
parent 74c33118cf
commit 26a8243e80
1 changed files with 41 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
pdcurses/panel.c
View File

@@ -27,81 +27,73 @@ panel
### Description
The panel library is built using the curses library, and any
program using panels routines must call one of the curses
initialization routines such as initscr(). A program using these
routines must be linked with the panels and curses libraries.
The header <panel.h> includes the header <curses.h>.
For historic reasons, and for compatibility with other versions of
curses, the panel functions are prototyped in a separate header,
panel.h. In many implementations, they're also in a separate library,
but PDCurses incorporates them.
The panels package gives the applications programmer a way to
have depth relationships between curses windows; a curses window
is associated with every panel. The panels routines allow curses
windows to overlap without making visible the overlapped
portions of underlying windows. The initial curses window,
stdscr, lies beneath all panels. The set of currently visible
panels is the 'deck' of panels.
The panel functions provide a way to have depth relationships between
curses windows. Panels can overlap without making visible the
overlapped portions of underlying windows. The initial curses window,
stdscr, lies beneath all panels. The set of currently visible panels
is the 'deck' of panels.
The panels package allows the applications programmer to create
panels, fetch and set their associated windows, shuffle panels
in the deck, and manipulate panels in other ways.
You can create panels, fetch and set their associated windows,
shuffle panels in the deck, and manipulate them in other ways.
bottom_panel() places pan at the bottom of the deck. The size,
location and contents of the panel are unchanged.
del_panel() deletes pan, but not its associated winwow.
hide_panel() removes a panel from the deck and thus hides it
from view.
hide_panel() removes a panel from the deck and thus hides it from
view.
move_panel() moves the curses window associated with pan, so
that its upper lefthand corner is at the supplied coordinates.
(Do not use mvwin() on the window.)
move_panel() moves the curses window associated with pan, so that its
upper lefthand corner is at the supplied coordinates. (Don't use
mvwin() on the window.)
new_panel() creates a new panel associated with win and returns
the panel pointer. The new panel is placed at the top of the
deck.
new_panel() creates a new panel associated with win and returns the
panel pointer. The new panel is placed at the top of the deck.
panel_above() returns a pointer to the panel in the deck above
pan, or NULL if pan is the top panel. If the value of pan passed
is NULL, this function returns a pointer to the bottom panel in
the deck.
panel_above() returns a pointer to the panel in the deck above pan,
or NULL if pan is the top panel. If the value of pan passed is NULL,
this function returns a pointer to the bottom panel in the deck.
panel_below() returns a pointer to the panel in the deck below
pan, or NULL if pan is the bottom panel. If the value of pan
passed is NULL, this function returns a pointer to the top panel
in the deck.
panel_below() returns a pointer to the panel in the deck below pan,
or NULL if pan is the bottom panel. If the value of pan passed is
NULL, this function returns a pointer to the top panel in the deck.
panel_hidden() returns OK if pan is hidden and ERR if it is not.
panel_userptr() - Each panel has a user pointer available for
maintaining relevant information. This function returns a
pointer to that information previously set up by
set_panel_userptr().
maintaining relevant information. This function returns a pointer to
that information previously set up by set_panel_userptr().
panel_window() returns a pointer to the curses window associated
with the panel.
panel_window() returns a pointer to the curses window associated with
the panel.
replace_panel() replaces the current window of pan with win.
set_panel_userptr() - Each panel has a user pointer available
for maintaining relevant information. This function sets the
value of that information.
set_panel_userptr() - Each panel has a user pointer available for
maintaining relevant information. This function sets the value of
that information.
show_panel() makes a previously hidden panel visible and places
it back in the deck on top.
show_panel() makes a previously hidden panel visible and places it
back in the deck on top.
top_panel() places pan on the top of the deck. The size,
location and contents of the panel are unchanged.
top_panel() places pan on the top of the deck. The size, location and
contents of the panel are unchanged.
update_panels() refreshes the virtual screen to reflect the
depth relationships between the panels in the deck. The user
must use doupdate() to refresh the physical screen.
update_panels() refreshes the virtual screen to reflect the depth
relationships between the panels in the deck. The user must use
doupdate() to refresh the physical screen.
### Return Value
Each routine that returns a pointer to an object returns NULL if
an error occurs. Each panel routine that returns an integer,
returns OK if it executes successfully and ERR if it does not.
Each routine that returns a pointer to an object returns NULL if an
error occurs. Each panel routine that returns an integer, returns OK
if it executes successfully and ERR if it does not.
### Portability
X/Open BSD SYS V