diff options
Diffstat (limited to 'doc/html/man/curs_legacy.3x.html')
| -rw-r--r-- | doc/html/man/curs_legacy.3x.html | 127 |
1 files changed, 72 insertions, 55 deletions
diff --git a/doc/html/man/curs_legacy.3x.html b/doc/html/man/curs_legacy.3x.html index 5451ff7..24071db 100644 --- a/doc/html/man/curs_legacy.3x.html +++ b/doc/html/man/curs_legacy.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2007,2010 Free Software Foundation, Inc. * + * Copyright 2019,2020 Thomas E. Dickey * + * Copyright 2007-2015,2017 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * * copy of this software and associated documentation files (the * @@ -27,92 +27,109 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_legacy.3x,v 1.5 2010/12/04 18:38:55 tom Exp @ + * @Id: curs_legacy.3x,v 1.10 2020/02/02 23:34:34 tom Exp @ --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <HTML> <HEAD> +<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> +<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> <TITLE>curs_legacy 3x</TITLE> -<link rev=made href="mailto:bug-ncurses@gnu.org"> +<link rel="author" href="mailto:bug-ncurses@gnu.org"> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> </HEAD> <BODY> -<H1>curs_legacy 3x</H1> -<HR> +<H1 class="no-header">curs_legacy 3x</H1> <PRE> -<!-- Manpage converted by man2html 3.0.1 --> -<STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG> <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG> +<STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG> <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG> -</PRE> -<H2>NAME</H2><PRE> - getattrs - get <STRONG>curses</STRONG> cursor and window coordinates, - attributes +</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> + curs_legacy - get <STRONG>curses</STRONG> cursor and window coordinates, attributes -</PRE> -<H2>SYNOPSIS</H2><PRE> +</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> - <STRONG>int</STRONG> <STRONG>getattrs(WINDOW</STRONG> <STRONG>*win);</STRONG> - <STRONG>int</STRONG> <STRONG>getbegx(WINDOW</STRONG> <STRONG>*win);</STRONG> - <STRONG>int</STRONG> <STRONG>getbegy(WINDOW</STRONG> <STRONG>*win);</STRONG> - <STRONG>int</STRONG> <STRONG>getcurx(WINDOW</STRONG> <STRONG>*win);</STRONG> - <STRONG>int</STRONG> <STRONG>getcury(WINDOW</STRONG> <STRONG>*win);</STRONG> - <STRONG>int</STRONG> <STRONG>getmaxx(WINDOW</STRONG> <STRONG>*win);</STRONG> - <STRONG>int</STRONG> <STRONG>getmaxy(WINDOW</STRONG> <STRONG>*win);</STRONG> - <STRONG>int</STRONG> <STRONG>getparx(WINDOW</STRONG> <STRONG>*win);</STRONG> - <STRONG>int</STRONG> <STRONG>getpary(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>getattrs(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>getbegx(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>getbegy(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>getcurx(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>getcury(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>getmaxx(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>getmaxy(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>getparx(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>getpary(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> -</PRE> -<H2>DESCRIPTION</H2><PRE> - The <STRONG>getbegy</STRONG> and <STRONG>getbegx</STRONG> functions return the same data as - <STRONG>getbegyx</STRONG>. +</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> + These legacy functions are simpler to use than the X/Open Curses func- + tions: - The <STRONG>getcury</STRONG> and <STRONG>getcurx</STRONG> functions return the same data as - <STRONG>getyx</STRONG>. + <STRONG>o</STRONG> The <STRONG>getattrs</STRONG> function returns the same attribute data as <STRONG>wattr_get</STRONG>. - The <STRONG>getmaxy</STRONG> and <STRONG>getmaxx</STRONG> functions return the same data as - <STRONG>getmaxyx</STRONG>. + However, <STRONG>getattrs</STRONG> returns an integer (actually a <STRONG>chtype</STRONG>), while + <STRONG>wattr_get</STRONG> returns the current color pair in a separate parameter. + In the wide-character library configuration, color pairs may not + fit into a <STRONG>chtype</STRONG>, so <STRONG>wattr_get</STRONG> is the only way to obtain the color + information. - The <STRONG>getpary</STRONG> and <STRONG>getparx</STRONG> functions return the same data as - <STRONG>getparyx</STRONG>. + Because <STRONG>getattrs</STRONG> returns the attributes in a single parameter, it + would not be possible for an application to distinguish that from + <STRONG>ERR</STRONG> (a <EM>-1</EM>). If the window parameter is null, <STRONG>getattrs</STRONG> returns + <STRONG>A_NORMAL</STRONG> (zero). + <STRONG>o</STRONG> The <STRONG>getbegy</STRONG> and <STRONG>getbegx</STRONG> functions return the same data as <STRONG>getbegyx</STRONG>. -</PRE> -<H2>RETURN VALUE</H2><PRE> - These functions return an integer, or ERR if the window - parameter is null. + <STRONG>o</STRONG> The <STRONG>getcury</STRONG> and <STRONG>getcurx</STRONG> functions return the same data as <STRONG>getyx</STRONG>. + <STRONG>o</STRONG> The <STRONG>getmaxy</STRONG> and <STRONG>getmaxx</STRONG> functions return the same data as <STRONG>getmaxyx</STRONG>. -</PRE> -<H2>NOTES</H2><PRE> - All of these interfaces are provided as macros and func- - tions. The macros are suppressed (and only the functions - provided) when <STRONG>NCURSES_OPAQUE</STRONG> is defined. The standard - forms such as <STRONG>getyx</STRONG> must be implemented as macros, and (in - this implementation) are defined in terms of the functions - described here, to avoid reliance on internal details of - the WINDOW structure. + <STRONG>o</STRONG> The <STRONG>getpary</STRONG> and <STRONG>getparx</STRONG> functions return the same data as <STRONG>getparyx</STRONG>. -</PRE> -<H2>PORTABILITY</H2><PRE> - These functions were supported on Version 7, BSD or System - V implementations. +</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> + Except as noted, these functions return an integer, or <STRONG>ERR</STRONG> if the win- + dow parameter is null. -</PRE> -<H2>SEE ALSO</H2><PRE> +</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> + All of these interfaces are provided as macros and functions. The + macros are suppressed (and only the functions provided) when + <STRONG>NCURSES_OPAQUE</STRONG> is defined. The standard forms such as <STRONG>getyx</STRONG> must be + implemented as macros, and (in this implementation) are defined in + terms of the functions described here, to avoid reliance on internal + details of the WINDOW structure. + + +</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> + These functions were supported on Version 7, BSD or System V implemen- + tations. None of those implementations checked the window parameter. + + The <STRONG>getattrs</STRONG> function and macro are defined to return a (signed) inte- + ger for compatibility with those implementations although an unsigned + type would have been more appropriate. + + +</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> <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> - <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG> + <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG> </PRE> -<HR> -Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> +<div class="nav"> +<ul> +<li><a href="#h2-NAME">NAME</a></li> +<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> +<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> +<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> +<li><a href="#h2-NOTES">NOTES</a></li> +<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> +<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> +</ul> +</div> </BODY> </HTML> |