***************************************************************************
Copyright 2020 Thomas E. Dickey *
Copyright 2007-2014,2015 Free Software Foundation, Inc. *
*
Permission is hereby granted, free of charge, to any person obtaining a *
copy of this software and associated documentation files (the *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: curs_opaque.3x,v 1.15 2020/10/24 09:41:22 tom Exp $
is_cleared, is_idlok, is_idcok, is_immedok, is_keypad, is_leaveok, is_nodelay, is_notimeout, is_pad, is_scrollok, is_subwin, is_syncok, wgetdelay, wgetparent, wgetscrreg - curses window properties #include <curses.h> bool is_cleared(const WINDOW *win);

bool is_idcok(const WINDOW *win);

bool is_idlok(const WINDOW *win);

bool is_immedok(const WINDOW *win);

bool is_keypad(const WINDOW *win);

bool is_leaveok(const WINDOW *win);

bool is_nodelay(const WINDOW *win);

bool is_notimeout(const WINDOW *win);

bool is_pad(const WINDOW *win);

bool is_scrollok(const WINDOW *win);

bool is_subwin(const WINDOW *win);

bool is_syncok(const WINDOW *win);

WINDOW * wgetparent(const WINDOW *win);

int wgetdelay(const WINDOW *win);

int wgetscrreg(const WINDOW *win, int *top, int *bottom);

This implementation provides functions which return properties set in the WINDOW structure, allowing it to be \*(``opaque\*('' if the symbol NCURSES_OPAQUE is defined:

5 is_cleared returns the value set in clearok

5 is_idcok returns the value set in idcok

5 is_idlok returns the value set in idlok

5 is_immedok returns the value set in immedok

5 is_keypad returns the value set in keypad

5 is_leaveok returns the value set in leaveok

5 is_nodelay returns the value set in nodelay

5 is_notimeout returns the value set in notimeout

5 is_pad returns TRUE if the window is a pad i.e., created by newpad

5 is_scrollok returns the value set in scrollok

5 is_subwin returns TRUE if the window is a subwindow, i.e., created by subwin or derwin

5 is_syncok returns the value set in syncok

5 wgetdelay returns the delay timeout as set in wtimeout.

5 wgetparent returns the parent WINDOW pointer for subwindows, or NULL for windows having no parent.

5 wgetscrreg returns the top and bottom rows for the scrolling margin as set in wsetscrreg.

These functions all return TRUE or FALSE, except as noted. Both a macro and a function are provided for each name. These routines are specific to ncurses. They were not supported on Version 7, BSD or System V implementations. It is recommended that any code depending on ncurses extensions be conditioned using NCURSES_VERSION. curses(3X), curs_inopts(3X), curs_outopts(3X), curs_window(3X)