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

   1 <!--
   2   ****************************************************************************
   3   * Copyright (c) 1998-2015,2016 Free Software Foundation, Inc.              *
   4   *                                                                          *
   5   * Permission is hereby granted, free of charge, to any person obtaining a  *
   6   * copy of this software and associated documentation files (the            *
   7   * "Software"), to deal in the Software without restriction, including      *
   8   * without limitation the rights to use, copy, modify, merge, publish,      *
   9   * distribute, distribute with modifications, sublicense, and/or sell       *
  10   * copies of the Software, and to permit persons to whom the Software is    *
  11   * furnished to do so, subject to the following conditions:                 *
  12   *                                                                          *
  13   * The above copyright notice and this permission notice shall be included  *
  14   * in all copies or substantial portions of the Software.                   *
  15   *                                                                          *
  16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23   *                                                                          *
  24   * Except as contained in this notice, the name(s) of the above copyright   *
  25   * holders shall not be used in advertising or otherwise to promote the     *
  26   * sale, use or other dealings in this Software without prior written       *
  27   * authorization.                                                           *
  28   ****************************************************************************
  29   * @Id: curs_window.3x,v 1.20 2016/10/15 17:26:09 tom Exp @
  30 -->
  31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  32 <HTML>
  33 <HEAD>
  34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  35 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  36 <TITLE>curs_window 3x</TITLE>
  37 <link rev=made href="mailto:bug-ncurses@gnu.org">
  38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  39 </HEAD>
  40 <BODY>
  41 <H1 class="no-header">curs_window 3x</H1>
  42 <PRE>
  43 <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>                                                <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
  44
  45
  46
  47
  48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  49        <STRONG>newwin</STRONG>, <STRONG>delwin</STRONG>, <STRONG>mvwin</STRONG>, <STRONG>subwin</STRONG>, <STRONG>derwin</STRONG>, <STRONG>mvderwin</STRONG>, <STRONG>dupwin</STRONG>, <STRONG>wsyncup</STRONG>,
  50        <STRONG>syncok</STRONG>, <STRONG>wcursyncup</STRONG>, <STRONG>wsyncdown</STRONG> - create <STRONG>curses</STRONG> windows
  51
  52
  53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  55
  56        <STRONG>WINDOW</STRONG> <STRONG>*newwin(</STRONG>
  57              <STRONG>int</STRONG> <EM>nlines</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>ncols</EM><STRONG>,</STRONG>
  58              <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>
  59        <STRONG>int</STRONG> <STRONG>delwin(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
  60        <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>
  61        <STRONG>WINDOW</STRONG> <STRONG>*subwin(WINDOW</STRONG> <STRONG>*</STRONG><EM>orig</EM><STRONG>,</STRONG>
  62              <STRONG>int</STRONG> <EM>nlines</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>ncols</EM><STRONG>,</STRONG>
  63              <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>
  64        <STRONG>WINDOW</STRONG> <STRONG>*derwin(WINDOW</STRONG> <STRONG>*</STRONG><EM>orig</EM><STRONG>,</STRONG>
  65              <STRONG>int</STRONG> <EM>nlines</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>ncols</EM><STRONG>,</STRONG>
  66              <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>
  67        <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>
  68        <STRONG>WINDOW</STRONG> <STRONG>*dupwin(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
  69        <STRONG>void</STRONG> <STRONG>wsyncup(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
  70        <STRONG>int</STRONG> <STRONG>syncok(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
  71        <STRONG>void</STRONG> <STRONG>wcursyncup(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
  72        <STRONG>void</STRONG> <STRONG>wsyncdown(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
  73
  74
  75 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  76
  77 </PRE><H3><a name="h3-newwin">newwin</a></H3><PRE>
  78        Calling <STRONG>newwin</STRONG> creates and returns a pointer to a new window  with  the
  79        given  number  of lines and columns.  The upper left-hand corner of the
  80        window is at
  81               line <EM>begin</EM>_<EM>y</EM>,
  82               column <EM>begin</EM>_<EM>x</EM>
  83
  84        If either <EM>nlines</EM> or <EM>ncols</EM> is zero, they default to
  85               <STRONG>LINES</STRONG> <STRONG>-</STRONG> <EM>begin</EM>_<EM>y</EM> and
  86               <STRONG>COLS</STRONG> <STRONG>-</STRONG> <EM>begin</EM>_<EM>x</EM>.
  87
  88        A new full-screen window is created by calling <STRONG>newwin(0,0,0,0)</STRONG>.
  89
  90
  91 </PRE><H3><a name="h3-delwin">delwin</a></H3><PRE>
  92        Calling <STRONG>delwin</STRONG> deletes the named window, freeing all memory  associated
  93        with  it  (it does not actually erase the window's screen image).  Sub-
  94        windows must be deleted before the main window can be deleted.
  95
  96
  97 </PRE><H3><a name="h3-mvwin">mvwin</a></H3><PRE>
  98        Calling <STRONG>mvwin</STRONG> moves the window so that the upper left-hand corner is at
  99        position  (<EM>x</EM>,  <EM>y</EM>).   If  the  move would cause the window to be off the
 100        screen, it is an error and the window is not moved.  Moving  subwindows
 101        is allowed, but should be avoided.
 102
 103
 104 </PRE><H3><a name="h3-subwin">subwin</a></H3><PRE>
 105        Calling  <STRONG>subwin</STRONG>  creates and returns a pointer to a new window with the
 106        given number of lines, <EM>nlines</EM>, and columns, <EM>ncols</EM>.  The  window  is  at
 107        position (<EM>begin</EM>_<EM>y</EM>, <EM>begin</EM>_<EM>x</EM>) on the screen.  The subwindow shares memory
 108        with the window <EM>orig</EM>, so that changes made to one  window  will  affect
 109        both  windows.  When using this routine, it is necessary to call <STRONG>touch-</STRONG>
 110        <STRONG>win</STRONG> or <STRONG>touchline</STRONG> on <EM>orig</EM> before calling <STRONG>wrefresh</STRONG> on the subwindow.
 111
 112
 113 </PRE><H3><a name="h3-derwin">derwin</a></H3><PRE>
 114        Calling <STRONG>derwin</STRONG> is the same as calling <STRONG>subwin,</STRONG> except that  <EM>begin</EM>_<EM>y</EM>  and
 115        <EM>begin</EM>_<EM>x</EM>  are  relative to the origin of the window <EM>orig</EM> rather than the
 116        screen.  There is no difference between the subwindows and the  derived
 117        windows.
 118
 119        Calling  <STRONG>mvderwin</STRONG> moves a derived window (or subwindow) inside its par-
 120        ent window.  The screen-relative  parameters  of  the  window  are  not
 121        changed.  This routine is used to display different parts of the parent
 122        window at the same physical position on the screen.
 123
 124
 125 </PRE><H3><a name="h3-dupwin">dupwin</a></H3><PRE>
 126        Calling <STRONG>dupwin</STRONG> creates an exact duplicate of the window <EM>win</EM>.
 127
 128
 129 </PRE><H3><a name="h3-wsyncup">wsyncup</a></H3><PRE>
 130        Calling <STRONG>wsyncup</STRONG> touches all locations in  ancestors  of  <EM>win</EM>  that  are
 131        changed  in  <EM>win</EM>.   If  <STRONG>syncok</STRONG> is called with second argument <STRONG>TRUE</STRONG> then
 132        <STRONG>wsyncup</STRONG> is called automatically whenever there is a change in the  win-
 133        dow.
 134
 135
 136 </PRE><H3><a name="h3-wsyncdown">wsyncdown</a></H3><PRE>
 137        The  <STRONG>wsyncdown</STRONG>  routine  touches  each  location  in  <EM>win</EM> that has been
 138        touched in any of its ancestor windows.  This routine is called by <STRONG>wre-</STRONG>
 139        <STRONG>fresh</STRONG>, so it should almost never be necessary to call it manually.
 140
 141
 142 </PRE><H3><a name="h3-wcursyncup">wcursyncup</a></H3><PRE>
 143        The  routine  <STRONG>wcursyncup</STRONG> updates the current cursor position of all the
 144        ancestors of the window to reflect the current cursor position  of  the
 145        window.
 146
 147
 148 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 149        Routines that return an integer return the integer <STRONG>ERR</STRONG> upon failure and
 150        <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than  <STRONG>ERR</STRONG>")  upon  suc-
 151        cessful completion.
 152
 153        Routines that return pointers return <STRONG>NULL</STRONG> on error.
 154
 155        X/Open defines no error conditions.  In this implementation
 156
 157        <STRONG>delwin</STRONG>
 158             returns  an  error if the window pointer is null, or if the window
 159             is the parent of another window.
 160
 161        <STRONG>derwin</STRONG>
 162             returns an error if the parent window pointer is null, or  if  any
 163             of  its  ordinates  or dimensions is negative, or if the resulting
 164             window does not fit inside the parent window.
 165
 166        <STRONG>dupwin</STRONG>
 167             returns an error if the window pointer is null.
 168
 169             This implementation also maintains a list of windows,  and  checks
 170             that  the pointer passed to <STRONG>delwin</STRONG> is one that it created, return-
 171             ing an error if it was not..
 172
 173        <STRONG>mvderwin</STRONG>
 174             returns an error if the window pointer is null, or if some part of
 175             the window would be placed off-screen.
 176
 177        <STRONG>mvwin</STRONG>
 178             returns  an  error if the window pointer is null, or if the window
 179             is really a pad, or if some part of the  window  would  be  placed
 180             off-screen.
 181
 182        <STRONG>newwin</STRONG>
 183             will  fail if either of its beginning ordinates is negative, or if
 184             either the number of lines or columns is negative.
 185
 186        <STRONG>syncok</STRONG>
 187             returns an error if the window pointer is null.
 188
 189        <STRONG>subwin</STRONG>
 190             returns an error if the parent window pointer is null, or  if  any
 191             of  its  ordinates  or dimensions is negative, or if the resulting
 192             window does not fit inside the parent window.
 193
 194        The functions which return a window pointer may also fail if  there  is
 195        insufficient  memory  for  its data structures.  Any of these functions
 196        will fail if the screen has not been initialized, i.e., with <STRONG>initscr</STRONG> or
 197        <STRONG>newterm</STRONG>.
 198
 199
 200 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 201        If  many small changes are made to the window, the <STRONG>wsyncup</STRONG> option could
 202        degrade performance.
 203
 204        Note that <STRONG>syncok</STRONG> may be a macro.
 205
 206
 207 </PRE><H2><a name="h2-BUGS">BUGS</a></H2><PRE>
 208        The subwindow functions (<STRONG>subwin</STRONG>, <STRONG>derwin</STRONG>, <STRONG>mvderwin</STRONG>, <STRONG>wsyncup</STRONG>,  <STRONG>wsyncdown</STRONG>,
 209        <STRONG>wcursyncup</STRONG>,  <STRONG>syncok</STRONG>)  are flaky, incompletely implemented, and not well
 210        tested.
 211
 212        The System V curses documentation is very unclear  about  what  <STRONG>wsyncup</STRONG>
 213        and  <STRONG>wsyncdown</STRONG>  actually do.  It seems to imply that they are only sup-
 214        posed to touch exactly  those  lines  that  are  affected  by  ancestor
 215        changes.  The language here, and the behavior of the <STRONG>curses</STRONG> implementa-
 216        tion, is patterned on the XPG4 curses standard.  The weaker  XPG4  spec
 217        may result in slower updates.
 218
 219
 220 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 221        The XSI Curses standard, Issue 4 describes these functions.
 222
 223
 224 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 225        <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>
 226
 227
 228
 229                                                                <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
 230 </PRE>
 231 <div class="nav">
 232 <ul>
 233 <li><a href="#h2-NAME">NAME</a></li>
 234 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 235 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
 236 <ul>
 237 <li><a href="#h3-newwin">newwin</a></li>
 238 <li><a href="#h3-delwin">delwin</a></li>
 239 <li><a href="#h3-mvwin">mvwin</a></li>
 240 <li><a href="#h3-subwin">subwin</a></li>
 241 <li><a href="#h3-derwin">derwin</a></li>
 242 <li><a href="#h3-dupwin">dupwin</a></li>
 243 <li><a href="#h3-wsyncup">wsyncup</a></li>
 244 <li><a href="#h3-wsyncdown">wsyncdown</a></li>
 245 <li><a href="#h3-wcursyncup">wcursyncup</a></li>
 246 </ul>
 247 </li>
 248 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 249 <li><a href="#h2-NOTES">NOTES</a></li>
 250 <li><a href="#h2-BUGS">BUGS</a></li>
 251 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 252 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 253 </ul>
 254 </div>
 255 </BODY>
 256 </HTML>