2 ****************************************************************************
3 * Copyright 2020 Thomas E. Dickey *
4 * Copyright 2007-2014,2015 Free Software Foundation, Inc. *
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: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
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. *
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 *
29 ****************************************************************************
30 * @Id: curs_opaque.3x,v 1.14 2020/02/02 23:34:34 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
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</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
42 <H1 class="no-header">curs_opaque 3x</H1>
44 <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG> <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>is_cleared</STRONG>, <STRONG>is_idlok</STRONG>, <STRONG>is_idcok</STRONG>, <STRONG>is_immedok</STRONG>, <STRONG>is_keypad</STRONG>, <STRONG>is_leaveok</STRONG>,
51 <STRONG>is_nodelay</STRONG>, <STRONG>is_notimeout</STRONG>, <STRONG>is_pad</STRONG>, <STRONG>is_scrollok</STRONG>, <STRONG>is_subwin</STRONG>, <STRONG>is_syncok</STRONG>,
52 <STRONG>wgetdelay</STRONG>, <STRONG>wgetparent</STRONG>, <STRONG>wgetscrreg</STRONG> - <STRONG>curses</STRONG> window properties
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
58 <STRONG>bool</STRONG> <STRONG>is_cleared(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
59 <STRONG>bool</STRONG> <STRONG>is_idcok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
60 <STRONG>bool</STRONG> <STRONG>is_idlok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
61 <STRONG>bool</STRONG> <STRONG>is_immedok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
62 <STRONG>bool</STRONG> <STRONG>is_keypad(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
63 <STRONG>bool</STRONG> <STRONG>is_leaveok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
64 <STRONG>bool</STRONG> <STRONG>is_nodelay(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
65 <STRONG>bool</STRONG> <STRONG>is_notimeout(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
66 <STRONG>bool</STRONG> <STRONG>is_pad(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
67 <STRONG>bool</STRONG> <STRONG>is_scrollok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
68 <STRONG>bool</STRONG> <STRONG>is_subwin(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
69 <STRONG>bool</STRONG> <STRONG>is_syncok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
70 <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>wgetparent(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
71 <STRONG>int</STRONG> <STRONG>wgetdelay(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
72 <STRONG>int</STRONG> <STRONG>wgetscrreg(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>*top,</STRONG> <STRONG>int</STRONG> <STRONG>*bottom);</STRONG>
75 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
76 This implementation provides functions which return properties set in
77 the WINDOW structure, allowing it to be "opaque" if the symbol <STRONG>NCURS-</STRONG>
78 <STRONG>ES_OPAQUE</STRONG> is defined:
80 <STRONG>is_cleared</STRONG>
81 returns the value set in <STRONG>clearok</STRONG>
83 <STRONG>is_idcok</STRONG>
84 returns the value set in <STRONG>idcok</STRONG>
86 <STRONG>is_idlok</STRONG>
87 returns the value set in <STRONG>idlok</STRONG>
89 <STRONG>is_immedok</STRONG>
90 returns the value set in <STRONG>immedok</STRONG>
92 <STRONG>is_keypad</STRONG>
93 returns the value set in <STRONG>keypad</STRONG>
95 <STRONG>is_leaveok</STRONG>
96 returns the value set in <STRONG>leaveok</STRONG>
98 <STRONG>is_nodelay</STRONG>
99 returns the value set in <STRONG>nodelay</STRONG>
101 <STRONG>is_notimeout</STRONG>
102 returns the value set in <STRONG>notimeout</STRONG>
104 <STRONG>is_pad</STRONG>
105 returns <STRONG>TRUE</STRONG> if the window is a pad i.e., created by <STRONG>newpad</STRONG>
107 <STRONG>is_scrollok</STRONG>
108 returns the value set in <STRONG>scrollok</STRONG>
110 <STRONG>is_subwin</STRONG>
111 returns <STRONG>TRUE</STRONG> if the window is a subwindow, i.e., created by <STRONG>subwin</STRONG>
112 or <STRONG>derwin</STRONG>
114 <STRONG>is_syncok</STRONG>
115 returns the value set in <STRONG>syncok</STRONG>
117 <STRONG>wgetdelay</STRONG>
118 returns the delay timeout as set in <STRONG>wtimeout</STRONG>.
120 <STRONG>wgetparent</STRONG>
121 returns the parent WINDOW pointer for subwindows, or NULL for win-
122 dows having no parent.
124 <STRONG>wgetscrreg</STRONG>
125 returns the top and bottom rows for the scrolling margin as set in
126 <STRONG>wsetscrreg</STRONG>.
129 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
130 These functions all return <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>, except as noted.
133 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
134 Both a macro and a function are provided for each name.
137 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
138 These routines are specific to ncurses. They were not supported on
139 Version 7, BSD or System V implementations. It is recommended that any
140 code depending on ncurses extensions be conditioned using NCURSES_VER-
144 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
145 <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_window.3x.html">curs_window(3x)</A></STRONG>
149 <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>
153 <li><a href="#h2-NAME">NAME</a></li>
154 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
155 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
156 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
157 <li><a href="#h2-NOTES">NOTES</a></li>
158 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
159 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>