X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=man%2Fpanel.3x;h=7880e8cd346648e0ebd92661025a6066d3f0beae;hb=62ca6190a9a8ddccb2c4d5ca7b2ef9f88432da65;hp=f7179c994d98455bef7ca9f4fbd040bf41320459;hpb=71c0306f0824ef2b10c4c5813fb003db48f3012e;p=ncurses.git diff --git a/man/panel.3x b/man/panel.3x index f7179c99..7880e8cd 100644 --- a/man/panel.3x +++ b/man/panel.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2015,2016 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: panel.3x,v 1.16 2010/07/31 15:22:31 tom Exp $ +.\" $Id: panel.3x,v 1.20 2016/10/15 17:02:31 tom Exp $ .TH panel 3X "" .ds n 5 .ds d @TERMINFO@ @@ -37,35 +37,35 @@ panel \- panel stack extension for curses .P \fBcc [flags] sourcefiles \-lpanel \-lncurses\fR .P -\fBPANEL *new_panel(WINDOW *win)\fR +\fBPANEL *new_panel(WINDOW *win);\fR .br -\fBint bottom_panel(PANEL *pan)\fR +\fBint bottom_panel(PANEL *pan);\fR .br -\fBint top_panel(PANEL *pan)\fR +\fBint top_panel(PANEL *pan);\fR .br -\fBint show_panel(PANEL *pan)\fR +\fBint show_panel(PANEL *pan);\fR .br \fBvoid update_panels();\fR .br -\fBint hide_panel(PANEL *pan)\fR +\fBint hide_panel(PANEL *pan);\fR .br -\fBWINDOW *panel_window(const PANEL *pan)\fR +\fBWINDOW *panel_window(const PANEL *pan);\fR .br -\fBint replace_panel(PANEL *pan, WINDOW *window)\fR +\fBint replace_panel(PANEL *pan, WINDOW *window);\fR .br -\fBint move_panel(PANEL *pan, int starty, int startx)\fR +\fBint move_panel(PANEL *pan, int starty, int startx);\fR .br -\fBint panel_hidden(const PANEL *pan)\fR +\fBint panel_hidden(const PANEL *pan);\fR .br -\fBPANEL *panel_above(const PANEL *pan)\fR +\fBPANEL *panel_above(const PANEL *pan);\fR .br -\fBPANEL *panel_below(const PANEL *pan)\fR +\fBPANEL *panel_below(const PANEL *pan);\fR .br -\fBint set_panel_userptr(PANEL *pan, const void *ptr)\fR +\fBint set_panel_userptr(PANEL *pan, const void *ptr);\fR .br -\fBconst void *panel_userptr(const PANEL *pan)\fR +\fBconst void *panel_userptr(const PANEL *pan);\fR .br -\fBint del_panel(PANEL *pan)\fR +\fBint del_panel(PANEL *pan);\fR .br .SH DESCRIPTION Panels are \fBcurses\fR(3X) windows with the added feature of @@ -90,14 +90,14 @@ allocates a \fBPANEL\fR structure, associates it with to be displayed above any other panel) and returns a pointer to the new panel. .TP -.B update_panels() +.B update_panels refreshes the virtual screen to reflect the relations between the -panels in the stack, but does not call doupdate() to refresh the +panels in the stack, but does not call \fBdoupdate\fP to refresh the physical screen. Use this function and not \fBwrefresh\fP or \fBwnoutrefresh\fP. .B update_panels may be called more than once before a call to -doupdate(), but doupdate() is the function responsible for updating +\fBdoupdate\fP, but \fBdoupdate\fP is the function responsible for updating the physical screen. .TP .B del_panel(pan) @@ -109,8 +109,8 @@ removes the given panel from the panel stack and thus hides it from view. The \fBPANEL\fR structure is not lost, merely removed from the stack. .TP .B panel_hidden(pan) -returns TRUE if the panel is in the panel stack, -FALSE if it is not. +returns \fBTRUE\fP if the panel is in the panel stack, +\fBFALSE\fP if it is not. If the panel is a null pointer, return ERR. .TP .B show_panel(pan) @@ -127,7 +127,7 @@ puts panel at the bottom of all panels. .B move_panel(pan,starty,startx) moves the given panel window so that its upper-left corner is at \fBstarty\fR, \fBstartx\fR. It does not change the position of the -panel in the stack. Be sure to use this function, not \fBmvwin()\fR, +panel in the stack. Be sure to use this function, not \fBmvwin\fR, to move a panel window. .TP .B replace_panel(pan,window) @@ -163,11 +163,11 @@ the SVr4 manual pages suggests the programming interface is unchanged). The \fBPANEL\fR data structures are merely similar. The programmer is cautioned not to directly use \fBPANEL\fR fields. .P -The functions \fBshow_panel()\fR and \fBtop_panel()\fR are identical +The functions \fBshow_panel\fR and \fBtop_panel\fR are identical in this implementation, and work equally well with displayed or hidden -panels. In the native System V implementation, \fBshow_panel()\fR is +panels. In the native System V implementation, \fBshow_panel\fR 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\fR 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. .SH NOTE @@ -182,7 +182,8 @@ interface for the panels library libpanel.a the panels library itself .SH SEE ALSO -\fBcurses\fR(3X) +\fBcurses\fR(3X), +\fBcurs_variables\fR(3X), .PP This describes \fBncurses\fR version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).