curs_opaque3x
Curses window properties
Usage
#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);
Overview
This implementation provides functions which return properties set in the WINDOW structure, allowing it to be “opaque” if the symbol NCURSES_OPAQUE is defined:
is_cleared-
returns the value set in
clearok
is_idcok-
returns the value set in
idcok
is_idlok-
returns the value set in
idlok
is_immedok-
returns the value set in
immedok
is_keypad-
returns the value set in
keypad
is_leaveok-
returns the value set in
leaveok
is_nodelay-
returns the value set in
nodelay
is_notimeout-
returns the value set in
notimeout
is_pad-
returns TRUE if the window is a pad i.e., created by
newpad
is_scrollok-
returns the value set in
scrollok
is_subwin-
returns TRUE if the window is a subwindow, i.e., created by
subwinorderwin
is_syncok-
returns the value set in
syncok
wgetdelay-
returns the delay timeout as set in
wtimeout.
wgetparent-
returns the parent WINDOW pointer for subwindows, or NULL for windows having no parent.
wgetscrreg-
returns the top and bottom rows for the scrolling margin as set in
wsetscrreg.
Return value
These functions all return TRUE or FALSE, except as noted.
Notes
Both a macro and a function are provided for each name.
Portability
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.
Releases
106 releases since Mac OS X 10.6; the text changed 1 time.