1 .\"***************************************************************************
2 .\" Copyright 2020-2022,2023 Thomas E. Dickey *
3 .\" Copyright 2007-2014,2015 Free Software Foundation, Inc. *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a *
6 .\" copy of this software and associated documentation files (the *
7 .\" "Software"), to deal in the Software without restriction, including *
8 .\" without limitation the rights to use, copy, modify, merge, publish, *
9 .\" distribute, distribute with modifications, sublicense, and/or sell *
10 .\" copies of the Software, and to permit persons to whom the Software is *
11 .\" furnished to do so, subject to the following conditions: *
13 .\" The above copyright notice and this permission notice shall be included *
14 .\" in all copies or substantial portions of the Software. *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 .\" Except as contained in this notice, the name(s) of the above copyright *
25 .\" holders shall not be used in advertising or otherwise to promote the *
26 .\" sale, use or other dealings in this Software without prior written *
28 .\"***************************************************************************
30 .\" $Id: curs_opaque.3x,v 1.33 2023/09/23 22:59:48 tom Exp $
31 .TH curs_opaque 3X 2023-09-23 "ncurses 6.4" "Library calls"
52 obtain \fIcurses\fR window properties
55 \fB#include <curses.h>\fP
57 \fBbool is_cleared(const WINDOW *\fIwin\fB);\fR
58 \fBbool is_idcok(const WINDOW *\fIwin\fB);\fR
59 \fBbool is_idlok(const WINDOW *\fIwin\fB);\fR
60 \fBbool is_immedok(const WINDOW *\fIwin\fB);\fR
61 \fBbool is_keypad(const WINDOW *\fIwin\fB);\fR
62 \fBbool is_leaveok(const WINDOW *\fIwin\fB);\fR
63 \fBbool is_nodelay(const WINDOW *\fIwin\fB);\fR
64 \fBbool is_notimeout(const WINDOW *\fIwin\fB);\fR
65 \fBbool is_pad(const WINDOW *\fIwin\fB);\fR
66 \fBbool is_scrollok(const WINDOW *\fIwin\fB);\fR
67 \fBbool is_subwin(const WINDOW *\fIwin\fB);\fR
68 \fBbool is_syncok(const WINDOW *\fIwin\fB);\fR
69 \fBWINDOW * wgetparent(const WINDOW *\fIwin\fB);\fR
70 \fBint wgetdelay(const WINDOW *\fIwin\fB);\fR
71 \fBint wgetscrreg(const WINDOW *\fIwin\fB, int *\fItop\fB, int *\fIbottom\fB);\fR
74 This implementation provides functions which return properties
75 set in the \fB\%WINDOW\fP structure, allowing it to be \*(``opaque\*('' if
76 the symbol \fB\%NCURSES_OPAQUE\fP is defined:
79 returns the value set in \fB\%clearok\fP(3X)
82 returns the value set in \fB\%idcok\fP(3X)
85 returns the value set in \fB\%idlok\fP(3X)
88 returns the value set in \fB\%immedok\fP(3X)
91 returns the value set in \fB\%keypad\fP(3X)
94 returns the value set in \fB\%leaveok\fP(3X)
97 returns the value set in \fB\%nodelay\fP(3X)
100 returns the value set in \fB\%notimeout\fP(3X)
103 returns \fBTRUE\fP if the window is a pad
104 i.e., created by \fB\%newpad\fP(3X)
107 returns the value set in \fB\%scrollok\fP(3X)
110 returns \fBTRUE\fP if the window is a subwindow,
111 i.e., created by \fB\%subwin\fP(3X) or \fB\%derwin\fP(3X)
114 returns the value set in \fB\%syncok\fP(3X)
117 returns the delay timeout as set in \fB\%wtimeout\fP(3X).
120 returns the parent \fB\%WINDOW\fP pointer for subwindows,
121 or \fBNULL\fP for windows having no parent.
124 returns the top and bottom rows for the scrolling margin
125 as set in \fB\%wsetscrreg\fP(3X).
127 These functions all return \fBTRUE\fP or \fBFALSE\fP, except as noted.
129 Both a macro and a function are provided for each name.
131 These routines are specific to \fIncurses\fP.
132 They were not supported on Version 7, BSD or System V implementations.
133 It is recommended that any code depending on \fIncurses\fP extensions
134 be conditioned using \fB\%NCURSES_VERSION\fP.
137 \fB\%curs_inopts\fP(3X),
138 \fB\%curs_outopts\fP(3X),
139 \fB\%curs_window\fP(3X)