Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / b2cef93693cf7cfd01098c9b69603c90f0f4b803 / . / doc / html / man / curs_legacy.3x.html
blob: 36db4bf70c9432d0fe730d2d9acbb8297da1bf5e [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1<!--
2 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]3 * Copyright (c) 2007,2010 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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 ****************************************************************************
Steve Kondikae271bc2015-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 Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]30-->
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]31<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]32<HTML>
33<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]34<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]36<TITLE>curs_legacy 3x</TITLE>
37<link rev=made href="mailto:bug-ncurses@gnu.org">
38<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39</HEAD>
40<BODY>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]41<H1 class="no-header">curs_legacy 3x</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]42<PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43<STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG> <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>
44
45
46
47
48</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]49<H2><a name="h2-NAME">NAME</a></H2><PRE>
50 getattrs - get <STRONG>curses</STRONG> cursor and window coordinates,
51 attributes
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]52
53
54</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]55<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]56 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]58 <STRONG>int</STRONG> <STRONG>getattrs(WINDOW</STRONG> <STRONG>*win);</STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]59 <STRONG>int</STRONG> <STRONG>getbegx(WINDOW</STRONG> <STRONG>*win);</STRONG>
60 <STRONG>int</STRONG> <STRONG>getbegy(WINDOW</STRONG> <STRONG>*win);</STRONG>
61 <STRONG>int</STRONG> <STRONG>getcurx(WINDOW</STRONG> <STRONG>*win);</STRONG>
62 <STRONG>int</STRONG> <STRONG>getcury(WINDOW</STRONG> <STRONG>*win);</STRONG>
63 <STRONG>int</STRONG> <STRONG>getmaxx(WINDOW</STRONG> <STRONG>*win);</STRONG>
64 <STRONG>int</STRONG> <STRONG>getmaxy(WINDOW</STRONG> <STRONG>*win);</STRONG>
65 <STRONG>int</STRONG> <STRONG>getparx(WINDOW</STRONG> <STRONG>*win);</STRONG>
66 <STRONG>int</STRONG> <STRONG>getpary(WINDOW</STRONG> <STRONG>*win);</STRONG>
67
68
69</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]70<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]71 The <STRONG>getbegy</STRONG> and <STRONG>getbegx</STRONG> functions return the same data as
72 <STRONG>getbegyx</STRONG>.
73
74 The <STRONG>getcury</STRONG> and <STRONG>getcurx</STRONG> functions return the same data as
75 <STRONG>getyx</STRONG>.
76
77 The <STRONG>getmaxy</STRONG> and <STRONG>getmaxx</STRONG> functions return the same data as
78 <STRONG>getmaxyx</STRONG>.
79
80 The <STRONG>getpary</STRONG> and <STRONG>getparx</STRONG> functions return the same data as
81 <STRONG>getparyx</STRONG>.
82
83
84</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]85<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]86 These functions return an integer, or ERR if the window
87 parameter is null.
88
89
90</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]91<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]92 All of these interfaces are provided as macros and func-
93 tions. The macros are suppressed (and only the functions
94 provided) when <STRONG>NCURSES_OPAQUE</STRONG> is defined. The standard
95 forms such as <STRONG>getyx</STRONG> must be implemented as macros, and (in
96 this implementation) are defined in terms of the functions
97 described here, to avoid reliance on internal details of
98 the WINDOW structure.
99
100
101</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]102<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]103 These functions were supported on Version 7, BSD or System
104 V implementations.
105
106
107</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]108<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]109 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG>, <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>
110
111
112
113 <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>
114</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]115<div class="nav">
116<ul>
117<li><a href="#h2-NAME">NAME</a></li>
118<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
119<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
120<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
121<li><a href="#h2-NOTES">NOTES</a></li>
122<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
123<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
124</ul>
125</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]126</BODY>
127</HTML>