.\"***************************************************************************
-.\" Copyright 2018-2019,2020 Thomas E. Dickey *
+.\" Copyright 2018-2020,2021 Thomas E. Dickey *
.\" Copyright 1998-2016,2017 Free Software Foundation, Inc. *
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: panel.3x,v 1.39 2020/02/15 21:06:40 tom Exp $
+.\" $Id: panel.3x,v 1.41 2021/12/25 21:49:32 tom Exp $
.TH panel 3X ""
.ie \n(.g .ds `` \(lq
.el .ds `` ``
.SH NAME
panel \- panel stack extension for curses
.SH SYNOPSIS
-\fB#include <panel.h>\fR
+\fB#include <panel.h>\fP
.P
-\fBcc [flags] sourcefiles \-lpanel \-lncurses\fR
+\fBcc [flags] sourcefiles \-lpanel \-lncurses\fP
.P
-\fBPANEL *new_panel(WINDOW *\fIwin\fB);\fR
+\fBPANEL *new_panel(WINDOW *\fIwin\fP\fB);\fP
.sp
-\fBint bottom_panel(PANEL *\fIpan\fB);\fR
+\fBint bottom_panel(PANEL *\fP\fIpan\fP\fB);\fP
.br
-\fBint top_panel(PANEL *\fIpan\fB);\fR
+\fBint top_panel(PANEL *\fP\fIpan\fP\fB);\fP
.br
-\fBint show_panel(PANEL *\fIpan\fB);\fR
+\fBint show_panel(PANEL *\fP\fIpan\fP\fB);\fP
.br
-\fBvoid update_panels(void);\fR
+\fBvoid update_panels(void);\fP
.br
-\fBint hide_panel(PANEL *\fIpan\fB);\fR
+\fBint hide_panel(PANEL *\fP\fIpan\fP\fB);\fP
.sp
-\fBWINDOW *panel_window(const PANEL *\fIpan\fB);\fR
+\fBWINDOW *panel_window(const PANEL *\fIpan\fP\fB);\fP
.br
-\fBint replace_panel(PANEL *\fIpan\fB, WINDOW *\fIwindow\fB);\fR
+\fBint replace_panel(PANEL *\fIpan\fP\fB, WINDOW *\fIwindow\fP\fB);\fP
.br
-\fBint move_panel(PANEL *\fIpan\fB, int \fIstarty\fB, int \fIstartx\fB);\fR
+\fBint move_panel(PANEL *\fIpan\fP\fB, int \fIstarty\fP\fB, int \fIstartx\fP\fB);\fP
.br
-\fBint panel_hidden(const PANEL *\fIpan\fB);\fR
+\fBint panel_hidden(const PANEL *\fIpan\fP\fB);\fP
.sp
-\fBPANEL *panel_above(const PANEL *\fIpan\fB);\fR
+\fBPANEL *panel_above(const PANEL *\fIpan\fP\fB);\fP
.br
-\fBPANEL *panel_below(const PANEL *\fIpan\fB);\fR
+\fBPANEL *panel_below(const PANEL *\fIpan\fP\fB);\fP
.sp
-\fBint set_panel_userptr(PANEL *\fIpan\fB, const void *\fIptr\fB);\fR
+\fBint set_panel_userptr(PANEL *\fIpan\fP\fB, const void *\fIptr\fP\fB);\fP
.br
-\fBconst void *panel_userptr(const PANEL *\fIpan\fB);\fR
+\fBconst void *panel_userptr(const PANEL *\fIpan\fP\fB);\fP
.sp
-\fBint del_panel(PANEL *\fIpan\fB);\fR
+\fBint del_panel(PANEL *\fIpan\fP\fB);\fP
.sp
-/* ncurses-extensions */
+\fR/* ncurses-extensions */\fP
.br
-\fBPANEL *ground_panel(SCREEN *\fIsp\fB);\fR
+\fBPANEL *ground_panel(SCREEN *\fIsp\fP\fB);\fP
.br
-\fBPANEL *ceiling_panel(SCREEN *\fIsp\fB);\fR
+\fBPANEL *ceiling_panel(SCREEN *\fIsp\fP\fB);\fP
.br
.SH DESCRIPTION
-Panels are \fBcurses\fR(3X) windows with the added feature of
+Panels are \fBcurses\fP(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 curses \fBstdscr\fR window are
+the proper portions of each window and the curses \fBstdscr\fP window are
hidden or displayed when panels are added, moved, modified or removed.
The set of currently visible panels is the stack of panels.
The
-\fBstdscr\fR window is beneath all panels, and is not considered part
+\fBstdscr\fP window is beneath all panels, and is not considered part
of the stack.
.P
A window is associated with every panel.
you to create, move, hide, and show panels, as well as position a
panel at any desired location in the stack.
.P
-Panel routines are a functional layer added to \fBcurses\fR(3X), make only
+Panel routines are a functional layer added to \fBcurses\fP(3X), make only
high-level curses calls, and work anywhere terminfo curses does.
.SH FUNCTIONS
.\" ---------
.SS bottom_panel
-\fBbottom_panel(\fIpan\fB)\fR
+\fBbottom_panel(\fIpan\fP\fB)\fR
puts panel \fIpan\fP at the bottom of all panels.
.\" ---------
.SS ceiling_panel
-\fBceiling_panel(\fIsp\fB)\fR
+\fBceiling_panel(\fIsp\fP\fB)\fR
acts like \fBpanel_below(NULL)\fP, for the given \fBSCREEN\fP \fIsp\fP.
.\" ---------
.SS del_panel
-\fBdel_panel(\fIpan\fB)\fR
+\fBdel_panel(\fIpan\fP\fB)\fR
removes the given panel \fIpan\fP from the stack and deallocates the
-\fBPANEL\fR structure (but not its associated window).
+\fBPANEL\fP structure (but not its associated window).
.\" ---------
.SS ground_panel
-\fBground_panel(\fIsp\fB)\fR
+\fBground_panel(\fIsp\fP\fB)\fR
acts like \fBpanel_above(NULL)\fP, for the given \fBSCREEN\fP \fIsp\fP.
.\" ---------
.SS hide_panel
-\fBhide_panel(\fIpan\fB)\fR
+\fBhide_panel(\fIpan\fP\fB)\fR
removes the given panel \fIpan\fP from the panel stack
and thus hides it from view.
-The \fBPANEL\fR structure is not lost, merely removed from the stack.
+The \fBPANEL\fP structure is not lost, merely removed from the stack.
.\" ---------
.SS move_panel
-\fBmove_panel(\fIpan\fB,\fIstarty\fB,\fIstartx\fB)\fR
+\fBmove_panel(\fIpan\fP\fB,\fIstarty\fP\fB,\fIstartx\fP\fB)\fR
moves the given panel \fIpan\fP's window so that its upper-left corner is at
-\fIstarty\fR, \fIstartx\fR.
+\fIstarty\fP, \fIstartx\fP.
It does not change the position of the panel in the stack.
-Be sure to use this function, not \fBmvwin\fR(3X), to move a panel window.
+Be sure to use this function, not \fBmvwin\fP(3X), to move a panel window.
.\" ---------
.SS new_panel
-\fBnew_panel(\fIwin\fB)\fR allocates a \fBPANEL\fR structure,
-associates it with \fIwin\fR, places the panel on the top of the stack
+\fBnew_panel(\fIwin\fP\fB)\fR allocates a \fBPANEL\fP structure,
+associates it with \fIwin\fP, 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.
.\" ---------
.SS panel_above
-\fBpanel_above(\fIpan\fB)\fR
+\fBpanel_above(\fIpan\fP\fB)\fR
returns a pointer to the panel above \fIpan\fP.
If the panel argument is
-\fB(PANEL *)0\fR, it returns a pointer to the bottom panel in the stack.
+\fB(PANEL *)0\fP, it returns a pointer to the bottom panel in the stack.
.\" ---------
.SS panel_below
-\fBpanel_below(\fIpan\fB)\fR
+\fBpanel_below(\fIpan\fP\fB)\fR
returns a pointer to the panel just below \fIpan\fP.
If the panel argument
-is \fB(PANEL *)0\fR, it returns a pointer to the top panel in the stack.
+is \fB(PANEL *)0\fP, it returns a pointer to the top panel in the stack.
.\" ---------
.SS panel_hidden
-\fBpanel_hidden(\fIpan\fB)\fR
+\fBpanel_hidden(\fIpan\fP\fB)\fR
returns \fBTRUE\fP if the panel \fIpan\fP is in the panel stack,
\fBFALSE\fP if it is not.
If the panel is a null pointer, return \fBERR\fP.
.\" ---------
.SS panel_userptr
-\fBpanel_userptr(\fIpan\fB)\fR
+\fBpanel_userptr(\fIpan\fP\fB)\fR
returns the user pointer for a given panel \fIpan\fP.
.\" ---------
.SS panel_window
-\fBpanel_window(\fIpan\fB)\fR
+\fBpanel_window(\fIpan\fP\fB)\fR
returns a pointer to the window of the given panel \fIpan\fP.
.\" ---------
.SS replace_panel
-\fBreplace_panel(\fIpan\fB,\fIwindow\fB)\fR
-replaces the current window of panel \fIpan\fP with \fIwindow\fR
+\fBreplace_panel(\fIpan\fP\fB,\fIwindow\fP\fB)\fR
+replaces the current window of panel \fIpan\fP with \fIwindow\fP
This is useful, for example if you want to resize a panel.
-In \fBncurses\fR, you can call \fBreplace_panel\fR
-to resize a panel using a window resized with \fBwresize\fR(3X).
+In \fBncurses\fP, you can call \fBreplace_panel\fP
+to resize a panel using a window resized with \fBwresize\fP(3X).
It does not change the position of the panel in the stack.
.\" ---------
.SS set_panel_userptr
-\fBset_panel_userptr(\fIpan\fB,\fIptr\fB)\fR
+\fBset_panel_userptr(\fIpan\fP\fB,\fIptr\fP\fB)\fR
sets the panel's user pointer.
.\" ---------
.SS show_panel
-\fBshow_panel(\fIpan\fB)\fR
+\fBshow_panel(\fIpan\fP\fB)\fR
makes a hidden panel visible by placing it on top of the panels in the
panel stack.
See \fBCOMPATIBILITY\fP below.
.\" ---------
.SS top_panel
-\fBtop_panel(\fIpan\fB)\fR
+\fBtop_panel(\fIpan\fP\fB)\fR
puts the given visible panel \fIpan\fP on top of all panels in the stack.
See \fBCOMPATIBILITY\fP below.
.\" ---------
\fBdoupdate\fP, but \fBdoupdate\fP is the function responsible for updating
the \fIphysical screen\fP.
.SH DIAGNOSTICS
-Each routine that returns a pointer returns \fBNULL\fR if an error
+Each routine that returns a pointer returns \fBNULL\fP if an error
occurs.
-Each routine that returns an int value returns \fBOK\fR if it
-executes successfully and \fBERR\fR if not.
+Each routine that returns an int value returns \fBOK\fP if it
+executes successfully and \fBERR\fP if not.
.PP
Except as noted, the \fIpan\fP and \fIwindow\fP parameters must be non-null.
If those are null, an error is returned.
Reasonable care has been taken to ensure compatibility
with the native panel facility introduced in System V (inspection of
the SVr4 manual pages suggests the programming interface is unchanged).
-The \fBPANEL\fR data structures are merely similar.
+The \fBPANEL\fP data structures are merely similar.
The programmer
-is cautioned not to directly use \fBPANEL\fR fields.
+is cautioned not to directly use \fBPANEL\fP fields.
.P
-The functions \fBshow_panel\fR and \fBtop_panel\fR are identical
+The functions \fBshow_panel\fP and \fBtop_panel\fP are identical
in this implementation, and work equally well with displayed or hidden
panels.
-In the native System V implementation, \fBshow_panel\fR is
+In the native System V implementation, \fBshow_panel\fP is
intended for making a hidden panel visible (at the top of the stack)
-and \fBtop_panel\fR is intended for making an already-visible panel
+and \fBtop_panel\fP 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.
libpanel.a
the panels library itself
.SH SEE ALSO
-\fBcurses\fR(3X),
-\fBcurs_variables\fR(3X),
+\fBcurses\fP(3X),
+\fBcurs_variables\fP(3X),
.PP
-This describes \fBncurses\fR
+This describes \fBncurses\fP
version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).
.SH AUTHOR
.PP
projects / ncurses.git / blobdiff