diff options
Diffstat (limited to 'ncurses-5.2/doc/html/man/curs_window.3x.html')
-rw-r--r-- | ncurses-5.2/doc/html/man/curs_window.3x.html | 190 |
1 files changed, 0 insertions, 190 deletions
diff --git a/ncurses-5.2/doc/html/man/curs_window.3x.html b/ncurses-5.2/doc/html/man/curs_window.3x.html deleted file mode 100644 index 1fae384..0000000 --- a/ncurses-5.2/doc/html/man/curs_window.3x.html +++ /dev/null @@ -1,190 +0,0 @@ -<HTML> -<BODY> -<PRE> -<!-- Manpage converted by man2html 3.0.1 --> - -</PRE> -<H2>NAME</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 - - -</PRE> -<H2>SYNOPSIS</H2><PRE> - <B>#include</B> <B><curses.h></B> - - <B>WINDOW</B> <B>*newwin(int</B> <B>nlines,</B> <B>int</B> <B>ncols,</B> <B>int</B> <B>begin_y,</B> - <B>int</B> <B>begin_x);</B> - <B>int</B> <B>delwin(WINDOW</B> <B>*win);</B> - <B>int</B> <B>mvwin(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x);</B> - <B>WINDOW</B> <B>*subwin(WINDOW</B> <B>*orig,</B> <B>int</B> <B>nlines,</B> <B>int</B> <B>ncols,</B> - <B>int</B> <B>begin_y,</B> <B>int</B> <B>begin_x);</B> - <B>WINDOW</B> <B>*derwin(WINDOW</B> <B>*orig,</B> <B>int</B> <B>nlines,</B> <B>int</B> <B>ncols,</B> - <B>int</B> <B>begin_y,</B> <B>int</B> <B>begin_x);</B> - <B>int</B> <B>mvderwin(WINDOW</B> <B>*win,</B> <B>int</B> <B>par_y,</B> <B>int</B> <B>par_x);</B> - <B>WINDOW</B> <B>*dupwin(WINDOW</B> <B>*win);</B> - <B>void</B> <B>wsyncup(WINDOW</B> <B>*win);</B> - <B>int</B> <B>syncok(WINDOW</B> <B>*win,</B> <B>bool</B> <B>bf);</B> - <B>void</B> <B>wcursyncup(WINDOW</B> <B>*win);</B> - <B>void</B> <B>wsyncdown(WINDOW</B> <B>*win);</B> - - -</PRE> -<H2>DESCRIPTION</H2><PRE> - Calling <B>newwin</B> 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 <I>begin</I>_<I>y</I>, column - <I>begin</I>_<I>x</I>. 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>. A new full-screen - window is created by calling <B>newwin(0,0,0,0)</B>. - - Calling <B>delwin</B> deletes the named window, freeing all mem- - ory associated with it (it does not actually erase the - window's screen image). Subwindows must be deleted before - the main window can be deleted. - - 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 screen, it is an error and the window - is not moved. Moving subwindows is allowed, but should be - avoided. - - Calling <B>subwin</B> creates and returns a pointer to a new win- - dow 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. (This position is relative to the screen, and - not to the window <I>orig</I>.) The window is made in the middle - of the window <I>orig</I>, so that changes made to one window - will affect both windows. The subwindow shares memory - with the window <I>orig</I>. When using this routine, it is nec- - essary to call <B>touchwin</B> or <B>touchline</B> on <I>orig</I> before call- - ing <B>wrefresh</B> on the subwindow. - - 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 win- - dow <I>orig</I> 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 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. - - Calling <B>dupwin</B> creates an exact duplicate of the window - <I>win</I>. - - 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 when- - ever there is a change in the window. - - 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>wrefresh</B>, so it should almost never - be necessary to call it manually. - - The routine <B>wcursyncup</B> 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 <B>ERR</B> - upon failure and <B>OK</B> (SVr4 only specifies "an integer value - other than <B>ERR</B>") upon successful completion. - - <B>delwin</B> returns the integer <B>ERR</B> upon failure and <B>OK</B> upon - successful completion. - - Routines that return pointers return <B>NULL</B> on error. - - -</PRE> -<H2>NOTES</H2><PRE> - If many small changes are made to the window, the <B>wsyncup</B> - option could degrade performance. - - Note that <B>syncok</B> may be a macro. - - -</PRE> -<H2>BUGS</H2><PRE> - The subwindow functions (<I>subwin</I>, <I>derwin</I>, <I>mvderwin</I>, <B>wsyn-</B> - <B>cup</B>, <B>wsyncdown</B>, <B>wcursyncup</B>, <B>syncok</B>) are flaky, incom- - pletely 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 supposed to touch exactly those lines - that are affected by ancestor changes. The language here, - and the behavior of the <B>curses</B> 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> - <B><A HREF="ncurses.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> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -</PRE> -<HR> -<ADDRESS> -Man(1) output converted with -<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> -</ADDRESS> -</BODY> -</HTML> |