X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_legacy.3x.html;h=b0b8c75159282fdc66015d8714391d1884932d2b;hp=991037b3343464a2dede9ba33c3b66fd33a7d97f;hb=06078d3fa68db669ed37178c01873546b4b28745;hpb=6208c89f98f1cf9fe0980bd8e791846ce007a13d;ds=sidebyside diff --git a/doc/html/man/curs_legacy.3x.html b/doc/html/man/curs_legacy.3x.html index 991037b3..b0b8c751 100644 --- a/doc/html/man/curs_legacy.3x.html +++ b/doc/html/man/curs_legacy.3x.html @@ -1,6 +1,6 @@ @@ -40,14 +40,13 @@

curs_legacy 3x

-curs_legacy(3x)                                         curs_legacy(3x)
+curs_legacy(3x)                                                curs_legacy(3x)

NAME

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

SYNOPSIS

@@ -65,37 +64,52 @@

DESCRIPTION

-       The getbegy and getbegx functions return the same data  as
-       getbegyx.
+       These  legacy functions are simpler to use than the X/Open Curses func-
+       tions:
 
-       The  getcury and getcurx functions return the same data as
-       getyx.
+       o   The getattrs function returns the same attribute data as wattr_get.
 
-       The getmaxy and getmaxx functions return the same data  as
-       getmaxyx.
+           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.
 
-       The  getpary and getparx functions return the same data as
-       getparyx.
+           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.
+
+       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 getpary and getparx functions return the same data as getparyx.

RETURN VALUE

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

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.
+       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.

PORTABILITY

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