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

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