X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_legacy.3x.html;h=181060cb5865fd89a34bd5e8a41d3865a4e14138;hp=16f7d4d7547a25f4f42ee01ba9b0a9656a846026;hb=HEAD;hpb=761e4f0825b330e970558e82a4bd638383914429 diff --git a/doc/html/man/curs_legacy.3x.html b/doc/html/man/curs_legacy.3x.html index 16f7d4d7..c4f34e9c 100644 --- a/doc/html/man/curs_legacy.3x.html +++ b/doc/html/man/curs_legacy.3x.html @@ -1,7 +1,7 @@ - - + -curs_legacy 3x - - + + +curs_legacy 3x 2024-03-16 ncurses 6.4 Library calls + + -

curs_legacy 3x

-
+

curs_legacy 3x 2024-03-16 ncurses 6.4 Library calls

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

NAME

-       getattrs  -  get  curses  cursor  and  window coordinates,
-       attributes
+

NAME

+       getattrs,   getbegx,   getbegy,  getcurx,  getcury,  getmaxx,  getmaxy,
+       getparx,  getpary  -  get  curses  cursor  and  window  coordinates  or
+       attributes (legacy)
 
 
-
-

SYNOPSIS

+

SYNOPSIS

        #include <curses.h>
 
-       int getattrs(WINDOW *win);
-       int getbegx(WINDOW *win);
-       int getbegy(WINDOW *win);
-       int getcurx(WINDOW *win);
-       int getcury(WINDOW *win);
-       int getmaxx(WINDOW *win);
-       int getmaxy(WINDOW *win);
-       int getparx(WINDOW *win);
-       int getpary(WINDOW *win);
+       int getattrs(const WINDOW *win);
 
+       int getbegx(const WINDOW *win);
+       int getbegy(const WINDOW *win);
 
-
-

DESCRIPTION

-       The getbegy and getbegx functions return the same data  as
-       getbegyx.
+       int getcurx(const WINDOW *win);
+       int getcury(const WINDOW *win);
 
-       The  getcury and getcurx functions return the same data as
-       getyx.
+       int getmaxx(const WINDOW *win);
+       int getmaxy(const WINDOW *win);
 
-       The getmaxy and getmaxx functions return the same data  as
-       getmaxyx.
+       int getparx(const WINDOW *win);
+       int getpary(const WINDOW *win);
 
-       The  getpary and getparx functions return the same data as
-       getparyx.
 
+

DESCRIPTION

+       These  legacy  functions  are  simpler  to  use  than the X/Open curses
+       functions:
 
-
-

RETURN VALUE

-       These functions return an integer, or ERR  if  the  window
-       parameter is null.
+       o   The getattrs function returns the same attribute data as wattr_get.
 
+           However, getattrs returns an integer  (actually  a  chtype),  while
+           wattr_get  returns  the current color pair in a separate parameter.
+           In the wide-character library configuration, color  pairs  may  not
+           fit into a chtype, so wattr_get is the only way to obtain the color
+           information.
 
-
-

NOTES

-       All  of  these interfaces are provided as macros and func-
-       tions.  The macros are suppressed (and only the  functions
-       provided)  when  NCURSES_OPAQUE  is defined.  The standard
-       forms such as getyx must be implemented as macros, and (in
-       this implementation) are defined in terms of the functions
-       described here, to avoid reliance on internal  details  of
-       the WINDOW structure.
+           Because getattrs returns the attributes in a single  parameter,  it
+           would  not  be possible for an application to distinguish that from
+           ERR (a -1).  If the window  parameter  is  null,  getattrs  returns
+           A_NORMAL (zero).
 
+       o   The getbegy and getbegx functions return the same data as getbegyx.
 
-
-

PORTABILITY

-       These functions were supported on Version 7, BSD or System
-       V implementations.
+       o   The getcury and getcurx functions return the same data as getyx.
 
+       o   The getmaxy and getmaxx functions return the same data as getmaxyx.
 
-
-

SEE ALSO

+       o   The getpary and getparx functions return the same data as getparyx.
+
+
+

RETURN VALUE

+       Except  as  noted,  these  functions  return  an integer, or ERR if the
+       window parameter is null.
+
+
+

NOTES

+       All of these interfaces are implemented as macros and  functions.   The
+       macros  are suppressed (and only the functions provided) in an "opaque"
+       ncurses build, which defines the  preprocessor  symbol  NCURSES_OPAQUE.
+       See section "ALTERNATE CONFIGURATIONS" in ncurses(3x).
+
+       The standard forms such as getyx must be implemented as macros, and (in
+       this implementation) are defined in terms of  the  functions  described
+       here, to avoid reliance on internal details of the WINDOW structure.
+
+
+

PORTABILITY

+       These   functions  were  supported  on  Version  7,  BSD  or  System  V
+       implementations.  None of  those  implementations  checked  the  window
+       parameter.
+
+       The  getattrs  function  and  macro  are  defined  to return a (signed)
+       integer  for  compatibility  with  those  implementations  although  an
+       unsigned type would have been more appropriate.
+
+
+

SEE ALSO

        curses(3x), curs_getyx(3x), curs_opaque(3x)
 
 
 
-                                                        curs_legacy(3x)
+ncurses 6.4                       2024-03-16                   curs_legacy(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +