curs_opaque.3x

Langue: en

Version: 95509 (fedora - 25/11/07)

Section: 3 (Bibliothèques de fonctions)

NAME

is_cleared, is_idlok, is_idcok, is_immedok, is_keypad, is_leaveok, is_nodelay, is_timeout, is_scrollok, is_syncok - curses output options

SYNOPSIS

#include <curses.h>

bool is_cleared(WINDOW *win);
bool is_idcok(WINDOW *win);
bool is_idlok(WINDOW *win);
bool is_immedok(WINDOW *win);
bool is_keypad(WINDOW *win);
bool is_leaveok(WINDOW *win);
bool is_nodelay(WINDOW *win);
bool is_notimeout(WINDOW *win);
bool is_scrollok(WINDOW *win);
bool is_syncok(WINDOW *win);

DESCRIPTION

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_scrollok
returns the value set in scrollok
is_syncok
returns the value set in syncok

RETURN VALUE

These functions all return TRUE or FALSE.

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.

SEE ALSO

curses(3X), curs_inopts(3X), curs_outopts(3X), curs_window(3X)