Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / c1bcd6dd9af6865867a3d6716e4c1a45021a90e5 / . / doc / html / man / curs_legacy.3x.html
blob: d1de590cb09b716cf093c039b1ae7edd38c7d37a [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2<!--
3 ****************************************************************************
4 * Copyright (c) 2007 Free Software Foundation, Inc. *
5 * *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
13 * *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
16 * *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
28 * authorization. *
29 ****************************************************************************
30 * @Id: curs_legacy.3x,v 1.1 2007/04/07 23:54:29 tom Exp @
31-->
32<HTML>
33<HEAD>
34<TITLE>curs_legacy 3x</TITLE>
35<link rev=made href="mailto:bug-ncurses@gnu.org">
36<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
37</HEAD>
38<BODY>
39<H1>curs_legacy 3x</H1>
40<HR>
41<PRE>
42<!-- Manpage converted by man2html 3.0.1 -->
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>
49<H2>NAME</H2><PRE>
50 <STRONG>getbegx</STRONG>, <STRONG>getbegy</STRONG>, <STRONG>getcurx</STRONG>, <STRONG>getcury</STRONG>, <STRONG>getmaxx</STRONG>, <STRONG>getmaxy</STRONG>, <STRONG>get-</STRONG>
51 <STRONG>parx</STRONG>, <STRONG>getpary</STRONG> - get <STRONG>curses</STRONG> cursor and window coordinates
52
53
54</PRE>
55<H2>SYNOPSIS</H2><PRE>
56 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58 <STRONG>int</STRONG> <STRONG>getbegx(WINDOW</STRONG> <STRONG>*win);</STRONG>
59 <STRONG>int</STRONG> <STRONG>getbegy(WINDOW</STRONG> <STRONG>*win);</STRONG>
60 <STRONG>int</STRONG> <STRONG>getcurx(WINDOW</STRONG> <STRONG>*win);</STRONG>
61 <STRONG>int</STRONG> <STRONG>getcury(WINDOW</STRONG> <STRONG>*win);</STRONG>
62 <STRONG>int</STRONG> <STRONG>getmaxx(WINDOW</STRONG> <STRONG>*win);</STRONG>
63 <STRONG>int</STRONG> <STRONG>getmaxy(WINDOW</STRONG> <STRONG>*win);</STRONG>
64 <STRONG>int</STRONG> <STRONG>getparx(WINDOW</STRONG> <STRONG>*win);</STRONG>
65 <STRONG>int</STRONG> <STRONG>getpary(WINDOW</STRONG> <STRONG>*win);</STRONG>
66
67
68</PRE>
69<H2>DESCRIPTION</H2><PRE>
70 The <STRONG>getbegy</STRONG> and <STRONG>getbegx</STRONG> functions return the same data as
71 <STRONG>getbegyx</STRONG>.
72
73 The <STRONG>getcury</STRONG> and <STRONG>getcurx</STRONG> functions return the same data as
74 <STRONG>getyx</STRONG>.
75
76 The <STRONG>getmaxy</STRONG> and <STRONG>getmaxx</STRONG> functions return the same data as
77 <STRONG>getmaxyx</STRONG>.
78
79 The <STRONG>getpary</STRONG> and <STRONG>getparx</STRONG> functions return the same data as
80 <STRONG>getparyx</STRONG>.
81
82
83</PRE>
84<H2>RETURN VALUE</H2><PRE>
85 These functions return an integer, or ERR if the window
86 parameter is null.
87
88
89</PRE>
90<H2>NOTES</H2><PRE>
91 All of these interfaces are provided as macros and func-
92 tions. The macros are suppressed (and only the functions
93 provided) when <STRONG>NCURSES_OPAQUE</STRONG> is defined. The standard
94 forms such as <STRONG>getyx</STRONG> must be implemented as macros, and (in
95 this implementation) are defined in terms of the functions
96 described here, to avoid reliance on internal details of
97 the WINDOW structure.
98
99
100</PRE>
101<H2>PORTABILITY</H2><PRE>
102 These functions were supported on Version 7, BSD or System
103 V implementations.
104
105
106</PRE>
107<H2>SEE ALSO</H2><PRE>
108 <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>
109
110
111
112 <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>
113</PRE>
114<HR>
115<ADDRESS>
116Man(1) output converted with
117<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
118</ADDRESS>
119</BODY>
120</HTML>