X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_pad.3x.html;h=1619548451ef4e62bc4a83cf0f291501f7cbc90d;hp=77e534c17c071a3904865a46653a153b5007d72a;hb=71c0306f0824ef2b10c4c5813fb003db48f3012e;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/doc/html/man/curs_pad.3x.html b/doc/html/man/curs_pad.3x.html index 77e534c1..16195484 100644 --- a/doc/html/man/curs_pad.3x.html +++ b/doc/html/man/curs_pad.3x.html @@ -1,7 +1,7 @@ @@ -40,14 +40,14 @@ 
 
-curs_pad(3x)                                         curs_pad(3x)
+curs_pad(3x)                                               curs_pad(3x)

NAME

-       newpad,   subpad,   prefresh,   pnoutrefresh,   pechochar,
+       newpad, subpad, prefresh, pnoutrefresh, pechochar,
        pecho_wchar - create and display curses pads
 
 
@@ -74,10 +74,10 @@
        it is not restricted by the screen size, and is not neces-
        sarily associated with a particular part  of  the  screen.
        Pads can be used when a large window is needed, and only a
-       part of the window will be on  the  screen  at  one  time.
-       Automatic refreshes of pads (e.g., from scrolling or echo-
-       ing of input) do not occur.  It is not legal to call  wre-
-       fresh  with a pad as an argument; the routines prefresh or
+       part of the window will be on the screen at one time.  Au-
+       tomatic refreshes of pads (e.g., from scrolling or echoing
+       of input) do not occur.  It is not legal to call  wrefresh
+       with  a  pad  as  an  argument;  the  routines prefresh or
        pnoutrefresh should be called instead.   Note  that  these
        routines require additional parameters to specify the part
        of the pad to be displayed and the location on the  screen
@@ -89,24 +89,24 @@
        screen coordinates, the window is  at  position  (begin_x,
        begin_y)  on the pad.  The window is made in the middle of
        the window orig, so that changes made to one window affect
-       both  windows.   During  the  use of this routine, it will
-       often be necessary to call touchwin or touchline  on  orig
-       before calling prefresh.
+       both windows.  During the use of this routine, it will of-
+       ten be necessary to call touchwin or touchline on orig be-
+       fore calling prefresh.
 
        The  prefresh  and  pnoutrefresh routines are analogous to
        wrefresh and wnoutrefresh except that they relate to  pads
        instead  of windows.  The additional parameters are needed
        to indicate what part of the pad and screen are  involved.
-       pminrow  and pmincol specify the upper left-hand corner of
-       the rectangle to be displayed in the pad.  sminrow,  smin-
-       col, smaxrow, and smaxcol specify the edges of the rectan-
-       gle to be displayed on the screen.  The  lower  right-hand
-       corner of the rectangle to be displayed in the pad is cal-
-       culated from the screen coordinates, since the  rectangles
-       must  be  the same size.  Both rectangles must be entirely
-       contained within their  respective  structures.   Negative
-       values  of  pminrow,  pmincol,  sminrow,  or  smincol  are
-       treated as if they were zero.
+       The pminrow and pmincol parameters specify the upper left-
+       hand corner of the rectangle to be displayed in  the  pad.
+       The  sminrow,  smincol,  smaxrow,  and  smaxcol parameters
+       specify the edges of the rectangle to be displayed on  the
+       screen.   The  lower right-hand corner of the rectangle to
+       be displayed in the pad is calculated from the screen  co-
+       ordinates,  since  the  rectangles  must be the same size.
+       Both rectangles must be entirely  contained  within  their
+       respective  structures.  Negative values of pminrow, pmin-
+       col, sminrow, or smincol are treated as if they were zero.
 
        The pechochar routine is functionally equivalent to a call
        to  addch  followed by a call to refresh, a call to waddch
@@ -114,10 +114,10 @@
        lowed  by  a  call to prefresh.  The knowledge that only a
        single character is being output is taken into  considera-
        tion  and, for non-control characters, a considerable per-
-       formance gain  might  be  seen  by  using  these  routines
-       instead  of  their equivalents.  In the case of pechochar,
-       the last location of the pad on the screen is  reused  for
-       the arguments to prefresh.
+       formance gain might be seen by using  these  routines  in-
+       stead of their equivalents.  In the case of pechochar, the
+       last location of the pad on the screen is reused  for  the
+       arguments to prefresh.
 
        The  pecho_wchar  function is the analogous wide-character
        form of pechochar.  It outputs one character to a pad  and
@@ -134,6 +134,26 @@
        Routines that return pointers return NULL  on  error,  and
        set errno to ENOMEM.
 
+       X/Open  does not define any error conditions.  In this im-
+       plementation
+
+              prefresh and pnoutrefresh
+                   return an error if the window pointer is null,
+                   or if the window is not really a pad or if the
+                   area to refresh extends off-screen or  if  the
+                   minimum coordinates are greater than the maxi-
+                   mum.
+
+              pechochar
+                   returns an error if the window is not really a
+                   pad,  and the associated call to wechochar re-
+                   turns an error.
+
+              pecho_wchar
+                   returns an error if the window is not really a
+                   pad,  and  the  associated call to wecho_wchar
+                   returns an error.
+

NOTES

@@ -142,18 +162,18 @@

PORTABILITY

-       The  XSI  Curses  standard,  Issue 4 describes these func-
+       The XSI Curses standard, Issue  4  describes  these  func-
        tions.

SEE ALSO

-       curses(3x),       curs_refresh(3x),        curs_touch(3x),
-       curs_addch(3x).
+       curses(3x),  curs_refresh(3x),  curs_touch(3x),  curs_add-
+       ch(3x).
 
 
 
-                                                     curs_pad(3x)
+                                                           curs_pad(3x)