X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_inch.3x.html;h=397664a1146cdaf82206371e01674694e6d30377;hp=e360994a93edefeebd433b5b8af0579a952aec45;hb=81304798ee736c467839c779c9ca5dca48db7bea;hpb=ed646e3f683083e787c6ba773364401dc9fa9d40 diff --git a/doc/html/man/curs_inch.3x.html b/doc/html/man/curs_inch.3x.html index e360994a..397664a1 100644 --- a/doc/html/man/curs_inch.3x.html +++ b/doc/html/man/curs_inch.3x.html @@ -1,7 +1,8 @@ - - + curs_inch 3x - + @@ -55,15 +56,16 @@ #include <curses.h> chtype inch(void); - chtype winch(WINDOW *win); - chtype mvinch(int y, int x); - chtype mvwinch(WINDOW *win, int y, int x); + chtype winch(WINDOW *win); + + chtype mvinch(int y, int x); + chtype mvwinch(WINDOW *win, int y, int x);

DESCRIPTION

        These routines return the character, of type  chtype,  at  the  current
-       position in the named window.  If any attributes are set for that posi-
-       tion, their values  are  OR'ed  into  the  value  returned.   Constants
+       position  in  the  named  window.   If  any attributes are set for that
+       position, their values are OR'ed into the  value  returned.   Constants
        defined  in <curses.h> can be used with the & (logical AND) operator to
        extract the character or attributes alone.
 
@@ -82,6 +84,10 @@
        wmove, and return an error if the position is outside the window, or if
        the window pointer is null.
 
+       The  winch  function  does  not  return an error if the window contains
+       characters larger than 8-bits (255).  Only the low-order 8 bits of  the
+       character are used by winch.
+

NOTES

        Note that all of these routines may be macros.
@@ -90,12 +96,40 @@

PORTABILITY

        These functions are described in the XSI Curses standard, Issue 4.
 
+       Very  old systems (before standardization) provide a different function
+       with the same name:
+
+       o   The winch function was part of the  original  BSD  curses  library,
+           which   stored   a  7-bit  character  combined  with  the  standout
+           attribute.
+
+           In BSD curses, winch returned only the character  (as  an  integer)
+           with the standout attribute removed.
+
+       o   System  V  curses  added support for several video attributes which
+           could be combined with characters in the window.
+
+           Reflecting this improvement, the function was altered to return the
+           character combined with all video attributes in a chtype value.
+
+       X/Open Curses does not specify the size and layout of attributes, color
+       and character values in chtype; it is  implementation-dependent.   This
+       implementation  uses 8 bits for character values.  An application using
+       more bits,  e.g.,  a  Unicode  value,  should  use  the  wide-character
+       equivalents to these functions.
+

SEE ALSO

-       curses(3x).
+       curses(3x)
+            gives an overview of the WINDOW and chtype data types.
+
+       curs_attr(3x)
+            goes  into  more  detail,  pointing  out  portability problems and
+            constraints on the use of chtype for returning window information.
 
-       Comparable  functions  in  the  wide-character  (ncursesw)  library are
-       described in curs_in_wch(3x).
+       curs_in_wch(3x)
+            describes comparable functions for the  wide-character  (ncursesw)
+            library.