src - FreeBSD source tree

diff options


context:
space:
mode:

author	Ed Schouten <ed@FreeBSD.org>	2011-04-30 10:55:14 +0000
committer	Ed Schouten <ed@FreeBSD.org>	2011-04-30 10:55:14 +0000
commit	0294a182a1629b1d854b84906e73487d6cb75fba (patch)
tree	e563e21bcc0164ba11452983316bda26eebb1d3c /doc/html/man/curs_window.3x.html
parent	22b11c4db16996bf8d4878fab98762c348676df3 (diff)

Import a stock copy of ncurses 5.8 into the vendor space.vendor/ncurses/5.8-20110226

It seems both local changes we made to 5.7 have already been fixed upstream properly, so there is no need to preserve the changes. Also, with SVN we import full source trees. Unlike CVS, where we removed unneeded cruft.

Notes

Notes: svn path=/vendor/ncurses/dist/; revision=221243 svn path=/vendor/ncurses/5.8-20110226/; revision=221244; tag=vendor/ncurses/5.8-20110226

Diffstat (limited to 'doc/html/man/curs_window.3x.html')

-rw-r--r--

doc/html/man/curs_window.3x.html

216

1 files changed, 216 insertions, 0 deletions

diff --git a/doc/html/man/curs_window.3x.html b/doc/html/man/curs_window.3x.html
new file mode 100644
index 000000000000..d3d4ef4ae6e1
--- /dev/null
+++ b/doc/html/man/curs_window.3x.html

@@ -0,0 +1,216 @@

+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">

+<!--

+ ****************************************************************************

+ * *

+ * Permission is hereby granted, free of charge, to any person obtaining a *

+ * copy of this software and associated documentation files (the *

+ * "Software"), to deal in the Software without restriction, including *

+ * without limitation the rights to use, copy, modify, merge, publish, *

+ * distribute, distribute with modifications, sublicense, and/or sell *

+ * copies of the Software, and to permit persons to whom the Software is *

+ * furnished to do so, subject to the following conditions: *

+ * *

+ * The above copyright notice and this permission notice shall be included *

+ * in all copies or substantial portions of the Software. *

+ * *

+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *

+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *

+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *

+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *

+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *

+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *

+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *

+ * *

+ * Except as contained in this notice, the name(s) of the above copyright *

+ * holders shall not be used in advertising or otherwise to promote the *

+ * sale, use or other dealings in this Software without prior written *

+ * authorization. *

+ ****************************************************************************

+ * @Id: curs_window.3x,v 1.17 2010/12/04 18:38:55 tom Exp @

+-->

+<HTML>

+<HEAD>

+<TITLE>curs_window 3x</TITLE>

+<link rev=made href="mailto:bug-ncurses@gnu.org">

+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">

+</HEAD>

+<BODY>

+<H1>curs_window 3x</H1>

+<HR>

+<PRE>

+

+<A HREF="curs_window.3x.html">curs_window(3x)</A> <A HREF="curs_window.3x.html">curs_window(3x)</A>

+</PRE>

+<H2>NAME</H2><PRE>

+ newwin, delwin, mvwin, subwin, derwin, mvderwin, dupwin,

+ wsyncup, syncok, wcursyncup, wsyncdown - create curses

+ windows

+</PRE>

+<H2>SYNOPSIS</H2><PRE>

+ #include <curses.h>

+ WINDOW *newwin(int nlines, int ncols, int begin_y,

+ int begin_x);

+ int delwin(WINDOW *win);

+ int mvwin(WINDOW *win, int y, int x);

+ WINDOW *subwin(WINDOW *orig, int nlines, int ncols,

+ int begin_y, int begin_x);

+ WINDOW *derwin(WINDOW *orig, int nlines, int ncols,

+ int begin_y, int begin_x);

+ int mvderwin(WINDOW *win, int par_y, int par_x);

+ WINDOW *dupwin(WINDOW *win);

+ void wsyncup(WINDOW *win);

+ int syncok(WINDOW *win, bool bf);

+ void wcursyncup(WINDOW *win);

+ void wsyncdown(WINDOW *win);

+</PRE>

+<H2>DESCRIPTION</H2><PRE>

+ Calling newwin creates and returns a pointer to a new win-

+ dow with the given number of lines and columns. The upper

+ left-hand corner of the window is at line begin_y, column

+ begin_x. If either nlines or ncols is zero, they default

+ to LINES - begin_y and COLS - begin_x. A new full-screen

+ window is created by calling newwin(0,0,0,0).

+ Calling delwin deletes the named window, freeing all memo-

+ ry associated with it (it does not actually erase the win-

+ dow's screen image). Subwindows must be deleted before

+ the main window can be deleted.

+ Calling mvwin moves the window so that the upper left-hand

+ corner is at position (x, y). 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.

+ Calling subwin creates and returns a pointer to a new win-

+ dow with the given number of lines, nlines, and columns,

+ ncols. The window is at position (begin_y, begin_x) on

+ the screen. (This position is relative to the screen, and

+ not to the window orig.) The window is made in the middle

+ of the window orig, so that changes made to one window

+ will affect both windows. The subwindow shares memory

+ with the window orig. When using this routine, it is nec-

+ essary to call touchwin or touchline on orig before call-

+ ing wrefresh on the subwindow.

+ Calling derwin is the same as calling subwin, except that

+ begin_y and begin_x are relative to the origin of the win-

+ dow orig rather than the screen. There is no difference

+ between the subwindows and the derived windows.

+ Calling mvderwin moves a derived window (or subwindow) in-

+ side its parent window. The screen-relative parameters of

+ the window are not changed. This routine is used to dis-

+ play different parts of the parent window at the same

+ physical position on the screen.

+ Calling dupwin creates an exact duplicate of the window

+ win.

+ Calling wsyncup touches all locations in ancestors of win

+ that are changed in win. If syncok is called with second

+ argument TRUE then wsyncup is called automatically whenev-

+ er there is a change in the window.

+ The wsyncdown routine touches each location in win that

+ has been touched in any of its ancestor windows. This

+ routine is called by wrefresh, so it should almost never

+ be necessary to call it manually.

+ The routine wcursyncup updates the current cursor position

+ of all the ancestors of the window to reflect the current

+ cursor position of the window.

+</PRE>

+<H2>RETURN VALUE</H2><PRE>

+ Routines that return an integer return the integer ERR up-

+ on failure and OK (SVr4 only specifies "an integer value

+ other than ERR") upon successful completion.

+ Routines that return pointers return NULL on error.

+ X/Open defines no error conditions. In this implementa-

+ tion

+ delwin

+ returns an error if the window pointer is

+ null, or if the window is the parent of anoth-

+ er window.

+ This implementation also maintains a list of

+ windows, and checks that the pointer passed to

+ delwin is one that it created, returning an

+ error if it was not..

+ mvderwin

+ returns an error if the window pointer is

+ null, or if some part of the window would be

+ placed off-screen.

+ mvwin

+ returns an error if the window pointer is

+ null, or if the window is really a pad, or if

+ some part of the window would be placed off-

+ screen.

+ syncok

+ returns an error if the window pointer is

+ null.

+</PRE>

+<H2>NOTES</H2><PRE>

+ If many small changes are made to the window, the wsyncup

+ option could degrade performance.

+ Note that syncok may be a macro.

+</PRE>

+<H2>BUGS</H2><PRE>

+ The subwindow functions (subwin, derwin, mvderwin, wsyn-

+ cup, wsyncdown, wcursyncup, syncok) are flaky, incomplete-

+ ly implemented, and not well tested.

+ The System V curses documentation is very unclear about

+ what wsyncup and wsyncdown 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 curses implementation, is pat-

+ terned on the XPG4 curses standard. The weaker XPG4 spec

+ may result in slower updates.

+</PRE>

+<H2>PORTABILITY</H2><PRE>

+ The XSI Curses standard, Issue 4 describes these func-

+ tions.

+</PRE>

+<H2>SEE ALSO</H2><PRE>

+ <A HREF="ncurses.3x.html">curses(3x)</A>, <A HREF="curs_refresh.3x.html">curs_refresh(3x)</A>, <A HREF="curs_touch.3x.html">curs_touch(3x)</A>, curs_vari-

+ <A HREF="curs_variables.3x.html">ables(3x)</A>

+ <A HREF="curs_window.3x.html">curs_window(3x)</A>

+</PRE>

+<HR>

+<ADDRESS>

+Man(1) output converted with

+<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>

+</ADDRESS>

+</BODY>

+</HTML>