is_nodelay3ncurses
Obtain curses window properties
Part of opaque(3ncurses).
Usage
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
ncurses provides functions returning properties of a WINDOW structure, allowing it to be “opaque” if the application defines the NCURSES_OPAQUE preprocessor symbol. Opacity in this sense means that the members of struct data types are not directly accessible (for instance, through “.” or “->” operators), but instead must be queried and/or set via library functions. Advantages of opacity include greater abstraction and improved management of concurrent accesses to data structures, keeping object states coherent.
is_cleared-
returns the value set by clearok(3NCURSES).
is_idcok-
returns the value set by idcok(3NCURSES).
is_idlok-
returns the value set by idlok(3NCURSES).
is_immedok-
returns the value set by immedok(3NCURSES).
is_keypad-
returns the value set by keypad(3NCURSES).
is_leaveok-
returns the value set by leaveok(3NCURSES).
is_nodelay-
returns the value set by nodelay(3NCURSES).
is_notimeout-
returns the value set by notimeout(3NCURSES).
is_pad-
returns TRUE if the window is a pad; that is, it was created by newpad(3NCURSES).
is_scrollok-
returns the value set by scrollok(3NCURSES).
is_subwin-
returns TRUE if the window is a subwindow, that is, it was created by subwin(3NCURSES) or derwin(3NCURSES).
is_syncok-
returns the value set by syncok(3NCURSES).
wgetdelay-
returns the delay timeout set by wtimeout(3NCURSES).
wgetparent-
returns the parent WINDOW pointer for subwindows,
orNULL for windows having no parent.
wgetscrreg-
stores the top and bottom rows for the scrolling margin set by wsetscrreg(3NCURSES) in the corresponding arguments, returning ERR upon failure and OK upon successful
completion.
Return value
These functions return TRUE or FALSE except as noted.
Notes
ncurses provides both a C function and a preprocessor macro for each function documented in this page.
Extensions
These functions originated with ncurses.
Portability
Applications employing ncurses extensions should condition their use on the visibility of the NCURSES_VERSION preprocessor macro.
NetBSD curses since 10.1 (2024) supports wgetscr_reg. It also implements getscr_reg, operating on stdscr.
History
- Debian 13 (Trixie): the text shown here
- Debian 12 (Bookworm)
- Debian 11 (Bullseye)
- Debian 10 (Buster) to Debian 9 (Stretch)
- Debian 8 (Jessie)
- Debian 7 (Wheezy)
- Debian 6.0 (Squeeze)
- Debian 5.0 (Lenny)