| 1 |
<!-- |
| 2 |
**************************************************************************** |
| 3 |
* Copyright 2020-2024,2025 Thomas E. Dickey * |
| 4 |
* Copyright 2007-2014,2015 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_opaque.3x,v 1.50 2025/02/15 19:36:24 tom Exp @ |
| 31 |
--> |
| 32 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> |
| 33 |
<HTML> |
| 34 |
<HEAD> |
| 35 |
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> |
| 36 |
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> |
| 37 |
<TITLE>curs_opaque 3x 2025-02-15 ncurses 6.6 Library calls</TITLE> |
| 38 |
<link rel="author" href="mailto:[email protected]"> |
| 39 |
|
| 40 |
</HEAD> |
| 41 |
<BODY> |
| 42 |
<H1 class="no-header">curs_opaque 3x 2025-02-15 ncurses 6.6 Library calls</H1> |
| 43 |
<PRE> |
| 44 |
<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> |
| 45 |
|
| 46 |
|
| 47 |
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> |
| 48 |
<STRONG>is_cleared</STRONG>, <STRONG>is_idlok</STRONG>, <STRONG>is_idcok</STRONG>, <STRONG>is_immedok</STRONG>, <STRONG>is_keypad</STRONG>, <STRONG>is_leaveok</STRONG>, |
| 49 |
<STRONG>is_nodelay</STRONG>, <STRONG>is_notimeout</STRONG>, <STRONG>is_pad</STRONG>, <STRONG>is_scrollok</STRONG>, <STRONG>is_subwin</STRONG>, <STRONG>is_syncok</STRONG>, |
| 50 |
<STRONG>wgetdelay</STRONG>, <STRONG>wgetparent</STRONG>, <STRONG>wgetscrreg</STRONG> - obtain <EM>curses</EM> window properties |
| 51 |
|
| 52 |
|
| 53 |
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> |
| 54 |
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG> |
| 55 |
|
| 56 |
<STRONG>bool</STRONG> <STRONG>is_cleared(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG> |
| 57 |
<STRONG>bool</STRONG> <STRONG>is_idcok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG> |
| 58 |
<STRONG>bool</STRONG> <STRONG>is_idlok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG> |
| 59 |
<STRONG>bool</STRONG> <STRONG>is_immedok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG> |
| 60 |
<STRONG>bool</STRONG> <STRONG>is_keypad(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG> |
| 61 |
<STRONG>bool</STRONG> <STRONG>is_leaveok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG> |
| 62 |
<STRONG>bool</STRONG> <STRONG>is_nodelay(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG> |
| 63 |
<STRONG>bool</STRONG> <STRONG>is_notimeout(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG> |
| 64 |
<STRONG>bool</STRONG> <STRONG>is_pad(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG> |
| 65 |
<STRONG>bool</STRONG> <STRONG>is_scrollok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG> |
| 66 |
<STRONG>bool</STRONG> <STRONG>is_subwin(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG> |
| 67 |
<STRONG>bool</STRONG> <STRONG>is_syncok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG> |
| 68 |
|
| 69 |
<STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>wgetparent(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG> |
| 70 |
<STRONG>int</STRONG> <STRONG>wgetdelay(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG> |
| 71 |
<STRONG>int</STRONG> <STRONG>wgetscrreg(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>top</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>bottom</EM><STRONG>);</STRONG> |
| 72 |
|
| 73 |
|
| 74 |
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> |
| 75 |
<EM>ncurses</EM> provides functions returning properties of a <EM>WINDOW</EM> structure, |
| 76 |
allowing it to be "opaque" if the application defines the |
| 77 |
<STRONG>NCURSES_OPAQUE</STRONG> preprocessor symbol. <EM>Opacity</EM> in this sense means that |
| 78 |
the members of <EM>struct</EM> data types are not directly accessible (for |
| 79 |
instance, through "." or "->" operators), but instead must be queried |
| 80 |
and/or set via library functions. Advantages of opacity include |
| 81 |
greater abstraction and improved management of concurrent accesses to |
| 82 |
data structures, keeping object states coherent. |
| 83 |
|
| 84 |
<STRONG>is_cleared</STRONG> |
| 85 |
returns the value set by <STRONG><A HREF="curs_outopts.3x.html">clearok(3x)</A></STRONG>. |
| 86 |
|
| 87 |
<STRONG>is_idcok</STRONG> |
| 88 |
returns the value set by <STRONG><A HREF="idcok.3x.html">idcok(3x)</A></STRONG>. |
| 89 |
|
| 90 |
<STRONG>is_idlok</STRONG> |
| 91 |
returns the value set by <STRONG><A HREF="idlok.3x.html">idlok(3x)</A></STRONG>. |
| 92 |
|
| 93 |
<STRONG>is_immedok</STRONG> |
| 94 |
returns the value set by <STRONG><A HREF="curs_outopts.3x.html">immedok(3x)</A></STRONG>. |
| 95 |
|
| 96 |
<STRONG>is_keypad</STRONG> |
| 97 |
returns the value set by <STRONG><A HREF="curs_inopts.3x.html">keypad(3x)</A></STRONG>. |
| 98 |
|
| 99 |
<STRONG>is_leaveok</STRONG> |
| 100 |
returns the value set by <STRONG><A HREF="leaveok.3x.html">leaveok(3x)</A></STRONG>. |
| 101 |
|
| 102 |
<STRONG>is_nodelay</STRONG> |
| 103 |
returns the value set by <STRONG><A HREF="nodelay.3x.html">nodelay(3x)</A></STRONG>. |
| 104 |
|
| 105 |
<STRONG>is_notimeout</STRONG> |
| 106 |
returns the value set by <STRONG><A HREF="notimeout.3x.html">notimeout(3x)</A></STRONG>. |
| 107 |
|
| 108 |
<STRONG>is_pad</STRONG> returns <STRONG>TRUE</STRONG> if the window is a pad; that is, it was created by |
| 109 |
<STRONG><A HREF="newpad.3x.html">newpad(3x)</A></STRONG>. |
| 110 |
|
| 111 |
<STRONG>is_scrollok</STRONG> |
| 112 |
returns the value set by <STRONG><A HREF="scrollok.3x.html">scrollok(3x)</A></STRONG>. |
| 113 |
|
| 114 |
<STRONG>is_subwin</STRONG> |
| 115 |
returns <STRONG>TRUE</STRONG> if the window is a subwindow, that is, it was |
| 116 |
created by <STRONG><A HREF="subwin.3x.html">subwin(3x)</A></STRONG> or <STRONG><A HREF="derwin.3x.html">derwin(3x)</A></STRONG>. |
| 117 |
|
| 118 |
<STRONG>is_syncok</STRONG> |
| 119 |
returns the value set by <STRONG><A HREF="syncok.3x.html">syncok(3x)</A></STRONG>. |
| 120 |
|
| 121 |
<STRONG>wgetdelay</STRONG> |
| 122 |
returns the delay timeout set by <STRONG><A HREF="wtimeout.3x.html">wtimeout(3x)</A></STRONG>. |
| 123 |
|
| 124 |
<STRONG>wgetparent</STRONG> |
| 125 |
returns the parent <EM>WINDOW</EM> pointer for subwindows, or <EM>NULL</EM> for |
| 126 |
windows having no parent. |
| 127 |
|
| 128 |
<STRONG>wgetscrreg</STRONG> |
| 129 |
stores the top and bottom rows for the scrolling margin set by |
| 130 |
<STRONG><A HREF="curs_outopts.3x.html">wsetscrreg(3x)</A></STRONG> in the corresponding arguments, returning <STRONG>ERR</STRONG> |
| 131 |
upon failure and <STRONG>OK</STRONG> upon successful completion. |
| 132 |
|
| 133 |
|
| 134 |
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> |
| 135 |
These functions return <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG> except as noted. |
| 136 |
|
| 137 |
|
| 138 |
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> |
| 139 |
<EM>ncurses</EM> provides both a C function and a preprocessor macro for each |
| 140 |
function documented in this page. |
| 141 |
|
| 142 |
|
| 143 |
</PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE> |
| 144 |
These functions originated with <EM>ncurses</EM>. |
| 145 |
|
| 146 |
|
| 147 |
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> |
| 148 |
Applications employing <EM>ncurses</EM> extensions should condition their use on |
| 149 |
the visibility of the <STRONG>NCURSES_VERSION</STRONG> preprocessor macro. |
| 150 |
|
| 151 |
NetBSD <EM>curses</EM> since 10.1 (2024) supports <EM>wgetscr</EM><STRONG>_</STRONG><EM>reg</EM>. It also |
| 152 |
implements <EM>getscr</EM><STRONG>_</STRONG><EM>reg</EM>, operating on <EM>stdscr</EM>. |
| 153 |
|
| 154 |
|
| 155 |
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> |
| 156 |
<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>, |
| 157 |
<STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG> |
| 158 |
|
| 159 |
ncurses 6.6 2025-02-15 <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG> |
| 160 |
</PRE> |
| 161 |
<div class="nav"> |
| 162 |
<ul> |
| 163 |
<li><a href="#h2-NAME">NAME</a></li> |
| 164 |
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> |
| 165 |
<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> |
| 166 |
<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> |
| 167 |
<li><a href="#h2-NOTES">NOTES</a></li> |
| 168 |
<li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li> |
| 169 |
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> |
| 170 |
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> |
| 171 |
</ul> |
| 172 |
</div> |
| 173 |
</BODY> |
| 174 |
</HTML> |