ncurses 6.0 - patch 20171118
[ncurses.git] / doc / html / man / curs_legacy.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 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   * @Id: curs_legacy.3x,v 1.7 2017/11/19 00:23:58 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
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">
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>
41 <H1 class="no-header">curs_legacy 3x</H1>
42 <PRE>
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><H2><a name="h2-NAME">NAME</a></H2><PRE>
49        curs_legacy - get <STRONG>curses</STRONG> cursor and window coordinates, attributes
50
51
52 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
53        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
54
55        <STRONG>int</STRONG> <STRONG>getattrs(WINDOW</STRONG> <STRONG>*win);</STRONG>
56        <STRONG>int</STRONG> <STRONG>getbegx(WINDOW</STRONG> <STRONG>*win);</STRONG>
57        <STRONG>int</STRONG> <STRONG>getbegy(WINDOW</STRONG> <STRONG>*win);</STRONG>
58        <STRONG>int</STRONG> <STRONG>getcurx(WINDOW</STRONG> <STRONG>*win);</STRONG>
59        <STRONG>int</STRONG> <STRONG>getcury(WINDOW</STRONG> <STRONG>*win);</STRONG>
60        <STRONG>int</STRONG> <STRONG>getmaxx(WINDOW</STRONG> <STRONG>*win);</STRONG>
61        <STRONG>int</STRONG> <STRONG>getmaxy(WINDOW</STRONG> <STRONG>*win);</STRONG>
62        <STRONG>int</STRONG> <STRONG>getparx(WINDOW</STRONG> <STRONG>*win);</STRONG>
63        <STRONG>int</STRONG> <STRONG>getpary(WINDOW</STRONG> <STRONG>*win);</STRONG>
64
65
66 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
67        These  legacy functions are simpler to use than the X/Open Curses func-
68        tions:
69
70        <STRONG>o</STRONG>   The <STRONG>getattrs</STRONG> function returns the same attribute data as <STRONG>wattr_get</STRONG>.
71
72            However, <STRONG>getattrs</STRONG> returns an integer  (actually  a  <STRONG>chtype</STRONG>),  while
73            <STRONG>wattr_get</STRONG>  returns  the current color pair in a separate parameter.
74            In the wide-character library configuration, color  pairs  may  not
75            fit into a <STRONG>chtype</STRONG>, so <STRONG>wattr_get</STRONG> is the only way to obtain the color
76            information.
77
78            Because <STRONG>getattrs</STRONG> returns the attributes in a single  parameter,  it
79            would  not  be possible for an application to distinguish that from
80            <STRONG>ERR</STRONG> (a <EM>-1</EM>).  If the window  parameter  is  null,  <STRONG>getattrs</STRONG>  returns
81            <STRONG>A_NORMAL</STRONG> (zero).
82
83        <STRONG>o</STRONG>   The <STRONG>getbegy</STRONG> and <STRONG>getbegx</STRONG> functions return the same data as <STRONG>getbegyx</STRONG>.
84
85        <STRONG>o</STRONG>   The <STRONG>getcury</STRONG> and <STRONG>getcurx</STRONG> functions return the same data as <STRONG>getyx</STRONG>.
86
87        <STRONG>o</STRONG>   The <STRONG>getmaxy</STRONG> and <STRONG>getmaxx</STRONG> functions return the same data as <STRONG>getmaxyx</STRONG>.
88
89        <STRONG>o</STRONG>   The <STRONG>getpary</STRONG> and <STRONG>getparx</STRONG> functions return the same data as <STRONG>getparyx</STRONG>.
90
91
92 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
93        Except  as noted, these functions return an integer, or ERR if the win-
94        dow parameter is null.
95
96
97 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
98        All of these interfaces are provided  as  macros  and  functions.   The
99        macros   are   suppressed   (and  only  the  functions  provided)  when
100        <STRONG>NCURSES_OPAQUE</STRONG> is defined.  The standard forms such as  <STRONG>getyx</STRONG>  must  be
101        implemented  as  macros,  and  (in  this implementation) are defined in
102        terms of the functions described here, to avoid  reliance  on  internal
103        details of the WINDOW structure.
104
105
106 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
107        These  functions were supported on Version 7, BSD or System V implemen-
108        tations.  None of those implementations checked the window parameter.
109
110        The <STRONG>getattrs</STRONG> function and macro are defined to return a (signed)  inte-
111        ger  for  compatibility with those implementations although an unsigned
112        type would have been more appropriate.
113
114
115 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
116        <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>
117
118
119
120                                                                <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>
121 </PRE>
122 <div class="nav">
123 <ul>
124 <li><a href="#h2-NAME">NAME</a></li>
125 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
126 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
127 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
128 <li><a href="#h2-NOTES">NOTES</a></li>
129 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
130 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
131 </ul>
132 </div>
133 </BODY>
134 </HTML>