Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 1 | .\"*************************************************************************** |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame^] | 2 | .\" Copyright (c) 2007,2010 Free Software Foundation, Inc. * |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 3 | .\" * |
| 4 | .\" Permission is hereby granted, free of charge, to any person obtaining a * |
| 5 | .\" copy of this software and associated documentation files (the * |
| 6 | .\" "Software"), to deal in the Software without restriction, including * |
| 7 | .\" without limitation the rights to use, copy, modify, merge, publish, * |
| 8 | .\" distribute, distribute with modifications, sublicense, and/or sell * |
| 9 | .\" copies of the Software, and to permit persons to whom the Software is * |
| 10 | .\" furnished to do so, subject to the following conditions: * |
| 11 | .\" * |
| 12 | .\" The above copyright notice and this permission notice shall be included * |
| 13 | .\" in all copies or substantial portions of the Software. * |
| 14 | .\" * |
| 15 | .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * |
| 16 | .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * |
| 17 | .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * |
| 18 | .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * |
| 19 | .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * |
| 20 | .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * |
| 21 | .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * |
| 22 | .\" * |
| 23 | .\" Except as contained in this notice, the name(s) of the above copyright * |
| 24 | .\" holders shall not be used in advertising or otherwise to promote the * |
| 25 | .\" sale, use or other dealings in this Software without prior written * |
| 26 | .\" authorization. * |
| 27 | .\"*************************************************************************** |
| 28 | .\" |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame^] | 29 | .\" $Id: curs_legacy.3x,v 1.5 2010/12/04 18:38:55 tom Exp $ |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 30 | .TH curs_legacy 3X "" |
| 31 | .SH NAME |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame^] | 32 | getattrs \- get \fBcurses\fR cursor and window coordinates, attributes |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 33 | .SH SYNOPSIS |
| 34 | \fB#include <curses.h>\fR |
| 35 | .sp |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame^] | 36 | \fBint getattrs(WINDOW *win);\fR |
| 37 | .br |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 38 | \fBint getbegx(WINDOW *win);\fR |
| 39 | .br |
| 40 | \fBint getbegy(WINDOW *win);\fR |
| 41 | .br |
| 42 | \fBint getcurx(WINDOW *win);\fR |
| 43 | .br |
| 44 | \fBint getcury(WINDOW *win);\fR |
| 45 | .br |
| 46 | \fBint getmaxx(WINDOW *win);\fR |
| 47 | .br |
| 48 | \fBint getmaxy(WINDOW *win);\fR |
| 49 | .br |
| 50 | \fBint getparx(WINDOW *win);\fR |
| 51 | .br |
| 52 | \fBint getpary(WINDOW *win);\fR |
| 53 | .br |
| 54 | .SH DESCRIPTION |
| 55 | The \fBgetbegy\fR and \fBgetbegx\fR functions return the same |
| 56 | data as \fBgetbegyx\fR. |
| 57 | .PP |
| 58 | The \fBgetcury\fR and \fBgetcurx\fR functions return the same |
| 59 | data as \fBgetyx\fR. |
| 60 | .PP |
| 61 | The \fBgetmaxy\fR and \fBgetmaxx\fR functions return the same |
| 62 | data as \fBgetmaxyx\fR. |
| 63 | .PP |
| 64 | The \fBgetpary\fR and \fBgetparx\fR functions return the same |
| 65 | data as \fBgetparyx\fR. |
| 66 | .SH RETURN VALUE |
| 67 | These functions return an integer, |
| 68 | or ERR if the window parameter is null. |
| 69 | .SH NOTES |
| 70 | All of these interfaces are provided as macros and functions. |
| 71 | The macros are suppressed (and only the functions provided) |
| 72 | when \fBNCURSES_OPAQUE\fR is defined. |
| 73 | The standard forms such as \fBgetyx\fP must be implemented as macros, |
| 74 | and (in this implementation) are defined in terms of the functions |
| 75 | described here, |
| 76 | to avoid reliance on internal details of the WINDOW structure. |
| 77 | .SH PORTABILITY |
| 78 | These functions were supported on Version 7, BSD or System V implementations. |
| 79 | .SH SEE ALSO |
| 80 | \fBcurses\fR(3X), |
| 81 | \fBcurs_getyx\fR(3X), |
| 82 | \fBcurs_opaque\fR(3X) |