Ada95/html/man/curs_window.3x.html

   1 <HTML>
   2 <BODY>
   3 <PRE>
   4        <STRONG>newwin</STRONG>,  <STRONG>delwin</STRONG>,  <STRONG>mvwin</STRONG>, <STRONG>subwin</STRONG>, <STRONG>derwin</STRONG>, <STRONG>mvderwin</STRONG>, <STRONG>dupwin</STRONG>,
   5        <STRONG>wsyncup</STRONG>, <STRONG>syncok</STRONG>, <STRONG>wcursyncup</STRONG>,  <STRONG>wsyncdown</STRONG>  -  create  <STRONG>curses</STRONG>
   6        windows
   7
   8
   9 </PRE>
  10 <H2>SYNOPSIS</H2><PRE>
  11        <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
  12
  13        <STRONG>WINDOW</STRONG> <STRONG>*newwin(int</STRONG> <STRONG>nlines,</STRONG> <STRONG>int</STRONG> <STRONG>ncols,</STRONG> <STRONG>int</STRONG> <STRONG>begin_y,</STRONG>
  14              <STRONG>int</STRONG> <STRONG>begin_x);</STRONG>
  15        <STRONG>int</STRONG> <STRONG>delwin(WINDOW</STRONG> <STRONG>*win);</STRONG>
  16        <STRONG>int</STRONG> <STRONG>mvwin(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
  17        <STRONG>WINDOW</STRONG> <STRONG>*subwin(WINDOW</STRONG> <STRONG>*orig,</STRONG> <STRONG>int</STRONG> <STRONG>nlines,</STRONG> <STRONG>int</STRONG> <STRONG>ncols,</STRONG>
  18              <STRONG>int</STRONG> <STRONG>begin_y,</STRONG> <STRONG>int</STRONG> <STRONG>begin_x);</STRONG>
  19        <STRONG>WINDOW</STRONG> <STRONG>*derwin(WINDOW</STRONG> <STRONG>*orig,</STRONG> <STRONG>int</STRONG> <STRONG>nlines,</STRONG> <STRONG>int</STRONG> <STRONG>ncols,</STRONG>
  20              <STRONG>int</STRONG> <STRONG>begin_y,</STRONG> <STRONG>int</STRONG> <STRONG>begin_x);</STRONG>
  21        <STRONG>int</STRONG> <STRONG>mvderwin(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>par_y,</STRONG> <STRONG>int</STRONG> <STRONG>par_x);</STRONG>
  22        <STRONG>WINDOW</STRONG> <STRONG>*dupwin(WINDOW</STRONG> <STRONG>*win);</STRONG>
  23        <STRONG>void</STRONG> <STRONG>wsyncup(WINDOW</STRONG> <STRONG>*win);</STRONG>
  24        <STRONG>int</STRONG> <STRONG>syncok(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>bool</STRONG> <STRONG>bf);</STRONG>
  25        <STRONG>void</STRONG> <STRONG>wcursyncup(WINDOW</STRONG> <STRONG>*win);</STRONG>
  26        <STRONG>void</STRONG> <STRONG>wsyncdown(WINDOW</STRONG> <STRONG>*win);</STRONG>
  27
  28
  29 </PRE>
  30 <H2>DESCRIPTION</H2><PRE>
  31        Calling <STRONG>newwin</STRONG> creates and returns a pointer to a new win-
  32        dow with the given number of lines and columns.  The upper
  33        left-hand  corner of the window is at line <EM>begin</EM>_<EM>y</EM>, column
  34        <EM>begin</EM>_<EM>x</EM>.  If either <EM>nlines</EM> or <EM>ncols</EM> is zero, they  default
  35        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
  36        window is created by calling <STRONG>newwin(0,0,0,0)</STRONG>.
  37
  38        Calling <STRONG>delwin</STRONG> deletes the named window, freeing all  mem-
  39        ory  associated  with  it  (it does not actually erase the
  40        window's screen image).  Subwindows must be deleted before
  41        the main window can be deleted.
  42
  43        Calling <STRONG>mvwin</STRONG> moves the window so that the upper left-hand
  44        corner is at position (<EM>x</EM>, <EM>y</EM>).  If the move would cause the
  45        window to be off the screen, it is an error and the window
  46        is not moved.  Moving subwindows is allowed, but should be
  47        avoided.
  48
  49        Calling <STRONG>subwin</STRONG> creates and returns a pointer to a new win-
  50        dow with the given number of lines, <EM>nlines</EM>,  and  columns,
  51        <EM>ncols</EM>.   The  window  is at position (<EM>begin</EM>_<EM>y</EM>, <EM>begin</EM>_<EM>x</EM>) on
  52        the screen.  (This position is relative to the screen, and
  53        not to the window <EM>orig</EM>.)  The window is made in the middle
  54        of the window <EM>orig</EM>, so that changes  made  to  one  window
  55        will  affect  both  windows.   The subwindow shares memory
  56        with the window <EM>orig</EM>.  When using this routine, it is nec-
  57        essary  to call <STRONG>touchwin</STRONG> or <STRONG>touchline</STRONG> on <EM>orig</EM> before call-
  58        ing <STRONG>wrefresh</STRONG> on the subwindow.
  59
  60        dow <EM>orig</EM> rather than the screen.  There is  no  difference
  61        between the subwindows and the derived windows.
  62
  63        Calling  <STRONG>mvderwin</STRONG>  moves  a  derived window (or subwindow)
  64        inside its parent window.  The screen-relative  parameters
  65        of  the  window  are not changed.  This routine is used to
  66        display different parts of the parent window at  the  same
  67        physical position on the screen.
  68
  69        Calling  <STRONG>dupwin</STRONG>  creates  an exact duplicate of the window
  70        <EM>win</EM>.
  71
  72        Calling <STRONG>wsyncup</STRONG> touches all locations in ancestors of  <EM>win</EM>
  73        that  are changed in <EM>win</EM>.  If <STRONG>syncok</STRONG> is called with second
  74        argument <STRONG>TRUE</STRONG> then <STRONG>wsyncup</STRONG> is called  automatically  when-
  75        ever there is a change in the window.
  76
  77        The  <STRONG>wsyncdown</STRONG>  routine  touches each location in <EM>win</EM> that
  78        has been touched in any of  its  ancestor  windows.   This
  79        routine  is  called by <STRONG>wrefresh</STRONG>, so it should almost never
  80        be necessary to call it manually.
  81
  82        The routine <STRONG>wcursyncup</STRONG> updates the current cursor position
  83        of  all the ancestors of the window to reflect the current
  84        cursor position of the window.
  85
  86
  87 </PRE>
  88 <H2>RETURN VALUE</H2><PRE>
  89        Routines that return an integer  return  the  integer  <STRONG>ERR</STRONG>
  90        upon failure and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value
  91        other than <STRONG>ERR</STRONG>") upon successful completion.
  92
  93        <STRONG>delwin</STRONG> returns the integer <STRONG>ERR</STRONG> upon failure  and  <STRONG>OK</STRONG>  upon
  94        successful completion.
  95
  96        Routines that return pointers return <STRONG>NULL</STRONG> on error.
  97
  98
  99 </PRE>
 100 <H2>NOTES</H2><PRE>
 101        If  many small changes are made to the window, the <STRONG>wsyncup</STRONG>
 102        option could degrade performance.
 103
 104        Note that <STRONG>syncok</STRONG> may be a macro.
 105
 106
 107 </PRE>
 108 <H2>BUGS</H2><PRE>
 109        The subwindow functions (<EM>subwin</EM>, <EM>derwin</EM>,  <EM>mvderwin</EM>,  <STRONG>wsyn-</STRONG>
 110        <STRONG>cup</STRONG>,  <STRONG>wsyncdown</STRONG>,  <STRONG>wcursyncup</STRONG>,  <STRONG>syncok</STRONG>)  are  flaky, incom-
 111        pletely implemented, and not well tested.
 112
 113        The System V curses documentation is  very  unclear  about
 114        what <STRONG>wsyncup</STRONG> and <STRONG>wsyncdown</STRONG> actually do.  It seems to imply
 115        that they are only supposed to touch exactly  those  lines
 116        that are affected by ancestor changes.  The language here,
 117        and the behavior of the  <STRONG>curses</STRONG>  implementation,  is  pat-
 118
 119
 120 </PRE>
 121 <H2>PORTABILITY</H2><PRE>
 122        The XSI Curses standard, Issue  4  describes  these  func-
 123        tions.
 124
 125
 126 </PRE>
 127 <H2>SEE ALSO</H2><PRE>
 128        <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>
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174 </PRE>
 175 </BODY>
 176 </HTML>