ncurses 6.2 - patch 20210213
[ncurses.git] / man / curs_window.3x
index ec811d367ec2cbbb54a73a9392b66eee6bd5cf03..77cbffa723e64346ccf3e5bfeaebf3beac18bbf0 100644 (file)
@@ -1,5 +1,6 @@
 .\"***************************************************************************
-.\" Copyright (c) 1998-2010,2014 Free Software Foundation, Inc.              *
+.\" Copyright 2020 Thomas E. Dickey                                          *
+.\" Copyright 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 +27,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_window.3x,v 1.18 2014/03/01 23:36:38 tom Exp $
+.\" $Id: curs_window.3x,v 1.21 2020/02/02 23:34:34 tom Exp $
 .TH curs_window 3X ""
 .na
 .hy 0
 \fB#include <curses.h>\fR
 .sp
 \fBWINDOW *newwin(\fR
-      \fBint nlines, int ncols,\fR
-      \fBint begin_y, int begin_x);\fR
+      \fBint \fP\fInlines\fP\fB, int \fP\fIncols\fP\fB,\fR
+      \fBint \fP\fIbegin_y\fP\fB, int \fP\fIbegin_x\fP\fB);\fR
 .br
-\fBint delwin(WINDOW *win);\fR
+\fBint delwin(WINDOW *\fP\fIwin\fP\fB);\fR
 .br
-\fBint mvwin(WINDOW *win, int y, int x);\fR
+\fBint mvwin(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB);\fR
 .br
-\fBWINDOW *subwin(WINDOW *orig,\fR
-      \fBint nlines, int ncols,\fR
-      \fBint begin_y, int begin_x);\fR
+\fBWINDOW *subwin(WINDOW *\fP\fIorig\fP\fB,\fR
+      \fBint \fP\fInlines\fP\fB, int \fP\fIncols\fP\fB,\fR
+      \fBint \fP\fIbegin_y\fP\fB, int \fP\fIbegin_x\fP\fB);\fR
 .br
-\fBWINDOW *derwin(WINDOW *orig,\fR
-      \fBint nlines, int ncols,\fR
-      \fBint begin_y, int begin_x);\fR
+\fBWINDOW *derwin(WINDOW *\fP\fIorig\fP\fB,\fR
+      \fBint \fP\fInlines\fP\fB, int \fP\fIncols\fP\fB,\fR
+      \fBint \fP\fIbegin_y\fP\fB, int \fP\fIbegin_x\fP\fB);\fR
 .br
-\fBint mvderwin(WINDOW *win, int par_y, int par_x);\fR
+\fBint mvderwin(WINDOW *\fP\fIwin\fP\fB, int \fP\fIpar_y\fP\fB, int \fP\fIpar_x\fP\fB);\fR
 .br
-\fBWINDOW *dupwin(WINDOW *win);\fR
+\fBWINDOW *dupwin(WINDOW *\fP\fIwin\fP\fB);\fR
 .br
-\fBvoid wsyncup(WINDOW *win);\fR
+\fBvoid wsyncup(WINDOW *\fP\fIwin\fP\fB);\fR
 .br
-\fBint syncok(WINDOW *win, bool bf);\fR
+\fBint syncok(WINDOW *\fP\fIwin\fP\fB, bool \fP\fIbf\fP\fB);\fR
 .br
-\fBvoid wcursyncup(WINDOW *win);\fR
+\fBvoid wcursyncup(WINDOW *\fP\fIwin\fP\fB);\fR
 .br
-\fBvoid wsyncdown(WINDOW *win);\fR
+\fBvoid wsyncdown(WINDOW *\fP\fIwin\fP\fB);\fR
 .br
 .SH DESCRIPTION
+.SS newwin
 Calling \fBnewwin\fR creates and returns a pointer to a new window with the
 given number of lines and columns.
 The upper left-hand corner of the window is
@@ -95,17 +97,20 @@ If either
 .RE
 .PP
 A new full-screen window is created by calling \fBnewwin(0,0,0,0)\fR.
+.SS delwin
 .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.
+.SS mvwin
 .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.
+.SS subwin
 .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.
@@ -117,6 +122,7 @@ will affect both windows.
 When using this routine, it is necessary to call
 \fBtouchwin\fR or \fBtouchline\fR on \fIorig\fR before calling
 \fBwrefresh\fR on the subwindow.
+.SS derwin
 .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
@@ -129,19 +135,23 @@ 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.
+.SS dupwin
 .PP
 Calling \fBdupwin\fR creates an exact duplicate of the window \fIwin\fR.
+.SS wsyncup
 .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.
+.SS wsyncdown
 .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.
+.SS wcursyncup
 .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
@@ -206,7 +216,7 @@ degrade performance.
 .PP
 Note that \fBsyncok\fR may be a macro.
 .SH BUGS
-The subwindow functions (\fIsubwin\fR, \fIderwin\fR, \fImvderwin\fR,
+The subwindow functions (\fBsubwin\fR, \fBderwin\fR, \fBmvderwin\fR,
 \fBwsyncup\fR, \fBwsyncdown\fR, \fBwcursyncup\fR, \fBsyncok\fR) are flaky,
 incompletely implemented, and not well tested.
 .PP