man/curs_legacy.3x

   1 .\"***************************************************************************
   2 .\" Copyright 2019-2023,2024 Thomas E. Dickey                                *
   3 .\" Copyright 2007-2015,2017 Free Software Foundation, Inc.                  *
   4 .\"                                                                          *
   5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   6 .\" copy of this software and associated documentation files (the            *
   7 .\" "Software"), to deal in the Software without restriction, including      *
   8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  10 .\" copies of the Software, and to permit persons to whom the Software is    *
  11 .\" furnished to do so, subject to the following conditions:                 *
  12 .\"                                                                          *
  13 .\" The above copyright notice and this permission notice shall be included  *
  14 .\" in all copies or substantial portions of the Software.                   *
  15 .\"                                                                          *
  16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23 .\"                                                                          *
  24 .\" Except as contained in this notice, the name(s) of the above copyright   *
  25 .\" holders shall not be used in advertising or otherwise to promote the     *
  26 .\" sale, use or other dealings in this Software without prior written       *
  27 .\" authorization.                                                           *
  28 .\"***************************************************************************
  29 .\"
  30 .\" $Id: curs_legacy.3x,v 1.32 2024/03/16 15:35:01 tom Exp $
  31 .TH curs_legacy 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
  32 .ie \n(.g \{\
  33 .ds `` \(lq
  34 .ds '' \(rq
  35 .\}
  36 .el \{\
  37 .ie t .ds `` ``
  38 .el   .ds `` ""
  39 .ie t .ds '' ''
  40 .el   .ds '' ""
  41 .\}
  42 .
  43 .de bP
  44 .ie n  .IP \(bu 4
  45 .el    .IP \(bu 2
  46 ..
  47 .SH NAME
  48 \fB\%getattrs\fP,
  49 \fB\%getbegx\fP,
  50 \fB\%getbegy\fP,
  51 \fB\%getcurx\fP,
  52 \fB\%getcury\fP,
  53 \fB\%getmaxx\fP,
  54 \fB\%getmaxy\fP,
  55 \fB\%getparx\fP,
  56 \fB\%getpary\fP \-
  57 get \fIcurses\fR cursor and window coordinates or attributes (legacy)
  58 .SH SYNOPSIS
  59 .nf
  60 \fB#include <curses.h>
  61 .PP
  62 \fBint getattrs(const WINDOW *\fIwin\fP);
  63 .PP
  64 \fBint getbegx(const WINDOW *\fIwin\fP);
  65 \fBint getbegy(const WINDOW *\fIwin\fP);
  66 .PP
  67 \fBint getcurx(const WINDOW *\fIwin\fP);
  68 \fBint getcury(const WINDOW *\fIwin\fP);
  69 .PP
  70 \fBint getmaxx(const WINDOW *\fIwin\fP);
  71 \fBint getmaxy(const WINDOW *\fIwin\fP);
  72 .PP
  73 \fBint getparx(const WINDOW *\fIwin\fP);
  74 \fBint getpary(const WINDOW *\fIwin\fP);
  75 .fi
  76 .SH DESCRIPTION
  77 These legacy functions are simpler to use
  78 than the X/Open \fIcurses\fP functions:
  79 .bP
  80 The \fB\%getattrs\fP function returns the same attribute data
  81 as \fB\%wattr_get\fP.
  82 .IP
  83 However, \fB\%getattrs\fP returns an integer (actually a \fB\%chtype\fP),
  84 while \fB\%wattr_get\fP returns the current color pair in a separate parameter.
  85 In the wide-character library configuration,
  86 color pairs may not fit into a \fB\%chtype\fP,
  87 so \fB\%wattr_get\fP is the only way to obtain the color information.
  88 .IP
  89 Because \fB\%getattrs\fP returns the attributes in a single parameter,
  90 it would not be possible for an application to distinguish that from
  91 \fBERR\fP (a \fI-1\fP).
  92 If the window parameter is null, \fB\%getattrs\fP
  93 returns \fB\%A_NORMAL\fP (zero).
  94 .bP
  95 The \fB\%getbegy\fP and \fB\%getbegx\fP functions return the same
  96 data as \fB\%getbegyx\fP.
  97 .bP
  98 The \fB\%getcury\fP and \fB\%getcurx\fP functions return the same
  99 data as \fB\%getyx\fP.
 100 .bP
 101 The \fB\%getmaxy\fP and \fB\%getmaxx\fP functions return the same
 102 data as \fB\%getmaxyx\fP.
 103 .bP
 104 The \fB\%getpary\fP and \fB\%getparx\fP functions return the same
 105 data as \fB\%getparyx\fP.
 106 .SH RETURN VALUE
 107 Except as noted,
 108 these functions return an integer,
 109 or \fBERR\fP if the window parameter is null.
 110 .SH NOTES
 111 All of these interfaces are implemented as macros and functions.
 112 The macros are suppressed
 113 (and only the functions provided)
 114 in an \*(``opaque\*(''
 115 .I \%ncurses
 116 build,
 117 which defines the preprocessor symbol
 118 .BR \%NCURSES_OPAQUE .
 119 See section \*(``ALTERNATE CONFIGURATIONS\*('' in \fB\%ncurses\fP(3X).
 120 .PP
 121 The standard forms such as \fB\%getyx\fP
 122 .I must
 123 be implemented as macros,
 124 and
 125 (in this implementation)
 126 are defined in terms of the functions described here,
 127 to avoid reliance on internal details of the \fI\%WINDOW\fP structure.
 128 .SH PORTABILITY
 129 These functions were supported on Version 7, BSD or System V implementations.
 130 None of those implementations checked the window parameter.
 131 .PP
 132 The \fB\%getattrs\fP function and macro are defined to return a (signed) integer
 133 for compatibility with those implementations
 134 although an unsigned type would have been more appropriate.
 135 .SH SEE ALSO
 136 \fB\%curses\fP(3X),
 137 \fB\%curs_getyx\fP(3X),
 138 \fB\%curs_opaque\fP(3X)