X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_window.3x;h=552862e9e253a1a1b20256d5269e7dacfeafb883;hp=8c572995e9e439627e815b73e8347d60cb90c12a;hb=7b2974498fac39a3ffde257c92f572234d529239;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8 diff --git a/man/curs_window.3x b/man/curs_window.3x index 8c572995..552862e9 100644 --- a/man/curs_window.3x +++ b/man/curs_window.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2005,2006 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: curs_window.3x,v 1.13 2005/05/15 16:32:02 tom Exp $ +.\" $Id: curs_window.3x,v 1.14 2006/02/25 21:49:19 tom Exp $ .TH curs_window 3X "" .na .hy 0 @@ -46,7 +46,7 @@ .hy .SH SYNOPSIS \fB#include \fR - +.sp \fBWINDOW *newwin(int nlines, int ncols, int begin_y,\fR \fBint begin_x);\fR .br @@ -79,17 +79,17 @@ at line \fIbegin\fR_\fIy\fR, column \fIbegin\fR_\fIx\fR. If either \fInlines\fR or \fIncols\fR is zero, they default to \fBLINES -\fR \fIbegin\fR_\fIy\fR and \fBCOLS -\fR \fIbegin\fR_\fIx\fR. A new full-screen window is created by calling \fBnewwin(0,0,0,0)\fR. - +.PP Calling \fBdelwin\fR 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. - +.PP Calling \fBmvwin\fR moves the window so that the upper left-hand corner is at position (\fIx\fR, \fIy\fR). 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. - +.PP Calling \fBsubwin\fR creates and returns a pointer to a new window with the given number of lines, \fInlines\fR, and columns, \fIncols\fR. The window is at position (\fIbegin\fR_\fIy\fR, @@ -100,29 +100,29 @@ will affect both windows. The subwindow shares memory with the window \fIorig\fR. When using this routine, it is necessary to call \fBtouchwin\fR or \fBtouchline\fR on \fIorig\fR before calling \fBwrefresh\fR on the subwindow. - +.PP Calling \fBderwin\fR is the same as calling \fBsubwin,\fR except that \fIbegin\fR_\fIy\fR and \fIbegin\fR_\fIx\fR are relative to the origin of the window \fIorig\fR rather than the screen. There is no difference between the subwindows and the derived windows. - +.PP Calling \fBmvderwin\fR moves a derived window (or subwindow) inside its parent window. The screen-relative parameters of the window are not changed. This routine is used to display different parts of the parent window at the same physical position on the screen. - +.PP Calling \fBdupwin\fR creates an exact duplicate of the window \fIwin\fR. - +.PP Calling \fBwsyncup\fR touches all locations in ancestors of \fIwin\fR that are changed in \fIwin\fR. If \fBsyncok\fR is called with second argument \fBTRUE\fR then \fBwsyncup\fR is called automatically whenever there is a change in the window. - +.PP The \fBwsyncdown\fR routine touches each location in \fIwin\fR that has been touched in any of its ancestor windows. This routine is called by \fBwrefresh\fR, so it should almost never be necessary to call it manually. - +.PP The routine \fBwcursyncup\fR updates the current cursor position of all the ancestors of the window to reflect the current cursor position of the window. @@ -163,13 +163,13 @@ if the window pointer is null. .SH NOTES If many small changes are made to the window, the \fBwsyncup\fR option could degrade performance. - +.PP Note that \fBsyncok\fR may be a macro. .SH BUGS The subwindow functions (\fIsubwin\fR, \fIderwin\fR, \fImvderwin\fR, \fBwsyncup\fR, \fBwsyncdown\fR, \fBwcursyncup\fR, \fBsyncok\fR) are flaky, incompletely implemented, and not well tested. - +.PP The System V curses documentation is very unclear about what \fBwsyncup\fR and \fBwsyncdown\fR actually do. It seems to imply that they are only supposed to touch exactly those lines that are affected by ancestor changes.