X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_legacy.3x;h=c2eb86b8834c2c20a9f415ea2c240ab951b3c677;hp=bf24a74d490933d7ae9fba1744e9dee7db596432;hb=HEAD;hpb=894a177fd5228cdbe790bd1dc9435bd435c29681 diff --git a/man/curs_legacy.3x b/man/curs_legacy.3x index bf24a74d..24be01b8 100644 --- a/man/curs_legacy.3x +++ b/man/curs_legacy.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2019-2022,2023 Thomas E. Dickey * +.\" 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 * @@ -27,8 +27,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_legacy.3x,v 1.28 2023/10/07 21:19:07 tom Exp $ -.TH curs_legacy 3X 2023-10-07 "ncurses 6.4" "Library calls" +.\" $Id: curs_legacy.3x,v 1.32 2024/03/16 15:35:01 tom Exp $ +.TH curs_legacy 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 @@ -63,9 +74,11 @@ get \fIcurses\fR cursor and window coordinates or attributes (legacy) \fBint getpary(const WINDOW *\fIwin\fP); .fi .SH DESCRIPTION -These legacy functions are simpler to use than the X/Open \fIcurses\fP functions: +These legacy functions are simpler to use +than the X/Open \fIcurses\fP functions: .bP -The \fB\%getattrs\fP function returns the same attribute data as \fB\%wattr_get\fP. +The \fB\%getattrs\fP function returns the same attribute data +as \fB\%wattr_get\fP. .IP However, \fB\%getattrs\fP returns an integer (actually a \fB\%chtype\fP), while \fB\%wattr_get\fP returns the current color pair in a separate parameter. @@ -76,7 +89,8 @@ so \fB\%wattr_get\fP is the only way to obtain the color information. Because \fB\%getattrs\fP returns the attributes in a single parameter, it would not be possible for an application to distinguish that from \fBERR\fP (a \fI-1\fP). -If the window parameter is null, \fB\%getattrs\fP returns \fB\%A_NORMAL\fP (zero). +If the window parameter is null, \fB\%getattrs\fP +returns \fB\%A_NORMAL\fP (zero). .bP The \fB\%getbegy\fP and \fB\%getbegx\fP functions return the same data as \fB\%getbegyx\fP. @@ -94,13 +108,23 @@ Except as noted, these functions return an integer, or \fBERR\fP if the window parameter is null. .SH NOTES -All of these interfaces are provided as macros and functions. -The macros are suppressed (and only the functions provided) -when \fB\%NCURSES_OPAQUE\fP is defined. -The standard forms such as \fB\%getyx\fP 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 \fB\%WINDOW\fP structure. +All of these interfaces are implemented as macros and functions. +The macros are suppressed +(and only the functions provided) +in an \*(``opaque\*('' +.I \%ncurses +build, +which defines the preprocessor symbol +.BR \%NCURSES_OPAQUE . +See section \*(``ALTERNATE CONFIGURATIONS\*('' in \fB\%ncurses\fP(3X). +.PP +The standard forms such as \fB\%getyx\fP +.I 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 \fI\%WINDOW\fP structure. .SH PORTABILITY These functions were supported on Version 7, BSD or System V implementations. None of those implementations checked the window parameter.