<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</TITLE>
+<TITLE>curs_window 3x</TITLE>
<link rel="author" href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
-<H1 class="no-header">curs_window 3X</H1>
+<H1 class="no-header">curs_window 3x</H1>
<PRE>
-<B><A HREF="curs_window.3X.html">curs_window(3X)</A></B> <B><A HREF="curs_window.3X.html">curs_window(3X)</A></B>
+<STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG> <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
- <B>newwin</B>, <B>delwin</B>, <B>mvwin</B>, <B>subwin</B>, <B>derwin</B>, <B>mvderwin</B>, <B>dupwin</B>, <B>wsyncup</B>,
- <B>syncok</B>, <B>wcursyncup</B>, <B>wsyncdown</B> - create <B>curses</B> windows
+ <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 <STRONG>curses</STRONG> windows
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
- <B>#include</B> <B><curses.h></B>
-
- <B>WINDOW</B> <B>*newwin(</B>
- <B>int</B> <I>nlines</I><B>,</B> <B>int</B> <I>ncols</I><B>,</B>
- <B>int</B> <I>begin</I><B>_</B><I>y</I><B>,</B> <B>int</B> <I>begin</I><B>_</B><I>x</I><B>);</B>
- <B>int</B> <B>delwin(WINDOW</B> <B>*</B><I>win</I><B>);</B>
- <B>int</B> <B>mvwin(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>);</B>
- <B>WINDOW</B> <B>*subwin(WINDOW</B> <B>*</B><I>orig</I><B>,</B>
- <B>int</B> <I>nlines</I><B>,</B> <B>int</B> <I>ncols</I><B>,</B>
- <B>int</B> <I>begin</I><B>_</B><I>y</I><B>,</B> <B>int</B> <I>begin</I><B>_</B><I>x</I><B>);</B>
- <B>WINDOW</B> <B>*derwin(WINDOW</B> <B>*</B><I>orig</I><B>,</B>
- <B>int</B> <I>nlines</I><B>,</B> <B>int</B> <I>ncols</I><B>,</B>
- <B>int</B> <I>begin</I><B>_</B><I>y</I><B>,</B> <B>int</B> <I>begin</I><B>_</B><I>x</I><B>);</B>
- <B>int</B> <B>mvderwin(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>par</I><B>_</B><I>y</I><B>,</B> <B>int</B> <I>par</I><B>_</B><I>x</I><B>);</B>
- <B>WINDOW</B> <B>*dupwin(WINDOW</B> <B>*</B><I>win</I><B>);</B>
- <B>void</B> <B>wsyncup(WINDOW</B> <B>*</B><I>win</I><B>);</B>
- <B>int</B> <B>syncok(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>bool</B> <I>bf</I><B>);</B>
- <B>void</B> <B>wcursyncup(WINDOW</B> <B>*</B><I>win</I><B>);</B>
- <B>void</B> <B>wsyncdown(WINDOW</B> <B>*</B><I>win</I><B>);</B>
+ <STRONG>#include</STRONG> <STRONG><curses.h></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>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
</PRE><H3><a name="h3-newwin">newwin</a></H3><PRE>
- Calling <B>newwin</B> creates and returns a pointer to a new window with the
+ Calling <STRONG>newwin</STRONG> 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 at
- line <I>begin</I>_<I>y</I>,
- column <I>begin</I>_<I>x</I>
+ line <EM>begin</EM>_<EM>y</EM>,
+ column <EM>begin</EM>_<EM>x</EM>
- If either <I>nlines</I> or <I>ncols</I> is zero, they default to
- <B>LINES</B> <B>-</B> <I>begin</I>_<I>y</I> and
- <B>COLS</B> <B>-</B> <I>begin</I>_<I>x</I>.
+ If either <EM>nlines</EM> or <EM>ncols</EM> is zero, they default to
+ <STRONG>LINES</STRONG> <STRONG>-</STRONG> <EM>begin</EM>_<EM>y</EM> and
+ <STRONG>COLS</STRONG> <STRONG>-</STRONG> <EM>begin</EM>_<EM>x</EM>.
- A new full-screen window is created by calling <B>newwin(0,0,0,0)</B>.
+ A new full-screen window is created by calling <STRONG>newwin(0,0,0,0)</STRONG>.
Regardless of the function used for creating a new window (e.g.,
- <B>newwin</B>, <B>subwin</B>, <B>derwin</B>, <B>newpad</B>), rather than a duplicate (with <B>dupwin</B>),
+ <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:
</PRE><H3><a name="h3-delwin">delwin</a></H3><PRE>
- Calling <B>delwin</B> deletes the named window, freeing all memory associated
+ Calling <STRONG>delwin</STRONG> deletes the named window, freeing all memory associated
with it (it does not actually erase the window's screen image). Sub-
windows must be deleted before the main window can be deleted.
</PRE><H3><a name="h3-mvwin">mvwin</a></H3><PRE>
- Calling <B>mvwin</B> moves the window so that the upper left-hand corner is at
- position (<I>x</I>, <I>y</I>). If the move would cause the window to be off the
+ Calling <STRONG>mvwin</STRONG> moves the window so that the upper left-hand corner is at
+ position (<EM>x</EM>, <EM>y</EM>). 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.
</PRE><H3><a name="h3-subwin">subwin</a></H3><PRE>
- Calling <B>subwin</B> creates and returns a pointer to a new window with the
- given number of lines, <I>nlines</I>, and columns, <I>ncols</I>. The window is at
- position (<I>begin</I>_<I>y</I>, <I>begin</I>_<I>x</I>) on the screen. The subwindow shares memory
- with the window <I>orig</I>, so that changes made to one window will affect
- both windows. When using this routine, it is necessary to call <B>touch-</B>
- <B>win</B> or <B>touchline</B> on <I>orig</I> before calling <B>wrefresh</B> on the subwindow.
+ 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>, so that changes made to one window will affect
+ both windows. When using this routine, it is necessary to call <STRONG>touch-</STRONG>
+ <STRONG>win</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 <B>derwin</B> is the same as calling <B>subwin,</B> except that <I>begin</I>_<I>y</I> and
- <I>begin</I>_<I>x</I> are relative to the origin of the window <I>orig</I> rather than the
+ 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.
- Calling <B>mvderwin</B> moves a derived window (or subwindow) inside its par-
+ Calling <STRONG>mvderwin</STRONG> moves a derived window (or subwindow) inside its par-
ent 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.
</PRE><H3><a name="h3-dupwin">dupwin</a></H3><PRE>
- Calling <B>dupwin</B> creates an exact duplicate of the window <I>win</I>.
+ Calling <STRONG>dupwin</STRONG> creates an exact duplicate of the window <EM>win</EM>.
</PRE><H3><a name="h3-wsyncup">wsyncup</a></H3><PRE>
- Calling <B>wsyncup</B> touches all locations in ancestors of <I>win</I> that are
- changed in <I>win</I>. If <B>syncok</B> is called with second argument <B>TRUE</B> then
- <B>wsyncup</B> is called automatically whenever there is a change in the win-
+ Calling <STRONG>wsyncup</STRONG> touches all locations in ancestors of <EM>win</EM> that are
+ changed in <EM>win</EM>. If <STRONG>syncok</STRONG> is called with second argument <STRONG>TRUE</STRONG> then
+ <STRONG>wsyncup</STRONG> is called automatically whenever there is a change in the win-
dow.
</PRE><H3><a name="h3-wsyncdown">wsyncdown</a></H3><PRE>
- The <B>wsyncdown</B> routine touches each location in <I>win</I> that has been
- touched in any of its ancestor windows. This routine is called by <B>wre-</B>
- <B>fresh</B>, so it should almost never be necessary to call it manually.
+ The <STRONG>wsyncdown</STRONG> routine touches each location in <EM>win</EM> that has been
+ touched in any of its ancestor windows. This routine is called by <STRONG>wre-</STRONG>
+ <STRONG>fresh</STRONG>, so it should almost never be necessary to call it manually.
</PRE><H3><a name="h3-wcursyncup">wcursyncup</a></H3><PRE>
- The routine <B>wcursyncup</B> updates the current cursor position of all the
+ The routine <STRONG>wcursyncup</STRONG> updates the current cursor position of all the
ancestors of the window to reflect the current cursor position of the
window.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
- Routines that return an integer return the integer <B>ERR</B> upon failure and
- <B>OK</B> (SVr4 only specifies "an integer value other than <B>ERR</B>") upon suc-
+ 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 suc-
cessful completion.
- Routines that return pointers return <B>NULL</B> on error.
+ Routines that return pointers return <STRONG>NULL</STRONG> on error.
X/Open defines no error conditions. In this implementation
- <B>delwin</B>
+ <STRONG>delwin</STRONG>
returns an error if the window pointer is null, or if the window
is the parent of another window.
- <B>derwin</B>
+ <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.
- <B>dupwin</B>
+ <STRONG>dupwin</STRONG>
returns an error if the window pointer is null.
This implementation also maintains a list of windows, and checks
- that the pointer passed to <B>delwin</B> is one that it created, return-
+ that the pointer passed to <STRONG>delwin</STRONG> is one that it created, return-
ing an error if it was not..
- <B>mvderwin</B>
+ <STRONG>mvderwin</STRONG>
returns an error if the window pointer is null, or if some part of
the window would be placed off-screen.
- <B>mvwin</B>
+ <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.
- <B>newwin</B>
+ <STRONG>newwin</STRONG>
will fail if either of its beginning ordinates is negative, or if
either the number of lines or columns is negative.
- <B>syncok</B>
+ <STRONG>syncok</STRONG>
returns an error if the window pointer is null.
- <B>subwin</B>
+ <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.
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 <B>initscr</B> or
- <B>newterm</B>.
+ will fail if the screen has not been initialized, i.e., with <STRONG>initscr</STRONG> or
+ <STRONG>newterm</STRONG>.
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
- If many small changes are made to the window, the <B>wsyncup</B> option could
+ If many small changes are made to the window, the <STRONG>wsyncup</STRONG> option could
degrade performance.
- Note that <B>syncok</B> may be a macro.
+ Note that <STRONG>syncok</STRONG> may be a macro.
</PRE><H2><a name="h2-BUGS">BUGS</a></H2><PRE>
- The subwindow functions (<B>subwin</B>, <B>derwin</B>, <B>mvderwin</B>, <B>wsyncup</B>, <B>wsyncdown</B>,
- <B>wcursyncup</B>, <B>syncok</B>) are flaky, incompletely implemented, and not well
+ The subwindow functions (<STRONG>subwin</STRONG>, <STRONG>derwin</STRONG>, <STRONG>mvderwin</STRONG>, <STRONG>wsyncup</STRONG>, <STRONG>wsyncdown</STRONG>,
+ <STRONG>wcursyncup</STRONG>, <STRONG>syncok</STRONG>) are flaky, incompletely implemented, and not well
tested.
- The System V curses documentation is very unclear about what <B>wsyncup</B>
- and <B>wsyncdown</B> actually do. It seems to imply that they are only sup-
+ The System V curses documentation is very unclear about what <STRONG>wsyncup</STRONG>
+ and <STRONG>wsyncdown</STRONG> actually do. It seems to imply that they are only sup-
posed to touch exactly those lines that are affected by ancestor
- changes. The language here, and the behavior of the <B>curses</B> implementa-
+ changes. The language here, and the behavior of the <STRONG>curses</STRONG> implementa-
tion, is patterned on the XPG4 curses standard. The weaker XPG4 spec
may result in slower updates.
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_refresh.3X.html">curs_refresh(3X)</A></B>, <B><A HREF="curs_touch.3X.html">curs_touch(3X)</A></B>, <B><A HREF="curs_variables.3X.html">curs_variables(3X)</A></B>
+ <STRONG><A HREF="ncurses.3x.html">curses(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>
- <B><A HREF="curs_window.3X.html">curs_window(3X)</A></B>
+ <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
</PRE>
<div class="nav">
<ul>
projects / ncurses.git / blobdiff