X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=man%2Fpanel.3x;h=f16931ce3ec268f18c6ce4f21f455848d435e55f;hb=2632b47fdcf4dcd101962c92acafaac69630388f;hp=932ef48eef7d96c1cd7647fb29577b8d6c1c47cf;hpb=84cf9f63bf604413fa5714ef91f83076ac8f236b;p=ncurses.git diff --git a/man/panel.3x b/man/panel.3x index 932ef48e..f16931ce 100644 --- a/man/panel.3x +++ b/man/panel.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 2018-2021,2022 Thomas E. Dickey * .\" Copyright 1998-2016,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,7 +27,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: panel.3x,v 1.39 2020/02/15 21:06:40 tom Exp $ +.\" $Id: panel.3x,v 1.42 2022/02/12 20:03:40 tom Exp $ .TH panel 3X "" .ie \n(.g .ds `` \(lq .el .ds `` `` @@ -40,9 +40,9 @@ .SH NAME panel \- panel stack extension for curses .SH SYNOPSIS -\fB#include \fR +\fB#include \fP .P -\fBcc [flags] sourcefiles \-lpanel \-lncurses\fR +\fBcc [flags] sourcefiles \-lpanel \-lncurses\fP .P \fBPANEL *new_panel(WINDOW *\fIwin\fB);\fR .sp @@ -52,7 +52,7 @@ panel \- panel stack extension for curses .br \fBint show_panel(PANEL *\fIpan\fB);\fR .br -\fBvoid update_panels(void);\fR +\fBvoid update_panels(void);\fP .br \fBint hide_panel(PANEL *\fIpan\fB);\fR .sp @@ -74,21 +74,21 @@ panel \- panel stack extension for curses .sp \fBint del_panel(PANEL *\fIpan\fB);\fR .sp -/* ncurses-extensions */ +\fR/* ncurses-extensions */\fP .br \fBPANEL *ground_panel(SCREEN *\fIsp\fB);\fR .br \fBPANEL *ceiling_panel(SCREEN *\fIsp\fB);\fR .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. @@ -96,7 +96,7 @@ 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. .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 .\" --------- @@ -111,7 +111,7 @@ acts like \fBpanel_below(NULL)\fP, for the given \fBSCREEN\fP \fIsp\fP. .SS del_panel \fBdel_panel(\fIpan\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 @@ -121,18 +121,18 @@ acts like \fBpanel_above(NULL)\fP, for the given \fBSCREEN\fP \fIsp\fP. \fBhide_panel(\fIpan\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 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\fB)\fR allocates a \fBPANEL\fR 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. .\" --------- @@ -140,13 +140,13 @@ pointer to the new panel. \fBpanel_above(\fIpan\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 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 @@ -164,10 +164,10 @@ 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 +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 @@ -196,10 +196,10 @@ Use this function and not \fBwrefresh\fP(3X) or \fBwnoutrefresh\fP(3X). \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. @@ -210,16 +210,16 @@ and will return an error if \fBmvwin\fP returns an error. 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. @@ -263,10 +263,10 @@ interface for the panels library 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