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

   1 <!--
   2   ****************************************************************************
   3   * Copyright (c) 1998-2014,2015 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.19 2015/07/21 08:25:23 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 http://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>
  49 <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>,
  51        <STRONG>wsyncup</STRONG>, <STRONG>syncok</STRONG>, <STRONG>wcursyncup</STRONG>, <STRONG>wsyncdown</STRONG> - create <STRONG>curses</STRONG>
  52        windows
  53
  54
  55 </PRE>
  56 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  57        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  58
  59        <STRONG>WINDOW</STRONG> <STRONG>*newwin(</STRONG>
  60              <STRONG>int</STRONG> <EM>nlines</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>ncols</EM><STRONG>,</STRONG>
  61              <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>
  62        <STRONG>int</STRONG> <STRONG>delwin(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
  63        <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>
  64        <STRONG>WINDOW</STRONG> <STRONG>*subwin(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>WINDOW</STRONG> <STRONG>*derwin(WINDOW</STRONG> <STRONG>*</STRONG><EM>orig</EM><STRONG>,</STRONG>
  68              <STRONG>int</STRONG> <EM>nlines</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>ncols</EM><STRONG>,</STRONG>
  69              <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>
  70        <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>
  71        <STRONG>WINDOW</STRONG> <STRONG>*dupwin(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
  72        <STRONG>void</STRONG> <STRONG>wsyncup(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
  73        <STRONG>int</STRONG> <STRONG>syncok(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
  74        <STRONG>void</STRONG> <STRONG>wcursyncup(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
  75        <STRONG>void</STRONG> <STRONG>wsyncdown(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
  76
  77
  78 </PRE>
  79 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  80
  81 </PRE>
  82 <H3><a name="h3-newwin">newwin</a></H3><PRE>
  83        Calling <STRONG>newwin</STRONG> creates and returns a pointer to a new win-
  84        dow with the given number of lines and columns.  The upper
  85        left-hand corner of the window is at
  86               line <EM>begin</EM>_<EM>y</EM>,
  87               column <EM>begin</EM>_<EM>x</EM>
  88
  89        If either <EM>nlines</EM> or <EM>ncols</EM> is zero, they default to
  90               <STRONG>LINES</STRONG> <STRONG>-</STRONG> <EM>begin</EM>_<EM>y</EM> and
  91               <STRONG>COLS</STRONG> <STRONG>-</STRONG> <EM>begin</EM>_<EM>x</EM>.
  92
  93        A   new   full-screen   window   is   created  by  calling
  94        <STRONG>newwin(0,0,0,0)</STRONG>.
  95
  96
  97 </PRE>
  98 <H3><a name="h3-delwin">delwin</a></H3><PRE>
  99        Calling <STRONG>delwin</STRONG> deletes the named window, freeing all memo-
 100        ry associated with it (it does not actually erase the win-
 101        dow's screen image).  Subwindows must  be  deleted  before
 102        the main window can be deleted.
 103
 104
 105 </PRE>
 106 <H3><a name="h3-mvwin">mvwin</a></H3><PRE>
 107        Calling <STRONG>mvwin</STRONG> moves the window so that the upper left-hand
 108        corner is at position (<EM>x</EM>, <EM>y</EM>).  If the move would cause the
 109        window to be off the screen, it is an error and the window
 110        is not moved.  Moving subwindows is allowed, but should be
 111        avoided.
 112
 113
 114 </PRE>
 115 <H3><a name="h3-subwin">subwin</a></H3><PRE>
 116        Calling <STRONG>subwin</STRONG> creates and returns a pointer to a new win-
 117        dow with the given number of lines, <EM>nlines</EM>,  and  columns,
 118        <EM>ncols</EM>.   The  window  is at position (<EM>begin</EM>_<EM>y</EM>, <EM>begin</EM>_<EM>x</EM>) on
 119        the screen.  The subwindow shares memory with  the  window
 120        <EM>orig</EM>,  so that changes made to one window will affect both
 121        windows.  When using this routine, it is necessary to call
 122        <STRONG>touchwin</STRONG>  or  <STRONG>touchline</STRONG> on <EM>orig</EM> before calling <STRONG>wrefresh</STRONG> on
 123        the subwindow.
 124
 125
 126 </PRE>
 127 <H3><a name="h3-derwin">derwin</a></H3><PRE>
 128        Calling <STRONG>derwin</STRONG> is the same as calling <STRONG>subwin,</STRONG> except  that
 129        <EM>begin</EM>_<EM>y</EM> and <EM>begin</EM>_<EM>x</EM> are relative to the origin of the win-
 130        dow <EM>orig</EM> rather than the screen.  There is  no  difference
 131        between the subwindows and the derived windows.
 132
 133        Calling <STRONG>mvderwin</STRONG> moves a derived window (or subwindow) in-
 134        side its parent window.  The screen-relative parameters of
 135        the  window are not changed.  This routine is used to dis-
 136        play different parts of the  parent  window  at  the  same
 137        physical position on the screen.
 138
 139
 140 </PRE>
 141 <H3><a name="h3-dupwin">dupwin</a></H3><PRE>
 142        Calling  <STRONG>dupwin</STRONG>  creates  an exact duplicate of the window
 143        <EM>win</EM>.
 144
 145
 146 </PRE>
 147 <H3><a name="h3-wsyncup">wsyncup</a></H3><PRE>
 148        Calling <STRONG>wsyncup</STRONG> touches all locations in ancestors of  <EM>win</EM>
 149        that  are changed in <EM>win</EM>.  If <STRONG>syncok</STRONG> is called with second
 150        argument <STRONG>TRUE</STRONG> then <STRONG>wsyncup</STRONG> is called automatically whenev-
 151        er there is a change in the window.
 152
 153
 154 </PRE>
 155 <H3><a name="h3-wsyncdown">wsyncdown</a></H3><PRE>
 156        The  <STRONG>wsyncdown</STRONG>  routine  touches each location in <EM>win</EM> that
 157        has been touched in any of  its  ancestor  windows.   This
 158        routine  is  called by <STRONG>wrefresh</STRONG>, so it should almost never
 159        be necessary to call it manually.
 160
 161
 162 </PRE>
 163 <H3><a name="h3-wcursyncup">wcursyncup</a></H3><PRE>
 164        The routine <STRONG>wcursyncup</STRONG> updates the current cursor position
 165        of  all the ancestors of the window to reflect the current
 166        cursor position of the window.
 167
 168
 169 </PRE>
 170 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 171        Routines that return an integer return the integer <STRONG>ERR</STRONG> up-
 172        on  failure  and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value
 173        other than <STRONG>ERR</STRONG>") upon successful completion.
 174
 175        Routines that return pointers return <STRONG>NULL</STRONG> on error.
 176
 177        X/Open defines no error conditions.  In  this  implementa-
 178        tion
 179
 180        <STRONG>delwin</STRONG>
 181             returns an error if the window pointer is null, or if
 182             the window is the parent of another window.
 183
 184        <STRONG>derwin</STRONG>
 185             returns an error if  the  parent  window  pointer  is
 186             null,  or  if  any  of its ordinates or dimensions is
 187             negative, or if the resulting window does not fit in-
 188             side the parent window.
 189
 190        <STRONG>dupwin</STRONG>
 191             returns an error if the window pointer is null.
 192
 193             This implementation also maintains a list of windows,
 194             and checks that the pointer passed to <STRONG>delwin</STRONG>  is  one
 195             that it created, returning an error if it was not..
 196
 197        <STRONG>mvderwin</STRONG>
 198             returns an error if the window pointer is null, or if
 199             some part of the window would be placed off-screen.
 200
 201        <STRONG>mvwin</STRONG>
 202             returns an error if the window pointer is null, or if
 203             the  window  is  really a pad, or if some part of the
 204             window would be placed off-screen.
 205
 206        <STRONG>newwin</STRONG>
 207             will fail if either of  its  beginning  ordinates  is
 208             negative, or if either the number of lines or columns
 209             is negative.
 210
 211        <STRONG>syncok</STRONG>
 212             returns an error if the window pointer is null.
 213
 214        <STRONG>subwin</STRONG>
 215             returns an error if  the  parent  window  pointer  is
 216             null,  or  if  any  of its ordinates or dimensions is
 217             negative, or if the resulting window does not fit in-
 218             side the parent window.
 219
 220        The  functions which return a window pointer may also fail
 221        if there is insufficient memory for its  data  structures.
 222        Any  of  these  functions  will fail if the screen has not
 223        been initialized, i.e., with <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG>.
 224
 225
 226 </PRE>
 227 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 228        If many small changes are made to the window, the  <STRONG>wsyncup</STRONG>
 229        option could degrade performance.
 230
 231        Note that <STRONG>syncok</STRONG> may be a macro.
 232
 233
 234 </PRE>
 235 <H2><a name="h2-BUGS">BUGS</a></H2><PRE>
 236        The  subwindow  functions (<EM>subwin</EM>, <EM>derwin</EM>, <EM>mvderwin</EM>, <STRONG>wsyn-</STRONG>
 237        <STRONG>cup</STRONG>, <STRONG>wsyncdown</STRONG>, <STRONG>wcursyncup</STRONG>, <STRONG>syncok</STRONG>) are flaky, incomplete-
 238        ly implemented, and not well tested.
 239
 240        The  System  V  curses documentation is very unclear about
 241        what <STRONG>wsyncup</STRONG> and <STRONG>wsyncdown</STRONG> actually do.  It seems to imply
 242        that  they  are only supposed to touch exactly those lines
 243        that are affected by ancestor changes.  The language here,
 244        and  the  behavior  of  the <STRONG>curses</STRONG> implementation, is pat-
 245        terned on the XPG4 curses standard.  The weaker XPG4  spec
 246        may result in slower updates.
 247
 248
 249 </PRE>
 250 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 251        The  XSI  Curses  standard,  Issue 4 describes these func-
 252        tions.
 253
 254
 255 </PRE>
 256 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 257        <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>curs_vari-</STRONG>
 258        <STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG>
 259
 260
 261
 262                                                         <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
 263 </PRE>
 264 <div class="nav">
 265 <ul>
 266 <li><a href="#h2-NAME">NAME</a></li>
 267 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 268 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
 269 <ul>
 270 <li><a href="#h3-newwin">newwin</a></li>
 271 <li><a href="#h3-delwin">delwin</a></li>
 272 <li><a href="#h3-mvwin">mvwin</a></li>
 273 <li><a href="#h3-subwin">subwin</a></li>
 274 <li><a href="#h3-derwin">derwin</a></li>
 275 <li><a href="#h3-dupwin">dupwin</a></li>
 276 <li><a href="#h3-wsyncup">wsyncup</a></li>
 277 <li><a href="#h3-wsyncdown">wsyncdown</a></li>
 278 <li><a href="#h3-wcursyncup">wcursyncup</a></li>
 279 </ul>
 280 </li>
 281 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 282 <li><a href="#h2-NOTES">NOTES</a></li>
 283 <li><a href="#h2-BUGS">BUGS</a></li>
 284 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 285 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 286 </ul>
 287 </div>
 288 </BODY>
 289 </HTML>