***************************************************************************
Copyright 2019-2023,2024 Thomas E. Dickey *
Copyright 2007-2015,2017 Free Software Foundation, Inc. *
*
Permission is hereby granted, free of charge, to any person obtaining a *
copy of this software and associated documentation files (the *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: curs_legacy.3x,v 1.32 2024/03/16 15:35:01 tom Exp $
.\} .\} . .. \%getattrs, \%getbegx, \%getbegy, \%getcurx, \%getcury, \%getmaxx, \%getmaxy, \%getparx, \%getpary - get curses cursor and window coordinates or attributes (legacy)

#include <curses.h>

int getattrs(const WINDOW *win);

int getbegx(const WINDOW *win);
int getbegy(const WINDOW *win);

int getcurx(const WINDOW *win);
int getcury(const WINDOW *win);

int getmaxx(const WINDOW *win);
int getmaxy(const WINDOW *win);

int getparx(const WINDOW *win);
int getpary(const WINDOW *win);

These legacy functions are simpler to use than the X/Open curses functions: .bP 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. 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). .bP The \%getbegy and \%getbegx functions return the same data as \%getbegyx. .bP The \%getcury and \%getcurx functions return the same data as \%getyx. .bP The \%getmaxy and \%getmaxx functions return the same data as \%getmaxyx. .bP The \%getpary and \%getparx functions return the same data as \%getparyx. Except as noted, these functions return an integer, or ERR if the window parameter is null. 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.

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.

\%curses(3X), \%curs_getyx(3X), \%curs_opaque(3X)