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=634ecc93ce4bba89c7e17bdc67c530e79accb37c;hb=HEAD;hpb=9f479192e3ca3413d235c66bf058f8cc63764898 diff --git a/doc/html/man/curs_legacy.3x.html b/doc/html/man/curs_legacy.3x.html index 634ecc93..c4f34e9c 100644 --- a/doc/html/man/curs_legacy.3x.html +++ b/doc/html/man/curs_legacy.3x.html @@ -1,6 +1,6 @@ -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

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

SYNOPSIS

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

DESCRIPTION

-       These  legacy  functions  are  simpler  to  use  than the X/Open Curses
+       These  legacy  functions  are  simpler  to  use  than the X/Open curses
        functions:
 
-       o   The getattrs function returns the same attribute data as wattr_get.
+       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.
+           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
+           fit into a chtype, so wattr_get is the only way to obtain the color
            information.
 
-           Because getattrs returns the attributes in a single  parameter,  it
+           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).
+           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.
+       o   The getbegy and getbegx functions return the same data as getbegyx.
 
-       o   The getcury and getcurx functions return the same data as getyx.
+       o   The getcury and getcurx functions return the same data as getyx.
 
-       o   The getmaxy and getmaxx functions return the same data as getmaxyx.
+       o   The getmaxy and getmaxx functions return the same data as getmaxyx.
 
-       o   The getpary and getparx functions return the same data as getparyx.
+       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
+       Except  as  noted,  these  functions  return  an integer, or ERR if the
        window parameter is null.

NOTES

-       All of these interfaces are provided  as  macros  and  functions.   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.
+       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

@@ -113,17 +117,17 @@
        implementations.  None of  those  implementations  checked  the  window
        parameter.
 
-       The  getattrs  function  and  macro  are  defined  to return a (signed)
+       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.