* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_opaque.3x,v 1.36 2023/10/07 21:19:07 tom Exp @
+ * @Id: curs_opaque.3x,v 1.38 2023/10/28 14:49:04 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_opaque 3x 2023-10-07 ncurses 6.4 Library calls</TITLE>
+<TITLE>curs_opaque 3x 2023-10-28 ncurses 6.4 Library calls</TITLE>
<link rel="author" href="mailto:bug-ncurses@gnu.org">
</HEAD>
<BODY>
-<H1 class="no-header">curs_opaque 3x 2023-10-07 ncurses 6.4 Library calls</H1>
+<H1 class="no-header">curs_opaque 3x 2023-10-28 ncurses 6.4 Library calls</H1>
<PRE>
<STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
<EM>ncurses</EM> provides functions returning properties of a <EM>WINDOW</EM> structure,
allowing it to be "opaque" if the application defines the
- <STRONG>NCURSES_OPAQUE</STRONG> preprocessor symbol.
+ <STRONG>NCURSES_OPAQUE</STRONG> preprocessor symbol. <EM>Opacity</EM> in this sense means that
+ the members of <EM>struct</EM> data types are not directly accessible (for
+ instance, through "." or "->" operators), but instead must be queried
+ and/or set via library functions. Advantages of opacity include
+ greater abstraction and improved management of concurrent accesses to
+ data structures, keeping object states coherent.
<STRONG>is_cleared</STRONG>
returns the value set by <STRONG><A HREF="curs_outopts.3x.html">clearok(3x)</A></STRONG>.
<STRONG>is_notimeout</STRONG>
returns the value set by <STRONG><A HREF="notimeout.3x.html">notimeout(3x)</A></STRONG>.
- <STRONG>is_pad</STRONG> returns <STRONG>TRUE</STRONG> if the window is a pad; that is, it created by
+ <STRONG>is_pad</STRONG> returns <STRONG>TRUE</STRONG> if the window is a pad; that is, it created by
<STRONG><A HREF="newpad.3x.html">newpad(3x)</A></STRONG>.
<STRONG>is_scrollok</STRONG>
returns the value set by <STRONG><A HREF="scrollok.3x.html">scrollok(3x)</A></STRONG>.
<STRONG>is_subwin</STRONG>
- returns <STRONG>TRUE</STRONG> if the window is a subwindow, that is, it was
+ returns <STRONG>TRUE</STRONG> if the window is a subwindow, that is, it was
created by <STRONG><A HREF="subwin.3x.html">subwin(3x)</A></STRONG> or <STRONG><A HREF="derwin.3x.html">derwin(3x)</A></STRONG>.
<STRONG>is_syncok</STRONG>
returns the delay timeout set by <STRONG><A HREF="wtimeout.3x.html">wtimeout(3x)</A></STRONG>.
<STRONG>wgetparent</STRONG>
- returns the parent <EM>WINDOW</EM> pointer for subwindows, or <STRONG>NULL</STRONG> for
+ returns the parent <EM>WINDOW</EM> pointer for subwindows, or <STRONG>NULL</STRONG> for
windows having no parent.
<STRONG>wgetscrreg</STRONG>
- stores the the top and bottom rows for the scrolling margin set
- by <STRONG><A HREF="curs_outopts.3x.html">wsetscrreg(3x)</A></STRONG> in the corresponding arguments, returning <STRONG>ERR</STRONG>
+ stores the the top and bottom rows for the scrolling margin set
+ by <STRONG><A HREF="curs_outopts.3x.html">wsetscrreg(3x)</A></STRONG> in the corresponding arguments, returning <STRONG>ERR</STRONG>
upon failure and <STRONG>OK</STRONG> upon successful completion.
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
- <EM>ncurses</EM> provides both a C function and a preprocessor macro for each
+ <EM>ncurses</EM> provides both a C function and a preprocessor macro for each
function documented in this page.
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
- These routines are specific to <EM>ncurses</EM>. They were not supported on
+ These routines are specific to <EM>ncurses</EM>. They were not supported on
Version 7, BSD or System V implementations. It is recommended that any
code depending on <EM>ncurses</EM> extensions be conditioned using
<STRONG>NCURSES_VERSION</STRONG>.
</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_inopts.3x.html">curs_inopts(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>,
+ <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,
<STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>,
<STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
-ncurses 6.4 2023-10-
07 <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>
+ncurses 6.4 2023-10-
28 <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>
</PRE>
<div class="nav">
<ul>
projects / ncurses.git / blobdiff