X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_window.3x;h=77cbffa723e64346ccf3e5bfeaebf3beac18bbf0;hp=93862802831acc1070a9ef09e59e9fa7be23e5d4;hb=HEAD;hpb=f79c210479470378389aab5b8d4d42d4a7f3d9a4 diff --git a/man/curs_window.3x b/man/curs_window.3x index 93862802..d3d55c75 100644 --- a/man/curs_window.3x +++ b/man/curs_window.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2020-2021,2022 Thomas E. Dickey * +.\" Copyright 2020-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2015,2016 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,59 +27,47 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_window.3x,v 1.29 2022/08/13 23:24:22 tom Exp $ -.TH curs_window 3X 2022-08-13 "ncurses 6.4" "Library calls" +.\" $Id: curs_window.3x,v 1.48 2024/04/20 21:20:07 tom Exp $ +.TH curs_window 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 .SH NAME -\fBnewwin\fP, -\fBdelwin\fP, -\fBmvwin\fP, -\fBsubwin\fP, -\fBderwin\fP, -\fBmvderwin\fP, -\fBdupwin\fP, -\fBwsyncup\fP, -\fBsyncok\fP, -\fBwcursyncup\fP, -\fBwsyncdown\fP \- create \fBcurses\fP windows -.ad -.hy +\fB\%newwin\fP, +\fB\%delwin\fP, +\fB\%mvwin\fP, +\fB\%subwin\fP, +\fB\%derwin\fP, +\fB\%mvderwin\fP, +\fB\%dupwin\fP, +\fB\%wsyncup\fP, +\fB\%syncok\fP, +\fB\%wcursyncup\fP, +\fB\%wsyncdown\fP \- +create and manipulate \fIcurses\fR windows .SH SYNOPSIS -\fB#include \fP -.sp -\fBWINDOW *newwin(\fP +.nf +\fB#include +.PP +\fBWINDOW *newwin( \fBint \fInlines\fB, int \fIncols\fB,\fR \fBint \fIbegin_y\fB, int \fIbegin_x\fB);\fR -.br \fBint delwin(WINDOW *\fIwin\fB);\fR -.br \fBint mvwin(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB);\fR -.br \fBWINDOW *subwin(WINDOW *\fIorig\fB,\fR \fBint \fInlines\fB, int \fIncols\fB,\fR \fBint \fIbegin_y\fB, int \fIbegin_x\fB);\fR -.br \fBWINDOW *derwin(WINDOW *\fIorig\fB,\fR \fBint \fInlines\fB, int \fIncols\fB,\fR \fBint \fIbegin_y\fB, int \fIbegin_x\fB);\fR -.br \fBint mvderwin(WINDOW *\fIwin\fB, int \fIpar_y\fB, int \fIpar_x\fB);\fR -.br \fBWINDOW *dupwin(WINDOW *\fIwin\fB);\fR -.br \fBvoid wsyncup(WINDOW *\fIwin\fB);\fR -.br \fBint syncok(WINDOW *\fIwin\fB, bool \fIbf\fB);\fR -.br \fBvoid wcursyncup(WINDOW *\fIwin\fB);\fR -.br \fBvoid wsyncdown(WINDOW *\fIwin\fB);\fR -.br +.fi .SH DESCRIPTION .SS newwin Calling \fBnewwin\fP creates and returns a pointer to a new window with the @@ -108,54 +96,49 @@ rather than a duplicate (with \fBdupwin\fP), all of the window modes are initialized to the default values. These functions set window modes after a window is created: .RS -.na .PP -idcok, -idlok, -immedok, -keypad, -leaveok, -nodelay, -scrollok, -setscrreg, -syncok, -wbkgdset, -wbkgrndset, and -wtimeout +\fB\%idcok\fP +\fB\%idlok\fP +\fB\%immedok\fP +\fB\%keypad\fP +\fB\%leaveok\fP +\fB\%nodelay\fP +\fB\%scrollok\fP +\fB\%setscrreg\fP +\fB\%syncok\fP +\fB\%wbkgdset\fP +\fB\%wbkgrndset\fP and +\fB\%wtimeout\fP. .RE -.ad .SS delwin -.PP Calling \fBdelwin\fP deletes the named window, freeing all memory associated with it (it does not actually erase the window's screen image). Subwindows must be deleted before the main window can be deleted. .SS mvwin -.PP Calling \fBmvwin\fP moves the window so that the upper left-hand corner is at position (\fIx\fP, \fIy\fP). If the move would cause the window to be off the screen, it is an error and the window is not moved. Moving subwindows is allowed, but should be avoided. .SS subwin -.PP Calling \fBsubwin\fP creates and returns a pointer to a new window with the given number of lines, \fInlines\fP, and columns, \fIncols\fP. The window is at position (\fIbegin\fR_\fIy\fP, \fIbegin\fR_\fIx\fP) on the screen. The subwindow shares memory with the window \fIorig\fP, +its \fIancestor\fP, so that changes made to one window will affect both windows. When using this routine, it is necessary to call \fBtouchwin\fP or \fBtouchline\fP on \fIorig\fP before calling \fBwrefresh\fP on the subwindow. .SS derwin -.PP Calling \fBderwin\fP is the same as calling \fBsubwin,\fP except that \fIbegin\fR_\fIy\fP and \fIbegin\fR_\fIx\fP are relative to the origin of the window \fIorig\fP rather than the screen. There is no difference between the subwindows and the derived windows. -.PP +.SS mvderwin Calling \fBmvderwin\fP moves a derived window (or subwindow) inside its parent window. The screen-relative parameters of the window are not changed. @@ -163,23 +146,19 @@ This routine is used to display different parts of the parent window at the same physical position on the screen. .SS dupwin -.PP Calling \fBdupwin\fP creates an exact duplicate of the window \fIwin\fP. .SS wsyncup -.PP Calling \fBwsyncup\fP touches all locations in ancestors of \fIwin\fP that are changed in \fIwin\fP. If \fBsyncok\fP is called with second argument \fBTRUE\fP then \fBwsyncup\fP is called automatically whenever there is a change in the window. .SS wsyncdown -.PP The \fBwsyncdown\fP routine touches each location in \fIwin\fP that has been touched in any of its ancestor windows. This routine is called by \fBwrefresh\fP, so it should almost never be necessary to call it manually. .SS wcursyncup -.PP The routine \fBwcursyncup\fP updates the current cursor position of all the ancestors of the window to reflect the current cursor position of the window. @@ -242,20 +221,8 @@ If many small changes are made to the window, the \fBwsyncup\fP option could degrade performance. .PP Note that \fBsyncok\fP may be a macro. -.SH BUGS -The subwindow functions (\fBsubwin\fP, \fBderwin\fP, \fBmvderwin\fP, -\fBwsyncup\fP, \fBwsyncdown\fP, \fBwcursyncup\fP, \fBsyncok\fP) are flaky, -incompletely implemented, and not well tested. -.PP -The System V curses documentation is very unclear about what \fBwsyncup\fP -and \fBwsyncdown\fP actually do. -It seems to imply that they are only -supposed to touch exactly those lines that are affected by ancestor changes. -The language here, and the behavior of the \fBcurses\fP implementation, -is patterned on the XPG4 curses standard. -The weaker XPG4 spec may result in slower updates. .SH PORTABILITY -The XSI Curses standard, Issue 4 describes these functions. +X/Open Curses, Issue 4 describes these functions. .PP X/Open Curses states regarding \fBdelwin\fP: .bP @@ -268,15 +235,38 @@ It simply returned \fBERR\fP when asked to delete a subwindow. Solaris X/Open curses does not even make that check, and will delete a parent window which still has subwindows. .bP -Since release 4.0 (1996), ncurses maintains a list of windows for each screen, +Since release 4.0 (1996), +\fI\%ncurses\fP maintains a list of windows for each screen, to ensure that a window has no subwindows before allowing deletion. .bP -NetBSD copied this feature of ncurses in 2003. +NetBSD copied this feature of \fI\%ncurses\fP in 2003. .br PDCurses follows the scheme used in Solaris X/Open curses. +.SH BUGS +The subwindow functions +\fB\%subwin\fP, +\fB\%derwin\fP, +\fB\%mvderwin\fP, +\fB\%wsyncup\fP, +\fB\%wsyncdown\fP, +\fB\%wcursyncup\fP, +and +\fB\%syncok\fP +are flaky, +incompletely implemented, +and not well tested. +.PP +System\ V's \fIcurses\fP documentation is unclear about what +\fB\%wsyncup\fP and \fB\%wsyncdown\fP actually do. +It seems to imply that they are supposed to touch only those lines that +are affected by changes to a window's ancestors. +The language here, +and behavior of \fI\%ncurses\fP, +is patterned on the X/Open Curses standard; +this approach may result in slower updates. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_initscr\fP(3X), -\fBcurs_refresh\fP(3X), -\fBcurs_touch\fP(3X), -\fBcurs_variables\fP(3X) +\fB\%curses\fP(3X), +\fB\%curs_initscr\fP(3X), +\fB\%curs_refresh\fP(3X), +\fB\%curs_touch\fP(3X), +\fB\%curs_variables\fP(3X)