summaryrefslogtreecommitdiff
path: root/doc/html/man/curs_window.3x.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/man/curs_window.3x.html')
-rw-r--r--doc/html/man/curs_window.3x.html191
1 files changed, 86 insertions, 105 deletions
diff --git a/doc/html/man/curs_window.3x.html b/doc/html/man/curs_window.3x.html
index ea99659ecf62..3f5274efc16b 100644
--- a/doc/html/man/curs_window.3x.html
+++ b/doc/html/man/curs_window.3x.html
@@ -1,6 +1,6 @@
<!--
****************************************************************************
- * Copyright 2020-2023,2024 Thomas E. Dickey *
+ * Copyright 2020-2024,2025 Thomas E. Dickey *
* Copyright 1998-2015,2016 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
@@ -27,25 +27,23 @@
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_window.3x,v 1.48 2024/04/20 21:20:07 tom Exp @
+ * @Id: curs_window.3x,v 1.71 2025/08/23 22:50:00 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>curs_window 3x 2024-04-20 ncurses 6.5 Library calls</TITLE>
+<TITLE>curs_window 3x 2025-08-23 ncurses 6.6 Library calls</TITLE>
<link rel="author" href="mailto:bug-ncurses@gnu.org">
</HEAD>
<BODY>
-<H1 class="no-header">curs_window 3x 2024-04-20 ncurses 6.5 Library calls</H1>
+<H1 class="no-header">curs_window 3x 2025-08-23 ncurses 6.6 Library calls</H1>
<PRE>
<STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
-
-
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
<STRONG>newwin</STRONG>, <STRONG>delwin</STRONG>, <STRONG>mvwin</STRONG>, <STRONG>subwin</STRONG>, <STRONG>derwin</STRONG>, <STRONG>mvderwin</STRONG>, <STRONG>dupwin</STRONG>, <STRONG>wsyncup</STRONG>,
<STRONG>syncok</STRONG>, <STRONG>wcursyncup</STRONG>, <STRONG>wsyncdown</STRONG> - create and manipulate <EM>curses</EM> windows
@@ -54,23 +52,23 @@
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
<STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
- <STRONG>WINDOW</STRONG> <STRONG>*newwin(</STRONG>
- <STRONG>int</STRONG> <EM>nlines</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>ncols</EM><STRONG>,</STRONG>
- <STRONG>int</STRONG> <EM>begin</EM><STRONG>_</STRONG><EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>begin</EM><STRONG>_</STRONG><EM>x</EM><STRONG>);</STRONG>
- <STRONG>int</STRONG> <STRONG>delwin(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
- <STRONG>int</STRONG> <STRONG>mvwin(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
- <STRONG>WINDOW</STRONG> <STRONG>*subwin(WINDOW</STRONG> <STRONG>*</STRONG><EM>orig</EM><STRONG>,</STRONG>
- <STRONG>int</STRONG> <EM>nlines</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>ncols</EM><STRONG>,</STRONG>
- <STRONG>int</STRONG> <EM>begin</EM><STRONG>_</STRONG><EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>begin</EM><STRONG>_</STRONG><EM>x</EM><STRONG>);</STRONG>
- <STRONG>WINDOW</STRONG> <STRONG>*derwin(WINDOW</STRONG> <STRONG>*</STRONG><EM>orig</EM><STRONG>,</STRONG>
- <STRONG>int</STRONG> <EM>nlines</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>ncols</EM><STRONG>,</STRONG>
- <STRONG>int</STRONG> <EM>begin</EM><STRONG>_</STRONG><EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>begin</EM><STRONG>_</STRONG><EM>x</EM><STRONG>);</STRONG>
- <STRONG>int</STRONG> <STRONG>mvderwin(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>par</EM><STRONG>_</STRONG><EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>par</EM><STRONG>_</STRONG><EM>x</EM><STRONG>);</STRONG>
- <STRONG>WINDOW</STRONG> <STRONG>*dupwin(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
- <STRONG>void</STRONG> <STRONG>wsyncup(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
- <STRONG>int</STRONG> <STRONG>syncok(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
- <STRONG>void</STRONG> <STRONG>wcursyncup(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
- <STRONG>void</STRONG> <STRONG>wsyncdown(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
+ <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>newwin(</STRONG>
+ <STRONG>int</STRONG> <EM>nlines</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>ncols</EM><STRONG>,</STRONG>
+ <STRONG>int</STRONG> <EM>begin</EM><STRONG>_</STRONG><EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>begin</EM><STRONG>_</STRONG><EM>x</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>delwin(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>mvwin(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
+ <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>subwin(WINDOW</STRONG> <STRONG>*</STRONG> <EM>orig</EM><STRONG>,</STRONG>
+ <STRONG>int</STRONG> <EM>nlines</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>ncols</EM><STRONG>,</STRONG>
+ <STRONG>int</STRONG> <EM>begin</EM><STRONG>_</STRONG><EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>begin</EM><STRONG>_</STRONG><EM>x</EM><STRONG>);</STRONG>
+ <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>derwin(WINDOW</STRONG> <STRONG>*</STRONG> <EM>orig</EM><STRONG>,</STRONG>
+ <STRONG>int</STRONG> <EM>nlines</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>ncols</EM><STRONG>,</STRONG>
+ <STRONG>int</STRONG> <EM>begin</EM><STRONG>_</STRONG><EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>begin</EM><STRONG>_</STRONG><EM>x</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>mvderwin(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>par</EM><STRONG>_</STRONG><EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>par</EM><STRONG>_</STRONG><EM>x</EM><STRONG>);</STRONG>
+ <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>dupwin(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>);</STRONG>
+ <STRONG>void</STRONG> <STRONG>wsyncup(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>syncok(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
+ <STRONG>void</STRONG> <STRONG>wcursyncup(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>);</STRONG>
+ <STRONG>void</STRONG> <STRONG>wsyncdown(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>);</STRONG>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
@@ -90,16 +88,16 @@
Regardless of the function used for creating a new window (e.g.,
<STRONG>newwin</STRONG>, <STRONG>subwin</STRONG>, <STRONG>derwin</STRONG>, <STRONG>newpad</STRONG>), rather than a duplicate (with <STRONG>dupwin</STRONG>),
- all of the window modes are initialized to the default values. These
- functions set window modes after a window is created:
+ all of the window modes are initialized to the default values. The
+ following functions set a window's modes after it is created:
- <STRONG>idcok</STRONG> <STRONG>idlok</STRONG> <STRONG>immedok</STRONG> <STRONG>keypad</STRONG> <STRONG>leaveok</STRONG> <STRONG>nodelay</STRONG> <STRONG>scrollok</STRONG> <STRONG>setscrreg</STRONG>
- <STRONG>syncok</STRONG> <STRONG>wbkgdset</STRONG> <STRONG>wbkgrndset</STRONG> and <STRONG>wtimeout</STRONG>.
+ <STRONG>idcok</STRONG>, <STRONG>idlok</STRONG>, <STRONG>immedok</STRONG>, <STRONG>keypad</STRONG>, <STRONG>leaveok</STRONG>, <STRONG>nodelay</STRONG>, <STRONG>notimeout</STRONG>,
+ <STRONG>scrollok</STRONG>, <STRONG>setscrreg</STRONG>, <STRONG>syncok</STRONG>, <STRONG>wbkgdset</STRONG>, <STRONG>wbkgrndset</STRONG>, and <STRONG>wtimeout</STRONG>.
</PRE><H3><a name="h3-delwin">delwin</a></H3><PRE>
- Calling <STRONG>delwin</STRONG> deletes the named window, freeing all memory associated
- with it (it does not actually erase the window's screen image).
+ Calling <STRONG>delwin</STRONG> 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.
@@ -114,22 +112,22 @@
Calling <STRONG>subwin</STRONG> creates and returns a pointer to a new window with the
given number of lines, <EM>nlines</EM>, and columns, <EM>ncols</EM>. The window is at
position (<EM>begin</EM>_<EM>y</EM>, <EM>begin</EM>_<EM>x</EM>) on the screen. The subwindow shares memory
- with the window <EM>orig</EM>, its <EM>ancestor</EM>, so that changes made to one window
- will affect both windows. When using this routine, it is necessary to
- call <STRONG>touchwin</STRONG> or <STRONG>touchline</STRONG> on <EM>orig</EM> before calling <STRONG>wrefresh</STRONG> on the
+ with the window <EM>orig</EM>, its <EM>ancestor</EM>, so that changes made to one window
+ will affect both windows. When using this routine, it is necessary to
+ call <STRONG>touchwin</STRONG> or <STRONG>touchline</STRONG> on <EM>orig</EM> before calling <STRONG>wrefresh</STRONG> on the
subwindow.
</PRE><H3><a name="h3-derwin">derwin</a></H3><PRE>
- Calling <STRONG>derwin</STRONG> is the same as calling <STRONG>subwin,</STRONG> except that <EM>begin</EM>_<EM>y</EM> and
- <EM>begin</EM>_<EM>x</EM> are relative to the origin of the window <EM>orig</EM> rather than the
- screen. There is no difference between the subwindows and the derived
+ Calling <STRONG>derwin</STRONG> is the same as calling <STRONG>subwin,</STRONG> except that <EM>begin</EM>_<EM>y</EM> and
+ <EM>begin</EM>_<EM>x</EM> are relative to the origin of the window <EM>orig</EM> rather than the
+ screen. There is no difference between the subwindows and the derived
windows.
</PRE><H3><a name="h3-mvderwin">mvderwin</a></H3><PRE>
- Calling <STRONG>mvderwin</STRONG> moves a derived window (or subwindow) inside its
- parent window. The screen-relative parameters of the window are not
+ Calling <STRONG>mvderwin</STRONG> 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.
@@ -158,95 +156,81 @@
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
- Routines that return an integer return the integer <STRONG>ERR</STRONG> upon failure and
- <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than <STRONG>ERR</STRONG>") upon
- successful completion.
+ Functions that return integers return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> upon
+ success.
+
+ Functions that return pointers return a null pointer on failure.
- Routines that return pointers return <STRONG>NULL</STRONG> on error.
+ <EM>ncurses</EM> defines several error conditions.
- X/Open defines no error conditions. In this implementation
+ <STRONG>o</STRONG> <STRONG>delwin</STRONG> returns <STRONG>ERR</STRONG> if <EM>win</EM> is a null pointer, or if it is the parent
+ of another window.
- <STRONG>delwin</STRONG>
- returns an error if the window pointer is null, or if the window
- is the parent of another window.
+ <EM>ncurses</EM> maintains a list of windows, and checks that the pointer
+ passed to <STRONG>delwin</STRONG> is one that it created, returning <STRONG>ERR</STRONG> if it was
+ not.
- <STRONG>derwin</STRONG>
- returns an error if the parent window pointer is null, or if any
- of its ordinates or dimensions is negative, or if the resulting
- window does not fit inside the parent window.
+ <STRONG>o</STRONG> <STRONG>derwin</STRONG> returns <STRONG>ERR</STRONG> if <EM>orig</EM> is a null pointer, or if any of the
+ ordinate or dimension arguments is negative, or if the resulting
+ window does not fit inside the parent window.
- <STRONG>dupwin</STRONG>
- returns an error if the window pointer is null.
+ <STRONG>o</STRONG> <STRONG>dupwin</STRONG> returns <STRONG>ERR</STRONG> if <EM>win</EM> is a null pointer.
- This implementation also maintains a list of windows, and checks
- that the pointer passed to <STRONG>delwin</STRONG> is one that it created,
- returning an error if it was not..
+ <STRONG>o</STRONG> <STRONG>mvderwin</STRONG> returns <STRONG>ERR</STRONG> if <EM>win</EM> is a null pointer, or if any part of
+ the window would be placed off-screen.
- <STRONG>mvderwin</STRONG>
- returns an error if the window pointer is null, or if some part of
- the window would be placed off-screen.
+ <STRONG>o</STRONG> <STRONG>mvwin</STRONG> returns <STRONG>ERR</STRONG> if <EM>win</EM> is a null pointer, if <EM>win</EM> is a pad, or if
+ any part of the window would be placed off-screen.
- <STRONG>mvwin</STRONG>
- 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.
+ <STRONG>o</STRONG> <STRONG>newwin</STRONG> returns <STRONG>ERR</STRONG> if any of its arguments is negative.
- <STRONG>newwin</STRONG>
- will fail if either of its beginning ordinates is negative, or if
- either the number of lines or columns is negative.
+ <STRONG>o</STRONG> <STRONG>subwin</STRONG> returns <STRONG>ERR</STRONG> if <EM>orig</EM> is a null pointer, or if any of the
+ ordinate or dimension arguments is negative, or if the resulting
+ window does not fit inside the parent window.
- <STRONG>syncok</STRONG>
- returns an error if the window pointer is null.
+ <STRONG>o</STRONG> <STRONG>syncok</STRONG> returns <STRONG>ERR</STRONG> if <EM>win</EM> is a null pointer.
- <STRONG>subwin</STRONG>
- returns an error if the parent window pointer is null, or if any
- of its ordinates or dimensions is negative, or if the resulting
- window does not fit inside the parent window.
+ Functions that return a window pointer fail if memory allocation for
+ their data structures fails.
- The functions which return a window pointer may also fail if there is
- insufficient memory for its data structures. Any of these functions
- will fail if the screen has not been initialized, i.e., with <STRONG>initscr</STRONG> or
- <STRONG>newterm</STRONG>.
+ All of these functions fail if the screen has not been initialized; see
+ <STRONG><A HREF="curs_initscr.3x.html">initscr(3x)</A></STRONG> or <STRONG><A HREF="curs_initscr.3x.html">newterm(3x)</A></STRONG>.
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
- If many small changes are made to the window, the <STRONG>wsyncup</STRONG> option could
- degrade performance.
+ <STRONG>syncok</STRONG> may be implemented as a macro.
- Note that <STRONG>syncok</STRONG> may be a macro.
+ Calling <STRONG>syncup</STRONG> on a window and making many small changes to it could
+ degrade performance.
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
- X/Open Curses, Issue 4 describes these functions.
+ X/Open Curses Issue 4 describes these functions. It specifies no error
+ conditions for <EM>delwin</EM>, <EM>derwin</EM>, <EM>dupwin</EM>, <EM>newwin</EM>, <EM>mvderwin</EM>, or <EM>syncok</EM>.
- X/Open Curses states regarding <STRONG>delwin</STRONG>:
+ For functions returning integers (except <EM>delwin</EM>), SVr4 describes a
+ successful return value only as "an integer value other than <EM>ERR</EM>".
- <STRONG>o</STRONG> It must delete subwindows before deleting their parent.
+ Regarding <EM>delwin</EM>, X/Open Curses states that
- <STRONG>o</STRONG> If <STRONG>delwin</STRONG> is asked to delete a parent window, it can only succeed
- if the curses library keeps a list of the subwindows. SVr4 curses
- kept a count of the number of subwindows rather than a list. It
- simply returned <STRONG>ERR</STRONG> 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.
+ [t]he application must delete subwindows before deleting the
+ main window.
- <STRONG>o</STRONG> Since release 4.0 (1996), <EM>ncurses</EM> maintains a list of windows for
- each screen, to ensure that a window has no subwindows before
- allowing deletion.
+ If <EM>delwin</EM> is asked to delete a parent window, it can succeed only if
+ the <EM>curses</EM> library keeps a list of its subwindows. SVr4 <EM>curses</EM> kept a
+ count of the number of subwindows rather than a list. It simply
+ returned <STRONG>ERR</STRONG> when asked to delete a subwindow. Solaris X/Open <EM>curses</EM>
+ (<EM>xcurses</EM>) does not make even that check, and will delete a parent
+ window that still has subwindows. <EM>PDCurses</EM> also behaves this way.
- <STRONG>o</STRONG> NetBSD copied this feature of <EM>ncurses</EM> in 2003.
- PDCurses follows the scheme used in Solaris X/Open curses.
+ <EM>ncurses</EM> 4.0 (1996) and later maintains a list of windows for each
+ screen to ensure that a window has no subwindows before allowing its
+ deletion. NetBSD <EM>curses</EM> has followed suit since 2003.
-
-</PRE><H2><a name="h2-BUGS">BUGS</a></H2><PRE>
- The subwindow functions <STRONG>subwin</STRONG>, <STRONG>derwin</STRONG>, <STRONG>mvderwin</STRONG>, <STRONG>wsyncup</STRONG>, <STRONG>wsyncdown</STRONG>,
- <STRONG>wcursyncup</STRONG>, and <STRONG>syncok</STRONG> are flaky, incompletely implemented, and not
- well tested.
-
- System V's <EM>curses</EM> documentation is unclear about what <STRONG>wsyncup</STRONG> and
- <STRONG>wsyncdown</STRONG> 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 <EM>ncurses</EM>, is patterned on
+ SVr4 <EM>curses</EM> documentation is unclear about what <EM>wsyncup</EM> and <EM>wsyncdown</EM>
+ 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
+ description and behavior of these functions in <EM>ncurses</EM> is patterned on
the X/Open Curses standard; this approach may result in slower updates.
@@ -254,9 +238,7 @@
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG>,
<STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
-
-
-ncurses 6.5 2024-04-20 <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
+ncurses 6.6 2025-08-23 <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
</PRE>
<div class="nav">
<ul>
@@ -279,7 +261,6 @@ ncurses 6.5 2024-04-20 <STRONG><A HREF="
<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
<li><a href="#h2-NOTES">NOTES</a></li>
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
-<li><a href="#h2-BUGS">BUGS</a></li>
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
</ul>
</div>
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-19 09:33:11 +0000