X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_inch.3x.html;h=b4bcd57bfb4359bfa054dc877c0023aa81f979cf;hb=67327e4e3b2121f8273fb73ec14ef234ed01231e;hp=c1c25140c47f091cf71f4bd238cc304dff04a665;hpb=b5be26931d6488adcb1ff8bc07df9de378ce0d27;p=ncurses.git diff --git a/doc/html/man/curs_inch.3x.html b/doc/html/man/curs_inch.3x.html index c1c25140..b4bcd57b 100644 --- a/doc/html/man/curs_inch.3x.html +++ b/doc/html/man/curs_inch.3x.html @@ -1,7 +1,8 @@ - - -curs_inch 3x - - + +curs_inch 3x 2023-12-16 ncurses 6.4 Library calls + + -

curs_inch 3x

+

curs_inch 3x 2023-12-16 ncurses 6.4 Library calls

-curs_inch(3x)                                                    curs_inch(3x)
+curs_inch(3x)                    Library calls                   curs_inch(3x)

NAME

-       inch,  winch,  mvinch,  mvwinch - get a character and attributes from a
-       curses window
+       inch, winch, mvinch, mvwinch - get a curses character from a window

SYNOPSIS

        #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
-       defined  in <curses.h> can be used with the & (logical AND) operator to
+       These  routines  return  the  character, of type chtype, at the current
+       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.

Attributes

-       The following bit-masks may  be  AND-ed  with  characters  returned  by
+       The  following  bit  masks  may  be  AND-ed with characters returned by
        winch.
 
-       A_CHARTEXT     Bit-mask to extract character
-       A_ATTRIBUTES   Bit-mask to extract attributes
-       A_COLOR        Bit-mask to extract color-pair field information
+       A_CHARTEXT     Bit mask to extract character
+       A_ATTRIBUTES   Bit mask to extract attributes
+       A_COLOR        Bit mask to extract color pair field information

RETURN VALUE

-       Functions  with  a  "mv"  prefix  first perform a cursor movement using
+       Functions with a "mv" prefix first  perform  a  cursor  movement  using
        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
+       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.
 
 
@@ -94,44 +95,45 @@

PORTABILITY

        These functions are described in the XSI Curses standard, Issue 4.
 
-       Very  old systems (before standardization) provide a different function
+       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
+       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)
+           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
+       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 equiva-
-       lents to these functions.
+       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)
-            gives an overview of the WINDOW and chtype data types.
+              gives an overview of the WINDOW and chtype data types.
 
        curs_attr(3x)
-            goes  into more detail, pointing out portability problems and con-
-            straints on the use of chtype for returning window information.
+              goes into more detail, pointing  out  portability  problems  and
+              constraints   on   the   use  of  chtype  for  returning  window
+              information.
 
        curs_in_wch(3x)
-            describes comparable functions for the  wide-character  (ncursesw)
-            library.
+              describes comparable functions for the wide-character (ncursesw)
+              library.
 
 
 
-                                                                 curs_inch(3x)
+ncurses 6.4                       2023-12-16                     curs_inch(3x)