curs_opaque(3x) Library calls curs_opaque(3x)
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 - obtain 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:
is_cleared
returns the value set in clearok(3x)
is_idcok
returns the value set in idcok(3x)
is_idlok
returns the value set in idlok(3x)
is_immedok
returns the value set in immedok(3x)
is_keypad
returns the value set in keypad(3x)
is_leaveok
returns the value set in leaveok(3x)
is_nodelay
returns the value set in nodelay(3x)
is_notimeout
returns the value set in notimeout(3x)
is_pad
returns TRUE if the window is a pad i.e., created by newpad(3x)
is_scrollok
returns the value set in scrollok(3x)
is_subwin
returns TRUE if the window is a subwindow, i.e., created by
subwin(3x) or derwin(3x)
is_syncok
returns the value set in syncok(3x)
wgetdelay
returns the delay timeout as set in wtimeout(3x).
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(3x).
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)
ncurses 6.4 2023-09-23 curs_opaque(3x)