| 1 |
.\"*************************************************************************** |
| 2 |
.\" Copyright 2020-2024,2025 Thomas E. Dickey * |
| 3 |
.\" Copyright 2007-2014,2015 Free Software Foundation, Inc. * |
| 4 |
.\" * |
| 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: * |
| 12 |
.\" * |
| 13 |
.\" The above copyright notice and this permission notice shall be included * |
| 14 |
.\" in all copies or substantial portions of the Software. * |
| 15 |
.\" * |
| 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. * |
| 23 |
.\" * |
| 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 * |
| 27 |
.\" authorization. * |
| 28 |
.\"*************************************************************************** |
| 29 |
.\" |
| 30 |
.\" $Id: curs_opaque.3x,v 1.50 2025/02/15 19:36:24 tom Exp $ |
| 31 |
.TH opaque 3NCURSES 2025-02-15 "ncurses 6.6" "Library calls" |
| 32 |
.ie \n(.g \{\ |
| 33 |
.ds `` \(lq |
| 34 |
.ds '' \(rq |
| 35 |
.\} |
| 36 |
.el \{\ |
| 37 |
.ie t .ds `` `` |
| 38 |
.el .ds `` "" |
| 39 |
.ie t .ds '' '' |
| 40 |
.el .ds '' "" |
| 41 |
.\} |
| 42 |
.SH NAME |
| 43 |
\fB\%is_cleared\fP, |
| 44 |
\fB\%is_idlok\fP, |
| 45 |
\fB\%is_idcok\fP, |
| 46 |
\fB\%is_immedok\fP, |
| 47 |
\fB\%is_keypad\fP, |
| 48 |
\fB\%is_leaveok\fP, |
| 49 |
\fB\%is_nodelay\fP, |
| 50 |
\fB\%is_notimeout\fP, |
| 51 |
\fB\%is_pad\fP, |
| 52 |
\fB\%is_scrollok\fP, |
| 53 |
\fB\%is_subwin\fP, |
| 54 |
\fB\%is_syncok\fP, |
| 55 |
\fB\%wgetdelay\fP, |
| 56 |
\fB\%wgetparent\fP, |
| 57 |
\fB\%wgetscrreg\fP \- |
| 58 |
obtain \fIcurses\fR window properties |
| 59 |
.SH SYNOPSIS |
| 60 |
.nf |
| 61 |
\fB#include <curses.h> |
| 62 |
.PP |
| 63 |
\fBbool is_cleared(const WINDOW *\fIwin\fP); |
| 64 |
\fBbool is_idcok(const WINDOW *\fIwin\fP); |
| 65 |
\fBbool is_idlok(const WINDOW *\fIwin\fP); |
| 66 |
\fBbool is_immedok(const WINDOW *\fIwin\fP); |
| 67 |
\fBbool is_keypad(const WINDOW *\fIwin\fP); |
| 68 |
\fBbool is_leaveok(const WINDOW *\fIwin\fP); |
| 69 |
\fBbool is_nodelay(const WINDOW *\fIwin\fP); |
| 70 |
\fBbool is_notimeout(const WINDOW *\fIwin\fP); |
| 71 |
\fBbool is_pad(const WINDOW *\fIwin\fP); |
| 72 |
\fBbool is_scrollok(const WINDOW *\fIwin\fP); |
| 73 |
\fBbool is_subwin(const WINDOW *\fIwin\fP); |
| 74 |
\fBbool is_syncok(const WINDOW *\fIwin\fP); |
| 75 |
.PP |
| 76 |
\fBWINDOW * wgetparent(const WINDOW *\fIwin\fP); |
| 77 |
\fBint wgetdelay(const WINDOW *\fIwin\fP); |
| 78 |
\fBint wgetscrreg(const WINDOW *\fIwin\fP, int *\fItop\fP, int *\fIbottom\fP); |
| 79 |
.fi |
| 80 |
.SH DESCRIPTION |
| 81 |
\fI\%ncurses\fP provides functions returning properties of a |
| 82 |
\fI\%WINDOW\fP structure, |
| 83 |
allowing it to be \*(``opaque\*('' if |
| 84 |
the application defines the \fB\%NCURSES_OPAQUE\fP preprocessor symbol. |
| 85 |
\fIOpacity\fP in this sense means that the members of \fIstruct\fP data |
| 86 |
types are not directly accessible |
| 87 |
(for instance, |
| 88 |
through \*(``.\*('' or \*(``\->\*('' operators), |
| 89 |
but instead must be queried and/or set via library functions. |
| 90 |
Advantages of opacity include greater abstraction and improved |
| 91 |
management of concurrent accesses to data structures, |
| 92 |
keeping object states coherent. |
| 93 |
.TP |
| 94 |
\fBis_cleared\fP |
| 95 |
returns the value set by \fB\%clearok\fP(3NCURSES). |
| 96 |
.TP |
| 97 |
\fBis_idcok\fP |
| 98 |
returns the value set by \fB\%idcok\fP(3NCURSES). |
| 99 |
.TP |
| 100 |
\fBis_idlok\fP |
| 101 |
returns the value set by \fB\%idlok\fP(3NCURSES). |
| 102 |
.TP |
| 103 |
\fBis_immedok\fP |
| 104 |
returns the value set by \fB\%immedok\fP(3NCURSES). |
| 105 |
.TP |
| 106 |
\fBis_keypad\fP |
| 107 |
returns the value set by \fB\%keypad\fP(3NCURSES). |
| 108 |
.TP |
| 109 |
\fBis_leaveok\fP |
| 110 |
returns the value set by \fB\%leaveok\fP(3NCURSES). |
| 111 |
.TP |
| 112 |
\fBis_nodelay\fP |
| 113 |
returns the value set by \fB\%nodelay\fP(3NCURSES). |
| 114 |
.TP |
| 115 |
\fBis_notimeout\fP |
| 116 |
returns the value set by \fB\%notimeout\fP(3NCURSES). |
| 117 |
.TP |
| 118 |
\fBis_pad\fP |
| 119 |
returns \fBTRUE\fP if the window is a pad; |
| 120 |
that is, |
| 121 |
it was created by \fB\%newpad\fP(3NCURSES). |
| 122 |
.TP |
| 123 |
\fBis_scrollok\fP |
| 124 |
returns the value set by \fB\%scrollok\fP(3NCURSES). |
| 125 |
.TP |
| 126 |
\fBis_subwin\fP |
| 127 |
returns \fBTRUE\fP if the window is a subwindow, |
| 128 |
that is, |
| 129 |
it was created by \fB\%subwin\fP(3NCURSES) or \fB\%derwin\fP(3NCURSES). |
| 130 |
.TP |
| 131 |
\fBis_syncok\fP |
| 132 |
returns the value set by \fB\%syncok\fP(3NCURSES). |
| 133 |
.TP |
| 134 |
\fBwgetdelay\fP |
| 135 |
returns the delay timeout set by \fB\%wtimeout\fP(3NCURSES). |
| 136 |
.TP |
| 137 |
\fBwgetparent\fP |
| 138 |
returns the parent \fI\%WINDOW\fP pointer for subwindows, |
| 139 |
or |
| 140 |
.I NULL |
| 141 |
for windows having no parent. |
| 142 |
.TP |
| 143 |
\fBwgetscrreg\fP |
| 144 |
stores the top and bottom rows for the scrolling margin set by |
| 145 |
\fB\%wsetscrreg\fP(3NCURSES) in the corresponding arguments, |
| 146 |
returning \fBERR\fP upon failure and \fBOK\fP upon successful |
| 147 |
completion. |
| 148 |
.SH RETURN VALUE |
| 149 |
These functions return \fBTRUE\fP or \fBFALSE\fP except as noted. |
| 150 |
.SH NOTES |
| 151 |
\fI\%ncurses\fP provides both a C function and a preprocessor macro for |
| 152 |
each function documented in this page. |
| 153 |
.SH EXTENSIONS |
| 154 |
These functions originated with |
| 155 |
.IR \%ncurses "." |
| 156 |
.SH PORTABILITY |
| 157 |
Applications employing |
| 158 |
.I \%ncurses |
| 159 |
extensions should condition their use on the visibility of the |
| 160 |
.B \%NCURSES_VERSION |
| 161 |
preprocessor macro. |
| 162 |
.PP |
| 163 |
NetBSD |
| 164 |
.I curses |
| 165 |
since 10.1 (2024) supports |
| 166 |
.IR \%wgetscr_reg "." |
| 167 |
It also implements |
| 168 |
.IR \%getscr_reg "," |
| 169 |
operating on |
| 170 |
.IR \%stdscr "." |
| 171 |
.SH SEE ALSO |
| 172 |
\fB\%ncurses\fP(3NCURSES), |
| 173 |
\fB\%inopts\fP(3NCURSES), |
| 174 |
\fB\%outopts\fP(3NCURSES), |
| 175 |
\fB\%threads\fP(3NCURSES), |
| 176 |
\fB\%window\fP(3NCURSES) |