Scroll to navigation

opaque(3NCURSES) opaque(3NCURSES)


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:

returns the value set in clearok
returns the value set in idcok
returns the value set in idlok
returns the value set in immedok
returns the value set in keypad
returns the value set in leaveok
returns the value set in nodelay
returns the value set in notimeout
returns TRUE if the window is a pad i.e., created by newpad
returns the value set in scrollok
returns TRUE if the window is a subwindow, i.e., created by subwin or derwin
returns the value set in syncok
returns the delay timeout as set in wtimeout.
returns the parent WINDOW pointer for subwindows, or NULL for windows having no parent.
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.


ncurses(3NCURSES), inopts(3NCURSES), outopts(3NCURSES), window(3NCURSES)