]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/curs_legacy.3x.html
projects / ncurses.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
ncurses 6.4 - patch 20240420
[ncurses.git] / doc / html / man / curs_legacy.3x.html
diff --git a/doc/html/man/curs_legacy.3x.html b/doc/html/man/curs_legacy.3x.html
index 634ecc93ce4bba89c7e17bdc67c530e79accb37c..c4f34e9c72f52450b6f9f3020509aed32f08bcac 100644 (file)
--- a/doc/html/man/curs_legacy.3x.html
+++ b/doc/html/man/curs_legacy.3x.html
@@ -1,6 +1,6 @@
 <!--
   ****************************************************************************
 <!--
   ****************************************************************************
-  * Copyright 2019,2020 Thomas E. Dickey                                     *
+  * Copyright 2019-2023,2024 Thomas E. Dickey                                *
   * Copyright 2007-2015,2017 Free Software Foundation, Inc.                  *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
   * Copyright 2007-2015,2017 Free Software Foundation, Inc.                  *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
@@ -27,85 +27,89 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_legacy.3x,v 1.12 2020/10/18 00:16:04 tom Exp @
+  * @Id: curs_legacy.3x,v 1.32 2024/03/16 15:35:01 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">
 -->
 <!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>
+<TITLE>curs_legacy 3x 2024-03-16 ncurses 6.4 Library calls</TITLE>
 <link rel="author" 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>
 </HEAD>
 <BODY>
-<H1 class="no-header">curs_legacy 3X</H1>
+<H1 class="no-header">curs_legacy 3x 2024-03-16 ncurses 6.4 Library calls</H1>
 <PRE>
 <PRE>
-<B><A HREF="curs_legacy.3X.html">curs_legacy(3X)</A></B>                                                <B><A HREF="curs_legacy.3X.html">curs_legacy(3X)</A></B>
+<STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>                  Library calls                 <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>
 
 
 
 
 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
 
 
 
 
 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
-       curs_legacy - get <B>curses</B> cursor and window coordinates, attributes
+       <STRONG>getattrs</STRONG>,   <STRONG>getbegx</STRONG>,   <STRONG>getbegy</STRONG>,  <STRONG>getcurx</STRONG>,  <STRONG>getcury</STRONG>,  <STRONG>getmaxx</STRONG>,  <STRONG>getmaxy</STRONG>,
+       <STRONG>getparx</STRONG>,  <STRONG>getpary</STRONG>  -  get  <EM>curses</EM>  cursor  and  window  coordinates  or
+       attributes (legacy)
 
 
 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
-       <B>#include</B> <B>&lt;curses.h&gt;</B>
+       <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
 
 
-       <B>int</B> <B>getattrs(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
+       <STRONG>int</STRONG> <STRONG>getattrs(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
 
 
-       <B>int</B> <B>getbegx(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
-       <B>int</B> <B>getbegy(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
+       <STRONG>int</STRONG> <STRONG>getbegx(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>getbegy(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
 
 
-       <B>int</B> <B>getcurx(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
-       <B>int</B> <B>getcury(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
+       <STRONG>int</STRONG> <STRONG>getcurx(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>getcury(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
 
 
-       <B>int</B> <B>getmaxx(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
-       <B>int</B> <B>getmaxy(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
+       <STRONG>int</STRONG> <STRONG>getmaxx(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>getmaxy(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
 
 
-       <B>int</B> <B>getparx(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
-       <B>int</B> <B>getpary(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
+       <STRONG>int</STRONG> <STRONG>getparx(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>getpary(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
 
 
 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
-       These  legacy  functions  are  simpler  to  use  than the X/Open Curses
+       These  legacy  functions  are  simpler  to  use  than the X/Open <EM>curses</EM>
        functions:
 
        functions:
 
-       <B>o</B>   The <B>getattrs</B> function returns the same attribute data as <B>wattr_get</B>.
+       <STRONG>o</STRONG>   The <STRONG>getattrs</STRONG> function returns the same attribute data as <STRONG>wattr_get</STRONG>.
 
 
-           However, <B>getattrs</B> returns an integer  (actually  a  <B>chtype</B>),  while
-           <B>wattr_get</B>  returns  the current color pair in a separate parameter.
+           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
            In the wide-character library configuration, color  pairs  may  not
-           fit into a <B>chtype</B>, so <B>wattr_get</B> is the only way to obtain the color
+           fit into a <STRONG>chtype</STRONG>, so <STRONG>wattr_get</STRONG> is the only way to obtain the color
            information.
 
            information.
 
-           Because <B>getattrs</B> returns the attributes in a single  parameter,  it
+           Because <STRONG>getattrs</STRONG> returns the attributes in a single  parameter,  it
            would  not  be possible for an application to distinguish that from
            would  not  be possible for an application to distinguish that from
-           <B>ERR</B> (a <I>-1</I>).  If the window  parameter  is  null,  <B>getattrs</B>  returns
-           <B>A_NORMAL</B> (zero).
+           <STRONG>ERR</STRONG> (a <EM>-1</EM>).  If the window  parameter  is  null,  <STRONG>getattrs</STRONG>  returns
+           <STRONG>A_NORMAL</STRONG> (zero).
 
 
-       <B>o</B>   The <B>getbegy</B> and <B>getbegx</B> functions return the same data as <B>getbegyx</B>.
+       <STRONG>o</STRONG>   The <STRONG>getbegy</STRONG> and <STRONG>getbegx</STRONG> functions return the same data as <STRONG>getbegyx</STRONG>.
 
 
-       <B>o</B>   The <B>getcury</B> and <B>getcurx</B> functions return the same data as <B>getyx</B>.
+       <STRONG>o</STRONG>   The <STRONG>getcury</STRONG> and <STRONG>getcurx</STRONG> functions return the same data as <STRONG>getyx</STRONG>.
 
 
-       <B>o</B>   The <B>getmaxy</B> and <B>getmaxx</B> functions return the same data as <B>getmaxyx</B>.
+       <STRONG>o</STRONG>   The <STRONG>getmaxy</STRONG> and <STRONG>getmaxx</STRONG> functions return the same data as <STRONG>getmaxyx</STRONG>.
 
 
-       <B>o</B>   The <B>getpary</B> and <B>getparx</B> functions return the same data as <B>getparyx</B>.
+       <STRONG>o</STRONG>   The <STRONG>getpary</STRONG> and <STRONG>getparx</STRONG> functions return the same data as <STRONG>getparyx</STRONG>.
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
-       Except  as  noted,  these  functions  return  an integer, or <B>ERR</B> if the
+       Except  as  noted,  these  functions  return  an integer, or <STRONG>ERR</STRONG> if the
        window parameter is null.
 
 
 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
        window parameter is null.
 
 
 </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
-       <B>NCURSES_OPAQUE</B> is defined.  The standard forms such as  <B>getyx</B>  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.
+       All of these interfaces are implemented as macros and  functions.   The
+       macros  are suppressed (and only the functions provided) in an "opaque"
+       <EM>ncurses</EM> build, which defines the  preprocessor  symbol  <STRONG>NCURSES_OPAQUE</STRONG>.
+       See section "ALTERNATE CONFIGURATIONS" in <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>.
+
+       The standard forms such as <STRONG>getyx</STRONG> <EM>must</EM> 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 <EM>WINDOW</EM> structure.
 
 
 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
@@ -113,17 +117,17 @@
        implementations.  None of  those  implementations  checked  the  window
        parameter.
 
        implementations.  None of  those  implementations  checked  the  window
        parameter.
 
-       The  <B>getattrs</B>  function  and  macro  are  defined  to return a (signed)
+       The  <STRONG>getattrs</STRONG>  function  and  macro  are  defined  to return a (signed)
        integer  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>
        integer  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>
-       <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_getyx.3X.html">curs_getyx(3X)</A></B>, <B><A HREF="curs_opaque.3X.html">curs_opaque(3X)</A></B>
+       <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>
 
 
 
 
 
 
-                                                               <B><A HREF="curs_legacy.3X.html">curs_legacy(3X)</A></B>
+ncurses 6.4                       2024-03-16                   <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>
 </PRE>
 <div class="nav">
 <ul>
 </PRE>
 <div class="nav">
 <ul>
ncurses, with patches starting at ncurses-5.6; new users should use https://github.com/ThomasDickey/ncurses-snapshots/